{ "components": { "headers": {}, "parameters": { "ApiNames": { "description": "Specify the feature API names to filter the response. To retrieve details of more than one feature, provide the names in comma-separated format. Possible values: custom_field - Feature API name for the custom field feature. custom_field,encrypt_field,unique_field,private_fields,external_field,personal_health_fields - Feature API names for multiple features specified together. encrypt_field - Feature API name for the encrypt field feature. external_field - Feature API name for the external field feature. personal_health_fields - Feature API name for the personal health fields feature. private_fields - Feature API name for the private fields feature. unique_field - Feature API name for the unique field feature.", "in": "query", "name": "api_names", "required": false, "schema": { "enum": [ "custom_field", "custom_field,encrypt_field,unique_field,private_fields,external_field,personal_health_fields", "personal_health_fields", "encrypt_field", "external_field", "unique_field", "private_fields" ], "type": "string" } }, "ApisFilters": { "description": "This parameter allows you to filter the supported APIs for the version specified in the URL. You can filter based on three criteria: module, request method, and OAuth scope. The filter syntax is a JSON object with three fields: **field**, **comparator**, and **value**. The **field** can be one of the following: `module`, `operation_types.method`, or `operation_types.oauth_scope`. The **comparator** can be either `equals` or `contains`. The **value** is the value to filter by. Encode the filter while using it in any API platform.\n", "examples": { "Sample": { "summary": "Filter by send_mail scope", "value": "{\n \"field\": {\n \"api_name\": \"operation_types.oauth_scope\"\n },\n \"comparator\": \"equals\",\n \"value\": \"send_mail\"\n}" } }, "in": "query", "name": "filters", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, "AppointmentPreferenceInclude": { "description": "Specify this key to fetch deal record configuration when **when_appointment_completed:create_deal**.\nPossible values: **deal_record_configuration**.\n", "in": "query", "name": "include", "required": false, "schema": { "enum": [ "deal_record_configuration" ], "type": "string" } }, "AppointmentsCvid": { "description": "Specify the unique ID of the Custom View. Use the [Get Custom Views Metadata API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the Custom View IDs.", "in": "query", "name": "cvid", "schema": { "format": "int64", "type": "string" } }, "AppointmentsFields": { "description": "Specify a comma-separated list of field API names to include in the response. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and API names.", "in": "query", "name": "fields", "required": true, "schema": { "type": "string" } }, "AppointmentsPage": { "description": "Specify the page number to retrieve. Starts at 1.", "in": "query", "name": "page", "schema": { "format": "int32", "minimum": 1, "type": "integer" } }, "AppointmentsPageToken": { "description": "Specify the page token to retrieve records beyond the first 2,000 results. Use the **next_page_token** value from a previous response to access the next page of results.", "in": "query", "name": "page_token", "schema": { "maxLength": 96, "type": "string" } }, "AppointmentsParamQueryId": { "description": "Specify the ID of the appointment record to update. Use the [Get Appointments API](appointments.yaml#$.paths./Appointments__s.get) to get the ID.", "in": "query", "name": "id", "required": false, "schema": { "enum": [ 111115000000147180 ], "type": "number" } }, "AppointmentsParamQueryIds": { "description": "Specify the IDs of the appointment records to delete. Accepts comma-separated record IDs. Use the [Get Appointments API](appointments.yaml#$.paths./Appointments__s.get) to get the IDs.", "in": "query", "name": "ids", "required": false, "schema": { "enum": [ 111115000000147280, 111115000000147230 ], "type": "number" } }, "AppointmentsPerPage": { "description": "Specify the number of records to return per page. Maximum is 200.", "in": "query", "name": "per_page", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "AppointmentsSortBy": { "description": "Specify the field to sort records by. Possible values:**id** - Sorts by record ID. **Created_Time** - Sorts by creation timestamp. **Modified_Time** - Sorts by last modification timestamp.", "in": "query", "name": "sort_by", "schema": { "enum": [ "id", "Created_Time", "Modified_Time" ], "type": "string" } }, "AppointmentsSortOrder": { "description": "Specify the sort order for the records.
Possible values:
desc - Returns records in descending order.
asc - Returns records in ascending order.", "in": "query", "name": "sort_order", "schema": { "enum": [ "desc", "asc" ], "type": "string" } }, "AssignmentRulesParamQueryIncludeInnerDetails": { "description": "Specify the param query include inner details value for the request.\nPossible values:\n**created_by.zuid** - Represents created by.zuid.\n**modified_by.zuid** - Represents modified by.zuid.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "enum": [ "created_by.zuid", "modified_by.zuid" ], "type": "string" } }, "AssignmentRulesParamQueryModuleSchema": { "description": "Specify the param query module schema value for the request. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module ID and API name.", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 100, "type": "string" } }, "AttachmentsFields": { "description": "Specify the fields to retrieve. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs.", "in": "query", "name": "fields", "required": false, "schema": { "maxLength": 100000, "type": "string" } }, "AttachmentsId": { "description": "Specify the unique identifier of the attachment. Use the [Get Attachments](attachments.yaml#$.paths./{moduleApiName}/{recordId}/Attachments.get) resource to retrieve attachment IDs.\n", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 64, "type": "string" } }, "AttachmentsModuleApiName": { "description": "Specify the API name of the module (e.g., `Leads`, `Contacts`, `Accounts`). Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.\n", "in": "path", "name": "moduleApiName", "required": true, "schema": { "maxLength": 64, "type": "string" } }, "AttachmentsRecordId": { "description": "Specify the unique identifier of the record. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.\n", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 64, "type": "string" } }, "AuditLogExportId": { "description": "Specify the unique ID of the audit log export job.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 64, "type": "string" } }, "BulkReadJobId": { "description": "Specify the unique identifier of the bulk read job.", "in": "path", "name": "jobId", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "BulkWriteJobId": { "description": "Specify the unique identifier of the bulk write job whose details you want to retrieve.", "in": "path", "name": "jobId", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "CadencesExecutionModule": { "description": "Specify the API name of the module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "example": "Leads", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "CadencesParamQueryIds": { "description": "Specify the unique identifiers of the Cadences to retrieve. Enter a comma-separated list of Cadence IDs.", "in": "query", "name": "ids", "required": false, "schema": { "description": "Comma-separated cadence ids", "example": "111112000000092007,111112000000092270,111112000000094004", "maxLength": 2000, "type": "string" } }, "CadencesParamQueryPage": { "description": "Specify the page number for paginated results.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "CadencesParamQueryPerPage": { "description": "Specify the number of Cadence records to retrieve per page.", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "ChangeOwnerModule": { "description": "Specify the API name of the module.", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "ChangeOwnerRecord": { "description": "Specify the ID of the record for which you want to change the owner.", "in": "path", "name": "record", "required": true, "schema": { "maxLength": 19, "pattern": "^[0-9]+$", "type": "string" } }, "ChannelId": { "description": "Specify the unique identifier of a single notification channel to filter the results.", "in": "query", "name": "channel_id", "required": false, "schema": { "maxLength": 64, "type": "string" } }, "ChannelIds": { "description": "Specify a comma-separated list of channel IDs identifying the notification channels to disable.", "in": "query", "name": "channel_ids", "required": false, "schema": { "maxLength": 512, "type": "string" } }, "ChildData": { "description": "Specify the child data object containing the record ID of the module with a user lookup field. This is required only if the user lookup field has criteria based on the dynamic value of a record. The **query_id** parameter is required when this parameter is provided.", "in": "query", "name": "child_data", "required": false, "schema": { "additionalProperties": true, "properties": { "id": { "description": "Record ID of the module with user look up field", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "id" ], "type": "object" } }, "Contact": { "description": "Represents the unique identifier of the contact record. Use the [Get Records API](record.yaml#$./{module}.get) to get the valid Contact IDs.", "in": "path", "name": "contactId", "required": true, "schema": { "format": "int64", "type": "string" } }, "ContactId": { "description": "The ID of the contact to which the email is to be linked or unlinked", "in": "path", "name": "contactId", "required": true, "schema": { "examples": [ "4876876000000476011" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" } }, "ContactRolesIds": { "description": "Specify a comma-separated list of contact role IDs to delete. Use the [List Contact Roles](contact_roles.yaml#$.paths./contacts/roles.get) resource to retrieve contact role IDs.\n", "in": "query", "name": "ids", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "ContactRolesRole": { "description": "Specify the unique identifier of the contact role. Use the [List Contact Roles](contact_roles.yaml#$.paths./contacts/roles.get) resource to retrieve contact role IDs.\n", "in": "path", "name": "role", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "ConversionOptionIncludeInnerDetails": { "description": "Fetches additional details of lookup or referenced inner resources within the same API call, avoiding separate dependent requests. Accepts a comma-separated list of inner resource paths starting from the root key of the response (the root key itself must not be included). Supports dot notation and JSONPath-style notation (e.g. $..key.sub_key). Invalid or non-permitted paths are silently ignored.", "explode": false, "in": "query", "name": "include_inner_details", "required": false, "schema": { "description": "Comma-separated list of inner resource paths to include additional details for", "maxLength": 256, "minLength": 1, "type": "string" }, "style": "form" }, "ConversionOptionLeadId": { "description": "The unique identifier of the Lead record (int64 as string) for which you want to retrieve conversion options. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the lead record ID.\n", "in": "path", "name": "leadId", "required": true, "schema": { "format": "int64", "type": "string" } }, "ConvertLeadId": { "description": "Unique identifier of the Lead record to convert. Must be a valid Lead ID that exists in the CRM and has not been previously converted. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the lead ID.", "in": "path", "name": "leadId", "required": true, "schema": { "format": "int64", "type": "string" } }, "Currency": { "description": "Path parameter identifying the currency ID.", "in": "path", "name": "currency", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "CurrentUser": { "description": "Specify whether to return only the share entries for the current user. When set to **true**, the response returns only the share entries for the user making the API call.", "in": "query", "name": "current_user", "required": false, "schema": { "type": "boolean" } }, "CustomViewsFilters": { "description": "Specify the filter criteria for retrieving specific Custom Views. Accepts a filter object to narrow down results based on Custom View properties.", "in": "query", "name": "filters", "required": false, "schema": { "$ref": "#/components/schemas/FilterCriterionRequest" } }, "CustomViewsId": { "description": "Specify the unique ID of the Custom View. Use the [Get Custom View API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the custom view IDs.", "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "maxLength": 25, "type": "string" } }, "CustomViewsIds": { "description": "Specify the comma-separated list of unique IDs of the Custom Views to delete. Accepts up to 100 IDs. Use the [Get Custom Views API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the custom view IDs.", "example": [ "123456789012345", "234567890123456" ], "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "description": "List of custom view IDs", "items": { "description": "Custom view ID", "format": "int64", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "style": "form" }, "CustomViewsInclude": { "description": "Specify whether to include the inner details of criteria and cross filters in the response.\nPossible values:\n**inner_details** - Includes the full criteria and cross filter details in the response.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "maxLength": 50, "type": "string" } }, "CustomViewsModule": { "description": "Specify the API name of the module for which to manage Custom Views. Refer to the Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs.resource for valid values.", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 25, "type": "string" } }, "CustomViewsPage": { "description": "Specify the page number for pagination.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "minimum": 1, "type": "integer" } }, "CustomViewsPerPage": { "description": "Specify the number of Custom Views to return per page.", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "DealContactRolesFields": { "description": "Comma-separated list of field names to include in the response. Field names must follow API naming conventions. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) to get the valide field API names.", "examples": { "BasicFields": { "summary": "Basic contact fields", "value": "First_Name,Last_Name,Email" } }, "in": "query", "name": "fields", "required": true, "schema": { "maxLength": 1000, "minLength": 1, "pattern": "^[A-Za-z_][A-Za-z0-9_]*(?:,[A-Za-z_][A-Za-z0-9_]*)*$", "type": "string" } }, "DealContactRolesIds": { "description": "Represents the comma-separated list of contact role relation IDs to delete. Use the [Get Contact Roles API](deal_contact_roles.yaml#$.paths./{module}/{dealId}/Contact_Roles.get) to get the valide IDs.", "in": "query", "name": "ids", "required": false, "schema": { "format": "int64", "type": "string" } }, "DealContactRolesModule": { "description": "Represents the module name for the deal record. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the required module API name.", "in": "path", "name": "module", "required": true, "schema": { "enum": [ "Deals" ], "type": "string" } }, "DealId": { "description": "Represents the unique identifier of the deal record. Use the [Get Records API](record.yaml#$.paths./{module}.get) and get the unique ID of the Deal.", "in": "path", "name": "dealId", "required": true, "schema": { "format": "int64", "type": "string" } }, "DealLinkEmailsMessageId": { "description": "The ID of the email message to be linked or unlinked", "in": "path", "name": "messageId", "required": true, "schema": { "examples": [ "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782" ], "maxLength": 500, "pattern": "^[a-zA-Z0-9]+$", "type": "string" } }, "DeletePreviousForecasts": { "description": "Represents the delete_previous_forecasts query parameter, which specifies whether to delete previous forecast data when transferring and deleting a territory.", "in": "query", "name": "delete_previous_forecasts", "required": false, "schema": { "description": "Denotes whether the request have to delete previous forecasts for these territories.", "type": "boolean" } }, "DeletedRecordsType": { "description": "Specify the category of deleted records to retrieve. Possible values: **all** - Returns both recycled and permanently deleted records. **recycle** - Returns only records in the Recycle Bin. **permanent** - Returns only permanently deleted records.", "in": "query", "name": "type", "required": false, "schema": { "default": "all", "enum": [ "all", "recycle", "permanent" ], "maxLength": 20, "type": "string" } }, "DependencyId": { "description": "Specify the unique identifier of the map dependency to retrieve, update, or delete.", "in": "path", "name": "dependencyId", "required": true, "schema": { "format": "int64", "type": "string" } }, "DownloadAttachmentsId": { "description": "Specify the unique ID of the attachment to download.", "in": "query", "name": "id", "required": true, "schema": { "maxLength": 1000, "type": "string" } }, "DownloadAttachmentsMessageId": { "description": "The message ID you get in the response when you send an email. Refer to the \"message_id\" key in the response of [Send Mail API](send_mail.yaml#$.paths.//{moduleName}/{id}/actions/send_mail.post) or [Get Emails](emails.yaml#$.paths./{moduleApiName}/{id}/Emails.get) of a Record API to get the message ID.", "in": "query", "name": "message_id", "required": true, "schema": { "maxLength": 500, "type": "string" } }, "DownloadAttachmentsModule": { "description": "Specify the API name of the CRM module that contains the record associated with the email. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for module details.", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "DownloadAttachmentsName": { "description": "Specify the file name of the attachment to download. You can get this from the response of [Get Emails API](emails.yaml#$.paths./{moduleApiName}/{id}/Emails.get).", "in": "query", "name": "name", "required": true, "schema": { "maxLength": 150, "type": "string" } }, "DownloadAttachmentsRecordId": { "description": "Specify the unique ID of the record that the email is associated with.", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 20, "type": "string" } }, "DownloadAttachmentsUserId": { "description": "Specify the unique ID of the user who sent the email. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values.", "in": "query", "name": "user_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, "DownloadInlineImagesId": { "description": "Specify the unique ID of the inline image to download. Refer to the **img_id** property in the **content** key of the [Get Emails API](emails.yaml#$.paths./{moduleApiName}/{id}/Emails.get) response to obtain this ID.", "in": "query", "name": "id", "required": true, "schema": { "maxLength": 1000, "type": "string" } }, "DownloadInlineImagesMessageId": { "description": "Specify the message ID of the email containing the inline image. Refer to the **message_id** key in the response of [Send Mail API](send_mail.yaml#$.paths./{moduleName}/{id}/actions/send_mail.post) or [Get Emails API](emails.yaml#$.paths./{moduleApiName}/{id}/Emails.get) to obtain this ID.", "in": "query", "name": "message_id", "required": true, "schema": { "maxLength": 500, "type": "string" } }, "DownloadInlineImagesModule": { "description": "Specify the API name of the module to which the record belongs. Supported modules include Leads, Accounts, Contacts, Deals, Quotes, Invoices, Sales Orders, Purchase Orders, and custom modules.", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 50, "type": "string" } }, "DownloadInlineImagesRecordId": { "description": "Specify the unique ID of the record associated with the email containing the inline image.", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "DownloadInlineImagesUserId": { "description": "The unique ID of the record owner whose email you want to retrieve. Use the [Get Users API](users.yaml#$.paths./users.get) to get the user's ID.", "in": "query", "name": "user_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, "Draft": { "description": "Specifies the unique encrypted draft identifier. Use the [Get Email Drafts](email_drafts.yaml#$.paths./{module}/{record}/__email_drafts.get) resource to retrieve draft IDs.\n", "in": "path", "name": "draft", "required": true, "schema": { "maxLength": 256, "type": "string" } }, "DuplicateCheckPreferenceModule": { "description": "Represents the module whose Duplicate Check Preference details you want to retrieve. Supported module: Leads.", "in": "query", "name": "module", "required": true, "schema": { "enum": [ "Leads" ], "type": "string" } }, "Email": { "description": "Specify an email address to filter the count to records that contain this value in any email field of the specified module. Encode special characters before submitting (for example, use `p%2Bboyle@example.com` for `p+boyle@example.com`).", "example": "p%2Bboyle@abc.com", "in": "query", "name": "email", "required": false, "schema": { "description": "The email address to filter records by. Note that special characters must be URL-encoded (e.g., `p%2Bboyle@example.com` for `p+boyle@example.com`).", "maxLength": 3000, "type": "string" } }, "EmailDraftsModule": { "description": "Specifies the module of the record. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the API names of modules.\n", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "EmailDraftsPage": { "description": "Specifies the page number for pagination. Default:1.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "EmailDraftsPerPage": { "description": "Specifies the number of records per page. Default:200.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "EmailDraftsRecord": { "description": "Specifies the unique identifier of the record. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.\n", "in": "path", "name": "record", "required": true, "schema": { "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" } }, "EmailTemplatesModule": { "description": "Provide the API name of the CRM module to filter Email Templates by. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for module API name.", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 255, "type": "string" } }, "EmailTemplatesPage": { "description": "Specify the page number to retrieve in a paginated response. The default value is 1.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "EmailTemplatesPerPage": { "description": "Provide the maximum number of Email Template records to return per page. Default value is **200** and the maximum value is **200.**", "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "format": "int32", "maximum": 200, "type": "integer" } }, "Event": { "description": "This refers to the Event's id that need to be cancel", "in": "path", "name": "event", "required": true, "schema": { "maxLength": 255, "type": "string", "x-zs-$id": "EventId" }, "x-zs-llm-description": "The unique ID of the Event (Meeting) record to cancel. Obtain this by calling GET /Events API to list events, or use the ID from a previously created event response." }, "ExtraProperties": { "description": "Set to **true** to include additional metadata properties for each related list entry beyond the default set. Possible values: **true**, **false**.", "examples": { "Disabled": { "summary": "Return only default properties", "value": false }, "Enabled": { "summary": "Include extra properties in the response", "value": true } }, "in": "query", "name": "extra_properties", "required": false, "schema": { "default": false, "type": "boolean" } }, "Favourite": { "description": "Filter custom views by favourite status. Set to true to fetch only favourite custom views.", "in": "query", "name": "favourite", "required": false, "schema": { "type": "boolean" } }, "Feature": { "description": "Specify the API name of the feature for which you want to retrieve detailed information.", "in": "path", "name": "feature", "required": true, "schema": { "maxLength": 25, "type": "string" } }, "FeatureName": { "description": "Specify the feature name to filter modules associated with a specific CRM feature.This is case-sensitive and follows snake_case format. An empty string returns 400 error", "examples": { "Forecasts": { "summary": "Retrieve modules for forecasts feature", "value": "forecasts" }, "ScoringRules": { "summary": "Retrieve modules for scoring rules feature", "value": "scoring_rules" } }, "in": "query", "name": "feature_name", "required": false, "schema": { "enum": [ "Kiosk_Test_Run", "sales_motivator_games_users", "functions", "linkingmodule_custom_field_long_integer", "smart_prompt_zia_llm", "voc_parent", "linkingmodule_custom_field_dataparam", "mb_delete_limit_popup", "unsubscribe", "query_sources", "field_updates", "crl_queries_click", "web_case", "google_instant_booking", "emailsai_summary_translation", "ASKZIA_MODULE_CREATION", "static_subform_max_rows", "triggers", "public_field", "custom_field_datetime", "extensions", "mass_email", "nextgenui_new_panel_enabled", "connected_workflows_limit", "CANVAS_META_CACHE_REVERTER", "send_mail_attachments_total_count", "date_queries", "production_tracking", "nbx_early_access", "picklist colour coding V2", "custom_field_dataparam", "teammodule_custom_field", "address_field_enabled", "data_storage_count", "privacy_modules", "email_relay", "manage_signals", "wizard_cross_screen_fields_in_criteria", "page_layout", "sample_subfeature_1", "zoho_reports", "hipaa_compliance", "custom_dashboards", "imap", "Kiosk_Screens", "abm", "massconvert_dealcreation_newflow", "best_mode_to_contact_special_access", "action_field_update_product_configurator", "send_mail_inventory_module", "bounce_email_block", "reports", "personal_health_fields", "Lead_Status_Mapping", "CANVAS_META_CACHE", "analytics", "create_record", "anomaly_notifications", "organize_tabs", "wf_di_notification", "pathfinder_processing_count", "Kiosk", "detailview_customization", "orchestration_execution_limit", "export", "picklist colour coding", "detailview_canvasrules", "duplicate_check_preference", "bigin_domain_mapping", "web_tabs", "Kiosk_GetRecords_Fetch_limit", "custom_field_decision_box", "emailsai_test_account", "notes_short_content", "lookup_filter_new_mapping", "email_notifications", "exchange", "portal_readonlymodule", "custom_field_imageupload", "bcc_dropbox", "gsuite", "writing_assistant", "adwords", "roles", "voc", "consent_email", "disable_nio_flow", "custom_button_api_name_page_lyte", "linkingmodule_custom_field_radio", "firstname_limit_increase_revert", "autofollowup_rules", "microsoft_office", "support_access", "records_limit_custom_view", "zoho_mobile_edition", "outlook", "DATA_BRIDGE", "association_per_global_field", "subform_custom_field_check_box", "WF_BH_FLOW_CHANGE", "rfm_segmentation_contribution_module", "bulk_write", "file_storage_per_user", "event_rsvp_update", "slack", "custom_related_list", "cscript_dotsdk_spec_flow", "QuickML_Integration", "zia_config", "linkingmodule_custom_field_date", "mass_convert", "price_rule_volume", "smart_prompt_new_bot", "zia_agent_in_cb", "kiosk_versions_wise", "record_level_sharing_groups", "linkingmodule_custom_field_rich_text", "printview_customization", "LZ_FAAS_TEST", "linkingmodule_custom_field_imageupload", "related_list_customization", "portals_signup_form", "gdpr_lyte_revamp", "zia_agent", "email_storage_ui", "email_templates_attachments_total_size", "global_picklist_colourCode", "zoho_projects", "Stage_Probability_Mapping", "email_parser", "web_apps", "email_intent_workflow", "FX_CREDITS_STATIC_ISSUE_FIX", "Stage_Used_Option_Count", "user_licenses", "data_storage", "REPORT_FORMULA_DYNAMIC_GROUP_LIMIT", "Kiosk_Components", "zoho_campaigns", "canvas_reusable_component", "comparator", "custom_field_date", "custom_field_text_area", "web_vendor", "abm_segment_export", "Kiosk_GetRecord_Selection_Limit", "organization_emails", "cscript_mxn_field", "email_storage_trigger_resync", "wizards", "email_storage_phase2", "functions_minimum_calls", "voc_inventory", "external_share_record", "email_authentication", "microsoft_teams", "smart_prompt_googleai_llm", "pages", "wizard_cscript_transition_begin", "best_time_to_contact", "zia_vision", "zoho_fsm", "zia_summary", "zoho_contracts", "zia_summary_multilanguage_support", "custom_field_url", "sales_motivator_dashboards", "detailview_canvasfiles", "custom_field_phone", "linkingmodule_custom_field_lookup", "schedule_mail", "mobilecanvas_kiosk_support", "zia_sales_recommendation", "business_card", "shift_hours", "instant_sync_cvid", "CHATBOT_MULTILINGUAL", "firstname_limit_increase", "used_option_count", "smart_prompt_in_cb", "calendar_schedule_user_event", "rfm_record_processing_count", "linkingmodule_custom_field_url", "path_finder_version_wise", "unused_option_count", "record_tags_count", "emailConfigFeatures", "zoho_expense", "bounce_email", "next_best_action", "field_level_security", "portal_personalitymodule", "domain_mappings", "custom_function_upgrade", "gmail_rest_api", "custom_field_check_box", "talk_with_us_zoho_voice_call", "email_workflow", "intergration", "sandbox", "AUTOMATIC_ANOMALY_ENCH_2", "notify_owner", "mobiledetailview_customization", "territory_management", "custom_field_formula", "copy_customization", "form_rules_actions", "functions_limits", "scoring_rules", "sales_signals_mobile_notification_support", "custom_link", "Stage_Total_Option_Count", "inventory_management", "accessibility", "team_module_requester_settings", "dxeditor_m1", "email_templates", "auto_response_rules", "campaign_hierarchy_depth", "sandbox_email_support", "journey_limit_increase", "Bundles__s", "excluded_profiles", "subform_allowed_file_limit", "abm_product", "MS_GRAPH_API", "sales_motivator_dashboards_comp", "zia_score_special_access", "feeds_autofollowuprules_support", "zoho_circuits_pricing", "linkingmodule_custom_field_fileupload", "email_duplication", "linkingmodule_custom_field_percentage", "webform_multidomain", "bigin_dashboards_new_signup", "abm_widget", "zia_call_transcription_cops", "email_credibility", "scheduled_mass_email", "emailparser", "FormviewCustomization", "custommodule", "zcircuits_free_execution_per_month", "orchestration_actions", "homepage_report_components", "BUSINESS_HOURS_SANDBOX", "business_hours", "pdf_sendmail_to_contacts", "auto_responders", "custom_field_small_text_area", "zia_record_summary_special_access", "orchestration_versions_wise", "mail_merge", "connected_workflows", "multicurrency", "zoho_invoice", "file_storage_base", "data_sharing_rules_criteria", "linkingmodule_custom_field_decimal", "waterfall", "connected_records", "web_multimodule_fields", "ListviewCustomization", "activity_badge_upgrade", "abm_contact", "record_level_sharing_indirect_groups", "homepage_components", "abm_plus", "form_rules", "services", "mail_apps", "validation_rule_custom_function", "linkingmodule_custom_field_phone", "payments_integration", "cscript_reports", "store_widget", "custom_field_long_integer", "workflow_rules_summary", "chart", "multipipelines", "cscript_commands", "REPORT_FORMULA_DYNAMIC_SELECT_LIMIT", "text_case_intelligence", "zoho_sign", "voc_sales", "zoho_mail", "record_clone", "multi_page_layout", "input_options_gs", "custom_ai_solutions", "portal_users_store_widget", "holidays", "component_suggestion_early_access", "cscript_dotsdk_new_flow", "email_emotion_analysis", "linkedIn_sales_navigator", "chat_support", "cscript_support_in_portals", "custom_field_integer", "subform_custom_field_large_text_area", "custom_link_new_tab", "recommendation_early_access_new_dc", "custom_field_email", "tiktok_leadchain", "MS_21VIANET", "webform_abtesting", "abm_churn", "telephony", "large_global_set", "mass_delete", "portal_users", "portal_authorizationmodule", "form_rules_branch_criteria_per_condition", "import", "subform_custom_field_small_text_area", "module_builder_new_ui", "zoho_forms", "subform_multiple_fileupload", "ZOHOCPQ", "abm_voc", "team_module_requester_settings_disable", "global_picklists", "live_chat", "zoho_support", "calendar_schedule_team_event", "zoho_circuits", "encrypt_field", "activity_calendar", "disable_ecw_recipient", "zia_call_analytics_automation", "switch_edition", "mb_lyte_qc_enabled", "homeview_customization", "Kiosk_GetRecords_Fetch", "blueprint_states", "calendar_schedule_team_call", "funnel", "subform_encrypt_field", "subform_custom_field_text_area", "CANVAS_BP_MANDATORY_CSCRIPT", "zia_summary_special_access", "ews_mailapps_integ", "datahub", "hamburger_menu_recommended_section", "abm_account", "twitter", "smart_prompt_anthropic_llm_special_access", "zcircuits_free_execution_per_user", "sales_motivator_games_rules", "Kiosk_Screen_Max_Buttons", "quadrant", "custom_reports", "sentiment_analysis", "webform analytics cleanup duration", "system_address_field_enabled", "custom_field_radio", "criteria_entities_product_configurator", "web_custommodule", "CLIENTPORTAL_FOOTER_HIDING", "zia_supported_deployment", "zoho_bookings", "price_rule_direct", "blueprint_transitions", "linkingmodule_custom_field_radiobutton", "custom_field_currency", "calendar_schedule_user", "enable_record_state", "form_rules_primary_condition", "module_deleted_core_flow", "call_transcription_early_access", "emailsai_selfmarketing", "disable_composer_default_spellcheck", "zoho_showtime", "schedule_mass_operation", "emails_ai", "Zoho_Docs", "custom_field_cfpool_userlookup", "gsearch_auto_complete", "blueprint_transition_during_fields", "google_calendar", "cscript_preload", "nextgenui_setuphome_enabled", "guided_selling", "emailFeatures", "api_trigger_limit", "smart_prompt_in_cb_special_access", "visitor_tracking", "mb_new_header", "REPORT_FORMULA_DYNAMIC_CRITERIA_LIMIT", "abm_deal", "rename_tabs", "cscript_subform_row_lock_function", "notes_badge_listview", "smart_prompt_cohere_llm", "validation_rules", "zia_conversation_summary_special_access", "subform_module_max_rows_crud", "linkingmodule_custom_field_decision_box", "zone", "bigin_dashboards_enabled", "global_picklist_per_module", "ear_for_email", "external_field", "cscript_multiuserlookup_field", "rules_limit_per_module", "marketplace", "linkingmodule_custom_field_text_area", "portal_users_new", "Translation_Workbench", "dynamic_lookup_filter", "subform", "linkingmodule_custom_field_text", "homepage_quick_link_components", "validation_rule_primary_condition", "forecasts", "mobilecanvas_navigator", "automation_new_massmail_sources_enabled", "Kiosk_Draft_Execution", "Lyte_Stage_Probability_Mapping", "cpq_dashboard_v2_2_support", "hide_unauthorized_create_link", "best_time_analytics_segmentation_access", "copy_customization_interdc", "custom_function_schedulers", "custom_field_decimal", "change_owner", "appsspace_enabled", "portal_parentmodule", "business_messages", "macros_suggest", "abm_data_enrichment", "portal_user_list_page_landing", "sales_motivator_tvchannels", "similarity_early_access", "email_templates_attachments_total_count", "crm_widgets", "notes_rich_text_support_disable", "zia_copilot", "workflow_rules_executeon_safieldupdate", "team_module_enabled", "mailmerge_email", "cscript", "Kiosk_Execution_Per_User", "trend_analysis", "ZRC", "module_limit_per_process", "zia_anomaly", "lux", "detailview_queries_association", "event_meeting_config", "canvas_clickto_ajaxedit", "chart_view", "office365", "sample_feature_1", "mailchimp", "abm_mood_score", "tags", "event_participants_reminder", "workflow_suggestion", "c3", "abm_rel_flow_demo", "web_forms", "blueprint_common_transitions", "di_cases_access", "zia_reminder", "nbx_goal", "private_fields", "duplicate_image_detection_special_access", "sales_motivator_games_teams", "CANVAS_FILES_UDSDOWNLOAD", "linkingmodule_custom_field_currency", "mass_update_by_cvid", "dynamic_groups_product_configurator", "web_lead", "participants_limit", "best_time_analytics_early_access", "zia_summary_multilanguage_support_special_access", "smart_prompt_deepseek_llm_special_access", "linkingmodule_custom_field_pick_list", "custom_field", "mapview_and_autosuggest", "remote_sales_office", "data_storage_limits_more_than_200_user", "modules_prediction", "stage", "text_product_intelligence", "zia_owner_recommendation", "emailcatchAllFeatures", "sales_motivator_games", "action_entities_product_configurator", "unique_field", "teamdrive", "deduplication_tool", "target_meter", "inventory_templates", "google_docs", "record_level_sharing_indirect_roles", "record_locking_configurations", "query_workbench", "Map_Dependency_Fields", "IS_MAKING_NOTES_RT_NULL_ENABLED", "CHATBOT_QUERY_SUGGESTION", "ms_calendar", "custom_ai_studio", "sandbox_partial_deployment", "custom_field_percentage", "best_time_analytics_special_access", "data_migration", "feeds_followed_records_support", "custom_field_large_text_area", "data_enrichment", "people_enrichment", "phonebridge", "smart_prompt_anthropic_llm", "canvas_grid_layout", "customer_usage_data", "cadences", "custom_functions", "bm_line_integration", "sales_motivator", "cohort", "DT_Filter", "portals_authorization_criteria_count", "custom_field_mxn", "compliance_settings", "apiname_page_corruption_view_enabled", "custom_field_picklist", "best_mode_to_contact", "leadchain", "subform_max_rows_crud_v2", "Kiosk_GetRecord_Selection_Limit_Fetch", "nextgenui_enabled", "form_rules_branch_condition", "api_name_page_lyte", "webform_analytics_revamp", "zia_score", "voc_dashboard_limit", "linking_module", "web_contact", "question_pages_gs", "ciscoteams", "custom_field_lookup", "price_rule", "calendar_schedule_user_call", "SHIFT_IMPORT", "presentation_special_access", "schedule_call", "linkedin_leadchain", "leads_prediction", "CHATBOT_V2_SPECIAL_ACCESS", "keyboard_shortcuts", "subForm_configured_fields", "free_data_backup", "intelligent_character_recognition", "ASKZIA_WORKFLOW_CREATION", "ListviewFromImageToCanvas", "recommendation", "custom_list_views", "custom_field_aggregate_fields", "smart_prompt", "zia_conversation_summary", "field_encryption", "CANVAS_SERVICE", "canvas_detailview_rl_scope", "approval_processes", "notes_rich_text_support", "pitch", "tasks", "team_spaces", "anomaly_notifications_new", "export_xlsx", "query_associations", "portals", "pathfinder_instance_creation_limit", "crm_variables", "zoho_cliq", "di_cases_access_ee", "calendar_schedule_team_per_service", "zoho_backstage", "people_enrichment_isc", "voc_computation_keyword_limit", "subform_permissions", "workflow_report", "user_associations_module_users", "mass_transfer", "CHATBOT_NEW_UI_ENABLED", "customize_setup", "workflow_rules_executeon_sectionupdate", "zia_copilot_language_support", "zia_in_email", "google_contacts", "picklist_history_tracking", "workflow_rules_executeon_fieldupdate", "Kiosk_GetRecords", "calendar_booking", "abm_recommendation", "unique_chk_for_contacts", "portal_user_group_new_ui", "webform_fields_limit", "record_level_sharing_users", "webhooks", "abm_suggested_segments", "subform_max_rows_crud", "subform_v2", "ListviewCanvasRulesLimit", "workflow_rules", "cscript_notes_events", "teamspace_enabled", "subform_module_max_rows_crud_v2", "google_chat", "send_mail", "people_enrichment_extension_migration", "zia_call_analytics", "homepage_kiosk_components", "custom_field_multi_select", "dup_chk_preference", "workflow", "writing_assistant_special_access", "voc_for_loweredition", "notes_edit_delete_by_owner", "abm_recommendation_kakfa_disable", "abm_tour", "booking_pages", "duplicate_image_detection", "workflow_rules_executeon_datetime", "report_export_daily", "call_transcription", "AI_CREDITS", "prediction", "calendar_schedule_team", "cscript_uploadfields_events", "zia_voice", "abm_segment_journey_limit", "zoho_assist", "cscript_subform_feild_set_visible_function", "record_level_sharing_roles", "relay_smtp_debug", "nbx_goal_ui", "customview_sandbox_support", "macro", "teammodule", "multiselect_filter_options", "assignment_rules", "social", "mailcollabview", "presentation_dc", "multicurrency_nf", "total_validation_rules", "Kiosk_Association_Limit_Per_Page", "locking_rules", "pathfinder_limit_increase", "nbx_live_update", "data_storage_per_user", "email_in", "custom_field_radio_button", "schedule_reports", "smart_prompt_siliconflow_llm", "full_data_sandbox", "subject_line_suggestion", "workflow_time_based_actions", "mass_update", "zoho_webinar", "workflow_rules_executeon_delete_plugin", "salesinbox", "text_call_intelligence", "zoho_docs", "emailsai_selfmarketing_phase2", "voc_anonymous", "excluded_fields", "voc_primary", "abm_engagement_score", "linkingmodule_custom_field", "smart_prompt_special_access", "executable_file_upload_restrict", "pop_up_reminders", "trends", "custom_pages", "send_mail_attachments_total_size", "custom_field_auto_number", "text_note_intelligence", "zoho_pagesense", "sales_motivator_rules", "sales_motivator_tvchannels_comp", "product_configurator", "salesinbox_mobile", "split_view_enabled", "total_data_sharing_rules", "google_instant_booking_profile", "customization", "mobile_apps", "lead_conversion_layoutrule", "smart_prompt_zia_llm_special_access", "add_meeting", "record_image", "email_insights", "path_finder", "email", "email_authorisation", "zoho_survey", "churn_prediction", "assign_owner", "report_aggregates_limit", "custom_field_multi_select_multi_module_lookup", "component_suggestion", "dashboards_cache_reduced", "prm_feature_enabled", "Kiosk_Data_Hub", "route_iq", "price_rule_range", "client_portal_saml_configuration", "presentation", "rfm_draft", "linkingmodule_custom_field_small_text_area", "linkingmodule_custom_field_check_box", "canvas_flex_layout", "sales_motivator_targets", "crl_queries", "feedback_mechanism", "subform_permissions_disable", "CSCRIPT_ORG_ZAPPS_RETRY", "data_storage_per_user_more_than_200_user", "admin_center", "sales_motivator_teams_users", "tab_groups", "voc_component_limit", "data_sharing_rules", "subform_custom_field_pick_list", "Lookup_Filter", "records_limit", "custom_field_userlookup", "reports_scheduled", "recommendation_for_workflow", "case_escalation_rules", "FORMULA_DYNAMIC_CRITERIA_LIMIT", "workflow_rules_executeon_delete", "zoho_sheet", "zoho_flow_pricing", "sky_eye", "webform_analytics_url_revamp", "linkingmodule_custom_field_large_text_area", "linkingmodule_custom_field_integer", "webform_suggestions", "disable_sandbox_emailconsumer", "smart_prompt_cohere_llm_special_access", "similarity", "schedules", "field_prevent_duplicate", "zoho_creator", "zia_score_automation", "email_storage", "assignment_thresholds", "facebook_leadchain", "inc_used_option_count", "subform_custom_field", "listview_queries_association", "cv_anomaly", "user_associations_admin_users", "reporting_hierarchy", "smart_filters_limit", "integration_email", "subform_bulk_addition_max_rows", "custom_field_text", "smart_prompt_new_bot_v2_special_access", "zia_record_summary", "sales_signals", "rfm_segmentation", "form_rules_picklist_values_overall", "data_sharing", "zoho_flow", "blueprints", "user_type", "zia", "validation_rule_branch_condition", "record_state_options_limit", "booking_event_participant_limit", "smart_prompt_googleai_llm_special_access", "module_summary", "search_layout", "Competitors_Alert", "marketing_attribution", "abm_limit_enhancement", "nextgenui_user_settings_preference", "catalyst_solutions", "EXTERNAL_MODULE_CONFIG", "gmail", "best_time_analytics", "custom_field_fileupload", "record_level_sharing", "multiple_kanban_view", "audit_logs", "Closure_Restrictions", "linkingmodule_custom_field_multi_select", "functions_call_per_user", "zia_scoring_rule_special_access", "zia_pitch_special_access", "mailbox_mails_population", "additional_pipelines", "text_meeting_intelligence", "chatbot", "facebook", "user_associations", "custom_field_multiuserlookup", "smart_prompt_new_bot_v2", "CSCRIPT_PAGES_MIGRATION", "bigin_dashboards_enabled_trigger", "caldav", "smart_prompt_deepseek_llm", "zia_field_creation", "zoho_circuits_execution", "custom_field_rich_text", "custom_button", "linkingmodule_custom_field_datetime", "reminders", "review_process", "zcircuits_max_execution_per_month", "RELATED_LIST_FIELDS", "sales_motivator_teams", "smart_prompt_siliconflow_llm_special_access", "revert_connected_records", "dashboards_enabled", "CHATBOT_DETAIL_VIEW", "report_export_records_limit", "webform_analytics", "Bundle_Product_Relations__s", "email_sending_restriction", "kpi", "events_notification_mail", "profiles", "record_level_sharing_indirect_users", "recommendation_early_access", "text_email_intelligence", "colourcode_option_count", "fx_mics", "custom_field_cfpool_lookup", "sandbox_data_population_modules", "CanvasRevisions", "email_sharing", "kanban_view", "static_resource", "connected_records_for_org_modules", "CANVAS_LV_CSCRIPT", "linkedin", "presentation_early_access", "custom_field_address_field", "file_cabinet", "m360_newmail_queue", "custom_button_in_zia_widgets", "zoho_campaigns_create", "lead_chain", "form_rules_picklist_values_per_condition", "groups", "email_attachments", "microsoft_outlook", "zia_call_audio_transcription", "gamification", "prediction_analytics", "zoho_subscription", "email_analytics", "ZIA_DASHBOARD_COMPANION", "cscript_subform_events", "linkingmodule_custom_field_email", "restricted_custom_buttons", "zoho_lens" ], "type": "string" } }, "FeaturesModule": { "description": "Specify the API name of the CRM module to filter features that are specific to that module. Refer to the [Get Modules](modules.json#$.paths./settings/modules.get) resource for valid values.", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 25, "type": "string" } }, "FeaturesPage": { "description": "Specify the page number to retrieve features from the corresponding results page. Possible values: 1 - Retrieves features from page one. 2 - Retrieves features from page two.", "in": "query", "name": "page", "required": false, "schema": { "enum": [ "1", "2" ], "type": "string" } }, "FeaturesPerPage": { "description": "Specify the number of features to return per page. Possible values: 10 - Returns ten features per page.", "in": "query", "name": "per_page", "required": false, "schema": { "enum": [ "10" ], "type": "string" } }, "FetchFullDataFields": { "description": "A comma-separated list of rich text field API names whose values you want to retrieve. Mandatory when retrieving rich text fields for multiple records (maximum 8 field API names). Optional when retrieving rich text fields for a specific record - if omitted, all rich text fields of the record are returned.", "examples": { "MultipleFields": { "summary": "A comma-separated list of multiple rich text field API names", "value": "RichTextField1,RichTextField2,RichTextField3" }, "SingleField": { "summary": "A single rich text field API name", "value": "RichTextField1" } }, "in": "query", "name": "fields", "schema": { "maxLength": 1000, "type": "string" } }, "FetchFullDataId": { "description": "The unique identifier of the record whose rich text field content you want to retrieve. Must be a valid numeric record ID. If the ID is invalid, an INVALID_DATA error (HTTP 400) is returned.", "examples": { "ContactId": { "summary": "Typical contact record ID", "value": "3652397000000624002" }, "LeadId": { "summary": "Typical lead record ID", "value": "3652397000000624001" } }, "in": "path", "name": "id", "required": true, "schema": { "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string" } }, "FetchFullDataIds": { "description": "Mandatory when retrieving rich text fields for multiple records. A comma-separated list of unique record IDs whose rich text field values you want to retrieve. You can specify up to 200 record IDs. Exceeding this limit results in an INVALID_REQUEST error.", "examples": { "MultipleIds": { "summary": "A comma-separated list of multiple record IDs", "value": "3652397000000624001,3652397000000624002,3652397000000624003" }, "SingleId": { "summary": "A single record ID", "value": "3652397000000624001" } }, "in": "query", "name": "ids", "required": true, "schema": { "format": "int64", "type": "string" } }, "FetchFullDataModuleApiName": { "description": "The API name of the CRM module containing the record(s) whose rich text fields you want to retrieve (e.g., Leads, Contacts, Deals, Accounts). This is a mandatory path parameter.", "examples": { "Contacts": { "summary": "Contacts module", "value": "Contacts" }, "Leads": { "summary": "Leads module", "value": "Leads" } }, "in": "path", "name": "moduleApiName", "required": true, "schema": { "maxLength": 50, "type": "string" } }, "FieldId": { "description": "Specify the unique numeric identifier of the field. Refer to the [Get Fields Metadata](fields.json#$.paths./settings/fields/{fieldId}.get) resource for valid values.", "examples": { "StandardField": { "summary": "Example field ID", "value": "1629307000006596211" } }, "explode": false, "in": "path", "name": "fieldId", "required": true, "schema": { "format": "int64", "minLength": 1, "type": "string" }, "style": "simple" }, "FieldUpdatesParamQueryFeatureType": { "description": "Filter field updates by automation feature type.", "in": "query", "name": "feature_type", "required": false, "schema": { "enum": [ "workflow", "approval_process", "blueprint", "blueprint_transition", "blueprint_state", "review_process", "orchestration", "assignment_rules", "kiosk", "pathfinder", "connected_workflows", "commandcenter_service" ], "type": "string" } }, "FieldUpdatesParamQueryFilter": { "description": "Advanced filter criteria (JSON-encoded string). Supported only: **field.api_name='name'** and **comparator='contains'**. The value field is dynamic.", "in": "query", "name": "filter", "required": false, "schema": { "example": "{\"field\":{\"api_name\":\"name\"},\"comparator\":\"contains\",\"value\":\"\"}", "maxLength": 10000, "type": "string" } }, "FieldUpdatesParamQueryIds": { "description": "The unique field update IDs you want to delete. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to retrieve the IDs.\n\n", "explode": true, "in": "query", "name": "ids", "required": true, "schema": { "description": "Comma-separated field update IDs to delete (e.g., '111111000000050001,111111000000050002'). Maximum 10 IDs per request.", "maxLength": 10000, "type": "string" }, "style": "form" }, "FieldUpdatesParamQueryIncludeInnerDetails": { "description": "Include optional field metadata in the response. `field_label`: UI label, `enable_colour_code`: picklist color-coding flag, `pick_list_values.colour_code`: HEX color per picklist option, `data_type`: field data type, `display_value`: UI-friendly rendered value.", "explode": true, "in": "query", "name": "include_inner_details", "required": false, "schema": { "enum": [ "field_label", "enable_colour_code", "pick_list_values.colour_code", "data_type", "display_value" ], "type": "string" }, "style": "form" }, "FieldUpdatesParamQueryModule": { "description": "Filter by CRM module API name. Use module API names from the Zoho CRM Modules API (for example: Leads, Contacts, Deals). Use the [Modules metadata API](modules.yaml#$.paths./settings/modules/.get) to get module API names and IDs.", "in": "query", "name": "module", "required": false, "schema": { "example": "Leads", "maxLength": 255, "type": "string" } }, "FieldUpdatesParamQueryPage": { "description": "Page number (1-based).", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "example": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "FieldUpdatesParamQueryPerPage": { "description": "Indicates records per page. Maximum 200.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "example": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "FieldUpdatesParamQueryRelatedModule": { "description": "Filter by related module API name. Use related module API names from the Zoho CRM Modules API (for example: Notes). Use the [Modules metadata API](modules.yaml#$.paths./settings/modules.get) to get module API names.", "in": "query", "name": "related_module", "required": false, "schema": { "example": "Notes", "maxLength": 255, "type": "string" } }, "FieldUpdatesParamQuerySortBy": { "description": "Sort field for list response. Default sorting is by created_time; currently supported explicit value is modified_time.", "explode": true, "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "modified_time" ], "type": "string" }, "style": "form" }, "FieldUpdatesParamQuerySortOrder": { "description": "Sort order for the results based on sort_by. Allowed values: desc, asc.", "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "desc", "asc" ], "type": "string" } }, "FieldsIncludes": { "description": "Specify whether to include the **allowed_permissions** JSON object in the response. Possible values: allowed_permissions_to_update - Includes the allowed_permissions JSON object with details about the default permissions for each field.", "explode": true, "in": "query", "name": "include", "required": false, "schema": { "description": "To include additional information about the field's permissions to update.", "enum": [ "allowed_permissions_to_update" ], "example": "allowed_permissions_to_update", "maxLength": 50, "type": "string" }, "style": "form" }, "FieldsModule": { "description": "Specify the API name of the module for which you want to retrieve field data. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "explode": true, "in": "query", "name": "module", "required": true, "schema": { "description": "The API name of the module to which the field belongs.", "example": "Leads", "maxLength": 30, "type": "string" }, "style": "form" }, "FieldsParamQueryPage": { "description": "Specify the page number for paginating the scheduled jobs list.", "example": 1, "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "FieldsParamQueryPerPage": { "description": "Specify the number of scheduled jobs to return per page.", "example": 200, "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "FieldsType": { "description": "Specify the usage type of the fields to retrieve. Possible values: all - Retrieves both used and unused fields in the module. unused - Retrieves only fields that are not in use. used - Retrieves only fields that are currently in use.", "explode": true, "in": "query", "name": "type", "required": false, "schema": { "enum": [ "all", "unused", "used" ], "maxLength": 10, "type": "string" }, "style": "form" }, "Filter": { "description": "**`filters` Parameter**\n\nThe `filters` parameter is used to filter responses from the Timeline API based on specific conditions.\n\nEach filter condition consists of the following components:\n- field`\n- `comparator`\n- `value`\n\n**Supported `field.api_name` Values**\nThe following values are supported for `field.api_name`:\n- `record.module.api_name`\n- `source`\n- `audited_time`\n- `done_by.id`\n\n**`record.module.api_name`**\nUse this field to filter timeline details related to the following record types:\n- `Notes`\n- `Attachments`\n- `Tasks`\n- `Calls`\n- `Events`\n- `Emails`\n\n**Allowed Comparators**\n- `equal`\n- `in`\n\n**Allowed Values**\n- `Notes`\n- `Attachments`\n- `Tasks`\n- `Calls`\n- `Events`\n- `Emails`\n\n**Example: Filter Notes**\n```json\n{\n \"field\": {\n \"api_name\": \"record.module.api_name\"\n },\n \"comparator\": \"equal\",\n \"value\": \"Notes\"\n}\n```\n**Example: Filter Notes and Tasks**\n```json\n{\n \"field\": {\n \"api_name\": \"record.module.api_name\"\n },\n \"comparator\": \"in\",\n \"value\": [\"Notes\", \"Tasks\"]\n}\n```\n**`done_by.id`**\n\nUse this field to filter timeline details performed by a specific user.\n\n**Allowed Comparators**\n\n- `equal`\n- `in`\n\n**Allowed Values**\n\n- User IDs\n\n**Example**\n\n```json\n{\n \"field\": {\n \"api_name\": \"done_by.id\"\n },\n \"comparator\": \"in\",\n \"value\": [\"5843104000000424001\"]\n}\n```\n\n**`audited_time`**\n\nUse this field to filter timeline data based on the audit timestamp.\n\n**Allowed Comparator**\n\n- `between`\n\n**Allowed Values**\n\n- Time in ISO 8601 format\n\n**Example: Filter Timeline Details Between Two Dates**\n\n```json\n{\n \"field\": {\n \"api_name\": \"audited_time\"\n },\n \"comparator\": \"between\",\n \"value\": [\n \"2023-10-25T00:00:00+12:00\",\n \"2023-10-30T23:59:59+12:00\"\n ]\n}\n```\n\n**`source`**\n\nUse this field to filter timeline data based on its source.\n\n**Allowed Comparators**\n\n- `equal`\n- `in`\n\n**Allowed Values**\n\n- `crm_api`\n- `mass_delete_via_crm_api`\n- `bulkapi`\n- `approval_process`\n- `assignment_rules`\n- `blueprint`\n- `mass_update_via_blueprint`\n- `orchestration`\n- `convert`\n- `massconvert`\n- `custom_function`\n- `macro`\n- `crm_ui`\n- `mass_update`\n- `mass_update_via_scheduler`\n- `mass_delete_via_clean_up`\n- `bulk_action`\n- `change_owner`\n- `mass_change_owner_via_scheduler`\n- `review_process`\n- `scoringrule`\n- `wizard`\n- `workflow`\n\n**Example: Filter by a Single Source**\n\n```json\n{\n \"field\": {\n \"api_name\": \"source\"\n },\n \"comparator\": \"equal\",\n \"value\": \"crm_ui\"\n}\n```\n\n**Example: Filter by Multiple Sources**\n\n```json\n{\n \"field\": {\n \"api_name\": \"source\"\n },\n \"comparator\": \"in\",\n \"value\": [\"crm_api\", \"crm_ui\"]\n}\n```\n\n---\n\n**Combining Multiple Conditions**\n\nUse `group_operator` and `group` to combine multiple filter conditions.\n\n**Example**\n\n```json\n{\n \"group_operator\": \"AND\",\n \"group\": [\n {\n \"field\": {\n \"api_name\": \"record.module.api_name\"\n },\n \"comparator\": \"in\",\n \"value\": [\"Notes\"]\n },\n {\n \"field\": {\n \"api_name\": \"source\"\n },\n \"comparator\": \"in\",\n \"value\": [\"crm_ui\", \"crm_api\"]\n }\n ]\n}\n```\n\nYou can also refer to the sample request for the complete structure.\n\n> **Note:** The value of the `filters` parameter must be URL-encoded before sending the request.\n\n**URL Encoding Example**\n\nThe following filter:\n\n```json\n{\n \"comparator\": \"between\",\n \"field\": {\n \"api_name\": \"audited_time\"\n },\n \"value\": [\n \"2023-06-07T00:00:00+05:30\",\n \"2023-06-07T12:59:59+05:30\"\n ]\n}\n```\n\nis encoded as:\n\n```text\nfilters=%7B%22comparator%22%3A%22between%22%2C%22field%22%3A%7B%22api_name%22%3A%22audited_time%22%7D%2C%22value%22%3A%5B%222023-06-07T00%3A00%3A00%2B05%3A30%22%2C%222023-06-07T12%3A59%3A59%2B05%3A30%22%5D%7D\n```\n\nYou can use the **Encode URL** and **Decode URL** options in the [URL Encoder/Decoder tool](https://www.zoho.com/toolkit/encode-decode.html) to encode or decode this value.\n", "in": "query", "name": "filters", "required": false, "schema": { "maxLength": 255, "type": "string" } }, "FilterId": { "description": "The filter identifier", "in": "query", "name": "filterId", "schema": { "description": "The filter identifier", "format": "int64", "maxLength": 20, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFilters", "propertyId": "FilterId" } ], "resource": "filters" } } }, "FindAndMergeJobId": { "description": "The ID represents the unique identifier of your scheduled merge job, which you get from the response of the [Merge Records API](find_and_merge.yaml#$.paths./{module}/{masterRecordId}/actions/merge.get). ", "in": "query", "name": "job_id", "required": false, "schema": { "description": "Unique identifier for merge job", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "FindAndMergeModule": { "description": "Specify the CRM module name containing the records to be merged.\nPossible values:\n**Accounts** - Accounts module.\n**Contacts** - Contacts module.\n**Leads** - Leads module.\n**Deals** - Deals module.\n**Vendors** - Cases module.\nAdditionally, **custom modules** are also supported in this API. \n", "in": "path", "name": "module", "required": true, "schema": { "description": "Valid CRM module name", "enum": [ "Accounts", "Contacts", "Leads", "Deals", "Cases", "Campaigns" ], "type": "string" } }, "GetRelatedRecordsCountModuleApiName": { "description": "Specify the API name of the CRM module that contains the parent record. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API name and its unique ID.", "examples": { "Accounts": { "summary": "Accounts module", "value": "Accounts" }, "Contacts": { "summary": "Contacts module", "value": "Contacts" }, "CustomModule": { "summary": "Custom module example", "value": "Services__s" }, "Deals": { "summary": "Deals module", "value": "Deals" } }, "in": "path", "name": "moduleApiName", "required": true, "schema": { "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" } }, "GetRelatedRecordsCountRecordId": { "description": "Specify the unique ID of the parent record for which you want to count related records. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record ID.", "examples": { "Numeric": { "summary": "Numeric record ID", "value": "4150868000004381002" }, "Uuid": { "summary": "UUID format record ID", "value": "550e8400-e29b-41d4-a716-446655440000" } }, "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 50, "minLength": 1, "pattern": "^[0-9a-fA-F-]+$", "type": "string" } }, "GlobalPicklistsFields": { "description": "Comma-separated list of the api_names of the global picklist keys to be returned in the response, which lets you filter the response by key. Only the requested keys along with `id` are returned. Keys need not be unique — a key repeated in the list is processed once and the duplicates are ignored. Use CSV encoding (style=form, explode=false) for multiple values, e.g. fields=display_label,api_name,customizable.", "examples": { "Multiple": { "summary": "Multiple keys (CSV)", "value": [ "display_label", "api_name", "customizable" ] }, "Single": { "summary": "Single key", "value": [ "display_label" ] } }, "explode": false, "in": "query", "name": "fields", "required": false, "schema": { "items": { "description": "The api_name of a global picklist key to be returned in the response.", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string" }, "maxItems": 20, "minItems": 1, "type": "array" }, "style": "form" }, "GlobalPicklistsFilters": { "content": { "application/json": { "examples": { "BooleanCriteria": { "summary": "Filter the global picklists that are customizable", "value": { "comparator": "equal", "field": { "api_name": "customizable" }, "value": true } }, "GroupOfCriteria": { "summary": "Filter using multiple criteria combined with a group operator", "value": { "group": [ { "comparator": "equal", "field": { "api_name": "api_name" }, "value": "Industry" }, { "comparator": "equal", "field": { "api_name": "source" }, "value": "crm" } ], "group_operator": "and" } }, "NotEqualCriteria": { "summary": "Filter the global picklists that are not created from CRM", "value": { "comparator": "not_equal", "field": { "api_name": "source" }, "value": "crm" } }, "SingleCriteria": { "summary": "Filter the global picklists whose api_name is Industry", "value": { "comparator": "equal", "field": { "api_name": "api_name" }, "value": "Industry" } } }, "schema": { "$ref": "#/components/schemas/GlobalPicklistFilters" } } }, "description": "JSON object used to filter the global picklists by the value of a key. Give either a single criteria using \"field\", \"comparator\" and \"value\", or a set of criteria in \"group\" combined using \"group_operator\". \"group\" and \"group_operator\" are mandatory to each other, and within a criteria \"comparator\" and \"value\" are dependent on \"field\". Only the \"api_name\", \"source\" and \"customizable\" keys can be filtered on; any other key returns a 400 with the code NOT_SUPPORTED. The string keys \"api_name\" and \"source\" support the \"equal\" and \"not_equal\" comparators with a string value, and the boolean key \"customizable\" supports only the \"equal\" comparator with a boolean value. Criteria cannot be nested inside another \"group\".", "in": "query", "name": "filters", "required": false }, "GlobalPicklistsId": { "description": "Numeric id of the global picklist. Use the [Get All Global Picklists](global_picklists.yaml#$.paths./settings/global_picklists.get) resource to retrieve global picklist IDs.\n", "example": "111111000000055938", "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "string" } }, "GlobalPicklistsInclude": { "description": "Comma-separated list of related resources to include. Allowed values: \"used_in_modules\", \"pick_list_values\", \"associated_fields_count\". Use CSV encoding (style=form, explode=false) for multiple values, e.g. include=used_in_modules,pick_list_values.", "examples": { "Multiple": { "summary": "Multiple values (CSV)", "value": [ "used_in_modules", "associated_fields_count" ] }, "Single": { "summary": "Single value", "value": [ "used_in_modules" ] } }, "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "description": "Allowed values for including related resources in the response.", "enum": [ "used_in_modules", "pick_list_values", "associated_fields_count" ], "type": "string" }, "maxItems": 3, "type": "array" }, "style": "form" }, "GlobalPicklistsIncludeInnerDetails": { "description": "Optional detailed expansion keys. Currently only allowed when `used_in_modules` is present in `include`. Allowed value: used_in_modules.plural_label.", "examples": { "Example": { "summary": "plural label will be included in used_in_modules", "value": "used_in_modules.plural_label" } }, "in": "query", "name": "include_inner_details", "required": false, "schema": { "enum": [ "used_in_modules.plural_label" ], "type": "string" } }, "GlobalPicklistsPage": { "description": "Page number (positive integer). Default: 1.", "example": 1, "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "GlobalPicklistsPerPage": { "description": "Number of records per page. Default and maximum: 200.", "example": 20, "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "format": "int64", "maximum": 200, "minimum": 1, "type": "integer" } }, "Group": { "description": "Specify the unique ID of the user group to operate on. From API v9 onwards, UUID format is also accepted. Example: `1234567890`.", "in": "path", "name": "group", "required": true, "schema": { "enum": [ "1234567890" ], "type": "string" } }, "HolidayId": { "description": "Specify the unique identifier of the holiday.", "examples": { "Default": { "summary": "Example holiday ID", "value": "5725767000000525001" } }, "in": "path", "name": "holidayId", "required": true, "schema": { "description": "The Holiday id of the object.", "maxLength": 30, "minLength": 1, "pattern": "^[0-9]+$", "type": "string" } }, "HolidaysType": { "description": "Specify the type of holidays to retrieve.\nPossible values: business_holiday, shift_holiday.", "examples": { "Business": { "summary": "Business holidays", "value": "business_holiday" }, "Shift": { "summary": "Shift holidays", "value": "shift_holiday" } }, "in": "query", "name": "type", "required": false, "schema": { "description": "The Type of the object.", "enum": [ "business_holiday", "shift_holiday" ], "type": "string" } }, "IdsOptional": { "description": "Specify the unique identifiers of the records to retrieve as a comma-separated list.", "in": "query", "name": "ids", "required": false, "schema": { "maxLength": 2000, "pattern": "^[0-9]+(,[0-9]+)*$", "type": "string" } }, "IncludeChild": { "description": "Specify whether to include records assigned to child territories of the specified territory.", "in": "query", "name": "include_child", "schema": { "type": "boolean" } }, "IncludeFilters": { "description": "To include inner details of criteria and cross filters", "in": "query", "name": "include_filters", "required": false, "schema": { "maxLength": 50, "type": "string" } }, "IncludeTimelineType": { "description": "To include extra types in the \"timeline\" object. You can get \"signals\" data through this to get signals-related timeline entries.", "in": "query", "name": "include_timeline_types", "required": false, "schema": { "maxLength": 255, "type": "string" } }, "IncludeTypes": { "description": "Comma-separated list of additional profile types to include alongside the default Administrator, Standard, and custom profiles. Accepted pattern: `(Lite|Support)(,(Lite|Support))*`.", "examples": { "LiteAndSupport": { "summary": "Include both lite and support profiles", "value": "Lite,Support" }, "LiteOnly": { "summary": "Include lite profiles", "value": "Lite" }, "SupportOnly": { "summary": "Include support profiles", "value": "Support" } }, "in": "query", "name": "include_types", "required": false, "schema": { "description": "Allowed values (case-sensitive): Lite, Support. Use commas to include multiple.", "maxLength": 50, "pattern": "^(Lite|Support)(,(Lite|Support))*$", "type": "string" } }, "InventoryConvertId": { "description": "Specify the unique ID of the source inventory record to convert. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module's ID. \n**Possible values:** Quotes, Sales_Orders.\n", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "InventoryConvertModuleApiName": { "description": "Specify the API name of the source inventory module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module's API name.", "in": "path", "name": "moduleApiName", "required": true, "schema": { "enum": [ "Quotes", "Sales_Orders" ], "type": "string" } }, "InventoryTemplatesModule": { "description": "Specifies the API name of the CRM module used to filter the returned inventory templates.", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 128, "type": "string" } }, "InventoryTemplatesPage": { "description": "Specify the page number to retrieve in the paginated results.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "InventoryTemplatesPerPage": { "description": "Specify the number of inventory templates to return per page.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "format": "int32", "maximum": 200, "type": "integer" } }, "LayoutID": { "description": "Specify the Layout ID of the Deals module. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID.", "in": "query", "name": "layout_id", "required": true, "schema": { "description": "Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" } ], "resource": "layouts" } }, "x-zs-llm-description": "ID of the Deals module layout. Pipelines are configured per layout, so the layout must be resolved via the Get Layouts Metadata API before calling this endpoint. Required for all pipeline operations." }, "LayoutIdParameter": { "description": "Specify the unique identifier of the layout. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.", "examples": { "ValidId": { "summary": "Valid layout ID", "value": "111111000000098320" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" } ], "resource": "layouts" } } }, "LayoutsActivateDeactivateId": { "description": "Specify the unique identifier of the layout to activate or deactivate. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.", "examples": { "CustomLayoutId": { "summary": "Custom layout ID", "value": "4831139000000673152" }, "StandardLayoutId": { "summary": "Standard layout ID", "value": "4831139000000655701" } }, "in": "path", "name": "id", "required": true, "schema": { "description": "Layout identifier as a 64-bit integer", "format": "int64", "type": "string" } }, "LayoutsActivateDeactivateModule": { "description": "Specify the API name of the module that contains the layout. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "examples": { "ContactsModule": { "summary": "Standard CRM module - Contacts", "value": "Contacts" }, "CustomModule": { "summary": "Custom module example", "value": "Custom_Projects" }, "CustomModuleWithNumbers": { "summary": "Custom module with numeric suffix", "value": "Testing_module_1" }, "DealsModule": { "summary": "Standard CRM module - Deals", "value": "Deals" }, "LeadsModule": { "summary": "Standard CRM module - Leads", "value": "Leads" } }, "in": "query", "name": "module", "required": true, "schema": { "description": "Module API name", "maxLength": 100, "minLength": 1, "pattern": "^[A-Z][A-Za-z0-9_]*$", "type": "string" } }, "LayoutsIncludeInnerDetails": { "description": "Specify additional inner details to include in the response for each field. Possible values: `fields.allowed_permissions_to_update` - Include the set of permissions eligible for update per field. `fields.portal_user_types` - Include portal user type permission entries per field.", "examples": { "FieldsAllowedPermissions": { "summary": "Include allowed permissions to update for fields", "value": "fields.allowed_permissions_to_update" }, "FieldsPortalUserTypes": { "summary": "Include portal user types for fields", "value": "fields.portal_user_types" }, "MultipleDetails": { "summary": "Include multiple inner details", "value": "profiles.type,fields.portal_user_types" }, "ProfileType": { "summary": "Include profile type information", "value": "profiles.type" } }, "in": "query", "name": "include_inner_details", "required": false, "schema": { "example": "profiles.type,fields.portal_user_types,fields.allowed_permissions_to_update", "maxLength": 255, "pattern": "^[a-z_]+(\\.[a-z_]+)?(,[a-z_]+(\\.[a-z_]+)?)*$", "type": "string" } }, "LayoutsIncludes": { "description": "Specify additional data to include in the response beyond the default layout structure. Possible values: `total_profiles` — include the total count of profiles associated with each layout. `portal_user_types` — include portal user type associations for each layout.", "examples": { "IncludeTotalProfiles": { "summary": "Include total profiles", "value": "total_profiles" } }, "in": "query", "name": "include", "required": false, "schema": { "enum": [ "total_profiles", "portal_user_types" ], "type": "string" } }, "LockId": { "description": "Specify the unique identifier of the lock record to be removed or updated.", "in": "path", "name": "lockId", "required": true, "schema": { "maxLength": 32, "type": "string" } }, "LockingInformationsFields": { "description": "Specify the field API names to include in the response. Accepts comma-separated values. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs.", "in": "query", "name": "fields", "required": false, "schema": { "maxLength": 2048, "type": "string" } }, "LockingInformationsModuleName": { "description": "The API name of the module to which the locked record belongs. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module ID and API name.", "in": "path", "name": "moduleName", "required": true, "schema": { "maxLength": 256, "type": "string" } }, "LockingInformationsRecordId": { "description": "Specify the unique identifier of the record for which you want to manage the lock.", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 32, "type": "string" } }, "MapDependencyFilters": { "description": "Specify the filter criteria for field dependencies in JSON format. Supported filters allow narrowing results by specific field attributes using **comparator** and **field** attributes. Supported comparator values: **equal**, **in**.\n", "in": "query", "name": "filters", "required": false, "schema": { "maxLength": 100, "type": "string" } }, "MapDependencyLayoutId": { "description": "Specify the unique identifier of the layout. Use the [Get Layouts API](layouts.yaml#$./settings/layouts.get) to get the ID of the layout.", "in": "path", "name": "layoutId", "required": true, "schema": { "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "MapDependencyModule": { "description": "Specify the API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the valid API names. ", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string" } }, "MapDependencyPage": { "description": "Specify the page number to retrieve in the paginated response.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "MapDependencyPerPage": { "description": "Specify the number of records to include on each page of the response.", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "maximum": 200, "type": "integer" } }, "MassChangeOwnerJobId": { "description": "Specify the unique ID of the mass change owner job returned in the response of [Mass Change Owner API](mass_change_owner.yaml#$.paths./{module}/actions/mass_change_owner.post).", "in": "query", "name": "job_id", "required": true, "schema": { "maxLength": 19, "type": "string" } }, "MassChangeOwnerModule": { "description": "Specify the API name of the CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "MassConvertJobId": { "description": "Specify the identifier of the mass convert job to retrieve the status for. You can get the Job ID from the response of the [Mass Convert API](mass_convert.yaml#$.paths./Leads/actions/mass_convert.get).", "in": "query", "name": "job_id", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "MassDeleteModule": { "description": "Specify the API name of the CRM module for the mass delete operation. Make a [Get Modules API](modules.yaml#$.paths./settings/modules.get) call for valid values.", "in": "path", "name": "module", "required": true, "schema": { "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, "type": "string" } }, "MassUpdateJobId": { "description": "Specify the unique ID of the mass update job whose status must be retrieved. This is the `job_id` returned in the response of the [Mass Update API](mass_update.yaml#$/{module}/actions/mass_update.post) request.", "in": "query", "name": "job_id", "required": true, "schema": { "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "MassUpdateModule": { "description": "Specify the API name of the CRM module on which the mass update operation must be performed. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to fetch the valid API name of the module. ", "in": "path", "name": "module", "required": true, "schema": { "enum": [ "Leads", "Accounts", "Contacts", "Deals", "Campaigns", "Tasks", "Calls", "Meetings", "Cases", "Solutions", "Products", "Vendors", "Price_Books", "Quotes", "Sales_Orders", "Purchase_Orders", "Invoices", "Custom" ], "type": "string" } }, "MasterRecordId": { "description": "Specify the unique identifier of the master record to be retained after the merge operation. ", "in": "path", "name": "masterRecordId", "required": true, "schema": { "description": "Master record identifier (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "MessageIds": { "description": "The IDs of the email messages to be linked", "in": "query", "name": "message_ids", "required": true, "schema": { "examples": [ "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782,6e78663d9e92be2868fc339bf88fea06cadeb6f678479e5d3e8aacd7c544ae8eea1034c510cec43527a3eec50151290f" ], "maxLength": 2000, "pattern": "^[a-zA-Z0-9]+(,[a-zA-Z0-9]+)*$", "type": "string" } }, "MirrorComponentParameter": { "description": "Specify the type of field component in the layout, distinguishing standard fields from mirror fields that derive their value from a lookup source. Possible values: `field` — a standard data field in the layout. `mirror_field` — a field that reflects a value from a related module lookup.", "examples": { "FieldsType": { "summary": "Field type", "value": "field" }, "MirrorFieldType": { "summary": "Mirror field type", "value": "mirror_field" } }, "in": "query", "name": "include_element_types", "required": false, "schema": { "enum": [ "field", "mirror_field" ], "type": "string" } }, "ModeParameter": { "description": "Specify the layout mode to filter the response. Available modes vary by module type. Possible values: `all` - Request all available layout modes. `business_card` - Business card layout view. `quick_create` - Quick create form layout.", "examples": { "AllModes": { "summary": "All modes", "value": "all" }, "BusinessCard": { "summary": "Business card mode", "value": "business_card" }, "QuickCreate": { "summary": "Quick create mode", "value": "quick_create" } }, "in": "query", "name": "mode", "required": false, "schema": { "enum": [ "all", "business_card", "quick_create" ], "type": "string" } }, "ModuleIdentifier": { "description": "Specify the module identifier, either the numeric module ID or the module API name(case-sensitive).", "in": "path", "name": "moduleIdentifier", "required": true, "schema": { "anyOf": [ { "description": "Unique numeric identifier. Numeric string representation of a 64-bit positive integer.", "format": "int64", "type": "string", "x-zs-$id": "ModuleIdentifierId" }, { "description": "API name of the module to retrieve. Case-sensitive identifier following specific naming rules: must start with a letter, contain only alphanumeric characters and underscores, cannot have consecutive underscores, and must end with alphanumeric character.", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*[A-Za-z0-9]$", "type": "string", "x-zs-$id": "ModuleIdentifierAPIName" } ] } }, "ModuleParameter": { "description": "Specify the API name of the required module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "examples": { "CustomModule": { "summary": "Custom module", "value": "Custom_Projects" }, "StandardModule": { "summary": "Standard module", "value": "Leads" } }, "in": "query", "name": "module", "required": true, "schema": { "description": "Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores.", "maxLength": 50, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } } }, "ModuleSearchApprovalState": { "description": "Specify the approval state to filter records by. The search returns only records in the specified approval state.\nPossible values: **approval_process_pending**, **webform_invalid**, **review_process_pending**, **webform_invalid_approval**, **zia_vision_validation**, **review_process_rejected**, **webform_unapproved**, **email_parser_waiting**, **approved**, **merge_pending**, **email_parser_rejected**, **zia_vision_rejected**, **zia_vision_pending**, **approval_process_rejected**, **webform_double_optin**.", "examples": { "Approved": { "summary": "Get only approved records", "value": "approved" }, "Pending": { "summary": "Get records pending approval", "value": "approval_process_pending" }, "Rejected": { "summary": "Get rejected records", "value": "approval_process_rejected" } }, "in": "query", "name": "approval_state", "required": false, "schema": { "enum": [ "approval_process_pending", "webform_invalid", "review_process_pending", "webform_invalid_approval", "zia_vision_validation", "review_process_rejected", "webform_unapproved", "email_parser_waiting", "approved", "merge_pending", "email_parser_rejected", "zia_vision_rejected", "zia_vision_pending", "approval_process_rejected", "webform_double_optin" ], "maxLength": 50, "type": "string" } }, "ModuleSearchConverted": { "description": "Specify whether to filter records by their conversion status. Applicable only for the Leads module.\nPossible values:\n**true** - Returns only converted leads.\n**false** - Returns only unconverted leads.\n**both** - Returns all leads regardless of conversion status.\nDefaults to **false**.", "examples": { "AllRecords": { "summary": "Get all records regardless of conversion status", "value": "both" }, "OnlyConverted": { "summary": "Get only converted records (e.g., converted leads)", "value": "true" }, "OnlyUnconverted": { "summary": "Get only non-converted records (default)", "value": "false" } }, "in": "query", "name": "converted", "required": false, "schema": { "default": "false", "enum": [ "true", "false", "both" ], "maxLength": 10, "type": "string" } }, "ModuleSearchCriteria": { "description": "Specify a criteria string to filter records using field-specific conditions and operators.\nPerforms a search using the following format:\n\n`(({field_API_name}:{operator}:{value}) and/or ({field_API_name}:{operator}:{value}))`\n\nReplace `{field_API_name}`, `{operator}`, and `{value}` with the\nappropriate field API name, condition, and value.\n- You can search using a maximum of 10 criteria, with the same or\n different fields.\n- The only operator supported for encrypted fields is `equals`.\n\nWhen using the `equals` operator in the Search API, it behaves like\n`contains`, retrieving records that include the specified value.\nFor a single condition, if the condition is:\n\n`(Company:equals:ABC)`\n\nthe response includes records with `ABC` as well as `ABC Inc.` in the\n`Company` field.\nFor multiple conditions, `equals` continues to behave like `contains`.\n\n**For example:**\n`((Company:equals:ABC) and (First_Name:starts_with:M))`\nThis retrieves records where:\n\n- `First_Name` starts with `M`\n- `Company` contains `ABC` (for example, `ABC` or `ABC Inc.`)\n\n** Note**: This behavior does not apply to picklist fields.\n\nThe `in` operator checks whether a field value matches any value in a given list.\n**For example:**\n\n`(Full_Name:in:Patricia,Boyle,Kate)`\n\nThis retrieves records where the `Full_Name` is `Patricia`, `Boyle`, or\n`Kate`.\n\nWhen a single-line field value contains characters such as:\n\n`{ } [ ] ^ : - / ! ? * _ @` or spaces,\n\nthe Search API may return records with similar-looking values, even when\nthe characters are not an exact match.\n\nFor example:\n\n- Record A: `sales-team@example.com`\n- Record B: `sales_team@example.com`\n\nA search using:\n\n`equals:sales-team@example.com`\n\nmay return both records.\n\n**Escaping Special Characters**\n\nWhen using parentheses `(` `)`, commas `,`, or a backslash `\\` as the\nlast character in a search value:\n\n1. Escape special characters using a backslash (`\\`).\n2. Encode the value before making the API request.\n3. Select the value of the criteria, right-click the value, and choose\n the `EncodeURIComponent` option.\n\n**Example 1: Escaping Parentheses and Commas**\n\nSearch term:\n\n`((Last_Name:equals:Burns,B) and (First_Name:starts_with:M))`\n\nEscape the comma:\n\n`((Last_Name:equals:Burns\\,B) and (First_Name:starts_with:M))`\n\nEncode the value:\n\n`((Last_Name:equals:Burns%5C%2CB) and (First_Name:starts_with:M))`\n\n**Example 2: Escaping a Backslash at the End**\n\nSearch term:\n\n`(Last_Name:equals:K\\)`\n\nEscape the backslash:\n\n`(Last_Name:equals:K\\\\)`\n\nEncode the value:\n\n`(Last_Name:equals:K%5C%5C)`\n\n**Supported Data Types**\n\n- `picklist`\n- `owner_lookup`\n- `user_lookup`\n- `lookup`\n- `phone`\n- `email`\n- `date`\n- `datetime`\n- `text`\n- `textarea`\n- `integer`\n- `currency`\n- `decimal`\n- `multiselectpicklist`\n- `bigint`\n- `percent`\n- `formula`\n- `website`\n- `boolean`\n- `double`\n\n**Supported Operators**\n\n- `equals`\n- `starts_with`\n- `in`\n- `not_equal`\n- `greater_equal`\n- `greater_than`\n- `less_equal`\n- `less_than`\n- `between`\n\nRefer to the following note for operator support by field type.\n* **Date, DateTime:** `equals`, `not_equal`, `greater_equal`, `greater_than`, `less_equal`, `less_than`, `between`, `in`\n* **Integer, Currency, Decimal:** `equals`, `not_equal`, `greater_equal`, `greater_than`, `less_equal`, `less_than`, `between`, `in`\n* **Boolean:** `equals`, `not_equal`\n* **textarea:** `equals`, `not_equal`, `starts_with`\n* **Lookup (user/owner):** `equals`, `not_equal`, `in`\n* **Picklist, Autonumber:** `equals`, `not_equal`, `in`\n* **Text, Email, Phone, Website:** `equals`, `not_equal`, `starts_with`, `in`\n* **multiselectpicklist:** `equals`, `not_equal`, `in`, `starts_with`\n* **bigint:** `equals`, `not_equal`, `greater_than`, `greater_equal`, `less_than`, `less_equal`, `between`, `in`\n* **percent:** `equals`, `not_equal`, `greater_than`, `greater_equal`, `less_than`, `less_equal`, `between`, `in`\n* **formula:** Operators depend on the formula return type. Check the corresponding data type's supported operators.\n\n", "examples": { "ComplexCriteria": { "summary": "Multiple conditions with AND operator", "value": "((Company:equals:Zylker) and (Lead_Status:equals:Qualified))" }, "DateRange": { "summary": "Date range criteria", "value": "((Created_Time:greater_equal:2023-01-01T00:00:00+00:00) and (Created_Time:less_equal:2023-12-31T23:59:59+00:00))" }, "InOperator": { "summary": "Using IN operator for multiple values", "value": "(Lead_Status:in:Qualified,Contacted,Converted)" }, "SimpleCriteria": { "summary": "Simple equality condition", "value": "(Company:equals:Zylker)" } }, "in": "query", "name": "criteria", "required": false, "schema": { "maxLength": 3000, "type": "string" } }, "ModuleSearchFields": { "description": "Specify a comma-separated list of field API names to include in the response. If omitted, the response includes all fields accessible to the current user.", "examples": { "AccountFields": { "summary": "Key account information fields", "value": "Account_Name,Industry,Annual_Revenue,Phone" }, "BasicFields": { "summary": "Basic contact information fields", "value": "First_Name,Last_Name,Email,Phone" }, "LeadFields": { "summary": "Essential lead tracking fields", "value": "Company,Lead_Status,Lead_Source,Created_Time" }, "Minimal": { "summary": "Minimal system fields only", "value": "id,Created_Time,Modified_Time" } }, "in": "query", "name": "fields", "required": false, "schema": { "maxLength": 2000, "type": "string" } }, "ModuleSearchIncludeLiteUsers": { "description": "Indicates whether lite users should be included in the search results.", "in": "query", "name": "include_lite_users", "required": false, "schema": { "default": false, "type": "boolean" } }, "ModuleSearchModule": { "description": "Specify the API name of the module to search within. Refer to [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) to retrieve a list of available modules.", "examples": { "Accounts": { "summary": "Search within Accounts module", "value": "Accounts" }, "Contacts": { "summary": "Search within Contacts module", "value": "Contacts" }, "Leads": { "summary": "Search within Leads module", "value": "Leads" } }, "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "ModuleSearchPage": { "description": "Specify the page number to retrieve for paginated results. The minimum value is 1. Defaults to 1.", "examples": { "FirstPage": { "summary": "First page of results (default)", "value": 1 }, "SecondPage": { "summary": "Second page of results", "value": 2 }, "TenthPage": { "summary": "Jump to tenth page", "value": 10 } }, "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "ModuleSearchPerPage": { "description": "Specify the number of records to return per page. The minimum value is 1, the maximum is 200, and the default is 200.", "examples": { "LargeBatch": { "summary": "Large batch for bulk operations", "value": 100 }, "Maximum": { "summary": "Maximum records per page (default)", "value": 200 }, "MediumBatch": { "summary": "Medium batch for regular processing", "value": 50 }, "SmallBatch": { "summary": "Small batch for testing or preview", "value": 10 } }, "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "ModuleSearchRoleId": { "description": "Filter users by role ID. This parameter is supported only for the Users module.", "in": "query", "name": "role_id", "required": false, "schema": { "format": "int64", "maxLength": 20, "type": "string" } }, "ModuleSearchSortBy": { "description": "Specify the API name of the field to sort the search results by.", "examples": { "ByCompany": { "summary": "Sort by company name", "value": "Company" }, "ByCreated": { "summary": "Sort by creation date", "value": "Created_Time" }, "ById": { "summary": "Sort by record ID (default)", "value": "id" }, "ByModified": { "summary": "Sort by last modification date", "value": "Modified_Time" }, "ByName": { "summary": "Sort by last name for contacts", "value": "Last_Name" } }, "in": "query", "name": "sort_by", "required": false, "schema": { "default": "id", "maxLength": 100, "type": "string" } }, "ModuleSearchSortOrder": { "description": "Specify the direction in which to sort the results. Defaults to **desc**.\nPossible values:\n**asc** - Ascending order (A-Z, 1-9).\n**desc** - Descending order (Z-A, 9-1).", "examples": { "Ascending": { "summary": "Ascending order (oldest/lowest first)", "value": "asc" }, "Descending": { "summary": "Descending order (newest/highest first, default)", "value": "desc" } }, "in": "query", "name": "sort_order", "required": false, "schema": { "default": "desc", "enum": [ "asc", "desc" ], "maxLength": 10, "type": "string" } }, "ModuleSearchType": { "description": "Specify the user type to filter the search results by.\nPossible values: **ActiveAndDeactive**, **CurrentUser**, **DeletedUsers**, **ParentRoleUsers**, **ChildRoleUsers**, **DeactiveUsers**, **NotConfirmedUsers**, **ConfirmedUsers**, **ActiveUsers**, **AdminUsers**, **ActiveConfirmedAdmins**, **ActiveConfirmedUsers**, **DeveloperUsers**, **SubordinateRoleUsers**, **AllUsers**, **AllActiveUsers**.\n\n**Note**\n\n- Only one of the mandatory parameters (`criteria`, `email`, `phone`, or `word`) can be used in a single request.\n- If multiple parameters are provided, the API processes them in the following priority order:\n 1. `criteria`\n 2. `email`\n 3. `phone`\n 4. `word`\n- Only the highest-priority parameter in the request is processed.\n\n- The `page` and `per_page` parameters help retrieve records based on their position in Zoho CRM.\n- A single API call can fetch a maximum of 200 records.\n- To retrieve more records, adjust the `page` and `per_page` values.\n\n Example: To fetch 400 records:\n\n - First API call: `page=1&per_page=200` -> Fetches records 1-200\n - Second API call: `page=2&per_page=200` -> Fetches records 201-400\n\n By making two API calls, all 400 records can be retrieved.\n\n- The Search API allows you to search for and retrieve a maximum of 2,000 records. If the search exceeds 2,000 records, the API returns a `LIMIT_REACHED` error.\n\n- Values of fields containing sensitive health data are retrieved only when the **Restrict Data Access through API** option in the compliance settings is disabled. If the option is enabled, the field value is returned as `null`. Refer to [HIPAA compliance documentation](https://www.zoho.com/crm/developer/docs/api/v8/hipaa-compliance.html) for more details.\n\n- When you create or edit a record and search for it immediately, you may receive a `204 NO CONTENT` response due to indexing delays. To fetch records without delay, use the [Query API](https://www.zoho.com/crm/developer/docs/api/v8/Get-Records-through-COQL-Query.html).\n- The `in` operator supports up to 100 values.\n- The `full_name` field contains the concatenated values of the `First Name` and `Last Name` fields.\n\n- `full_name` is a read-only field available only in the `Leads`, `Contacts`, and `Users` modules.\n\nTo retrieve subform records that match your search criteria, use the API name of the corresponding subform module.\n\nTo retrieve multi-select lookup (MxN) records that match your search criteria, use the API name of the corresponding linking module.", "examples": { "ActiveUsers": { "summary": "Get only active users", "value": "ActiveUsers" }, "AdminUsers": { "summary": "Get admin users only", "value": "AdminUsers" }, "AllUsers": { "summary": "Get all users regardless of status", "value": "AllUsers" }, "ConfirmedUsers": { "summary": "Get confirmed users", "value": "ConfirmedUsers" } }, "in": "query", "name": "type", "required": false, "schema": { "enum": [ "ActiveAndDeactive", "CurrentUser", "DeletedUsers", "ParentRoleUsers", "ChildRoleUsers", "DeactiveUsers", "NotConfirmedUsers", "ConfirmedUsers", "ActiveUsers", "AdminUsers", "ActiveConfirmedAdmins", "ActiveConfirmedUsers", "DeveloperUsers", "SubordinateRoleUsers", "AllUsers", "AllActiveUsers" ], "maxLength": 50, "type": "string" } }, "ModulesInclude": { "description": "Specify the additional module metadata fields to include in the response. Accepts comma-separated values. Allows retrieving optional module metadata that is not returned by default.", "examples": { "BusinessCardFields": { "summary": "Include business card fields", "value": "business_card_fields" }, "CustomView": { "summary": "Include custom view metadata", "value": "custom_view" }, "Fields": { "summary": "Include field metadata", "value": "fields" }, "Layouts": { "summary": "Include layout configurations", "value": "layouts" }, "Multiple": { "summary": "Include multiple optional fields", "value": "custom_view,related_lists,business_card_fields,layouts,fields" }, "RelatedLists": { "summary": "Include related lists configuration", "value": "related_lists" } }, "in": "query", "name": "include", "required": false, "schema": { "maxLength": 3000, "pattern": "^(custom_view|related_lists|business_card_fields|layouts|fields)(,(custom_view|related_lists|business_card_fields|layouts|fields))*$", "type": "string" } }, "ModulesIncludeInnerDetails": { "description": "Specify the nested field paths to include additional inner details in the module response. Accepts comma-separated values. Allows requesting extra metadata beyond the default module fields(for example fields.lookup.query_details.criteria.)", "examples": { "FieldsLookupQueryDetailsCriteria": { "summary": "Include query_details.criteria within lookup details", "value": "fields.lookup.query_details.criteria" } }, "explode": false, "in": "query", "name": "include_inner_details", "required": false, "schema": { "maxLength": 512, "type": "string" }, "style": "form" }, "ModulesParamQueryFields": { "description": "Specify the module property names to include in the response. Accepts an array of property names to filter the returned module fields.", "explode": false, "in": "query", "name": "fields", "required": false, "schema": { "items": { "description": "Specifies the properties to include in the response", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" }, "style": "form" }, "ModulesStatus": { "description": "Specify the visibility status to filter the modules returned in the response. Accepts comma-separated values to retrieve modules matching any of the specified statuses. This is case-sensitive.", "examples": { "Multiple": { "summary": "Retrieve visible and user hidden modules", "value": "visible,user_hidden" }, "Single": { "summary": "Retrieve only system hidden modules", "value": "system_hidden" } }, "in": "query", "name": "status", "required": false, "schema": { "maxLength": 56, "pattern": "^(visible|scheduled_for_deletion|user_hidden|system_hidden)(,(visible|scheduled_for_deletion|user_hidden|system_hidden))*$", "type": "string" } }, "NoteId": { "description": "Specify the unique numeric ID of the note record.", "examples": { "NoteId": { "summary": "Note record ID", "value": "1043386000020244003" } }, "in": "path", "name": "noteId", "required": true, "schema": { "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "NotesFields": { "description": "Comma-separated list of field API names to include in the response", "in": "query", "name": "fields", "required": false, "schema": { "maxLength": 1024, "type": "string" } }, "NotesId": { "description": "Unique identifier of the note. Use the [Get Notes API](notes.yaml#$.paths./Notes.get) to retrieve the note IDs.", "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "string" } }, "NotesIds": { "description": "Comma-separated list of note IDs to retrieve specific notes. Use the [Get Notes API](notes.yaml#$.paths./Notes.get) to retrieve the note IDs.", "in": "query", "name": "ids", "required": false, "schema": { "maxLength": 1024, "type": "string" } }, "NotesPage": { "description": "Page number for pagination", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "NotesPageToken": { "description": "Page token for retrieving records beyond the 2000-record limit.", "in": "query", "name": "page_token", "required": false, "schema": { "maxLength": 2000, "type": "string" } }, "NotesPerPage": { "description": "Number of records per page", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "NotesSortBy": { "description": "Field name to sort results by", "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "Modified_Time", "Created_Time", "id" ], "type": "string" } }, "NotesSortOrder": { "description": "Sort order (ascending or descending)", "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, "NotificationsModule": { "description": "Specify the API name of the CRM module to filter the notification channel list. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for valid values.", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 64, "type": "string" } }, "OwnerId": { "description": "The ID of the owner of the contact.", "in": "query", "name": "owner_id", "required": true, "schema": { "examples": [ "4876876000000362001" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" } }, "ParamPathAppointmentid": { "description": "Specify the unique identifier of the appointment record. Use the [Get Appointments API](appointments.yaml#$.paths./Appointments__s.get) to retrieve all appointment records and obtain the ID of the required appointment record.", "in": "path", "name": "appointmentId", "required": true, "schema": { "example": "{appointmentId}", "maxLength": 100, "type": "string" } }, "ParamPathFieldid": { "description": "Specify the unique ID of the custom field.", "in": "path", "name": "fieldId", "required": true, "schema": { "example": "{fieldId}", "maxLength": 255, "type": "string" } }, "ParamPathModule": { "description": "The API name of the module to perform the operation on. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.\n", "example": "Leads", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "ParamPathModuleApiName": { "description": "Specify the API name of the CRM module for which you want to perform the mail merge action. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "in": "path", "name": "moduleApiName", "required": true, "schema": { "example": "{moduleApiName}", "maxLength": 255, "type": "string" } }, "ParamPathModuleid": { "description": "Specify the API name of the module for which the web tab link has to be generated. This is case-sensitive Case-sensitive and should start with a letter and contain only alphanumeric characters and underscores.", "examples": { "CustomModule": { "summary": "Custom module API name", "value": "Custom_Module_1" }, "Leads": { "summary": "Leads module API name", "value": "Leads" } }, "in": "path", "name": "moduleid", "required": true, "schema": { "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*[A-Za-z0-9]$", "type": "string" } }, "ParamPathPickListValueId": { "description": "Path parameter: pickListValueId", "in": "path", "name": "pickListValueId", "required": true, "schema": { "example": "{pickListValueId}", "format": "int64", "maxLength": 255, "type": "string" } }, "ParamPathRecordId": { "description": "Specify the unique ID of the record for which you want to perform the mail merge action.", "in": "path", "name": "recordId", "required": true, "schema": { "example": 5725767000000524000, "format": "int64", "type": "integer" } }, "ParamPathRuleid": { "description": "Specifies the unique ID of the Scoring Rule to retrieve, update, activate, deactivate, delete, or clone.", "in": "path", "name": "ruleId", "required": true, "schema": { "example": "111114009900313120", "maxLength": 20, "type": "string" } }, "ParamPathServiceId": { "description": "Specify the unique ID of the service record to be deleted.", "explode": false, "in": "path", "name": "id", "required": true, "schema": { "example": "{id}", "maxLength": 100, "type": "string" }, "style": "simple" }, "ParamPathUserTypeid": { "description": "Provide the unique numeric identifier of the portal user type to retrieve, update, or delete.", "in": "path", "name": "userTypeId", "required": true, "schema": { "description": "Represents the unique numeric identifier of the portal user type.", "example": "{userTypeId}", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalUserTypes", "propertyId": "PortalUserTypesId" } ], "resource": "portal_user_type" } } }, "ParamPathWorkflowRuleId": { "description": "Represents the unique 19-digit numeric ID of the workflow rule to target. Obtain valid IDs from the List Workflow Rules endpoint.", "in": "path", "name": "workflowRuleId", "required": true, "schema": { "format": "string", "type": "string" } }, "ParamQueryActive": { "description": "Filter rules by their active/inactive status. Pass 'true' to retrieve only active rules, 'false' for inactive rules. Omit to retrieve all rules regardless of status.", "in": "query", "name": "active", "required": false, "schema": { "type": "boolean" } }, "ParamQueryAffectedData": { "description": "Specify whether to include the affected_data details in the response. Set to true to receive the IDs of records whose process flows were affected by the update.", "explode": true, "in": "query", "name": "affected_data", "required": false, "schema": { "enum": [ true ], "type": "boolean" }, "style": "form" }, "ParamQueryExecuteOnSchema": { "description": "Specifies the trigger type to filter workflow rules by, such as create, edit, or delete events.", "in": "query", "name": "execute_on", "required": false, "schema": { "maxLength": 25, "type": "string" } }, "ParamQueryExecutedFrom": { "description": "Specifies the start date of the usage data query window in ISO 8601 format (yyyy-MM-dd).", "in": "query", "name": "executed_from", "required": true, "schema": { "format": "date", "type": "string" } }, "ParamQueryExecutedTill": { "description": "Specifies the end date of the usage data query window in ISO 8601 format (yyyy-MM-dd).", "in": "query", "name": "executed_till", "required": true, "schema": { "format": "date", "type": "string" } }, "ParamQueryFilterSchema": { "description": "Specifies a JSON filter expression to search workflow rules by name. Supports only contains-type matching on the rule name field.", "example": "{\"field\":{\"api_name\":\"name\"},\"comparator\":\"contains\",\"value\":\"Lead Notification\"}", "in": "query", "name": "filter", "required": false, "schema": { "maxLength": 1000, "type": "string" } }, "ParamQueryFilters": { "description": "Specify the JSON filter expression to narrow webhook results by name. The object must include field (with api_name), comparator, and value keys. The only supported comparator is contains, which performs a case-insensitive partial match on the webhook name.", "in": "query", "name": "filters", "required": false, "schema": { "example": "{\"field\":{\"api_name\":\"name\"},\"comparator\":\"contains\",\"value\":\"Lead\"}", "maxLength": 1000, "type": "string" } }, "ParamQueryFrom": { "description": "Specify the start date (inclusive) for the query window in YYYY-MM-DD format, evaluated in the organization's time zone. For webhook_failures, defaults to 30 days before **to**; earlier dates are clamped to that 30-day window. For usage_reports, defaults to 30 days before **to**. Future dates return 400 INVALID_DATA.", "in": "query", "name": "from", "required": false, "schema": { "example": "2025-01-01", "format": "date", "maxLength": 10, "type": "string" } }, "ParamQueryGroup": { "description": "The unique ID or API name of the variable group to which the variable belongs. Mandatory when retrieving a specific variable by ID.", "explode": true, "in": "query", "name": "group", "required": false, "schema": { "format": "int64", "type": "string" }, "style": "form" }, "ParamQueryGroupBy": { "description": "Specify the grouping criteria for usage data. Must include date.\nPossible values:\n**date** - Returns daily totals; the resource object is omitted from each row.\n**date,resource** - Returns per-action rows including resource.id and resource.name.\n**date,resource,type** - Returns per-action rows grouped by resource and type.", "in": "query", "name": "group_by", "required": true, "schema": { "enum": [ "date", "date,resource", "date,resource,type" ], "maxLength": 100, "type": "string" } }, "ParamQueryIdSchema": { "description": "Represents the unique 19-digit numeric ID of the workflow rule. Obtain valid IDs from the List Workflow Rules endpoint.", "in": "path", "name": "id", "required": true, "schema": { "format": "string", "type": "string" } }, "ParamQueryIdsSchema": { "description": "Specifies one or more workflow rule IDs to filter the results. Provide multiple IDs as comma-separated values.", "in": "query", "name": "ids", "required": true, "schema": { "format": "string", "type": "string" } }, "ParamQueryIncludeInnerDetails1": { "description": "Include optional field metadata in the response. `field_label`: UI label, `enable_colour_code`: picklist color-coding flag, `pick_list_values.colour_code`: HEX color per picklist option, `data_type`: field data type, `display_value`: UI-friendly rendered value.", "explode": true, "in": "query", "name": "include_inner_details", "required": false, "schema": { "enum": [ "field_label", "enable_colour_code", "pick_list_values.colour_code", "data_type", "display_value" ], "type": "string" }, "style": "form" }, "ParamQueryIncludeInnerDetailsSchema": { "description": "When set to true, includes full condition details, criteria, and action configurations in the response. Defaults to false.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "type": "boolean" } }, "ParamQueryInnerDetailsFilters": { "content": { "application/json": { "examples": { "GroupOfCriteria": { "summary": "Filter the inner picklist values using multiple criteria combined with a group operator", "value": [ { "api_name": "pick_list_values", "filters": { "group": [ { "comparator": "equal", "field": { "api_name": "type" }, "value": "used" }, { "comparator": "equal", "field": { "api_name": "type" }, "value": "unused" } ], "group_operator": "or" } } ] }, "NotEqualCriteria": { "summary": "Exclude the unused picklist values of each global picklist", "value": [ { "api_name": "pick_list_values", "filters": { "comparator": "not_equal", "field": { "api_name": "type" }, "value": "unused" } } ] }, "SingleCriteria": { "summary": "Return only the unused picklist values of each global picklist", "value": [ { "api_name": "pick_list_values", "filters": { "comparator": "equal", "field": { "api_name": "type" }, "value": "unused" } } ] } }, "schema": { "description": "Array of filters, each applied on one inner detail of the global picklists.", "items": { "$ref": "#/components/schemas/GlobalPicklistInnerDetailsFilter" }, "maxItems": 10, "minItems": 1, "type": "array" } } }, "description": "JSON array used to filter the inner details returned for each global picklist in the list response. Each entry gives the inner resource in \"api_name\" and the criteria to apply in \"filters\", both of which are mandatory. Only \"pick_list_values\" is supported in \"api_name\", and within it only the \"type\" key can be filtered on, using the \"equal\" and \"not_equal\" comparators with the value \"used\" or \"unused\". \"filters\" takes either a single criteria using \"field\", \"comparator\" and \"value\", or a set of criteria in \"group\" combined using \"group_operator\", and a group may be nested inside another group. Use the \"filters\" query parameter instead to filter the global picklists themselves.", "in": "query", "name": "inner_details_filters", "required": false }, "ParamQueryJobId": { "description": "Specify the job ID of the scheduled field or picklist action to filter the results.", "example": "111113000000135098", "in": "query", "name": "job_id", "required": false, "schema": { "format": "int64", "type": "string" } }, "ParamQueryLayoutId": { "description": "Specifies the unique ID of the layout to filter Scoring Rules by.", "in": "query", "name": "layout_id", "required": false, "schema": { "type": "number" } }, "ParamQueryModule1": { "description": "The API name of the module to perform the operation on. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.\n", "example": "Leads", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 100, "type": "string" } }, "ParamQueryModuleRequiredSchema": { "description": "Specify the param query module required schema value for the request. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module ID and API name.", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "ParamQueryName": { "description": "Specifies the name of the Scoring Rule to filter by.", "in": "query", "name": "name", "required": false, "schema": { "maxLength": 25, "type": "string" } }, "ParamQueryOverWrite": { "description": "If true, replaces all existing tags on the record with the specified tags. If false or omitted, the specified tags are appended to the existing tags.", "in": "query", "name": "over_write", "required": false, "schema": { "type": "boolean" } }, "ParamQueryPageSchema": { "description": "Specifies the page number for paginated results. Page numbering starts at 1.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "minimum": 1, "type": "integer" } }, "ParamQueryPerPageSchema": { "description": "Specifies the number of workflow rules to return per page. The default and maximum value is 200.", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "ParamQuerySortBySchema": { "description": "Specifies the field to sort workflow rules by. Only `modified_time` is supported.", "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "modified_time" ], "type": "string" } }, "ParamQuerySortOrderSchema": { "description": "Specifies the sort direction for the workflow rule list. Accepted values are `asc` and `desc`.", "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, "ParamQueryStatusActiveSchema": { "description": "Filters workflow rules by activation status. Set to true to return only active rules, or false to return only inactive rules.", "in": "query", "name": "status_active", "required": false, "schema": { "type": "boolean" } }, "ParamQueryTo": { "description": "Specify the end date (inclusive) for the query window in YYYY-MM-DD format, evaluated in the organization's time zone. Defaults to the current date at 23:59:59 when omitted. Must be on or after the **from** date. Future dates are rejected.", "in": "query", "name": "to", "required": false, "schema": { "example": "2025-01-31", "format": "date", "maxLength": 10, "type": "string" } }, "ParamQueryType": { "description": "Specify the automation feature type to filter usage data. When omitted, usage across all supported feature types is returned.\nPossible values:\n**workflow_rules** - Workflow Rules.\n**approval_process** - Approval Process.\n**blueprint** - Blueprint.\n**orchestrations** - Orchestrations.\n**wizards** - Wizards.\n**modules** - Modules.\n**webhooks** - Webhooks.\n**kiosks** - Kiosks.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "workflow_rules", "approval_process", "blueprint", "orchestrations", "wizards", "modules", "webhooks", "kiosks" ], "maxLength": 50, "type": "string" } }, "ParamQueryUsageIncludeInnerDetails": { "description": "Specify to request additional nested fields within usage report resource objects. Currently, only resource.layout_id is recognized; it adds layout_id inside the resource object when available, primarily for wizard usage rows. Other values are silently ignored.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "enum": [ "resource.layout_id" ], "maxLength": 50, "type": "string" } }, "ParamQueryWebhookId": { "description": "Specify the unique identifier of the webhook whose failure records to retrieve. Refer to the [Get Webhooks](webhooks.yaml#$.paths./settings/automation/webhooks.get) resource for valid values. When omitted, failure records for all webhooks are returned.", "in": "query", "name": "webhook_id", "required": false, "schema": { "example": "5249735000000100001", "maxLength": 20, "type": "string" } }, "ParentRecord": { "description": "Specify the unique numeric identifier of the parent record.", "examples": { "ContactId": { "summary": "Contact record ID", "value": "3652397000000624001" }, "DealId": { "summary": "Deal record ID", "value": "3652397000000789001" } }, "in": "path", "name": "parentRecord", "required": true, "schema": { "maxLength": 20, "pattern": "^[0-9]+$", "type": "string" } }, "ParentRecordId": { "description": "Specify the unique numeric ID of the parent record.", "examples": { "ContactId": { "summary": "Contact record ID", "value": "1043386000019763257" }, "LeadId": { "summary": "Lead record ID", "value": "1043386000019763258" } }, "in": "path", "name": "parentRecordId", "required": true, "schema": { "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "Perpage": { "description": "Specify the number of records to retrieve per page. Default and maximum value is 100.", "in": "query", "name": "per_page", "required": false, "schema": { "enum": [ 100 ], "format": "int32", "type": "integer" } }, "Phone": { "description": "Specify a phone number to filter the count to records that contain this value in any phone field of the specified module.", "example": "9876543210", "in": "query", "name": "phone", "required": false, "schema": { "description": "The phone number to filter records by.", "maxLength": 3000, "type": "string" } }, "PickListValuesModule": { "description": "Specify the API name of the CRM module that contains the field. Refer to the [Get Modules](modules.json#$.paths./settings/modules.get) resource for valid values.", "examples": { "Accounts": { "summary": "Accounts module", "value": "Accounts" }, "Contacts": { "summary": "Contacts module", "value": "Contacts" }, "Deals": { "summary": "Deals module", "value": "Deals" }, "Leads": { "summary": "Leads module", "value": "Leads" } }, "explode": true, "in": "query", "name": "module", "required": true, "schema": { "maxLength": 50, "minLength": 1, "type": "string" }, "style": "form" }, "PipelineId": { "description": "Specify the Pipeline ID. Use the [Get Pipeline API](pipeline.yaml#$.paths./settings/pipeline.get) to get the Pipeline ID.", "in": "path", "name": "pipelineIdentifier", "required": true, "schema": { "format": "int64", "type": "string" } }, "PipelineParameter": { "description": "Specify the ID of the pipeline to transfer records to when deleting or deactivating a layout. Refer to the [Get Pipelines](pipeline.yaml#$.paths./settings/pipeline.get) resource for valid values.", "examples": { "PipelineId": { "summary": "Pipeline ID", "value": "111111000000098500" } }, "in": "query", "name": "pipeline", "required": false, "schema": { "$ref": "#/components/schemas/LayoutsId" } }, "PortalUserTypeParamQueryInclude": { "description": "When set to `modules`, the response includes the full list of CRM modules and their access configurations for each portal user type.", "in": "query", "name": "include", "required": false, "schema": { "enum": [ "modules" ], "type": "string" } }, "PortalUserTypeParamQueryIncludeInnerDetails": { "description": "When set to `fields` or another resource key, the response includes the detailed fields or sub-resource properties for the included modules.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "enum": [ "field.field_label" ], "type": "string" } }, "PortalUserTypePortal": { "description": "Specify the API name of the portal whose user types are being managed. This is the unique identifier for the portal in Zoho CRM.", "in": "path", "name": "portal", "required": true, "schema": { "description": "Represents the unique name of the portal.", "example": "{portal}", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortals", "propertyId": "PortalsName" } ], "resource": "portals" } } }, "PortalUsersModule": { "description": "Specify the API name of the CRM module for which you want to manage portal users. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for valid values.", "in": "path", "name": "module", "required": true, "schema": { "description": "Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } } }, "PortalUsersPortal": { "description": "Specify the unique identifier of the portal. Refer to the [Get Portals](https://www.zoho.com/crm/developer/docs/api/v8/get-portals.html) resource for valid values.", "in": "path", "name": "portal", "required": true, "schema": { "description": "Represents the unique name of the portal.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortals", "propertyId": "PortalsName" } ], "resource": "portals" } } }, "PortalUsersRecordId": { "description": "Specify the unique identifier of the CRM record for which you want to perform the portal action.", "in": "path", "name": "recordId", "required": true, "schema": { "description": "Represents the unique identifier of the RecordGETDataItem record.", "format": "int64", "type": "integer", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } } }, "Portals": { "description": "Specify the API name of the portal to retrieve or update. Use the Get Portals operation to retrieve the list of available portals and their names.", "in": "path", "name": "portal", "required": true, "schema": { "description": "Represents the unique name of the portal.", "maxLength": 60, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortals", "propertyId": "PortalsName" } ], "resource": "portals" } } }, "ProfilesFilters": { "content": { "application/json": { "examples": { "ProfileNameEqualsAdministrator": { "summary": "Filter by profile name equals Administrator", "value": { "group": [ { "comparator": "equal", "field": { "api_name": "name", "data_type": "text", "field_label": "Profile Name" }, "type": "value", "value": "Administrator" }, { "comparator": "equal", "field": { "api_name": "name", "data_type": "text", "field_label": "Profile Name" }, "type": "value", "value": "Administrator" } ], "group_operator": "or" } } }, "schema": { "$ref": "#/components/schemas/Filters" } } }, "description": "JSON-encoded filter criteria to narrow the profiles returned. Accepts a `Filters` object with `group` conditions and a `group_operator`.", "in": "query", "name": "filters", "required": false }, "ProfilesId": { "description": "Represents the unique identifier of the profile (64-bit integer represented as a string, 1-19 digits).", "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/ProfilesId" } }, "ProfilesPage": { "description": "Page number for paginated results. Defaults to 1.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "description": "Page number to retrieve.", "format": "int32", "minimum": 1, "type": "integer" } }, "ProfilesPerPage": { "description": "Maximum number of profiles to return per page. Minimum 1, maximum 200. Defaults to 200.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "description": "Number of records per page.", "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "ProfilesType": { "description": "Filters the returned profiles by profile type. Use `private_profile` to retrieve profiles used exclusively with team modules - private profiles are not allowed for normal custom modules, and non-private profiles are not allowed for team modules. \n**Possible values:**\n**`private_profile`**, **`normal_profile`**, **`portal_profile`**.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "private_profile", "normal_profile", "portal_profile" ], "type": "string" } }, "QueryId": { "description": "Specify the query ID of the user lookup field. Used to retrieve users based on the filter criteria of the lookup field.", "in": "query", "name": "query_id", "required": false, "schema": { "format": "int64", "type": "string" } }, "RecordConverted": { "description": "Specify whether to retrieve converted, unconverted, or both types of records. Possible values:**false** - Returns only unconverted records. **true** - Returns only converted records. **both** - Returns both converted and unconverted records.", "in": "query", "name": "converted", "schema": { "enum": [ "false", "true", "both" ], "type": "string" } }, "RecordCountApproved": { "description": "Specify the approval status to filter the count to lead records. This parameter is supported only for the **Leads** module. Possible values:\n**true** - Count only approved leads.\n**false** - Count only unapproved leads.\n**both** - Count leads regardless of approval status.", "examples": { "BothConvertedAndNonConvertedLeads": { "value": "both" }, "ConvertedLeads": { "value": "true" }, "NonConvertedLeads": { "value": "false" } }, "in": "query", "name": "approved", "required": false, "schema": { "description": "Set to true to count only converted leads; false to count only unconverted leads.", "enum": [ "true", "false", "both" ], "type": "string" } }, "RecordCountConverted": { "description": "Specify the conversion status to filter the count to lead records. This parameter is supported only for the **Leads** module. Possible values:\n**true** - Count only converted leads.\n**false** - Count only unconverted leads.\n**both** - Count leads regardless of conversion status.", "examples": { "BothConvertedAndNonConvertedLeads": { "value": "both" }, "ConvertedLeads": { "value": "true" }, "NonConvertedLeads": { "value": "false" } }, "in": "query", "name": "converted", "required": false, "schema": { "description": "Set to true to count only converted leads; false to count only unconverted leads.", "enum": [ "true", "false", "both" ], "type": "string" } }, "RecordCountCriteria": { "description": "Performs search by following the shown criteria: `(({api_name}:{operator}:{value}) and/or ({api_name}:{operator}:{value}))`\n\nPerforms a search based on the following format:\n`(({field_API_name}:{operator}:{value}) and/or ({field_API_name}:{operator}:{value}))`\n\nReplace `{field_API_name}`, `{operator}`, and `{value}` with the appropriate field API name, condition, and value.\n\n**Key Points:**\n- You can search for a maximum of **10 criteria** (with same or different columns)\n- The only operator that is supported for **encrypted fields** is `equals`\n- When using the `equals` operator in the Search API, it behaves like `contains`, retrieving records that include the specified value\n\n**Single Condition:**\nIf the condition is `(Company:equals:ABC)`, the response will include records with \"ABC\" as well as \"ABC Inc\" in the Company field.\n\n**Multiple Conditions:**\n`equals` still behaves like `contains`. For example, `((Company:equals:ABC) and (First_Name:starts_with:M))`, it retrieves records where the \"First Name\" starts with \"M\" and the \"Company\" contains \"ABC\" (e.g., \"ABC\" or \"ABC Inc.\").\n\n**Note:** The above behaviour does not apply to the **picklist field type**.\n\n**IN Operator:**\nThe `in` operator checks if a field's value matches any value in a given list.\nFor example, `(Full_Name:in:Patricia,Boyle,Kate)`, it retrieves records where the Full Name is Patricia, Boyle, or Kate.\n\n**Special Character Handling:**\nWhen a single-line field value contains characters such as `{`, `}`, `[`, `]`, `^`, `:`, `-`, `/`, `!`, `?`, `*`, `_`, `@`, space, the Search API returns records with similar-looking values, even if the characters are not an exact match.\n\nFor example, if Record A has the field value `sales-team@example.com` and Record B has `sales_team@example.com`, a search using `equals:sales-team@example.com` may return both records.\n\n**Escaping Special Characters:**\nWhen using parentheses `()`, commas `,`, or a backslash `\\` as the last character in a search value, follow these steps:\n1. Escape special characters using a backslash `\\`\n2. Encode the value before making the API request. Select the value of the criteria, right-click the value, and choose the EncodeURIComponent option.\n\n**Example 1: Escaping Parentheses and Commas**\n- Search term: `((Last_Name:equals:Burns,B) and (First_Name:starts_with:M))`\n- Escape the comma `\\,`: `((Last_Name:equals:Burns\\,B) and (First_Name:starts_with:M))`\n- Encode the value: `((Last_Name:equals:Burns%5C%2CB) and (First_Name:starts_with:M))`\n\n**Example 2: Escaping a Backslash at the End**\n- Search term: `(Last_Name:equals:K\\)`\n- Escape the backslash `\\\\`: `(Last_Name:equals:K\\\\)`\n- Encode the value: `(Last_Name:equals:K%5C%5C)`\n\n**Supported Data Types:**\n`picklist`, `owner_lookup`, `user_lookup`, `lookup`, `phone`, `email`, `date`, `datetime`, `text`, `textarea`, `integer`, `currency`, `decimal`, `multiselectpicklist`, `bigint`, `percent`, `formula`, `website`, `boolean`, `double`\n\n**Supported Operators:**\n`equals`, `starts_with`, `in`, `not_equal`, `greater_equal`, `greater_than`, `less_equal`, `less_than`, `between`\n\n**Operator Compatibility by Data Type:**\n\n| Data Type | equals | starts_with | in | not_equal | greater_equal | greater_than | less_equal | less_than | between |\n|---|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|\n| **text** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **textarea** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **email** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **phone** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **website** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **picklist** | ✓ | ✗ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **multiselectpicklist** | ✓ | ✗ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **lookup** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **owner_lookup** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **user_lookup** | ✓ | ✓ | ✓ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **boolean** | ✓ | ✗ | ✗ | ✓ | ✗ | ✗ | ✗ | ✗ | ✗ |\n| **integer** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **bigint** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **currency** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **decimal** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **double** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **percent** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **date** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **datetime** | ✓ | ✗ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n| **formula** | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |\n\n**Legend:** ✓ = Supported, ✗ = Not Supported\n\n**Note:** Refer to the Zoho CRM API documentation for the most up-to-date operator compatibility information.", "examples": { "AutonumberEquals": { "description": "Retrieves records where Lead_Number is exactly 'LEAD-10001'", "summary": "Autonumber field with equals operator", "value": "(Lead_Number:equals:LEAD-10001)" }, "AutonumberIn": { "description": "Retrieves records where Lead_Number matches any of the specified values", "summary": "Autonumber field with IN operator", "value": "(Lead_Number:in:LEAD-10001,LEAD-10002,LEAD-10003)" }, "Between": { "description": "Retrieves records within the specified date range", "summary": "Between operator for date range", "value": "(Created_Time:between:2024-01-01,2024-12-31)" }, "BigIntBetween": { "description": "Retrieves records where Record_ID is within the specified range", "summary": "BigInt field with between operator", "value": "(Record_ID:between:1000000000000,9999999999999)" }, "BigIntEquals": { "description": "Retrieves records where Record_ID is exactly 9876543210123", "summary": "BigInt field with equals operator", "value": "(Record_ID:equals:9876543210123)" }, "BigIntGreaterThan": { "description": "Retrieves records where Record_ID is greater than 1,000,000,000,000", "summary": "BigInt field with greater_than operator", "value": "(Record_ID:greater_than:1000000000000)" }, "BigIntIn": { "description": "Retrieves records where Record_ID matches any of the specified values", "summary": "BigInt field with IN operator", "value": "(Record_ID:in:1234567890123,9876543210123)" }, "BooleanEquals": { "description": "Retrieves records where Email_Opt_Out is true", "summary": "Boolean field with equals operator", "value": "(Email_Opt_Out:equals:true)" }, "BooleanNotEqual": { "description": "Retrieves records where Email_Opt_Out is false", "summary": "Boolean field with not_equal operator", "value": "(Email_Opt_Out:not_equal:true)" }, "Complex": { "description": "Complex query with nested AND/OR logic (max 10 criteria)", "summary": "Complex nested criteria", "value": "(((Company:equals:Zoho) and (First_Name:starts_with:J)) or (Last_Name:equals:Smith))" }, "ComplexNestedConditions": { "description": "Complex query combining multiple criteria with nested AND/OR logic", "summary": "Complex nested conditions with AND/OR", "value": "(((Company:equals:Zoho) and (Annual_Revenue:greater_than:1000000)) or ((Lead_Status:equals:Hot) and (No_of_Employees:greater_than:100)))" }, "CurrencyBetween": { "description": "Retrieves records where Annual_Revenue is between 100,000 and 1,000,000", "summary": "Currency field with between operator", "value": "(Annual_Revenue:between:100000,1000000)" }, "CurrencyEquals": { "description": "Retrieves records where Annual_Revenue is exactly 1,000,000", "summary": "Currency field with equals operator", "value": "(Annual_Revenue:equals:1000000)" }, "CurrencyGreaterThan": { "description": "Retrieves records where Annual_Revenue is greater than 500,000", "summary": "Currency field with greater_than operator", "value": "(Annual_Revenue:greater_than:500000)" }, "CurrencyIn": { "description": "Retrieves records where Annual_Revenue matches any of the specified values", "summary": "Currency field with IN operator", "value": "(Annual_Revenue:in:100000,500000,1000000)" }, "DateBetween": { "description": "Retrieves records where Closing_Date is within the 2024 calendar year", "summary": "Date field with between operator", "value": "(Closing_Date:between:2024-01-01,2024-12-31)" }, "DateEquals": { "description": "Retrieves records where Closing_Date is exactly 2024-12-31", "summary": "Date field with equals operator", "value": "(Closing_Date:equals:2024-12-31)" }, "DateGreaterThan": { "description": "Retrieves records where Closing_Date is after 2024-01-01", "summary": "Date field with greater_than operator", "value": "(Closing_Date:greater_than:2024-01-01)" }, "DateIn": { "description": "Retrieves records where Closing_Date matches any of the specified dates", "summary": "Date field with IN operator", "value": "(Closing_Date:in:2024-01-15,2024-03-15,2024-06-15)" }, "DateLessThan": { "description": "Retrieves records where Closing_Date is before 2024-06-30", "summary": "Date field with less_than operator", "value": "(Closing_Date:less_than:2024-06-30)" }, "DateNotEqual": { "description": "Retrieves records where Closing_Date is not 2024-12-31", "summary": "Date field with not_equal operator", "value": "(Closing_Date:not_equal:2024-12-31)" }, "DateRangeCurrentYear": { "description": "Retrieves all records created in 2024", "summary": "Date range for current year", "value": "(Created_Time:between:2024-01-01,2024-12-31)" }, "DateTimeBetween": { "description": "Retrieves records created within the 2024 calendar year", "summary": "DateTime field with between operator", "value": "(Created_Time:between:2024-01-01T00:00:00+00:00,2024-12-31T23:59:59+00:00)" }, "DateTimeEquals": { "description": "Retrieves records where Created_Time is exactly the specified date and time", "summary": "DateTime field with equals operator", "value": "(Created_Time:equals:2024-12-18T10:30:00+05:30)" }, "DateTimeGreaterEqual": { "description": "Retrieves records modified on or after 2024-01-01", "summary": "DateTime field with greater_equal operator", "value": "(Modified_Time:greater_equal:2024-01-01T00:00:00+00:00)" }, "DateTimeLessEqual": { "description": "Retrieves records modified on or before 2024-06-30", "summary": "DateTime field with less_equal operator", "value": "(Modified_Time:less_equal:2024-06-30T23:59:59+05:30)" }, "DecimalBetween": { "description": "Retrieves records where Exchange_Rate is between 1.0 and 1.5", "summary": "Decimal field with between operator", "value": "(Exchange_Rate:between:1.0,1.5)" }, "DecimalEquals": { "description": "Retrieves records where Exchange_Rate is exactly 1.25", "summary": "Decimal field with equals operator", "value": "(Exchange_Rate:equals:1.25)" }, "DecimalGreaterEqual": { "description": "Retrieves records where Exchange_Rate is 1.0 or more", "summary": "Decimal field with greater_equal operator", "value": "(Exchange_Rate:greater_equal:1.0)" }, "EmailEquals": { "description": "Retrieves records where Email contains 'john@example.com'", "summary": "Email field with equals operator", "value": "(Email:equals:john@example.com)" }, "EmailStartsWith": { "description": "Retrieves records where Email starts with 'admin'", "summary": "Email field with starts_with operator", "value": "(Email:starts_with:admin)" }, "EscapedBackslash": { "description": "Searching for a value ending with backslash: 'K\\' (escaped and encoded)", "summary": "Escaped backslash at end", "value": "(Last_Name:equals:K%5C%5C)" }, "EscapedComma": { "description": "Searching for a value containing comma: 'Burns,B' (escaped and encoded)", "summary": "Escaped comma in value", "value": "((Last_Name:equals:Burns%5C%2CB) and (First_Name:starts_with:M))" }, "GreaterThan": { "description": "Retrieves records where Annual_Revenue is greater than 1000000", "summary": "Greater than operator", "value": "(Annual_Revenue:greater_than:1000000)" }, "InOperator": { "description": "Matches any value in the comma-separated list (max 100 values)", "summary": "IN operator for multiple values", "value": "(Full_Name:in:Patricia,Boyle,Kate)" }, "IntegerBetween": { "description": "Retrieves records where No_of_Employees is between 100 and 500 (inclusive)", "summary": "Integer field with between operator", "value": "(No_of_Employees:between:100,500)" }, "IntegerEquals": { "description": "Retrieves records where No_of_Employees is exactly 100", "summary": "Integer field with equals operator", "value": "(No_of_Employees:equals:100)" }, "IntegerGreaterEqual": { "description": "Retrieves records where No_of_Employees is 100 or more", "summary": "Integer field with greater_equal operator", "value": "(No_of_Employees:greater_equal:100)" }, "IntegerGreaterThan": { "description": "Retrieves records where No_of_Employees is greater than 50", "summary": "Integer field with greater_than operator", "value": "(No_of_Employees:greater_than:50)" }, "IntegerIn": { "description": "Retrieves records where No_of_Employees matches any of the specified values", "summary": "Integer field with IN operator", "value": "(No_of_Employees:in:50,100,200,500)" }, "IntegerLessEqual": { "description": "Retrieves records where No_of_Employees is 1000 or less", "summary": "Integer field with less_equal operator", "value": "(No_of_Employees:less_equal:1000)" }, "IntegerLessThan": { "description": "Retrieves records where No_of_Employees is less than 500", "summary": "Integer field with less_than operator", "value": "(No_of_Employees:less_than:500)" }, "IntegerNotEqual": { "description": "Retrieves records where No_of_Employees is not 0", "summary": "Integer field with not_equal operator", "value": "(No_of_Employees:not_equal:0)" }, "LookupEquals": { "description": "Retrieves records where Account_Name is 'Zoho Corporation'", "summary": "Lookup field with equals operator", "value": "(Account_Name:equals:Zoho Corporation)" }, "LookupIn": { "description": "Retrieves records where Account_Name matches any of the specified accounts", "summary": "Lookup field with IN operator", "value": "(Account_Name:in:Zoho Corporation,ABC Inc,XYZ Ltd)" }, "LookupNotEqual": { "description": "Retrieves records where Account_Name is not 'Test Account'", "summary": "Lookup field with not_equal operator", "value": "(Account_Name:not_equal:Test Account)" }, "MaximumCriteria": { "description": "Example with 10 criteria (maximum allowed)", "summary": "Maximum 10 criteria example", "value": "(((Lead_Status:equals:Qualified) and (Annual_Revenue:greater_than:100000)) and ((No_of_Employees:greater_than:10) and (Industry:equals:Technology)) and ((Rating:equals:Hot) and (Email_Opt_Out:equals:false)) and ((Created_Time:greater_than:2024-01-01) and (Lead_Source:equals:Web)) and ((Country:equals:USA) and (State:equals:California)))" }, "MixedFieldTypes": { "description": "Combines date, currency, and picklist fields in one query", "summary": "Mixed field types with AND/OR", "value": "(((Closing_Date:between:2024-01-01,2024-12-31) and (Deal_Amount:greater_than:50000)) or (Priority:equals:High))" }, "MultipleAnd": { "description": "Combines multiple criteria with AND logic", "summary": "Multiple conditions with AND", "value": "((Company:equals:ABC) and (First_Name:starts_with:M))" }, "MultipleConditionsAnd": { "description": "Retrieves records where Company contains 'Zoho' AND Annual_Revenue is greater than 1,000,000", "summary": "Multiple conditions with AND logic", "value": "((Company:equals:Zoho) and (Annual_Revenue:greater_than:1000000))" }, "MultipleConditionsOr": { "description": "Retrieves records where Lead_Status is either 'Qualified' OR 'Contacted'", "summary": "Multiple conditions with OR logic", "value": "((Lead_Status:equals:Qualified) or (Lead_Status:equals:Contacted))" }, "MultipleOr": { "description": "Retrieves records matching either condition", "summary": "Multiple conditions with OR", "value": "((Last_Name:equals:Smith) or (Last_Name:equals:Johnson))" }, "MultiselectPicklistEquals": { "description": "Retrieves records where Interested_Products contains 'CRM'", "summary": "Multiselectpicklist field with equals operator", "value": "(Interested_Products:equals:CRM)" }, "MultiselectPicklistIn": { "description": "Retrieves records where Interested_Products contains any of the specified values", "summary": "Multiselectpicklist field with IN operator", "value": "(Interested_Products:in:CRM,Marketing,Sales)" }, "MultiselectPicklistNotEqual": { "description": "Retrieves records where Tags does not contain 'Archived'", "summary": "Multiselectpicklist field with not_equal operator", "value": "(Tags:not_equal:Archived)" }, "MultiselectPicklistStartsWith": { "description": "Retrieves records where Tags starts with 'Priority'", "summary": "Multiselectpicklist field with starts_with operator", "value": "(Tags:starts_with:Priority)" }, "NegativeConditions": { "description": "Retrieves records excluding 'Junk' and 'Lost' status", "summary": "Multiple NOT EQUAL conditions", "value": "((Lead_Status:not_equal:Junk) and (Lead_Status:not_equal:Lost))" }, "NotEqual": { "description": "Retrieves records where Lead_Status is not 'Converted'", "summary": "Not equal operator", "value": "(Lead_Status:not_equal:Converted)" }, "NumericRange": { "description": "Retrieves records within specified revenue and employee count ranges", "summary": "Numeric range with multiple conditions", "value": "((Annual_Revenue:between:100000,1000000) and (No_of_Employees:between:10,500))" }, "OwnerEquals": { "description": "Retrieves records where Owner is 'John Doe'", "summary": "Owner lookup field with equals operator", "value": "(Owner:equals:John Doe)" }, "OwnerIn": { "description": "Retrieves records owned by any of the specified users", "summary": "Owner lookup field with IN operator", "value": "(Owner:in:John Doe,Jane Smith,Bob Johnson)" }, "PercentBetween": { "description": "Retrieves records where Discount is between 5% and 20%", "summary": "Percent field with between operator", "value": "(Discount:between:5,20)" }, "PercentEquals": { "description": "Retrieves records where Discount is exactly 10%", "summary": "Percent field with equals operator", "value": "(Discount:equals:10)" }, "PercentGreaterThan": { "description": "Retrieves records where Discount is greater than 5%", "summary": "Percent field with greater_than operator", "value": "(Discount:greater_than:5)" }, "PercentLessEqual": { "description": "Retrieves records where Discount is 15% or less", "summary": "Percent field with less_equal operator", "value": "(Discount:less_equal:15)" }, "PhoneEquals": { "description": "Retrieves records where Phone contains '9876543210'", "summary": "Phone field with equals operator", "value": "(Phone:equals:9876543210)" }, "PhoneIn": { "description": "Retrieves records where Mobile matches any of the provided numbers", "summary": "Phone field with IN operator", "value": "(Mobile:in:9876543210,9876543211,9876543212)" }, "PicklistEquals": { "description": "Retrieves records where Lead_Status is exactly 'Qualified' (exact match for picklist)", "summary": "Picklist field with equals operator", "value": "(Lead_Status:equals:Qualified)" }, "PicklistIn": { "description": "Retrieves records where Lead_Status matches any of the specified values", "summary": "Picklist field with IN operator", "value": "(Lead_Status:in:Qualified,Contacted,Working)" }, "PicklistNotEqual": { "description": "Retrieves records where Lead_Status is not 'Converted'", "summary": "Picklist field with not_equal operator", "value": "(Lead_Status:not_equal:Converted)" }, "SimpleEquals": { "description": "Retrieves records where Last_Name contains 'Smith' (e.g., 'Smith', 'Smithson')", "summary": "Simple equals search (text field)", "value": "(Last_Name:equals:Smith)" }, "TextInOperator": { "description": "Retrieves records where Last_Name is Smith, Johnson, or Williams (max 100 values)", "summary": "Text field with IN operator", "value": "(Last_Name:in:Smith,Johnson,Williams)" }, "TextNotEqual": { "description": "Retrieves records where Department is not 'Sales'", "summary": "Text field with not_equal operator", "value": "(Department:not_equal:Sales)" }, "TextStartsWith": { "description": "Retrieves records where Company starts with 'Zoho'", "summary": "Text field with starts_with operator", "value": "(Company:starts_with:Zoho)" }, "TextareaEquals": { "description": "Retrieves records where Description contains 'Project'", "summary": "Textarea field with equals operator", "value": "(Description:equals:Project)" }, "TextareaNotEqual": { "description": "Retrieves records where Comments does not contain 'Closed'", "summary": "Textarea field with not_equal operator", "value": "(Comments:not_equal:Closed)" }, "TextareaStartsWith": { "description": "Retrieves records where Notes starts with 'Important'", "summary": "Textarea field with starts_with operator", "value": "(Notes:starts_with:Important)" }, "ThreeConditionsAnd": { "description": "Retrieves records matching all three conditions", "summary": "Three conditions with AND", "value": "(((Lead_Status:equals:Qualified) and (Annual_Revenue:greater_than:500000)) and (No_of_Employees:greater_than:50))" }, "WebsiteEquals": { "description": "Retrieves records where Website contains 'zoho.com'", "summary": "Website field with equals operator", "value": "(Website:equals:zoho.com)" }, "WebsiteStartsWith": { "description": "Retrieves records where Website starts with 'https'", "summary": "Website field with starts_with operator", "value": "(Website:starts_with:https)" } }, "in": "query", "name": "criteria", "required": false, "schema": { "description": "Search criteria string with field API name, operator, and value", "maxLength": 3000, "type": "string" } }, "RecordCountCrossFilters": { "description": "Cross filter criteria for related module records", "in": "query", "name": "cross_filters", "required": false, "schema": { "maxLength": 3000, "type": "string" } }, "RecordCountCvid": { "description": "Specify the ID of the Custom View from which to retrieve the record count. Refer to the [Get Custom Views](custom_views.yaml#$.paths./settings/custom_views.get) resource for valid values.", "example": "5690xxxx980", "in": "query", "name": "cvid", "required": false, "schema": { "description": "The Custom View ID to filter records by.", "maxLength": 3000, "type": "string" } }, "RecordCountFilters": { "description": "Filter for fetching specific custom views based on criteria", "in": "query", "name": "filters", "required": false, "schema": { "$ref": "#/components/schemas/FilterCriterionRequest" } }, "RecordCountModuleApiName": { "description": "Specify the API name of the module for which you want to retrieve the record count. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "examples": { "Accounts": { "value": "Accounts" }, "Leads": { "value": "Leads" } }, "in": "path", "name": "moduleApiName", "required": true, "schema": { "description": "The API name of the module for which to retrieve the record count (e.g., `Leads`, `Accounts`).", "maxLength": 5000, "type": "string" } }, "RecordCountPage": { "description": "Specify the page number to retrieve when paginating through results.", "example": 1, "in": "query", "name": "page", "required": false, "schema": { "default": 1, "description": "The page number for pagination.", "format": "int32", "minimum": 1, "type": "integer" } }, "RecordCountPerPage": { "description": "Specify the number of records to include per page.", "example": 200, "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "description": "Number of records per page for pagination.", "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "RecordCountType": { "description": "Specify the type of user records to count. This parameter is supported only for the **Users** module. Possible values:\n**AllUsers** - All users.\n**ActiveUsers** - Active users.\n**DeactiveUsers** - Deactivated users.\n**ConfirmedUsers** - Confirmed users.\n**ConfirmedReportingUsers** - Confirmed users with reporting access.\n**NotConfirmedUsers** - Unconfirmed users.\n**DeletedUsers** - Deleted users.\n**ActiveConfirmedUsers** - Active and confirmed users.\n**AdminUsers** - Users with administrator privileges.\n**ActiveConfirmedAdmins** - Active, confirmed users with administrator privileges.\n**CurrentUser** - The currently authenticated user.", "examples": { "ActiveConfirmedAdmins": { "description": "Retrieves count of users who are active, confirmed, and have admin privileges", "summary": "Get count of active confirmed admin users", "value": "ActiveConfirmedAdmins" }, "ActiveConfirmedUsers": { "description": "Retrieves count of users who are both active and confirmed", "summary": "Get count of active and confirmed users", "value": "ActiveConfirmedUsers" }, "ActiveUsers": { "description": "Retrieves count of users who are currently active", "summary": "Get count of active users", "value": "ActiveUsers" }, "AdminUsers": { "description": "Retrieves count of users with administrator privileges", "summary": "Get count of admin users", "value": "AdminUsers" }, "AllUsers": { "description": "Retrieves count of all users in the organization", "summary": "Get count of all users", "value": "AllUsers" }, "ConfirmedReportingUsers": { "description": "Retrieves count of confirmed users with reporting access", "summary": "Get count of confirmed reporting users", "value": "ConfirmedReportingUsers" }, "ConfirmedUsers": { "description": "Retrieves count of users who have confirmed their accounts", "summary": "Get count of confirmed users", "value": "ConfirmedUsers" }, "CurrentUser": { "description": "Retrieves count for the currently authenticated user (typically returns 1)", "summary": "Get current user information", "value": "CurrentUser" }, "DeactiveUsers": { "description": "Retrieves count of users who have been deactivated", "summary": "Get count of deactivated users", "value": "DeactiveUsers" }, "DeletedUsers": { "description": "Retrieves count of users who have been deleted", "summary": "Get count of deleted users", "value": "DeletedUsers" }, "NotConfirmedUsers": { "description": "Retrieves count of users who have not yet confirmed their accounts", "summary": "Get count of unconfirmed users", "value": "NotConfirmedUsers" } }, "in": "query", "name": "type", "required": false, "schema": { "description": "Specifies the user type to filter records by.", "enum": [ "AllUsers", "ActiveUsers", "DeactiveUsers", "ConfirmedUsers", "ConfirmedReportingUsers", "NotConfirmedUsers", "DeletedUsers", "ActiveConfirmedUsers", "AdminUsers", "ActiveConfirmedAdmins", "CurrentUser" ], "type": "string" } }, "RecordCrossFilters": { "description": "Specify the filter criteria for retrieving specific Custom Views. Accepts a filter object to narrow down results based on Custom View properties.", "explode": true, "in": "query", "name": "cross_filters", "schema": { "$ref": "#/components/schemas/CrossFiltersRequest" }, "style": "deepObject" }, "RecordCvid": { "description": "Specify the unique ID of the Custom View. Use the [Get Custom Views Metadata API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the Custom View IDs.", "in": "query", "name": "cvid", "schema": { "format": "int64", "type": "string" } }, "RecordFields": { "description": "Specify a comma-separated list of field API names to include in the response. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and API names.", "in": "query", "name": "fields", "required": true, "schema": { "type": "string" } }, "RecordFilters": { "description": "Specify the filter criteria for retrieving specific Custom Views. Accepts a filter object to narrow down results based on Custom View properties.", "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/FilterCriterionRequest" } }, "RecordIds": { "description": "Specify a comma-separated list of record IDs. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "description": "Unique record ID in int64 string format.", "format": "int64", "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true }, "style": "form" }, "RecordIfModifiedSince": { "description": "Use this header to get the list of records modified after the specified timestamp. The timestamp must be in ISO 8601 format.", "example": "2019-07-25T15:26:49+05:30", "in": "header", "name": "If-Modified-Since", "required": false, "schema": { "format": "date-time", "maxLength": 100, "type": "string" } }, "RecordLockingConfigurationsId": { "description": "Unique identifier of the record locking configuration. This ID is returned in the response when a configuration is created or retrieved.", "in": "path", "name": "id", "required": true, "schema": { "description": "Record Locking Configuration ID", "format": "int64", "type": "string" } }, "RecordLockingConfigurationsModule": { "description": "The API name of the module for which the record locking configuration is being managed. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module names.", "in": "query", "name": "module", "required": true, "schema": { "description": "Module API name", "examples": [ "Leads", "Contacts", "Accounts" ], "maxLength": 256, "type": "string" } }, "RecordModule": { "description": "Specify the API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name.", "example": "Leads", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 25, "type": "string" } }, "RecordPage": { "description": "Specify the page number to retrieve. Starts at 1.", "in": "query", "name": "page", "schema": { "format": "int32", "minimum": 1, "type": "integer" } }, "RecordPageToken": { "description": "Specify the page token to retrieve records beyond the first 2,000 results. Use the **next_page_token** value from a previous response to access the next page of results.", "in": "query", "name": "page_token", "schema": { "maxLength": 96, "type": "string" } }, "RecordPerPage": { "description": "Specify the number of records to return per page. Maximum is 200.", "in": "query", "name": "per_page", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "RecordPhotoModule": { "description": "Specify the API name of the module for which you want to manage the record photo. Refer to the [Get Modules Metadata API](modules.yaml#$.paths./settings/modules.get) to retrieve the module's API name.", "in": "path", "name": "module", "required": true, "schema": { "description": "Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores.", "maxLength": 50, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } } }, "RecordPhotoRecord": { "description": "Specify the unique identifier of the record for which you want to manage the photo. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.", "in": "path", "name": "record", "required": true, "schema": { "description": "Represents the unique identifier of the RecordGETDataItem record.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecord", "propertyId": "RecordsId" } ], "resource": "record" } } }, "RecordRecord": { "description": "Specify the unique ID of the record. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.", "in": "path", "name": "recordId", "required": true, "schema": { "format": "int64", "type": "string" } }, "RecordShareEmailId": { "description": "Specify the unique identifier of the record whose emails you want to manage. The ID must belong to a record in the specified module. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.", "in": "path", "name": "id", "required": true, "schema": { "example": "1034369001076415228", "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "RecordSortBy": { "description": "Specify the field to sort records by. Possible values:**id** - Sorts by record ID. **Created_Time** - Sorts by creation timestamp. **Modified_Time** - Sorts by last modification timestamp.", "in": "query", "name": "sort_by", "schema": { "enum": [ "id", "Created_Time", "Modified_Time" ], "type": "string" } }, "RecordSortOrder": { "description": "Specify the sort order for the records.
Possible values:
desc - Returns records in descending order.
asc - Returns records in ascending order.", "in": "query", "name": "sort_order", "schema": { "enum": [ "desc", "asc" ], "type": "string" } }, "RecycleBinFilters": { "description": "Specify the URL-encoded filter expression that scopes the operation to recycle-bin records matching the supplied conditions. The expression is a JSON object with a top-level **AND** group of field conditions covering **display_name**, **module**, **deleted_by**, or **deleted_time**.", "examples": { "ByModule": { "value": "module:Leads" } }, "in": "query", "name": "filters", "required": true, "schema": { "description": "Filter expression string.", "maxLength": 2000, "type": "string" } }, "RelatedList": { "description": "Specify the API name of the related list containing the records to retrieve or modify. Refer to the [Get Related Lists](https://www.zoho.com/crm/developer/docs/api/v8/related-list-meta.html) resource for valid values.", "examples": { "Attachments": { "summary": "Attachments related list", "value": "Attachments" }, "Notes": { "summary": "Notes related list", "value": "Notes" }, "Products": { "summary": "Products related list", "value": "Products" } }, "in": "path", "name": "relatedList", "required": true, "schema": { "maxLength": 100, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "type": "string" } }, "RelatedListsIncludeInnerDetails": { "description": "Specify a comma-separated list of detail keys to embed in each related list object. Controls which nested detail blocks are included in the response.", "examples": { "All": { "summary": "Include all inner details", "value": "all" } }, "in": "query", "name": "include_inner_details", "required": false, "schema": { "maxLength": 255, "minLength": 1, "type": "string" }, "x-zs-llm-description": "Comma-separated list of field-level detail keys to embed in each related list's fields array. Valid keys: fields.ui_type, fields.field_label, fields.lookup, fields.formula, fields.rollup_summary, fields.pick_list_values, fields.separator, fields.decimal_place, fields.mask_details, fields.refer_from_field. Use 'all' to include every detail key at once." }, "RelatedListsLayoutId": { "description": "Specify the unique identifier of the layout to scope the related lists response. Refer to the [Layouts API](https://www.zoho.com/crm/developer/docs/api/v8/layouts-meta.html) resource for valid values.", "examples": { "ValidLayoutId": { "summary": "Example of a valid layout ID", "value": "4150868000000091023" } }, "in": "query", "name": "layout_id", "required": false, "schema": { "format": "int64", "type": "string" }, "x-zs-llm-description": "ID of the CRM layout (a page configuration that defines field arrangement and sections for record detail views). Each module can have multiple layouts; omit to use the default layout." }, "RelatedListsModule": { "description": "Specify the API name of the CRM module for which to retrieve related lists. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for valid values.", "examples": { "Accounts": { "summary": "CRM Accounts module", "value": "Accounts" }, "Contacts": { "summary": "CRM Contacts module", "value": "Contacts" }, "Deals": { "summary": "CRM Deals/Opportunities module", "value": "Deals" }, "Leads": { "summary": "CRM Leads module", "value": "Leads" } }, "in": "query", "name": "module", "required": true, "schema": { "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string" } }, "RelatedListsStatus": { "description": "Specify the visibility status to filter related lists. Possible values: **visible**, **scheduled_for_deletion**, **user_hidden**.", "examples": { "Hidden": { "summary": "Show only user-hidden related lists", "value": "user_hidden" }, "ScheduledDeletion": { "summary": "Show only related lists scheduled for deletion", "value": "scheduled_for_deletion" }, "Visible": { "summary": "Show only visible related lists", "value": "visible" } }, "in": "query", "name": "status", "required": false, "schema": { "enum": [ "visible", "scheduled_for_deletion", "user_hidden" ], "type": "string" } }, "RelatedNotesFields": { "description": "A comma-separated list of field API names to return in the response. If not specified, all available fields are included in the response.", "examples": { "BasicFields": { "summary": "Basic note fields", "value": "Note_Title,Note_Content,Created_Time" } }, "in": "query", "name": "fields", "required": false, "schema": { "maxLength": 1000, "pattern": "^[A-Za-z_][A-Za-z0-9_]*(,[A-Za-z_][A-Za-z0-9_]*)*$", "type": "string" } }, "RelatedNotesIds": { "description": "Specify a comma-separated list of note record IDs to delete.", "examples": { "MultipleIds": { "summary": "Multiple note IDs", "value": "1043386000020244003,1043386000020244004,1043386000020244005" }, "SingleId": { "summary": "Single note ID", "value": "1043386000020244003" } }, "in": "query", "name": "ids", "required": true, "schema": { "maxLength": 2000, "pattern": "^[0-9]+(,[0-9]+)*$", "type": "string" } }, "RelatedNotesPage": { "description": "Specify the page number for pagination. The value must be **1 or greater**.", "examples": { "FirstPage": { "summary": "First page", "value": 1 }, "SecondPage": { "summary": "Second page", "value": 2 } }, "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" } }, "RelatedNotesParentRecordModule": { "description": "Specify the API name of the parent record module. Refer to [Get Modules](modules.yaml#$.paths./settings/modules.get) for the list of supported modules.", "examples": { "Contacts": { "summary": "Contacts module", "value": "Contacts" }, "Deals": { "summary": "Deals module", "value": "Deals" }, "Leads": { "summary": "Leads module", "value": "Leads" } }, "in": "path", "name": "parentRecordModule", "required": true, "schema": { "maxLength": 50, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "type": "string" } }, "RelatedNotesPerPage": { "description": "To get the list of records available per page. The default and the maximum possible value is **200.**", "examples": { "DefaultPageSize": { "summary": "Default page size", "value": 200 }, "SmallPageSize": { "summary": "Smaller page size for limited data", "value": 50 } }, "in": "query", "name": "perPage", "required": false, "schema": { "default": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "RelatedNotesSortBy": { "description": "Specify the field name to sort the note records by.\nPossible values:\nid - Sort by the note ID.\nCreated_Time - Sort by the creation date and time.\nModified_Time - Sort by the last modification date and time.", "examples": { "SortByCreatedTime": { "summary": "Sort by creation time", "value": "Created_Time" }, "SortById": { "summary": "Sort by note ID", "value": "id" }, "SortByModifiedTime": { "summary": "Sort by modification time", "value": "Modified_Time" } }, "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "id", "Created_Time", "Modified_Time" ], "maxLength": 50, "type": "string" } }, "RelatedNotesSortOrder": { "description": "The order in which results are returned.\nPossible values:\n**asc** - Returns results in ascending order.\n**desc** - Returns results in descending order.", "examples": { "Ascending": { "summary": "Ascending order", "value": "asc" }, "Descending": { "summary": "Descending order", "value": "desc" } }, "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "asc", "desc" ], "maxLength": 10, "type": "string" } }, "RelatedRecordsApprovalState": { "description": "Filter records by their current approval state.", "in": "query", "name": "approval_state", "required": false, "schema": { "enum": [ "webform_unapproved", "approved", "approval_process_pending", "approval_process_rejected", "webform_invalid", "webform_invalid_approval", "webform_double_optin", "review_process_pending", "review_process_rejected", "merge_pending", "zia_vision_pending", "zia_vision_rejected", "zia_vision_validation", "email_parser_waiting", "email_parser_rejected", "approval_process_recalled" ], "type": "string" } }, "RelatedRecordsApproved": { "description": "Filter records by approval status. When set to true, returns only approved records; when false, returns only unapproved records.", "in": "query", "name": "approved", "required": false, "schema": { "default": "true", "enum": [ "true", "false", "both" ], "type": "string" } }, "RelatedRecordsConverted": { "description": "Specify whether to filter records by conversion status. Possible values: **true**, **false**, **both**.", "in": "query", "name": "converted", "required": false, "schema": { "default": "false", "enum": [ "true", "false", "both" ], "type": "string" } }, "RelatedRecordsFields": { "description": "Specify the API names of the fields to include in the response as a comma-separated list.", "examples": { "BasicFields": { "summary": "Basic contact fields", "value": "First_Name,Last_Name,Email" }, "ExtendedFields": { "summary": "Extended fields including custom field", "value": "Account_Name,Phone,Lead_Source,Custom_Field__c" } }, "in": "query", "name": "fields", "required": true, "schema": { "maxLength": 1000, "pattern": "^[A-Za-z_][A-Za-z0-9_]*(,[A-Za-z_][A-Za-z0-9_]*)*$", "type": "string" } }, "RelatedRecordsFilters": { "description": "Filter for fetching specific related records based on criteria", "in": "query", "name": "filters", "required": false, "schema": { "$ref": "#/components/schemas/FilterCriterionRequest" } }, "RelatedRecordsIds": { "description": "Specify the unique identifiers of the records to delink from the parent record as a comma-separated list.", "examples": { "MultipleIds": { "summary": "Multiple record IDs", "value": "3652397000001234001,3652397000001234002,3652397000001234003" }, "SingleId": { "summary": "Single record ID", "value": "3652397000001234001" } }, "in": "query", "name": "ids", "required": true, "schema": { "maxLength": 2000, "pattern": "^[0-9]+(,[0-9]+)*$", "type": "string" } }, "RelatedRecordsIfModifiedSince": { "description": "Specify the date and time in RFC 2822 format. The response includes only records modified after this timestamp.", "examples": { "RecentChanges": { "summary": "Get records modified since January 20, 2024", "value": "2024-01-20T10:00:00Z" } }, "in": "header", "name": "If-Modified-Since", "required": false, "schema": { "format": "date-time", "type": "string" } }, "RelatedRecordsPage": { "description": "Specify the page number for paginating results.", "examples": { "FirstPage": { "summary": "First page", "value": 1 }, "SecondPage": { "summary": "Second page", "value": 2 } }, "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" } }, "RelatedRecordsPageToken": { "description": "Specify the token to retrieve the next set of records beyond the first 2,000 results. Use the **next_page_token** value from the previous response.", "in": "query", "name": "page_token", "required": false, "schema": { "maxLength": 500, "type": "string" } }, "RelatedRecordsParentRecordModule": { "description": "Specify the API name of the module the parent record belongs to. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for valid values.", "examples": { "Contacts": { "summary": "Contacts module", "value": "Contacts" }, "CustomModule": { "summary": "Custom Services module", "value": "Services__s" }, "Deals": { "summary": "Deals module", "value": "Deals" } }, "in": "path", "name": "parentRecordModule", "required": true, "schema": { "maxLength": 100, "pattern": "^[A-Za-z_][A-Za-z0-9_]*$", "type": "string" } }, "RelatedRecordsPerPage": { "description": "Specify the number of records to return per page.\n\nThe page and per_page parameter is used to fetch records according to their position in the CRM. Let us assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By using the page (1 and 2) and per_page (200) parameter, the user can fetch all 400 records using 2 API calls.\nIf the requested related list is not present or hidden in a layout, the system will return an INVALID_DATA response.", "examples": { "DefaultPageSize": { "summary": "Default page size", "value": 200 }, "SmallPageSize": { "summary": "Smaller page size for limited data", "value": 50 } }, "in": "query", "name": "perPage", "required": false, "schema": { "default": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "RelatedRecordsRecord": { "description": "Specify the unique numeric identifier of the specific related record.", "examples": { "NoteId": { "summary": "Note record ID", "value": "3652397000001567001" }, "ProductId": { "summary": "Product record ID", "value": "3652397000001234001" } }, "in": "path", "name": "record", "required": true, "schema": { "maxLength": 20, "pattern": "^[0-9]+$", "type": "string" } }, "RelatedRecordsSortBy": { "description": "Specify the field to sort the related records by. Possible values: **ID**, **Created_Time**, **Modified_Time**.", "in": "query", "name": "sort_by", "required": false, "schema": { "default": "id", "enum": [ "id", "Created_Time", "Modified_Time" ], "type": "string" } }, "RelatedRecordsSortOrder": { "description": "Specify the sort direction for the related records. Possible values: **asc**, **desc**.", "in": "query", "name": "sort_order", "required": false, "schema": { "default": "desc", "enum": [ "asc", "desc" ], "type": "string" } }, "RequestPathParamId": { "description": "Specify the request path param ID value for the request. Use the [Assignment Rule API](assignment_rules.yaml#$.paths./settings/automation/assignment_rules.get) to retrieve the Assignment Rule ID.", "examples": { "LargeId": { "description": "Maximum long value example", "value": "9223372036854775807" }, "Typical": { "description": "sample value 1", "value": "123456789" } }, "in": "path", "name": "id", "required": true, "schema": { "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string" } }, "RestrictTriggers": { "description": "(Optional) Comma-separated list of automation triggers to suppress during the operation. Accepted values are `workflow`, `approval`, `blueprint`, `pathfinder`, and `orchestration`.", "in": "query", "name": "restrict_triggers", "required": false, "schema": { "description": "Comma-separated trigger names to restrict.", "maxLength": 100, "type": "string" } }, "RolesRole": { "description": "The unique ID of the role.", "in": "path", "name": "role", "required": true, "schema": { "format": "int64", "type": "integer" } }, "Scope": { "description": "Represents the category of custom views to fetch. Allowed values are 'created_by_me', 'shared_with_me', 'public_views', 'other_users_views'.", "in": "query", "name": "scope", "required": false, "schema": { "enum": [ "created_by_me", "shared_with_me", "public_views", "other_users_views" ], "type": "string" } }, "ScoringRulesParamQueryFields": { "description": "Comma-separated list of fields to include in the response. If this param is passed, except the mentioned fields, value of other fields will be null. Supported values: field_rules, signal_rules, name, description, active.", "in": "query", "name": "fields", "required": false, "schema": { "example": "name,description", "maxLength": 255, "type": "string" } }, "ScoringRulesParamQueryIds": { "description": "Specifies the IDs of the Scoring Rules to delete, provided as a comma-separated list.", "in": "query", "name": "ids", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "ScoringRulesParamQueryIncludeInnerDetails": { "description": "Comma-separated list of inner detail fields to include in the response. Supported values: custom_fields.field_label, custom_fields.reference_field.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "example": "custom_fields.field_label,custom_fields.reference_field", "maxLength": 255, "type": "string" } }, "ScoringRulesParamQueryModule": { "description": "Specifies the API name of the module to filter Scoring Rules by.", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 100, "type": "string" } }, "ScoringRulesParamQueryPage": { "description": "Specifies the page number for paginated results.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "ScoringRulesParamQueryPerPage": { "description": "Specifies the number of Scoring Rules to return per page.", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "SearchEmail": { "description": "Specify the email address to search for across all email-type fields in the module. Partial matches are supported and searches multiple email fields simultaneously. *Mandatory if criteria, phone, and word are not present.*", "examples": { "DomainSearch": { "summary": "Search for all emails from a domain", "value": "@company.com" }, "ExactEmail": { "summary": "Search for exact email address", "value": "john.doe@example.com" }, "PartialEmail": { "summary": "Partial email search (finds john.doe@example.com)", "value": "john.doe" } }, "in": "query", "name": "email", "required": false, "schema": { "format": "string", "maxLength": 255, "type": "string" } }, "SearchPhone": { "description": "Specify the phone number to search for across all phone-type fields in the module. The value must be at least three characters long and may include digits, spaces, hyphens, parentheses, and the plus sign. Supports various phone number formats including international, national, and partial numbers.\n*Mandatory if criteria, email, and word are not present.*", "examples": { "DigitsOnly": { "summary": "Digits only format", "value": "5551234567" }, "International": { "summary": "International format with country code", "value": "+1-555-123-4567" }, "National": { "summary": "US national format with parentheses", "value": "(555) 123-4567" }, "Partial": { "summary": "Partial phone number search", "value": "555-123" } }, "in": "query", "name": "phone", "required": false, "schema": { "maxLength": 50, "minLength": 3, "pattern": "^[+]?[0-9\\s\\-\\(\\)\\.]+$", "type": "string" } }, "SearchWord": { "description": "Specify the word or phrase to search for across all searchable text fields in the module. The value must be at least two characters long. Performs a global search with minimum 2 characters required. This is the broadest search method but may be slower than specific field searches.\n*Mandatory if criteria, email, and phone are not present.*", "examples": { "CompanyName": { "summary": "Search for company name across fields", "value": "Zylker" }, "PersonName": { "summary": "Search for person name across fields", "value": "John Doe" }, "Phrase": { "summary": "Search for multi-word phrases", "value": "marketing campaign" }, "ProductTerm": { "summary": "Search for product-related terms", "value": "software" } }, "in": "query", "name": "word", "required": false, "schema": { "maxLength": 100, "minLength": 2, "type": "string" } }, "SendMailId": { "description": "Specify the unique ID of the record to send the email to.", "in": "path", "name": "id", "required": true, "schema": { "description": "Record ID", "maxLength": 100, "type": "string" } }, "SendMailModuleName": { "description": "Specify the API name of the Zoho CRM module for which the record exists. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Supported modules: Leads, Contacts, Deals, Accounts, Sales Orders, Purchase Orders, Invoices, Quotes, Cases, Vendors, and Custom Modules.", "in": "path", "name": "moduleName", "required": true, "schema": { "description": "Module API name", "maxLength": 100, "type": "string" } }, "ServicesCvid": { "description": "Specify the unique ID of the Custom View. Use the [Get Custom Views Metadata API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the Custom View IDs.", "in": "query", "name": "cvid", "schema": { "format": "int64", "type": "string" } }, "ServicesFields": { "description": "Specify a comma-separated list of field API names to include in the response. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and API names.", "in": "query", "name": "fields", "required": true, "schema": { "type": "string" } }, "ServicesPage": { "description": "Specify the page number to retrieve. Starts at 1.", "in": "query", "name": "page", "schema": { "format": "int32", "minimum": 1, "type": "integer" } }, "ServicesPageToken": { "description": "Specify the page token to retrieve records beyond the first 2,000 results. Use the **next_page_token** value from a previous response to access the next page of results.", "in": "query", "name": "page_token", "schema": { "maxLength": 96, "type": "string" } }, "ServicesParamPathId": { "description": "Specify the unique ID of the service record to be retrieved, updated, or deleted.", "explode": false, "in": "path", "name": "id", "required": true, "schema": { "example": "{id}", "maxLength": 100, "type": "string" }, "style": "simple" }, "ServicesParamQueryIds": { "description": "Specify the IDs of the service records to be deleted. Provide them as comma-separated values with a maximum of **100** IDs per request.", "explode": true, "in": "query", "name": "ids", "required": false, "schema": { "maximum": 100000000000000000, "minimum": 1, "type": "number" }, "style": "form" }, "ServicesPerPage": { "description": "Specify the number of records to return per page. Maximum is 200.", "in": "query", "name": "per_page", "schema": { "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "ServicesSortBy": { "description": "Specify the field to sort records by. Possible values:**id** - Sorts by record ID. **Created_Time** - Sorts by creation timestamp. **Modified_Time** - Sorts by last modification timestamp.", "in": "query", "name": "sort_by", "schema": { "enum": [ "id", "Created_Time", "Modified_Time" ], "type": "string" } }, "ServicesSortOrder": { "description": "Specify the sort order for the records.
Possible values:
desc - Returns records in descending order.
asc - Returns records in ascending order.", "in": "query", "name": "sort_order", "schema": { "enum": [ "desc", "asc" ], "type": "string" } }, "ShareRecordsApproved": { "description": "Filters sharing records by approval status.\n- `true` - return only approved sharing entries\n- `false` - return only unapproved (pending) sharing entries\n- `both` - return all sharing entries regardless of approval status", "in": "query", "name": "approved", "required": false, "schema": { "enum": [ "true", "false", "both" ], "type": "string" } }, "ShareRecordsModuleApiName": { "description": "Specify the API name of the module that owns the record. Refer to the [Get Modules API](modules.yaml#$.paths./settings/modules.get) for valid values.", "in": "path", "name": "moduleApiName", "required": true, "schema": { "description": "Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores.", "maxLength": 50, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } } }, "ShareRecordsRecordId": { "description": "Specify the unique ID of the record. Refer to the [Get Records API](record.yaml#$.paths./{module}.get) for valid values.", "in": "path", "name": "recordId", "required": true, "schema": { "description": "Represents the unique identifier of the RecordGETDataItem record.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } } }, "SharedTo": { "description": "Specify the unique ID of the user whose share entries you want to retrieve. When set, the response returns only the share entries for that user. Use the [Get Users API](users.yaml#$paths./users.get) to get the valid IDs for the users. ", "in": "query", "name": "sharedTo", "required": false, "schema": { "description": "Represents the unique identifier of the user.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } } }, "Shift": { "description": "Represents the unique identifier of the shift hour to retrieve, update, or delete.", "examples": { "Default": { "summary": "Example shift hour ID", "value": "5725767000000296005" } }, "in": "path", "name": "shift", "required": true, "schema": { "maxLength": 50, "type": "string" } }, "ShiftId": { "description": "Specify the unique identifier of the shift hour whose holidays to retrieve. Required when the type parameter is set to shift_holiday.", "examples": { "Default": { "summary": "Example shift ID", "value": "5725767000000296005" } }, "in": "query", "name": "shift_id", "required": false, "schema": { "description": "The Shift id of the object.", "maxLength": 30, "minLength": 1, "pattern": "^[0-9]+$", "type": "string" } }, "Sortby": { "description": "Specify the field to use for sorting the response based on created time. Accepts the literal value `created_time`.", "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "created_time" ], "type": "string" } }, "Sortorder": { "description": "Specify the direction(ascending or descending) in which to sort the response.\n\nPossible values:\n**asc** - Sort results in ascending order.\n**desc** - Sort results in descending order.", "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, "StageParameter": { "description": "Specify the ID of the stage within the pipeline to assign transferred records when deleting or deactivating a layout. Refer to the [Get Pipelines](pipeline.yaml#$.paths./settings/pipeline.get) resource for valid values.", "examples": { "StageId": { "summary": "Stage ID", "value": "111111000000098510" } }, "in": "query", "name": "stage", "required": false, "schema": { "$ref": "#/components/schemas/LayoutsId" } }, "TagsActionsParamPathId": { "description": "Unique identifier of the record or tag. Use the [Get Tags API](tags.yaml#$.paths./settings/tags.get) to retrieve tag IDs.\n", "in": "path", "name": "id", "required": true, "schema": { "example": "{id}", "maxLength": 19, "type": "string" } }, "TagsActionsParamQueryId": { "description": "Tag ID to retrieve the records count for. Use the [Get Tags API](tags.yaml#$.paths./settings/tags.get) to retrieve tag IDs.\n", "in": "query", "name": "id", "required": false, "schema": { "example": "111111111112346460", "maxLength": 19, "type": "string" } }, "TagsActionsParamQueryModule": { "description": "The API name of the module to retrieve the tag records count for. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.\n", "example": "Leads", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "TagsParamPathId": { "description": "Specify the unique ID of the tag.", "in": "path", "name": "id", "required": true, "schema": { "description": "Tag ID", "example": "{id}", "maxLength": 255, "type": "string" } }, "TagsParamQueryId": { "description": "Specify the unique ID of the tag to update.", "in": "query", "name": "id", "required": true, "schema": { "example": "111111000000071740", "maxLength": 19, "type": "string" } }, "TagsParamQueryInclude": { "description": "Specify the additional tag properties to include in the response. Possible values: **type**, **associated_record_count**, **last_accessed_time**.", "in": "query", "name": "include", "required": false, "schema": { "enum": [ "type", "associated_record_count", "last_accessed_time" ], "type": "string" } }, "TagsParamQueryModule": { "description": "Specify the API name of the module. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for valid values.", "example": "Leads", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, "TerritoriesFilters": { "description": "Represents the filters query parameter, which specifies the filter criteria to apply when retrieving territories.", "in": "query", "name": "filters", "required": false, "schema": { "$ref": "#/components/schemas/FilterCriterionRequest" } }, "TerritoriesId": { "description": "Represents the ID path parameter, which specifies the unique identifier of the territory.", "in": "path", "name": "id", "required": true, "schema": { "description": "Represents the list of Territory Id. Provide the ID of the territory. Use the [Ger Territories API](territories.yaml#$.paths./settings/territories.get) to get the valid values.", "format": "int64", "type": "string" } }, "TerritoriesIds": { "description": "Represents the ids query parameter, which specifies the unique identifiers of the territories to retrieve.", "explode": false, "in": "query", "name": "ids", "required": false, "schema": { "description": "Represents the list of Territory Ids.", "items": { "description": "Individual territory ID used in a comma-separated list for retrieval or operations on multiple territories.", "format": "int64", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "style": "form" }, "TerritoriesInclude": { "description": "Represents the include query parameter, which specifies the rule criteria to include in the response. Possible values: **account_rule_criteria**, **lead_rule_criteria**, **deal_rule_criteria**, **account_rule_criteria,lead_rule_criteria**, **account_rule_criteria,deal_rule_criteria**, **lead_rule_criteria,deal_rule_criteria**, **account_rule_criteria,lead_rule_criteria,deal_rule_criteria**.", "in": "query", "name": "include", "required": false, "schema": { "description": "The additional fields to include in the response, of type string.", "enum": [ "account_rule_criteria", "lead_rule_criteria", "deal_rule_criteria", "account_rule_criteria,lead_rule_criteria", "account_rule_criteria,deal_rule_criteria", "lead_rule_criteria,deal_rule_criteria", "account_rule_criteria,lead_rule_criteria,deal_rule_criteria" ], "maxLength": 100, "type": "string" } }, "TerritoriesIncludeInnerDetails": { "description": "Represents the include_inner_details query parameter, which specifies the additional manager fields to include in the response. Possible values: **manager.zuid,manager.status**, **manager.zuid**, **manager.status**.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "description": "Provide whether additional details has to be included in the response.", "enum": [ "manager.zuid,manager.status", "manager.zuid", "manager.status" ], "type": "string" } }, "TerritoriesJobId": { "description": "Represents the job_id query parameter, which specifies the unique identifier of the scheduled run rule job.", "in": "query", "name": "job_id", "required": true, "schema": { "description": "Unique identifier of the scheduled run rule job.", "format": "int64", "type": "string" } }, "TerritoriesModule": { "description": "Represents the module path parameter, which specifies the API name of the module for the territory operation.", "in": "path", "name": "module", "required": true, "schema": { "description": "The API name of the CRM module, of type string. use the [Get Modules API](modules.yaml#$.paths/settings/modules.get) to get the valid values.", "maxLength": 100, "type": "string" } }, "TerritoriesPage": { "description": "Represents the page query parameter, which specifies the page number for paginated results.", "in": "query", "name": "page", "required": false, "schema": { "description": "Page number as an integer, starting from 1.", "format": "int32", "minimum": 1, "type": "integer" } }, "TerritoriesPerPage": { "description": "Represents the per_page query parameter, which specifies the number of records to return per page.", "in": "query", "name": "per_page", "required": false, "schema": { "description": "Represents the per page number.", "format": "int32", "maximum": 2000, "minimum": 1, "type": "integer" } }, "TerritoriesRecord": { "description": "Represents the record path parameter, which specifies the unique identifier of the record for the territory operation.", "in": "path", "name": "record", "required": true, "schema": { "description": "The unique ID of the record, of type string. Use the [Get Records API](record.yaml#$.paths./{module}.get) to get the valid values.", "format": "int64", "type": "string" } }, "TerritoryId": { "description": "Specify the unique ID of the territory. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID.", "in": "query", "name": "territory_id", "schema": { "format": "int64", "type": "string" } }, "TerritoryUsersIds": { "description": "Specify the unique IDs of the users to disassociate from the territory as a comma-separated list.", "in": "query", "name": "ids", "required": true, "schema": { "description": "Represents a comma-separated list of user IDs as a string, with a maximum length of 500 characters.", "maxLength": 500, "type": "string" } }, "TerritoryUsersTerritory": { "description": "Specify the unique ID of the territory.", "in": "path", "name": "territory", "required": true, "schema": { "description": "Territory Id Param in URL. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID.", "maxLength": 100, "type": "string" } }, "TerritoryUsersUser": { "description": "Specify the unique ID of the user.", "in": "path", "name": "user", "required": true, "schema": { "description": "Represents the unique ID of the user as a string, with a maximum length of 100 characters. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve the user ID.", "maxLength": 100, "type": "string" } }, "TimelinesInclude": { "description": "Use this parameter if you want to view the details of updates to the record through signals or any other means. The possible values are extension and type. For example, if the record was updated through a signal, then the response will have details of the extension as email insights, while the type of update will be signals.", "in": "query", "name": "include", "required": false, "schema": { "maxLength": 255, "type": "string" } }, "TimelinesIncludeInnerDetails": { "description": "Use this parameter if you want to retrieve additional details about updates made to a record in the `field_history` object of the response.\n\n**Possible Values**\n\n- field_history.data_type : Gives the data type of the field that was updated.\n\n- `field_history.field_label` : Gives the label details of the fields that were updated.\n\n- field_history.pick_list_values : Represents the list of values available for a picklist field.\n\n- `field_history.enable_colour_code` : Indicates whether colour coding is enabled for the picklist values.\n\n- `done_by.profile` : Provides details of the user's profile who updated the record.\n\n- `done_by.type__s` : Indicates the type of user (for example, portal user or regular user) who modified the record.\n", "in": "query", "name": "include_inner_details", "required": false, "schema": { "maxLength": 255, "type": "string" } }, "TimelinesModule": { "description": "Specifies the API name of the CRM module to retrieve timeline entries from. Use the value from the **api_name** field returned by [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html).", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "TimelinesPage": { "description": "Specifies the page number for retrieving timeline entries in paginated results.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "TimelinesPageToken": { "description": "Specify the **next_page_token** or the **previous_page_token** after you have paginated and retrieved 200 records. Note that you cannot give **per_page** parameter if you give **page_token** in the request.", "in": "query", "name": "page_token", "required": false, "schema": { "maxLength": 255, "type": "string" } }, "TimelinesPerPage": { "description": "Specifies the number of timeline entries to return per page. The value must be **3**.", "in": "query", "name": "per_page", "required": false, "schema": { "enum": [ 3 ], "format": "int32", "type": "integer" } }, "TimelinesRecordId": { "description": "Specifies the unique ID of the CRM record to retrieve timeline entries for.", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "TimelinesSortBy": { "description": "Specifies the field to sort timeline entries by. The only supported value is **audited_time**.", "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "audited_time" ], "type": "string" } }, "TimelinesSortOrder": { "description": "Specifies the sort order for timeline entries. Possible values: **asc**, **desc**.", "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, "TransferToId": { "description": "The unique ID of the role to which subordinate records are transferred before the deletion. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "in": "query", "name": "transfer_to_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, "TransferToParameter": { "description": "Specify the ID of the layout to which records associated with the current layout move upon layout deletion or deactivation. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.", "examples": { "TransferLayoutId": { "summary": "Transfer to layout ID", "value": "111111000000337001" } }, "in": "query", "name": "transfer_to", "required": false, "schema": { "$ref": "#/components/schemas/LayoutsId" } }, "TypeS": { "description": "Specify the account type of the users to retrieve.\nPossible values:\nSandbox Developer User - User with access to the sandbox environment.\nSupport User - User with support access.\nClient Portal User - External client portal user.\nRegular User - Standard CRM user.\nTeam User - User operating as part of a team account.\nSystem User - User designated as a system-level account.\nDigital Employee - Automated or digital worker account.", "in": "query", "name": "type__s", "required": false, "schema": { "description": "Represents the type of the user account.\nPossible values:\n**Regular User** - A standard CRM user.\n**System User** - A system-level user account.\n**Sandbox Developer User** - A user with sandbox developer access.\n**Support User** - A support-level user account.\n**Client Portal User** - A user with client portal access.\n**Team User** - A user account used for team-level access.", "enum": [ "Sandbox Developer User", "Support User", "Client Portal User", "Regular User", "Team User", "System User", "Digital Employee" ], "readOnly": true, "type": "string" } }, "UnblockEmailId": { "description": "Represents the unique ID of the record. Use the [Get Records API](record.yaml#$.paths./{module}.get) to get valid values.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 50, "type": "string" } }, "UnblockEmailModule": { "description": "Represents the module API name. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get valid values. ", "in": "path", "name": "module", "required": true, "schema": { "enum": [ "Leads" ], "type": "string" } }, "UserGroupsFilters": { "description": "Filter criteria to narrow the results. Specify conditions as a structured filter expression. Maximum 250 characters.", "in": "query", "name": "filters", "required": false, "schema": { "maxLength": 250, "type": "string" } }, "UserGroupsIds": { "description": "Specify a comma-separated list of unique user group IDs to filter the results by.", "in": "query", "name": "ids", "required": false, "schema": { "maxLength": 250, "type": "string" } }, "UserGroupsInclude": { "description": "Specify additional related data to include in the response.\nPossible values:\n**sources** - Include the list of sources for each group.\n**sources_count** - Include the count of sources for each group.", "in": "query", "name": "include", "required": false, "schema": { "enum": [ "sources_count", "sources" ], "type": "string" } }, "UserGroupsName": { "description": "Specify the name of the user group to filter the results by.", "in": "query", "name": "name", "required": false, "schema": { "maxLength": 250, "type": "string" } }, "UserGroupsPage": { "description": "Specify the page number to retrieve paginated results. Default is 1. Minimum value is 1.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "UserGroupsPerPage": { "description": "Specify the number of records to return per page. Default is 200. Maximum value is 200.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "UserType": { "description": "Specify the user type of the portal users. Refer to the [Get Portal User Types](https://www.zoho.com/crm/developer/docs/api/v8/get-user-types.html) resource for valid values.", "in": "path", "name": "userType", "required": true, "schema": { "description": "Represents the unique numeric identifier of the portal user type.", "format": "int64", "maxLength": 255, "type": "integer", "x-zs-$ref": { "origins": [ { "operationId": "getPortalUserTypes", "propertyId": "PortalUserTypesId" } ], "resource": "portal_user_type" } } }, "UsersFields": { "description": "Specify the comma-separated list of field API names to include in the response.", "explode": false, "in": "query", "name": "fields", "required": false, "schema": { "description": "API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.", "example": "First_Name,Last_Name,Email,Isonline", "maxLength": 3000, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsApiName" } ], "resource": "fields" } }, "style": "form" }, "UsersIds": { "description": "Specify a comma-separated list of user IDs to retrieve. If not provided, the API retrieves all users based on the other parameters.", "explode": false, "in": "query", "name": "ids", "required": false, "schema": { "items": { "description": "Represents the unique ID of a user in the Zoho CRM organization.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } }, "maxItems": 100, "minItems": 1, "type": "array" }, "style": "form" }, "UsersIncludeLiteUsers": { "description": "Specify whether to include lite users in the result set.\\n\\nPossible values:\\ntrue - Lite users are included.\\nfalse - Lite users are not included.", "in": "query", "name": "include_lite_users", "required": false, "schema": { "type": "boolean" } }, "UsersPage": { "description": "Specify the page number to retrieve in the paginated response.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "UsersPerPage": { "description": "Specify the number of user records to return per page.", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "type": "integer" } }, "UsersRoleId": { "description": "Specify the role ID to filter users. The API retrieves users with the specified role and higher or lower roles based on the value of the **type** parameter. Applicable only for **ParentRoleUsers**, **ChildRoleUsers**, and **SubordinateRoleUsers** types.", "in": "query", "name": "role_id", "required": false, "schema": { "description": "Represents the unique ID of the role. ", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } } }, "UsersTerritoriesIds": { "description": "Specify the territory IDs to remove from the user. Accepts comma-separated values. Maximum: 100. Valid territory IDs can be retrieved using the [Get Territories](user_territories.json#$.paths./{users}/{user}/territories.get) API.", "in": "query", "name": "ids", "required": true, "schema": { "description": "Comma-separated IDs (digits only, separated by commas)", "maxLength": 2000, "pattern": "^[0-9]+(,[0-9]+)*$", "type": "string" } }, "UsersTerritoriesTerritory": { "description": "Specify the unique ID of the territory. Valid territory IDs can be retrieved using the [Get Territories](user_territories.json#$.paths./{users}/{user}/territories.get) API.", "in": "path", "name": "territory", "required": true, "schema": { "format": "int64", "type": "string" } }, "UsersTerritoriesUser": { "description": "Specify the unique ID of the user. Valid user IDs can be retrieved using the [Get Users](users.json#$.paths./{users}.get) API.", "in": "path", "name": "user", "required": true, "schema": { "format": "int64", "type": "string" } }, "UsersTransferJobId": { "description": "Indicates the ID of the job scheduled previously through the [Transfer Records and Delete User API](users_transfer.yaml#$.paths./users/{userId}/actions/transfer_and_delete.post).", "in": "query", "name": "job_id", "required": true, "schema": { "format": "int64", "type": "string" } }, "UsersTransferUserId": { "description": "Represents the unique identifier of the user whose data is to be transferred and whose account is to be deleted. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values.", "in": "path", "name": "userId", "required": true, "schema": { "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "UsersType": { "description": "Specify the type of users to retrieve.\nPossible values:\nCurrentUser - Retrieves the currently authenticated user.\nDeletedUsers - Retrieves only deleted users.\nDeactiveUsers - Retrieves only deactivated users.\nNotConfirmedUsers - Retrieves only unconfirmed users.\nConfirmedUsers - Retrieves only confirmed users.\nActiveUsers - Retrieves only active users.\nAdminUsers - Retrieves only administrator users.\nActiveConfirmedAdmins - Retrieves active, confirmed, and administrator users.\nActiveConfirmedUsers - Retrieves active and confirmed users.\nDeveloperUsers - Retrieves only developer users.\nAllUsers - Retrieves all users.\nAllActiveUsers - Retrieves all active users.\nActiveLiteUser - Retrieves active lite users.\nActiveAndDeactive - Retrieves both active and deactivated users.\nChildRoleUsers - Retrieves users belonging to child roles.\nParentRoleUsers - Retrieves users belonging to the parent role.\nSubordinateRoleUsers - Retrieves users in subordinate roles.\nConfirmedReportingUsers - Retrieves confirmed users who have reporting relationships.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "CurrentUser", "DeletedUsers", "DeactiveUsers", "NotConfirmedUsers", "ConfirmedUsers", "ActiveUsers", "AdminUsers", "ActiveConfirmedAdmins", "ActiveConfirmedUsers", "DeveloperUsers", "AllUsers", "AllActiveUsers", "ActiveLiteUser", "ActiveAndDeactive", "ChildRoleUsers", "ParentRoleUsers", "SubordinateRoleUsers", "ConfirmedReportingUsers" ], "type": "string" } }, "UsersUser": { "description": "Specify the unique ID of the user to retrieve, update, or delete.", "in": "path", "name": "user", "required": true, "schema": { "description": "Represents the unique identifier of the user.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } } }, "VariablesParamQueryIds": { "description": "Comma-separated list of variable IDs to delete. Mandatory when deleting multiple variables. Maximum: 100 IDs.", "explode": false, "in": "query", "name": "ids", "required": false, "schema": { "items": { "description": "The unique ID of the variable to delete.", "format": "int64", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "style": "form" }, "View": { "description": "Specify the level of detail to include in the response. \n**Possible values**: summary, manage.\n", "in": "query", "name": "view", "required": false, "schema": { "enum": [ "manage", "summary" ], "type": "string" } }, "WebhooksParamQueryFeatureType": { "description": "Specify the automation feature type to filter webhooks. When omitted, webhooks of all feature types are returned.\nPossible values:\n**workflow** - Workflow Rule.\n**approval_process** - Approval Process.\n**blueprint_transition** - Blueprint transition.\n**blueprint_state** - Blueprint state.\n**assignment_rules** - Assignment Rules.\n**kiosk** - Kiosk feature.\n**commandcenter_service** - CommandCenter service.", "in": "query", "name": "feature_type", "required": false, "schema": { "enum": [ "workflow", "approval_process", "blueprint_transition", "blueprint_state", "assignment_rules", "kiosk", "commandcenter_service" ], "type": "string" } }, "WebhooksParamQueryIds": { "description": "Specify the comma-separated list of webhook IDs to delete. Accepts comma-separated values. Refer to the [Get Webhooks](webhooks.yaml#$.paths./settings/automation/webhooks.get) resource for valid values.", "in": "query", "name": "ids", "required": true, "schema": { "example": "5249735000000100001,5249735000000100002", "maxLength": 250, "type": "string" } }, "WebhooksParamQueryModule": { "description": "Specify the API name of the parent CRM module to filter webhooks. When omitted, webhooks across all modules are returned. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "in": "query", "name": "module", "required": false, "schema": { "example": "Leads", "maxLength": 100, "type": "string" } }, "WebhooksParamQueryPage": { "description": "Specify the page number for paginated results. Defaults to 1 when omitted. Use together with per_page to navigate large result sets.", "in": "query", "name": "page", "required": false, "schema": { "example": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "WebhooksParamQueryPerPage": { "description": "Specify the number of records to return per page. Default and maximum is **200**.", "in": "query", "name": "per_page", "required": false, "schema": { "example": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "WebhooksParamQueryRelatedModule": { "description": "Specify the API name of a child or dependent module linked to the parent module (for example, Notes or Attachments). When omitted, webhooks across all related modules are returned.", "in": "query", "name": "related_module", "required": false, "schema": { "example": "Notes", "maxLength": 100, "type": "string" } }, "WebhooksParamQuerySortBy": { "description": "Specify the field used to sort the webhook list. Currently only Modified_Time is accepted.\nPossible values:\n**Modified_Time** - Sort by the last modified timestamp.", "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "Modified_Time" ], "type": "string" } }, "WebhooksParamQuerySortOrder": { "description": "Specify the sort direction for list results. Defaults to desc when omitted.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, "WizardsId": { "description": "Specify the unique ID of the wizard to retrieve or delete.", "in": "path", "name": "id", "required": true, "schema": { "description": "Numeric unique identifier of the wizard.", "format": "int64", "type": "string" } }, "WizardsLayoutId": { "description": "Specify the unique ID of the layout associated with the wizard. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.", "in": "query", "name": "layout_id", "required": true, "schema": { "description": "Numeric unique identifier of the layout.", "format": "int64", "type": "string" } }, "WizardsModule": { "description": "Specify the API name of the module for which you want to retrieve wizards. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "in": "query", "name": "module", "required": false, "schema": { "description": "API name of the module (e.g. Leads, Contacts, Deals).", "maxLength": 50, "type": "string" } }, "Word": { "description": "Specify a search term to filter the count to records that contain this word in any searchable field within the specified module.", "example": "fin", "in": "query", "name": "word", "required": false, "schema": { "description": "The word to filter records by.", "maxLength": 3000, "type": "string" } }, "WorkflowConfigurationsParamQueryModule": { "description": "Specify the API name of the CRM module for which you want to retrieve workflow configuration metadata. Must be a workflow-supported module (for example, Leads, Contacts, Deals, Accounts, Tasks, Cases, Products, Quotes, Sales_Orders, Purchase_Orders, Invoices, Campaigns, Vendors). Refer to the [Get Modules Metadata API](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "in": "query", "name": "module", "required": true, "schema": { "example": "Leads", "maxLength": 255, "type": "string" } }, "WorkflowRulesParamQueryModuleSchema": { "description": "Specifies the CRM module API name to filter workflow rules by, such as Leads, Contacts, or Deals.", "in": "query", "name": "module", "required": false, "schema": { "format": "string", "type": "string" } }, "WorkflowTasksParamQueryFeatureType": { "description": "Filter tasks by automation feature type. The filter accepts more values than POST does - values like `blueprint_transition`, `review_process`, and `orchestration` are system-created task types that can be retrieved but not created via POST. For POST, only `workflow`, `approval_process`, `Blueprint`, `kiosks`, `scoring_rule`, and `case_escalation_rule` are valid.", "in": "query", "name": "feature_type", "required": false, "schema": { "enum": [ "workflow", "approval_process", "blueprint", "kiosks", "scoring_rule", "case_escalation_rule", "blueprint_transition", "blueprint_state", "review_process", "orchestration", "assignment_rules", "pathfinder", "connected_workflows", "commandcenter_service", "cadences" ], "type": "string" } }, "WorkflowTasksParamQueryFilter": { "description": "Filter object to search tasks by name. Supported shape: field.api_name must be 'name', comparator must be 'contains', and value is the search string. Example: {\"field\":{\"api_name\":\"name\"},\"comparator\":\"contains\",\"value\":\"follow up\"}", "in": "query", "name": "filter", "required": false, "schema": { "example": "{\"field\":{\"api_name\":\"name\"},\"comparator\":\"contains\",\"value\":\"follow up\"}", "maxLength": 1000, "type": "string" } }, "WorkflowTasksParamQueryIds": { "description": "Comma-separated automation task definition IDs to delete in bulk. Maximum 10 IDs per request. Each ID must be a numeric string (e.g., \"111111000000200035,111111000000190030\"). Tasks associated with active automation cannot be deleted - returns NOT_ALLOWED per task.", "in": "query", "name": "ids", "required": true, "schema": { "example": "111111000000200035,111111000000190030,111111000000165002", "maxLength": 255, "pattern": "^[0-9]{1,20}(,[0-9]{1,20}){0,9}$", "type": "string" } }, "WorkflowTasksParamQueryIncludeInnerDetails": { "description": "Include additional nested labels/display metadata in task responses. Pass exactly one value per request (not comma-separated). Use \"display_value\" to include field_mapping display labels. Use \"module.module_name\" or \"module.singular_label\" to include module display names. Omit this parameter if you only need the raw task configuration.", "in": "query", "name": "include_inner_details", "required": false, "schema": { "enum": [ "related_module.module_name", "related_module.plural_label", "related_module.singular_label", "display_value", "module.module_name", "module.plural_label", "module.singular_label" ], "example": "display_value", "type": "string" } }, "WorkflowTasksParamQueryModule": { "description": "Filter tasks by CRM module API name (for example: Leads, Contacts, Deals).", "in": "query", "name": "module", "required": false, "schema": { "example": "Leads", "maxLength": 100, "type": "string" } }, "WorkflowTasksParamQueryPage": { "description": "To get the list of tasks from the respective pages. The default value is 1. Possible values: Positive integer values only.", "in": "query", "name": "page", "required": false, "schema": { "default": 1, "example": 1, "format": "int32", "minimum": 1, "type": "integer" } }, "WorkflowTasksParamQueryPerPage": { "description": "Specify how many tasks to return per page. The default and the maximum possible value is 200.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 200, "example": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "WorkflowTasksParamQuerySortBy": { "description": "Sort field. Currently only modified_time supported.", "in": "query", "name": "sort_by", "required": false, "schema": { "enum": [ "modified_time" ], "type": "string" } }, "WorkflowTasksParamQuerySortOrder": { "description": "Sort order for the results based on sort_by. Possible values: desc, asc.", "in": "query", "name": "sort_order", "required": false, "schema": { "enum": [ "desc", "asc" ], "type": "string" } }, "Year": { "description": "Specify the year for which to filter holidays.", "examples": { "Current": { "summary": "Current year", "value": 2024 }, "Next": { "summary": "Next year", "value": 2025 } }, "in": "query", "name": "year", "required": false, "schema": { "description": "The Year of the object.", "format": "int32", "maximum": 2100, "minimum": 2000, "type": "integer" } }, "ZiaOrgEnrichmentId": { "description": "Specify the unique identifier of the Zia organization enrichment job to retrieve. Obtain this value from the response of POST `/__zia_org_enrichment` or from the listing returned by GET `/__zia_org_enrichment`.", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 255, "type": "string" } }, "ZiaOrgEnrichmentPage": { "description": "Specify the page number to retrieve the list of records from the paginated results. Default value is 1. Accepts only positive integer values.", "in": "query", "name": "page", "required": false, "schema": { "enum": [ 1, 2 ], "format": "int32", "type": "integer" } }, "ZiaOrgEnrichmentStatus": { "description": "Filter the response by the status of the scheduled enrichment job, using the create org enrichment API.\n\nPossible values:\n**COMPLETED** - Returns jobs that finished and produced enriched data.\n**FAILED** - Returns jobs that ended with a failure.\n**DATA_NOT_FOUND** - Returns jobs that completed but could not locate any public data to enrich.\n**SCHEDULED** - Returns jobs that are queued and yet to run.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "COMPLETED", "FAILED", "DATA_NOT_FOUND", "SCHEDULED" ], "type": "string" } } }, "responses": { "ApisBadRequest": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the error response when the filters parameter contains invalid syntax or references an invalid module.", "summary": "You provided an invalid filter parameter.", "value": { "code": "BAD_REQUEST", "details": { "field": "module", "issue": "Unknown module." }, "message": "The request parameters are invalid.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ApisErrorResponse" } } }, "description": "The request parameter is invalid.\n\n**Resolution:** The request must include valid filter syntax and\nURL-encoded values.\n" }, "ApisForbidden": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the error response when the user lacks permission to access this resource.", "summary": "You do not have enough permission to access this resource.", "value": { "code": "FORBIDDEN", "details": {}, "message": "You do not have permission to access this resource.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ApisErrorResponse" } } }, "description": "Permission denied to access this resource.\n\n**Resolution:** Contact your CRM administrator to grant the required\npermission.\n" }, "ApisInternalServerError": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the error response when an unexpected server-side error occurs.", "summary": "Unexpected server error. Contact the support team. ", "value": { "code": "INTERNAL_ERROR", "details": { "trace_id": "abc123def456" }, "message": "An unexpected error occurred.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ApisErrorResponse" } } }, "description": "An unexpected error occurred on the server.\n\n**Resolution:** Unexpected and unhandled exception in the server.\nContact support team.\n" }, "ApisNotFound": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the error response when the requested endpoint or API version does not exist.", "summary": "Refer to the URL section of the API and provide a valid version and endpoint. ", "value": { "code": "NOT_FOUND", "details": {}, "message": "The requested resource was not found.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ApisErrorResponse" } } }, "description": "The requested resource does not exist.\n\n**Resolution:** The request URL must reference a valid API version and\nendpoint.\n" }, "ApisTooManyRequests": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the error response when the API rate limit is exceeded, including retry timing and limit details.", "summary": "Your rate limit has been exceeded. Please try again after sometime. ", "value": { "code": "TOO_MANY_REQUESTS", "details": { "limit": 100, "retry_after": 60, "trace_id": "rate-limit-trace-id-001", "window": 60 }, "message": "Rate limit exceeded. Please retry after the specified time.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ApisErrorResponse" } } }, "description": "The API rate limit has been exceeded.\n\n**Resolution:** The request should be retried after the time specified\nin the **retry_after** field in the response.\n" }, "ApisUnauthorized": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the error response when the access token is missing, expired, or invalid.", "summary": "Include a valid access token in the request header to authorize the API call.", "value": { "code": "UNAUTHORIZED", "details": {}, "message": "Authentication required or token invalid.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ApisErrorResponse" } } }, "description": "Authentication failed.\n\n**Resolution:** Pass the access token in the request header of the API\ncall.\n" }, "AttachmentsBadRequest": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Error response returned when the provided data format is invalid.", "summary": "Invalid data format", "value": { "code": "INVALID_DATA", "details": {}, "message": "invalid data provided", "status": "error" } }, "InvalidModule": { "description": "Error response returned when the module name is invalid.", "summary": "Invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecordId": { "description": "Error response returned when the record ID is invalid.", "summary": "Invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidUrl": { "description": "Error response returned when the attachment URL format is invalid.", "summary": "Invalid URL format", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "the given attachment URL is incorrect", "status": "error" } }, "MandatoryNotFound": { "description": "Error response returned when a required field is missing.", "summary": "Required field missing", "value": { "code": "MANDATORY_NOT_FOUND", "details": {}, "message": "required field not found", "status": "error" } }, "RequiredParamMissing": { "description": "Error response returned when a required parameter is missing.", "summary": "Required parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AttachmentsErrorResponse" } } }, "description": "Bad request - invalid input parameters or request body" }, "AttachmentsForbidden": { "content": { "application/json": { "examples": { "InsufficientScope": { "description": "Error response returned when the required OAuth scope is missing.", "summary": "Insufficient OAuth scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "required oauth scope is missing", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AttachmentsErrorResponse" } } }, "description": "Forbidden - insufficient permissions to perform the operation" }, "AttachmentsInternalServerError": { "content": { "application/json": { "examples": { "ServerError": { "description": "Error response returned when an unexpected server error occurs.", "summary": "Internal server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AttachmentsErrorResponse" } } }, "description": "Internal server error - unexpected server failure" }, "AttachmentsNotFound": { "content": { "application/json": { "examples": { "AttachmentNotFound": { "description": "Error response returned when the specified attachment is not found.", "summary": "Attachment not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "the id given seems to be invalid", "status": "error" } }, "RecordNotFound": { "description": "Error response returned when the specified record is not found.", "summary": "Record not found", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AttachmentsErrorResponse" } } }, "description": "Not found - the specified record or attachment does not exist" }, "AttachmentsTooManyRequests": { "content": { "application/json": { "examples": { "RateLimitExceeded": { "description": "Error response returned when the API rate limit is exceeded.", "summary": "API rate limit exceeded", "value": { "code": "RATE_LIMIT_EXCEEDED", "details": {}, "message": "API rate limit exceeded. Please retry after some time", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AttachmentsErrorResponse" } } }, "description": "Too many requests - rate limit exceeded" }, "AttachmentsUnauthorized": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Error response returned when the access token is invalid or expired.", "summary": "Invalid or expired access token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "invalid oauth token", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AttachmentsErrorResponse" } } }, "description": "Unauthorized - authentication credentials are missing or invalid" }, "AuditLogExportForbidden": { "content": { "application/json": { "examples": { "NoPermission": { "summary": "User does not have the required profile permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "profile permission" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AuditLogExportForbiddenResponse" } } }, "description": "Forbidden - the current user does not have an administrator profile, or the Audit Logs feature is not available for this organization." }, "BusinessHoursForbiddenResponse": { "content": { "application/json": { "examples": { "Forbidden": { "summary": "Forbidden Error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Users" ] }, "message": "Forbidden due to insufficient permissions", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Forbidden response schema", "properties": { "code": { "description": "Error code", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional contextual information about the error,", "properties": { "permissions": { "description": "List of missing permissions", "items": { "description": "Permission name", "enum": [ "Crm_Implied_Manage_Users" ], "type": "string" }, "maxItems": 5, "type": "array" } }, "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "BusinessHoursForbiddenResponse" } } }, "description": "Access denied. The authenticated user does not have the required permissions to manage business hours settings." }, "BusinessHoursNoContentResponse": { "description": "No business hours configuration exists for this organization." }, "BusinessHoursSuccessResponse": { "content": { "application/json": { "examples": { "Success": { "summary": "Success Response", "value": { "business_hours": { "code": "SUCCESS", "details": { "id": "1234567890" }, "message": "Business Hours saved successfully", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Standard success response for business hours operations", "properties": { "business_hours": { "additionalProperties": false, "description": "Business hours response object", "properties": { "code": { "description": "Code representing the operation status", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the created business hours", "properties": { "id": { "description": "Unique identifier of the created business hours", "maxLength": 255, "type": "string", "x-zs-$id": "BusinessHoursDetailsId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Message representing the operation status", "enum": [ "Business Hours saved successfully" ], "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" } }, "type": "object", "x-zs-$id": "BusinessHoursSuccessResponse" } } }, "description": "Business hours operation completed successfully." }, "DealContactRolesInternalServerError": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Provides the internal server error response object containing code, message, details, and status.", "properties": { "code": { "description": "Provides the error code indicating the type of error.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": true, "description": "Specifies the additional details about the error.", "type": "object" }, "message": { "description": "Provides the details of the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Provides the status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InternalServerErrorResponse" } } }, "description": "Response body of an Internal Server Error." }, "DeleteLayoutBadRequestResponse": { "content": { "application/json": { "examples": { "DependentPipelineParamMissing": { "description": "Returned when the pipeline parameter is required as a dependent of another supplied parameter but is absent from the request.", "summary": "Dependent pipeline parameter missing", "value": { "code": "DEPENDENT_PARAM_MISSING", "details": { "dependee": { "param_name": "transfer_to" }, "param_name": "pipeline" }, "message": "Cannot delete layout as pipeline is not specified for trasfer_to layout", "status": "error" } }, "DependentStageParamMissing": { "description": "Returned when the stage parameter is required as a dependent of another supplied parameter but is absent from the request.", "summary": "Dependent stage parameter missing", "value": { "code": "DEPENDENT_PARAM_MISSING", "details": { "dependee": { "param_name": "transfer_to" }, "param_name": "stage" }, "message": "Cannot delete layout as stage is not specified for trasfer_to layout", "status": "error" } }, "InvalidLayoutId": { "summary": "Invalid layout ID format", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "int64", "param_name": "id" }, "message": "The id given seems to be invalid", "status": "error" } }, "InvalidModule": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "summary": "Invalid HTTP method used", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "InvalidTransferToLayout": { "description": "Returned when the layout ID provided in the transfer_to parameter is invalid or does not exist in the Zoho CRM organization.", "summary": "Invalid transfer_to layout ID", "value": { "code": "INVALID_DATA", "details": { "param_name": "transfer_to" }, "message": "Transfer To Layout Id is Invalid", "status": "error" } }, "LayoutNotFound": { "description": "Returned when no layout with the specified layout ID exists in the CRM organization.", "summary": "Layout not found with given ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "No layout found with given id", "status": "error" } }, "LayoutNotFoundWrapped": { "description": "Returned when no layout with the specified ID exists, with the error wrapped inside the layouts array response format.", "summary": "Layout not found (wrapped in layouts array)", "value": { "layouts": [ { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "No layout found with given id", "status": "error" } ] } }, "MissingModule": { "summary": "Required module parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } }, "MissingPipeline": { "description": "Returned when the layout has an associated pipeline but the required pipeline parameter is absent from the request.", "summary": "Required pipeline parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "pipeline" }, "message": "One of the expected parameter is missing", "status": "error" } }, "MissingStage": { "description": "Returned when the layout has an associated pipeline but the required stage parameter is absent from the request.", "summary": "Required stage parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "stage" }, "message": "One of the expected parameter is missing", "status": "error" } }, "MissingTransferTo": { "description": "Returned when the layout has records associated with it but the required transfer_to parameter is absent from the request.", "summary": "Required transfer_to parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "transfer_to" }, "message": "One of the expected parameter is missing", "status": "error" } }, "TransferToDeactivatedLayout": { "description": "Returned when the layout specified in transfer_to is deactivated and cannot receive record transfers.", "summary": "Cannot transfer to deactivated layout", "value": { "code": "NOT_ALLOWED", "details": { "param_name": "transfer_to" }, "message": "Cannot transfer to the deactivated layout", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsErrorResponse" }, { "$ref": "#/components/schemas/LayoutErrorResponse" } ], "x-zs-$id": "LayoutErrorResponseStructure" } } }, "description": "Bad request response returned when a layout deletion request contains invalid or missing parameters, or when the requested deletion action is not permitted due to existing associations." }, "DeleteLayoutSuccessResponse": { "content": { "application/json": { "examples": { "LayoutDeleted": { "description": "Shows the response returned when a layout is successfully deleted, confirming the deletion with a status and details.", "summary": "Layout successfully deleted", "value": { "layouts": [ { "code": "SUCCESS", "details": { "id": "111112000000337004" }, "message": "layout deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteLayoutSuccessResponseBody" } } }, "description": "Successful response returned when one or more layouts complete the deletion operation. Contains the per-layout deletion outcome." }, "EmailDraftsMultiStatus": { "content": { "application/json": { "examples": { "MixedResults": { "summary": "Batch response with both successful and failed draft updates", "value": { "__email_drafts": [ { "code": "SUCCESS", "details": { "id": "bb08599ae908a3fc514349239ebd0dbf82a1fd0b60a7902244cf0ee6b52a88d1" }, "message": "Draft updated Successfully", "status": "success" }, { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "from", "json_path": "$.__email_drafts[1].from" }, "message": "required field not found", "status": "error" }, { "code": "SUCCESS", "details": { "id": "bb08599ae908a3fc514349239ebd0dbf82a1fd0b60a7902244cf0ee6b52a88d1" }, "message": "Draft updated Successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing per-draft status for mixed batch processing results.", "properties": { "__email_drafts": { "description": "Per-draft status results for the submitted batch.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Per-item success result.", "properties": { "code": { "description": "Operation result code.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details for successful draft operation.", "properties": { "id": { "description": "Updated or created draft identifier.", "maxLength": 64, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable result message.", "maxLength": 512, "type": "string" }, "status": { "description": "Per-item outcome status.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "EmailDraftsMultiStatusSuccessItem" }, { "additionalProperties": false, "description": "Per-item validation or processing error result.", "properties": { "code": { "description": "Operation error code.\n\n**Possible values:**\n- **MANDATORY_NOT_FOUND** - A required field is missing.\n- **INVALID_DATA** - The field contains invalid data.\n- **NOT_ALLOWED** - The field is not allowed in this operation.\n- **DUPLICATE_DATA** - A duplicate value was found (e.g. a duplicate attachment).\n- **EXPECTED_FIELD_MISSING** - At least one of a set of expected fields must be specified.\n- **AMBIGUITY_DURING_PROCESSING** - The given field values are ambiguous or conflicting.\n- **NOT_SUPPORTED** - The given field or value is not supported for this module.\n- **DEPENDENT_MISMATCH** - A field value does not match its dependent field.\n", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "NOT_ALLOWED", "DUPLICATE_DATA", "EXPECTED_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING", "NOT_SUPPORTED", "DEPENDENT_MISMATCH" ], "maxLength": 128, "type": "string" }, "details": { "additionalProperties": true, "description": "Details for failed draft operation.", "properties": { "api_name": { "description": "Field or API name that caused the error.", "maxLength": 128, "type": "string" }, "json_path": { "description": "JSON path for the invalid or missing field.", "maxLength": 256, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 512, "type": "string" }, "status": { "description": "Per-item outcome status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "EmailDraftsMultiStatusErrorItem" } ] }, "maxItems": 100, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object", "x-zs-$id": "EmailDraftsMultiStatusResponse" } } }, "description": "Multi-status response for batch operations with mixed success and error outcomes." }, "FetchFullDataInternalServerError": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Internal server error response. Indicates an unexpected and unhandled exception on the server. Contact the Zoho CRM support team if this error persists.", "properties": { "code": { "description": "Error code indicating the type of error.", "maxLength": 500, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InternalServerErrorResponse" } } }, "description": "Internal Server Error. An unexpected and unhandled exception occurred on the server. Contact the support team if this error persists." }, "FetchFullDataNoContentResponse": { "description": "No content. Returned when no record is found for the specified record ID, or when the specified fields contain no data." }, "GlobalPicklistsForbidden": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object containing code, message, details, and status.", "properties": { "code": { "description": "Error code indicating the type of error.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error.", "properties": { "permissions": { "description": "List of permissions required to access the resource.", "items": { "description": "Permission required to access the resource.", "enum": [ "Crm_Implied_Customize_Zoho_CRM" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "maxLength": 100, "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "NoPermissionErrorResponse" } } }, "description": "Forbidden" }, "GlobalPicklistsInternalServerError": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Internal server error response object containing code, message, details, and status.", "properties": { "code": { "description": "Error code indicating the type of error.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InternalServerErrorResponse" } } }, "description": "Internal Server Error" }, "HolidaysForbiddenError": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response when a user lacks the CRM profile permission required to access holiday data.", "summary": "No permission to access holiday data", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Permission to read holiday data is required", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when the user lacks permission to perform the requested operation.", "properties": { "code": { "description": "Indicates the error code for the permission violation. Possible values: NO_PERMISSION. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional information about the permission error.", "type": "object" }, "message": { "description": "Describes the specific permission requirement that was not met. ", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the response status. Possible values: error. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "HolidaysForbiddenError" } } }, "description": "The user does not have sufficient permission to perform the requested operation. **Resolution** The CRM administrator must grant the required permission to the user's profile." }, "HolidaysMultiStatusResponse": { "content": { "application/json": { "examples": { "Default": { "description": "Example multi-status response where some items succeed and others fail.", "summary": "An example multi-status response.", "value": { "holidays": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Holiday created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/HolidaysSuccessResponse" } } }, "description": "Returned when a batch request partially succeeds — some items succeed and some fail. Each item in the holidays array carries its own code, status, message, and details." }, "LayoutSuccessResponse": { "content": { "application/json": { "examples": { "LayoutSuccessResponse": { "description": "Complete example response showing the full layout structure with sections, fields, profiles, and portal user type associations for a custom module.", "summary": "Successful layout retrieval for custom module", "value": { "layouts": [ { "actions_allowed": { "clone": true, "deactivate": false, "delete": false, "downgrade": false, "edit": true, "rename": true, "set_layout_permissions": true }, "api_name": "Standard__s", "convert_mapping": { "Accounts": { "display_label": "Standard", "id": "4832675000000095047", "name": "Standard" }, "Contacts": { "display_label": "Standard", "id": "4832675000000095059", "name": "Standard" }, "Deals": { "display_label": "Standard", "fields": [ { "api_name": "Amount", "field_label": "Amount", "id": "4832675000000000517", "required": false }, { "api_name": "Deal_Name", "field_label": "Potential Name", "id": "4832675000000000519", "required": true }, { "api_name": "Closing_Date", "field_label": "Closing Date", "id": "4832675000000000521", "required": false }, { "api_name": "Stage", "field_label": "Stage", "id": "4832675000000000525", "required": true }, { "api_name": "Pipeline", "field_label": "Pipeline", "id": "4832675000000236001", "required": true } ], "id": "4832675000000095023", "name": "Standard" } }, "created_by": { "id": "2047208000000456001", "name": "Ajay Ajay" }, "created_for": null, "created_time": "2025-11-20T14:44:37+05:30", "display_label": "Standard", "generated_type": "system", "has_more_profiles": false, "id": "2047208000005744376", "modified_by": { "id": "2047208000000456001", "name": "Ajay Ajay" }, "modified_time": "2025-11-20T14:44:37+05:30", "name": "Standard", "portal_user_types": [ { "_default_view": { "id": "4832675000000095059", "name": "Standard", "type": "layout" }, "default": true, "id": "4832675000001280243", "name": "ClientPortal" } ], "profiles": [ { "_default_assignment_view": { "id": "2047208000005744376", "name": "Standard", "type": "layout" }, "_default_view": { "id": "2047208000005744376", "name": "Standard", "type": "layout" }, "default": true, "id": "2047208000000015972", "name": "Administrator" }, { "_default_assignment_view": { "id": "4832675000001271930", "name": "wizard Association", "type": "layout" }, "_default_view": { "id": "4832675000001280138", "name": "Testing wizard 1", "type": "wizard" }, "default": true, "id": "4832675000000015972", "name": "Administrator", "type": "normal_profile" }, { "_default_assignment_view": { "id": "4832675000001280644", "name": "Testing Canvas 1", "type": "canvas" }, "_default_view": { "id": "4832675000001280138", "name": "Testing wizard 1", "type": "wizard" }, "default": true, "id": "4832675000000015972", "name": "Administrator", "type": "normal_profile" } ], "sections": [ { "actions_allowed": { "add_field": false, "change_column_count": false, "change_tab_traversal": false, "delete": false, "remove_field": false, "rename": false, "reorder": false }, "api_name": "Record_Image__s", "column_count": 1, "display_label": "OAS Testing Module Image", "fields": [ { "additional_column": null, "address": null, "api_name": "Record_Image", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "PHOTO_FILEID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "image_enable", "add_to_other_layouts" ], "data_type": "profileimage", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Record Image", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "OAS Testing Module Image", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "2047208000005744479", "json_type": "string", "length": 255, "lookup": {}, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "portal_user_types": [ { "id": "4832675000001280243", "name": "ClientPortal", "permission_type": "hidden" } ], "profiles": [ { "id": "2047208000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "2047208000000015975", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": false, "section_id": 4, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 66, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "Account_Owner_1", "associated_module": null, "association_details": { "lookup_field": { "api_name": "Lookupfol", "id": "4832675000000849962" }, "related_field": { "api_name": "Owner", "id": "4832675000000000377" } }, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF511", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2025-11-18T13:09:25+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory", "fieldlabel", "removal", "deletion", "tooltip", "add_to_other_layouts", "lookup_filter", "recordaccess" ], "data_type": "userlookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Account Owner 1", "display_type": -1, "element_type": "mirror_field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Account Owner 1", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000849987", "json_type": "jsonobject", "length": 50, "lookup": { "revalidate_filter_during_edit": false }, "mass_update": true, "modified_time": "2025-11-18T13:09:25+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": { "id": "4832675000000000377" }, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 52, "sharing_properties": { "scheduler_status": "completed", "share_permission": "full-access", "share_preference_enabled": true }, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 221, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": "APPOINTMENTFOR", "address": null, "api_name": "Appointment_For", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SEID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position", "select_modules" ], "data_type": "multi_module_lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Appointment For", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Appointment For", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000851259", "json_type": "jsonobject", "length": 120, "lookup": {}, "mass_update": false, "modified_time": null, "multi_module_lookup": { "api_name": "Appointments__s", "display_label": "Appointments", "dynamic_module_addition_allowed": false, "modules": [ { "api_name": "Contacts", "id": "4832675000000000129", "module_name": "Contacts" } ] }, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "quick_sequence_number": "2", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 2, "show_type": 7, "sortable": false, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 132, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": "APPOINTMENTFOR", "address": null, "api_name": "Appointment_For", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SEID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position", "select_modules" ], "data_type": "multi_module_lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Appointment For", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Appointment For", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000851259", "json_type": "jsonobject", "length": 120, "lookup": {}, "mass_update": false, "modified_time": null, "multi_module_lookup": { "api_name": "Appointments__s", "display_label": "Appointments", "modules": [ { "api_name": "Contacts", "id": "4832675000000000129", "module_name": "Contacts" } ] }, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "quick_sequence_number": "2", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 2, "show_type": 7, "sortable": false, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 132, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "default", "id": "2047208000005744381", "isSubformSection": false, "mode": "default_create", "name": "Record Image", "properties": null, "sequence_number": 1, "tab_traversal": "left_to_right", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": true, "change_tab_traversal": true, "delete": true, "remove_field": true, "rename": true, "reorder": true }, "api_name": "CustomModule_Information__s", "column_count": 2, "display_label": "OAS Testing Module Information", "fields": [ { "additional_column": null, "address": null, "allowed_permissions_to_update": { "hidden": true, "read_only": true, "read_write": true }, "api_name": "Name", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "NAME", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fieldlabel", "max_length_digits", "unique", "tooltip" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": true, "display_format": null, "display_format_properties": null, "display_label": "CustomModule Name", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "OAS Testing Module Name", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "2047208000005744417", "json_type": "string", "length": 120, "lookup": {}, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "portal_user_types": [], "profiles": [ { "id": "2047208000000015972", "name": "Administrator", "permission_type": "read_write" } ], "quick_sequence_number": "1", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": true, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Currency", "associated_module": null, "association_details": null, "auto_number": {}, "blueprint_supported": false, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "CURRENCYISOCODE", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "removal", "add_to_other_layouts" ], "data_type": "picklist", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Currency", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Currency", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "2047208000005744435", "json_type": "string", "length": 120, "lookup": {}, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [ { "actual_value": "INR", "colour_code": null, "display_value": "INR", "id": "2047208000001015001", "maps": [], "reference_value": "INR", "sequence_number": 1, "type": "used" }, { "actual_value": "USD", "colour_code": null, "display_value": "USD", "id": "2047208000002283021", "maps": [], "reference_value": "USD", "sequence_number": 2, "type": "used" } ], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "2047208000000015972", "name": "Administrator", "permission_type": "read_write" } ], "quick_sequence_number": "10", "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 7, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 39, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Account_Site", "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "column_name": "ACCOUNTSITE", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Account Site", "display_type": -1, "element_type": "mirror_field", "external": null, "field_label": "Account Site", "field_read_only": false, "filterable": true, "formula": {}, "history_tracking": null, "id": "3359388000000121003", "json_type": "string", "length": 100, "lookup": {}, "lookup_field": { "api_name": "Account_Name", "id": "3359388000000000523" }, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "3359388000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "3359388000000015975", "name": "Standard", "permission_type": "read_write" }, { "id": "3359388000000584005", "name": "Team User", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "section_id": 1, "sequence_number": 5, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "visible": true, "webhook": true } ], "generated_type": "default", "id": "2047208000005744379", "isSubformSection": false, "mode": "default_create", "name": "CustomModule30 Information", "properties": null, "sequence_number": 2, "tab_traversal": "left_to_right", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": false, "change_tab_traversal": false, "delete": false, "remove_field": true, "rename": false, "reorder": false }, "api_name": "Event_Information1__s", "column_count": 1, "display_label": "Meeting Information", "fields": [ { "additional_column": null, "address": null, "api_name": "Event_Title", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SUBJECT", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": true, "display_format": null, "display_format_properties": null, "display_label": "Meeting Title", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Title", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004156", "json_type": "string", "length": 255, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "quick_sequence_number": "1", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": true, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Meeting_Venue__s", "associated_module": null, "association_details": null, "auto_number": {}, "blueprint_supported": false, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "MEETING_VENUE", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position", "tooltip", "display_value_alphabetically", "default_value", "color_code", "record_category", "add_record_category", "remove_record_category", "rename_record_category", "modify_record_category_type" ], "data_type": "picklist", "decimal_place": null, "default_value": "Client location", "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Meeting Venue", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Meeting Venue", "field_read_only": false, "filterable": true, "formula": {}, "global_map_dependency": { "id": "4832675000000722441" }, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000071545", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [ { "actual_value": "In-office", "colour_code": null, "display_value": "In-office", "id": "111111000000071549", "maps": [], "reference_value": "In-office", "sequence_number": 1, "type": "used" }, { "actual_value": "Client location", "colour_code": null, "display_value": "Client location", "id": "111111000000071551", "maps": [], "reference_value": "Client location", "sequence_number": 2, "type": "used" }, { "actual_value": "In-office", "colour_code": null, "display_value": "In-office", "id": "111111000000077054", "maps": [], "reference_value": "In-office", "sequence_number": 3, "type": "used" }, { "actual_value": "Online", "colour_code": null, "display_value": "Online", "id": "111111000000071553", "maps": [], "reference_value": "Online", "sequence_number": 4, "type": "used" } ], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" }, { "id": "111111000000000501", "name": "Admins", "permission_type": "read_write" }, { "id": "111111000000000503", "name": "Managers", "permission_type": "read_write" }, { "id": "111111000000000505", "name": "Members", "permission_type": "read_write" }, { "id": "111111000000000507", "name": "Participants", "permission_type": "read_write" }, { "id": "111111000000000509", "name": "Requesters", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 2, "show_type": 7, "sortable": true, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 2, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Venue", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LOCATION", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "fixed_position", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Venue", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Location", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004158", "json_type": "string", "length": 255, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "quick_sequence_number": "2", "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 3, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Meeting_Provider__s", "associated_module": null, "association_details": null, "auto_number": {}, "blueprint_supported": false, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "MEETING_PROVIDER", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "private_field", "tooltip", "hipaa_field", "history_tracking", "display_value_alphabetically", "default_value", "option_add", "add_to_other_layouts", "color_code", "replace_values", "record_category", "add_record_category", "remove_record_category", "rename_record_category", "modify_record_category_type" ], "data_type": "picklist", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Provider", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Provider", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000071546", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" }, { "id": "111111000000000501", "name": "Admins", "permission_type": "read_write" }, { "id": "111111000000000503", "name": "Managers", "permission_type": "read_write" }, { "id": "111111000000000505", "name": "Members", "permission_type": "read_write" }, { "id": "111111000000000507", "name": "Participants", "permission_type": "read_write" }, { "id": "111111000000000509", "name": "Requesters", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 4, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 2, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "All_day", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "ALLDAYEVENT", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position" ], "data_type": "boolean", "decimal_place": null, "default_value": false, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "All day", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "All day", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004160", "json_type": "boolean", "length": 5, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "quick_sequence_number": "3", "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 5, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 301, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Start_DateTime", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "STARTDATETIME", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position", "tooltip" ], "data_type": "datetime", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Start DateTime", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "From", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004162", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "quick_sequence_number": "4", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 6, "show_type": 7, "sortable": true, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 333, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "End_DateTime", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "ENDDATETIME", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position", "tooltip" ], "data_type": "datetime", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "End DateTime", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "To", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004164", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "quick_sequence_number": "5", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 7, "show_type": 7, "sortable": true, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 333, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Owner", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SMOWNERID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [], "data_type": "ownerlookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Meeting Owner", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Host", "field_read_only": true, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004166", "json_type": "jsonobject", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 8, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 8, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Description", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "DESCRIPTION", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "tooltip" ], "data_type": "textarea", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Description", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Description", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004194", "json_type": "string", "length": 32000, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 9, "show_type": 7, "sortable": false, "system_mandatory": false, "textarea": { "type": "large" }, "tooltip": null, "type": "used", "ui_type": 3, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Participants", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "PARTICIPANTID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [], "data_type": "bigint", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Participants", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Participants", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004192", "json_type": "jsonarray", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 10, "show_type": 9, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 41, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "Remind_Participants", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "REMINDINVITEESAT", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "removal" ], "data_type": "multireminder", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Remind Participants", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Participants Reminder", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004174", "json_type": "jsonarray", "length": 100, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 11, "show_type": 2, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 104, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "Tag", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "TAGMODULEREFID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Tag", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Tag", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004232", "json_type": "jsonarray", "length": 2000, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 12, "show_type": 7, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 209, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Who_Id", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "CONTACTID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal" ], "data_type": "lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Who Id", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Contact Name", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004168", "json_type": "jsonobject", "length": 120, "lookup": { "api_name": "Events", "display_label": "Open Meetings", "id": "111111000000011709", "module": { "api_name": "Contacts", "id": "111111000000002654" }, "query_details": { "system_query_id": null }, "revalidate_filter_during_edit": false }, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 13, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 4, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Recurring_Activity", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "RECURRING", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [], "data_type": "RRULE", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Recurring Activity", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Repeat", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004172", "json_type": "jsonobject", "length": 100, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": false, "web_create": true, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 14, "show_type": 2, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 123, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "Remind_At", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "REMINDAT", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [], "data_type": "multireminder", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Remind At", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Reminder", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004176", "json_type": "jsonarray", "length": 100, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 15, "show_type": 0, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 104, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "What_Id", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SEID", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "add_to_other_layouts", "lookup_filter", "field_of_lookup" ], "data_type": "lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "What Id", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Related To", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000004170", "json_type": "jsonobject", "length": 120, "lookup": { "api_name": null, "display_label": "activities", "id": null, "module": { "api_name": "se_module" } }, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 17, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 4, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "default", "id": "111111000000009824", "isSubformSection": false, "mode": "view", "name": "Event Information", "properties": null, "sequence_number": 1, "tab_traversal": "left_to_right", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": false, "change_tab_traversal": false, "delete": true, "remove_field": true, "rename": true, "reorder": true }, "api_name": "Subform_1", "column_count": 1, "display_label": "Subform 1", "fields": [ { "additional_column": null, "address": null, "api_name": "Subform_1", "associated_module": { "id": "111111000000216916", "layout": { "id": "111111000000216917", "name": "Standard" }, "module": "Subform_1" }, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LINKINGMXN1", "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": null, "data_type": "subform", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Subform 1", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Subform 1", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000217027", "json_type": "jsonarray", "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": false, "section_id": 6, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 500, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": true, "visible": true, "webhook": false } ], "generated_type": "custom", "id": "111111000000217245", "isSubformSection": true, "mode": "default_create", "name": "Subform 1", "properties": { "bulk_addition": null, "maximum_rows": 25, "reorder_rows": {}, "tooltip": null }, "sequence_number": 5, "tab_traversal": "left_to_right", "type": "used" } ], "show_business_card": true, "source": "campaign_integration", "status": "active", "total_profiles": 1, "visible": true }, { "actions_allowed": { "clone": true, "deactivate": false, "delete": false, "downgrade": false, "edit": true, "rename": true, "set_layout_permissions": true }, "api_name": "Standard__s", "convert_mapping": { "Invoices": { "display_label": "Standard", "id": "111111000000003680", "name": "Standard" } }, "created_by": null, "created_for": null, "created_time": null, "display_label": "Standard", "generated_type": "system", "has_more_profiles": false, "id": "111111000000003674", "modified_by": null, "modified_time": null, "name": "Standard", "profiles": [ { "_default_assignment_view": { "id": "111111000000003674", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000003674", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000497", "name": "Administrator" }, { "_default_assignment_view": { "id": "111111000000003674", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000003674", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000499", "name": "Standard" } ], "sections": [ { "actions_allowed": { "add_field": true, "change_column_count": true, "change_tab_traversal": true, "delete": true, "remove_field": true, "rename": true, "reorder": true }, "api_name": "Sales_Order_Information__s", "column_count": 2, "display_label": "Sales Order Information", "fields": [ { "additional_column": null, "address": null, "api_name": "Owner", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SMOWNERID", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "field_of_lookup" ], "data_type": "ownerlookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Sales Order Owner", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Sales Order Owner", "field_read_only": true, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005648", "json_type": "jsonobject", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 8, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "SO_Number", "associated_module": null, "association_details": null, "auto_number": { "prefix": null, "start_number": null, "suffix": null }, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SONUMBER", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "removal", "add_to_other_layouts" ], "data_type": "autonumber", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "SO Number", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "SO Number", "field_read_only": true, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005622", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_only" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_only" } ], "public": false, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 2, "show_type": 1, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 52, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Subject", "associated_module": null, "association_details": null, "auto_number": { "prefix": "", "start_number": 3, "starting_number_length": 1, "suffix": "" }, "businesscard_supported": false, "category": 1, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SALESORDERSUBJECT", "convert_mapping": { "Invoices": "Subject" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": true, "display_format": null, "display_format_properties": null, "display_label": "Subject", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Subject", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005624", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "quick_sequence_number": "1", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 3, "show_type": 7, "sortable": true, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Deal_Name", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "POTENTIALID", "convert_mapping": { "Invoices": "Deal_Name__s" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "add_to_other_layouts", "lookup_filter", "field_of_lookup" ], "data_type": "lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Potential Name", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Deal Name", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005626", "json_type": "jsonobject", "length": 120, "lookup": { "api_name": "SalesOrders", "display_label": "Sales Orders", "id": "111111000000011823", "module": { "api_name": "Deals", "crypt": false, "id": "111111000000002658" }, "query_details": { "system_query_id": null }, "revalidate_filter_during_edit": false }, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 4, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 133, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Customer_No", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "CUSTOMERNUMBER", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Customer No", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Customer No.", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005684", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 5, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Purchase_Order", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "PURCHASEORDER", "convert_mapping": { "Invoices": "Purchase_Order" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Purchase Order", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Purchase Order", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005628", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 6, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Quote_Name", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "QUOTEID", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "add_to_other_layouts", "lookup_filter", "field_of_lookup" ], "data_type": "lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Quote Name", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Quote Name", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005630", "json_type": "jsonobject", "length": 120, "lookup": { "api_name": "SalesOrders", "display_label": "Sales Orders", "id": "111111000000026323", "module": { "api_name": "Quotes", "crypt": false, "id": "111111000000002762" }, "query_details": { "system_query_id": null }, "revalidate_filter_during_edit": false }, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 7, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 133, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Due_Date", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "DUEDATE", "convert_mapping": { "Invoices": "Due_Date" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "date", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Due Date", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Due Date", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005632", "json_type": "string", "length": 20, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 8, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 24, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Pending", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "PENDING", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Pending", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Pending", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005634", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 9, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Contact_Name", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "CONTACTID", "convert_mapping": { "Invoices": "Contact_Name" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "add_to_other_layouts", "lookup_filter", "field_of_lookup" ], "data_type": "lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Contact Name", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Contact Name", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005636", "json_type": "jsonobject", "length": 120, "lookup": { "api_name": "SalesOrders", "display_label": "Sales Orders", "id": "111111000000011745", "module": { "api_name": "Contacts", "crypt": false, "id": "111111000000002654" }, "query_details": { "system_query_id": null }, "revalidate_filter_during_edit": false }, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 10, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 133, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Carrier", "associated_module": null, "association_details": null, "auto_number": {}, "blueprint_supported": false, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "CARRIER", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "private_field", "tooltip", "hipaa_field", "history_tracking", "display_value_alphabetically", "default_value", "option_add", "add_to_other_layouts", "color_code", "replace_values", "record_category", "add_record_category", "remove_record_category", "rename_record_category", "modify_record_category_type" ], "data_type": "picklist", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Carrier", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Carrier", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005638", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [ { "actual_value": "FedEX", "colour_code": null, "display_value": "FedEX", "id": "111111000000007836", "maps": [], "reference_value": "FedEX", "sequence_number": 1, "type": "used" }, { "actual_value": "UPS", "colour_code": null, "display_value": "UPS", "id": "111111000000007838", "maps": [], "reference_value": "UPS", "sequence_number": 2, "type": "used" }, { "actual_value": "USPS", "colour_code": null, "display_value": "USPS", "id": "111111000000007840", "maps": [], "reference_value": "USPS", "sequence_number": 3, "type": "used" }, { "actual_value": "DHL", "colour_code": null, "display_value": "DHL", "id": "111111000000007842", "maps": [], "reference_value": "DHL", "sequence_number": 4, "type": "used" }, { "actual_value": "BlueDart", "colour_code": null, "display_value": "BlueDart", "id": "111111000000007844", "maps": [], "reference_value": "BlueDart", "sequence_number": 5, "type": "used" } ], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 11, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 2, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Excise_Duty", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "EXCISEDUTY", "convert_mapping": { "Invoices": "Excise_Duty" }, "created_source": "default", "created_time": null, "crypt": null, "currency": { "precision": 2, "rounding_option": "normal" }, "custom_field": false, "customizable_properties": [ "mandatory", "max_length_digits", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "rounding_type", "maximum_decimal", "field_masking" ], "data_type": "currency", "decimal_place": 2, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Excise Duty", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Excise Duty", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005640", "json_type": "double", "length": 16, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 12, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 36, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Sales_Commission", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SALESCOMMISSION", "convert_mapping": { "Invoices": "Sales_Commission" }, "created_source": "default", "created_time": null, "crypt": null, "currency": { "precision": 2, "rounding_option": "normal" }, "custom_field": false, "customizable_properties": [ "mandatory", "max_length_digits", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "rounding_type", "maximum_decimal", "field_masking" ], "data_type": "currency", "decimal_place": 2, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Sales Commission", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Sales Commission", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005642", "json_type": "double", "length": 16, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 13, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 36, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Status", "associated_module": null, "association_details": null, "auto_number": {}, "blueprint_supported": true, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "STATUS", "convert_mapping": { "Invoices": "Status" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "private_field", "tooltip", "hipaa_field", "history_tracking", "display_value_alphabetically", "default_value", "option_add", "add_to_other_layouts", "color_code", "replace_values" ], "data_type": "picklist", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Status", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Status", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005644", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [ { "actual_value": "Created", "colour_code": null, "display_value": "Created", "id": "111111000000007846", "maps": [], "reference_value": "Created", "sequence_number": 1, "type": "used" }, { "actual_value": "Approved", "colour_code": null, "display_value": "Approved", "id": "111111000000007848", "maps": [], "reference_value": "Approved", "sequence_number": 2, "type": "used" }, { "actual_value": "Delivered", "colour_code": null, "display_value": "Delivered", "id": "111111000000007850", "maps": [], "reference_value": "Delivered", "sequence_number": 3, "type": "used" }, { "actual_value": "Cancelled", "colour_code": null, "display_value": "Cancelled", "id": "111111000000007852", "maps": [], "reference_value": "Cancelled", "sequence_number": 4, "type": "used" } ], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "quick_sequence_number": "2", "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 14, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 2, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Account_Name", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "ACCOUNTID", "convert_mapping": { "Invoices": "Account_Name" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "add_to_other_layouts", "lookup_filter", "field_of_lookup" ], "data_type": "lookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Account Name", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Account Name", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005646", "json_type": "jsonobject", "length": 120, "lookup": { "api_name": "SalesOrders", "display_label": "Sales Orders", "id": "111111000000011664", "module": { "api_name": "Accounts", "crypt": false, "id": "111111000000002656" }, "query_details": { "system_query_id": null }, "revalidate_filter_during_edit": false }, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "quick_sequence_number": "3", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 15, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 133, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Created_By", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SMCREATORID", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "removal", "add_to_other_layouts" ], "data_type": "ownerlookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Created By", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Created By", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005650", "json_type": "jsonobject", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 16, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 20, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Tag", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "TAGMODULEREFID", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Tag", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Tag", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005666", "json_type": "jsonarray", "length": 2000, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 16, "show_type": 7, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 209, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Modified_By", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "MODIFIEDBY", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "removal", "add_to_other_layouts" ], "data_type": "ownerlookup", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Modified By", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Modified By", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005652", "json_type": "jsonobject", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 17, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 20, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Created_Time", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "CREATEDTIME", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [], "data_type": "datetime", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Created Time", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Created Time", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005654", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 18, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 200, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Modified_Time", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "MODIFIEDTIME", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [], "data_type": "datetime", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Modified Time", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Modified Time", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005656", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 19, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 200, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "id", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SALESORDERID", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": null, "data_type": "bigint", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Record Id", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Record Id", "field_read_only": true, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005676", "json_type": "string", "length": 18, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_only" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_only" } ], "public": false, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 31, "show_type": 17, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 52, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": false }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Locked__s", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "ISLOCKED", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": null, "data_type": "boolean", "decimal_place": null, "default_value": false, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Locked", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Locked", "field_read_only": true, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005678", "json_type": "boolean", "length": 5, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_only" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_only" } ], "public": false, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 32, "show_type": 0, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 301, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": false }, "virtual_field": false, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "Last_Activity_Time", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LASTACTIVITYTIME", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "fixed_position", "tooltip", "field_masking" ], "data_type": "datetime", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Last Activity Time", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Last Activity Time", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005680", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_only" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_only" } ], "public": false, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": false, "sequence_number": 33, "show_type": 8, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 786, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Record_Status__s", "associated_module": null, "association_details": null, "auto_number": {}, "blueprint_supported": false, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SE_PRESENCE", "convert_mapping": { "Invoices": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": null, "data_type": "picklist", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Record Status", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Record Status", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005620", "json_type": "string", "length": 120, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [ { "actual_value": "Available", "colour_code": null, "display_value": "Available", "id": "111111000000007830", "maps": [], "reference_value": "Available", "sequence_number": 1, "type": "used" }, { "actual_value": "Draft", "colour_code": null, "display_value": "Draft", "id": "111111000000007832", "maps": [], "reference_value": "Draft", "sequence_number": 2, "type": "used" }, { "actual_value": "Trash", "colour_code": null, "display_value": "Trash", "id": "111111000000007834", "maps": [], "reference_value": "Trash", "sequence_number": 3, "type": "used" } ], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": false, "section_id": 1, "separator": false, "sequence_number": 42, "show_type": 17, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 2, "unique": {}, "validation_rule": null, "view_type": { "create": false, "edit": false, "quick_create": false, "view": false }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "default", "id": "111111000000027958", "isSubformSection": false, "mode": "default_create", "name": "Sales Order Information", "properties": null, "sequence_number": 1, "tab_traversal": "left_to_right", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": true, "change_tab_traversal": true, "delete": true, "remove_field": true, "rename": true, "reorder": true }, "api_name": "Address_Information__s", "column_count": 2, "display_label": "Address Information", "fields": [ { "additional_column": null, "address": null, "api_name": "Billing_Street", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "BILLINGSTREET", "convert_mapping": { "Invoices": "Billing_Street" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Billing Street", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Billing Street", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005686", "json_type": "string", "length": 250, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Shipping_Street", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SHIPPINGSTREET", "convert_mapping": { "Invoices": "Shipping_Street" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Shipping Street", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Shipping Street", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005688", "json_type": "string", "length": 250, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 2, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Billing_City", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "BILLINGCITY", "convert_mapping": { "Invoices": "Billing_City" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Billing City", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Billing City", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005690", "json_type": "string", "length": 100, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 3, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Shipping_City", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SHIPPINGCITY", "convert_mapping": { "Invoices": "Shipping_City" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Shipping City", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Shipping City", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005692", "json_type": "string", "length": 100, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 4, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Billing_State", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "BILLINGSTATE", "convert_mapping": { "Invoices": "Billing_State" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Billing State", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Billing State", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005694", "json_type": "string", "length": 100, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 5, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Shipping_State", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SHIPPINGSTATE", "convert_mapping": { "Invoices": "Shipping_State" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Shipping State", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Shipping State", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005696", "json_type": "string", "length": 100, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 6, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Billing_Code", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "BILLINGCODE", "convert_mapping": { "Invoices": "Billing_Code" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Billing Code", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Billing Code", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005698", "json_type": "string", "length": 30, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 7, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Shipping_Code", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SHIPPINGCODE", "convert_mapping": { "Invoices": "Shipping_Code" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Shipping Code", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Shipping Code", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005700", "json_type": "string", "length": 30, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 8, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Billing_Country", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "BILLINGCOUNTRY", "convert_mapping": { "Invoices": "Billing_Country" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Billing Country", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Billing Country", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005702", "json_type": "string", "length": 100, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 9, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Shipping_Country", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SHIPPINGCOUNTRY", "convert_mapping": { "Invoices": "Shipping_Country" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Shipping Country", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Shipping Country", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005704", "json_type": "string", "length": 100, "lookup": {}, "mask_details": null, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 2, "separator": false, "sequence_number": 10, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "default", "id": "111111000000028053", "isSubformSection": false, "mode": "default_create", "name": "Address Information", "properties": null, "sequence_number": 2, "tab_traversal": "top_to_bottom", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": false, "change_tab_traversal": false, "delete": false, "remove_field": true, "rename": true, "reorder": true }, "api_name": "Ordered_Items__s", "column_count": 1, "display_label": "Ordered Items", "fields": [ { "additional_column": null, "address": null, "api_name": "Ordered_Items", "associated_module": { "id": "111111000000002768", "layout": { "id": "111111000000003724", "name": "Standard" }, "module": "Ordered_Items" }, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LINKINGMXN1", "convert_mapping": { "Invoices": "Invoiced_Items" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": null, "data_type": "subform", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Ordered Items", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Ordered Items", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005712", "json_type": "jsonarray", "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": false, "section_id": 6, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": false, "system_mandatory": true, "tooltip": null, "type": "used", "ui_type": 500, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": true, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "Sub_Total", "associated_module": { "id": "111111000000002768", "module": "Ordered_Items" }, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SUBTOTAL", "convert_mapping": { "Invoices": "Sub_Total" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "removal", "tooltip", "add_to_other_layouts", "maximum_decimal", "formula_expression", "assume_default", "dynamic_formula", "conditional_formula", "conditional_formula_expression" ], "data_type": "formula", "decimal_place": 9, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Sub Total", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Sub Total", "field_read_only": false, "filterable": true, "formula": { "dynamic": false, "expression": "SUM(${OrderedItems.Net_Total})", "return_type": "currency", "stop_compute_conditionally": false, "stop_compute_expression": null }, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005714", "json_type": "double", "length": 16, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "query_details": null, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": false, "sequence_number": 2, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 117, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Discount", "associated_module": { "id": "111111000000002768", "module": "Ordered_Items" }, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "DISCOUNT", "convert_mapping": { "Invoices": "Discount" }, "created_source": "default", "created_time": null, "crypt": null, "currency": { "precision": 2, "rounding_option": "normal" }, "custom_field": false, "customizable_properties": [ "mandatory", "max_length_digits", "removal", "tooltip", "rounding_type", "maximum_decimal", "field_masking" ], "data_type": "currency", "decimal_place": 2, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Discount", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Discount", "field_read_only": false, "filterable": true, "formula": { "assume_default": false, "dynamic": false, "evaluation_order": 1, "expression": "Contains(${Owner},${Last_Name})", "return_type": "boolean", "stop_compute_conditionally": false, "stop_compute_expression": null }, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005716", "json_type": "double", "length": 16, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": false, "sequence_number": 3, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 36, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Tax", "associated_module": { "id": "111111000000002768", "module": "Ordered_Items" }, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "TAX", "convert_mapping": { "Invoices": "Tax" }, "created_source": "default", "created_time": null, "crypt": null, "currency": { "precision": 2, "rounding_option": "normal" }, "custom_field": false, "customizable_properties": [ "mandatory", "max_length_digits", "removal", "tooltip", "rounding_type", "maximum_decimal", "field_masking" ], "data_type": "currency", "decimal_place": 2, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Tax", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": { "show": false, "type": "org" }, "field_label": "Tax", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005718", "json_type": "double", "length": 16, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": false, "sequence_number": 4, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 36, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Adjustment", "associated_module": { "id": "111111000000002768", "module": "Ordered_Items" }, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "ADJUSTMENT", "convert_mapping": { "Invoices": "Adjustment" }, "created_source": "default", "created_time": null, "crypt": null, "currency": { "precision": 2, "rounding_option": "normal" }, "custom_field": false, "customizable_properties": [ "mandatory", "max_length_digits", "removal", "tooltip", "rounding_type", "maximum_decimal", "field_masking" ], "data_type": "currency", "decimal_place": 2, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Adjustment", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Adjustment", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005720", "json_type": "double", "length": 16, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": false, "sequence_number": 5, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 36, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Aggregate_Field_1", "associated_module": { "id": "4832675000000658658", "module": "Subform1" }, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF72", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2026-01-13T10:14:29+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "fieldlabel", "removal", "deletion", "tooltip", "add_to_other_layouts", "maximum_decimal", "formula_expression", "number_separator", "assume_default", "dynamic_formula", "conditional_formula", "conditional_formula_expression" ], "data_type": "formula", "decimal_place": 2, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Aggregate Field 1", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Aggregate Field 1", "field_read_only": false, "filterable": true, "formula": { "dynamic": false, "expression": "SUM(${LinkingModule1.Formula_1})", "return_type": "double", "stop_compute_conditionally": false, "stop_compute_expression": null }, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000001313360", "json_type": "double", "length": 16, "lookup": {}, "mass_update": false, "modified_time": "2026-01-13T10:14:29+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "query_details": null, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": true, "sequence_number": 2, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 117, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Subform1", "associated_module": { "id": "4832675000000658658", "layout": { "id": "4832675000000658659", "name": "Standard" }, "module": "Subform1" }, "association_details": null, "auto_number": {}, "businesscard_supported": false, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LINKINGMXN1", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": null, "data_type": "subform", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Subform1", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Subform1", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000658767", "json_type": "jsonarray", "lookup": {}, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": false, "section_id": 6, "separator": false, "sequence_number": 3, "show_type": 7, "sortable": false, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 500, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": true, "visible": true, "webhook": false }, { "additional_column": null, "address": null, "api_name": "Aggregate_Field_2", "associated_module": { "id": "4832675000000658658", "module": "Subform1" }, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF73", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2026-01-13T10:14:55+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "fieldlabel", "removal", "deletion", "tooltip", "add_to_other_layouts", "maximum_decimal", "formula_expression", "number_separator", "assume_default", "dynamic_formula", "conditional_formula", "conditional_formula_expression" ], "data_type": "formula", "decimal_place": 0, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Aggregate Field 2", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Aggregate Field 2", "field_read_only": false, "filterable": true, "formula": { "dynamic": false, "expression": "SUM(${LinkingModule1.Number_1})", "return_type": "double", "stop_compute_conditionally": false, "stop_compute_expression": null }, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000001313415", "json_type": "double", "length": 16, "lookup": {}, "mass_update": false, "modified_time": "2026-01-13T10:14:55+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "query_details": { "criteria": { "comparator": "equal", "field": { "api_name": "Pick_List_1", "id": "4832675000000696400" }, "type": "value", "value": "Option 1" }, "query_id": 4832675000001314000 }, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": true, "sequence_number": 4, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 117, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Grand_Total", "associated_module": { "id": "111111000000216916", "layout": { "id": "111111000000216917", "name": "Standard" }, "module": "Subform_1" }, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 2, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "GRANDTOTAL", "convert_mapping": { "Invoices": "Grand_Total" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "removal", "tooltip", "maximum_decimal", "formula_expression", "assume_default" ], "data_type": "formula", "decimal_place": 9, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Grand Total", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Grand Total", "field_read_only": false, "filterable": true, "formula": { "assume_default": false, "dynamic": false, "evaluation_order": 1, "expression": "${Sub_Total}-${Discount}+${Tax}+${Adjustment}", "return_type": "currency", "stop_compute_conditionally": false, "stop_compute_expression": null }, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005722", "json_type": "double", "length": 16, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": false, "api_update": false, "web_create": false, "web_update": false }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": true, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": false, "sequence_number": 6, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": { "name": "info_icon", "value": "Sample tool tip" }, "type": "used", "ui_type": 116, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Number_1", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF51", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2025-11-18T14:28:09+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory", "fieldlabel", "max_length_digits", "unique", "encrypted", "removal", "deletion", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "number_separator", "field_masking" ], "data_type": "integer", "decimal_place": null, "default_value": null, "display_field": false, "display_format": "slider", "display_format_properties": { "split": 8 }, "display_label": "Number 1", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Number 1", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000850773", "json_type": "integer", "length": 9, "lookup": {}, "mass_update": true, "modified_time": "2025-11-18T14:28:09+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": { "from": 0, "to": 99 }, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 1, "separator": true, "sequence_number": 5, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 32, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "default", "id": "111111000000028091", "isSubformSection": true, "mode": "default_create", "name": "Ordered Items", "properties": { "bulk_addition": null, "maximum_rows": 200, "reorder_rows": {}, "tooltip": null }, "sequence_number": 3, "tab_traversal": "left_to_right", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": true, "change_tab_traversal": true, "delete": true, "remove_field": true, "rename": true, "reorder": true }, "api_name": "Terms_and_Conditions__s", "column_count": 1, "display_label": "Terms and Conditions", "fields": [ { "additional_column": null, "address": null, "api_name": "Terms_and_Conditions", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "TERMSANDCONDITIONS", "convert_mapping": { "Invoices": "Terms_and_Conditions" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "tooltip", "default_value", "add_to_other_layouts" ], "data_type": "textarea", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Terms and Conditions", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Terms and Conditions", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005708", "json_type": "string", "length": 32000, "lookup": { "api_name": "Related_List_Label_1", "display_label": "Related List Label 1", "id": "4832675000000850800", "module": { "api_name": "Quotes", "crypt": false, "id": "4832675000000000169" }, "query_details": { "criteria": { "comparator": "not_equal", "field": { "api_name": "Contact_Name.Full_Name", "id": "4832675000000000485" }, "type": "value", "value": "${EMPTY}" }, "query_id": "4832675000000850792", "system_query_id": null }, "revalidate_filter_during_edit": false }, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 4, "separator": false, "sequence_number": 8, "show_type": 7, "sortable": false, "system_mandatory": false, "textarea": { "type": "large" }, "tooltip": null, "type": "used", "ui_type": 3, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "default", "id": "111111000000028081", "isSubformSection": false, "mode": "default_create", "name": "Terms and Conditions", "properties": null, "sequence_number": 4, "tab_traversal": "top_to_bottom", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": true, "change_tab_traversal": true, "delete": true, "remove_field": true, "rename": true, "reorder": true }, "api_name": "Description_Information__s", "column_count": 1, "display_label": "Description Information", "fields": [ { "additional_column": null, "address": null, "api_name": "Description", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "DESCRIPTION", "convert_mapping": { "Invoices": "Description" }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts" ], "data_type": "textarea", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Description", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": false, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Description", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000005710", "json_type": "string", "length": 32000, "lookup": {}, "mask_details": null, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 5, "separator": false, "sequence_number": 8, "show_type": 7, "sortable": false, "system_mandatory": false, "textarea": { "type": "large" }, "tooltip": null, "type": "used", "ui_type": 3, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Single_Line_2", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "CONTACTCF3", "convert_mapping": {}, "created_source": "default", "created_time": "2026-01-12T16:17:40+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory", "fieldlabel", "max_length_digits", "unique", "encrypted", "removal", "deletion", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "external_field", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Single Line 2", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Single Line 1", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": { "duration_configured_field": null, "followed_fields": [ { "api_name": "Rescheduled_By", "id": "4832675000000851325" }, { "api_name": "Rescheduled_From", "id": "4832675000000851317" }, { "api_name": "Rescheduled_To", "id": "4832675000000851319" }, { "api_name": "Reschedule_Reason", "id": "4832675000000851321" }, { "api_name": "Reschedule_Note", "id": "4832675000000851323" }, { "api_name": "Rescheduled_Time", "id": "4832675000000851327" } ], "module": { "api_name": "Appointments_Rescheduled_History__s", "id": "4832675000000853664" }, "related_list_name": "Appointments Rescheduled History" }, "history_tracking_enabled": false, "id": "4832675000001283738", "json_type": "string", "length": 255, "lookup": {}, "mass_update": true, "modified_time": "2026-01-12T16:18:01+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": { "from": 0, "to": null }, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 3, "separator": false, "sequence_number": 3, "sharing_properties": { "scheduler_status": "completed", "share_permission": "full-access", "share_preference_enabled": true }, "show_type": 7, "sortable": true, "static_field": false, "static_values": [ { "id": "3722469000001680088", "sequence_number": 1, "value": "Option 1" }, { "id": "3722469000001680090", "sequence_number": 2, "value": "Option 2" }, { "id": "3722469000001680092", "sequence_number": 3, "value": "Option 3" } ], "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Single_Line_1", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "ACCOUNTCF1", "created_source": "default", "created_time": "2026-01-12T10:14:54+00:00", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory", "fieldlabel", "max_length_digits", "unique", "encrypted", "removal", "deletion", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "external_field", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Single Line 1", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Single Line 1", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "history_tracking": null, "history_tracking_enabled": false, "id": "111111000000217664", "json_type": "string", "length": 255, "lookup": {}, "mask_details": { "complete_mask": true, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ] }, "mass_update": true, "modified_time": "2026-01-12T10:53:22+00:00", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 3, "separator": false, "sequence_number": 2, "show_type": 7, "sortable": true, "system_mandatory": false, "tooltip": { "name": "static_text", "value": "Static tool tip" }, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": "LEADTF1", "address": { "type": "city" }, "api_name": "Single_Line_2", "associated_module": null, "association_details": null, "auto_number": { "prefix": "D", "start_number": 1, "starting_number_length": 1, "suffix": "P" }, "blueprint_supported": false, "businesscard_supported": true, "category": 0, "child_fields": [ { "field": { "api_name": "Address_1_Coordinates_Latitude", "id": "4832675000000710341", "name": "Address 1 - Latitude" }, "sequence_number": 1 }, { "field": { "api_name": "Address_1_Coordinates_Longitude", "id": "4832675000000710342", "name": "Address 1 - Longitude" }, "sequence_number": 2 } ], "colour_code_enabled_by_system": false, "column_name": "ACCOUNTCF2", "convert_mapping": { "Accounts": "Phone", "Contacts": "Title", "Deals": null }, "created_source": "default", "created_time": "2026-01-12T10:54:19+00:00", "crypt": { "encrypt_case": null, "mode": "encryption", "status": 1 }, "currency": { "precision": 0, "rounding_option": "round_off" }, "custom_field": true, "customizable_properties": [ "mandatory", "fieldlabel", "max_length_digits", "unique", "encrypted", "removal", "deletion", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "external_field", "field_masking" ], "data_type": "text", "decimal_place": 9, "default_value": "Option 4", "display_field": false, "display_format": "slider", "display_format_properties": { "split": 8 }, "display_label": "Single Line 2", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Single Line 2", "field_read_only": false, "filterable": true, "formula": { "assume_default": false, "dynamic": false, "evaluation_order": 1, "expression": "Substring(${Lead_Source},2,5)", "return_type": "text", "stop_compute_conditionally": false, "stop_compute_expression": null }, "global_picklist": { "api_name": "Source", "id": "4832675000000491019" }, "hipaa_compliance": { "restricted": false, "restricted_in_export": false }, "hipaa_compliance_enabled": false, "history_tracking": { "duration_configuration": "days", "duration_configured_field": { "api_name": "Duration_Days", "id": "4832675000000699823" }, "followed_fields": [ { "api_name": "Mobile", "id": "4832675000000000569" }, { "api_name": "Lead_Source", "id": "4832675000000000573" } ], "module": { "api_name": "Globe_History", "id": "4832675000000699487" }, "related_list_name": "Globe History" }, "history_tracking_enabled": false, "id": "111111000000217727", "json_type": "string", "length": 255, "lookup": { "api_name": "Related_List_Label_1", "display_label": "Related List Label 1", "id": "4832675000000849966", "module": { "api_name": "Accounts", "crypt": false, "id": "4832675000000000127" }, "query_details": { "system_query_id": null }, "revalidate_filter_during_edit": false }, "mask_details": { "complete_mask": false, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "show_first": 3, "show_last": 1 }, "mass_update": true, "modified_time": "2026-01-12T10:54:19+00:00", "multi_module_lookup": {}, "multiselectlookup": { "connected_details": { "field": { "api_name": "MXNContact", "field_label": "MXNContact", "id": "4832675000000696488" }, "layouts": [ { "api_name": "Standard__s", "id": "4832675000000095059" }, { "api_name": "Custom_Layout_1", "id": "4832675000001280303" } ], "module": { "api_name": "Contacts", "id": "4832675000000000129", "plural_label": "Contacts" } }, "linking_details": { "connected_lookup_field": { "api_name": "MultiModuleLookup", "field_label": "MultiModuleLookup", "id": "4832675000000696496" }, "lookup_field": { "api_name": "MXNContact", "field_label": "MXNContact", "id": "4832675000000696494" }, "module": { "api_name": "Leads_X_Contacts", "id": "4832675000000696452", "plural_label": "Leads X Contacts", "visibility": 2 } }, "related_list": { "api_name": "Contacts2", "display_label": "Contacts", "id": "4832675000000696587" } }, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": { "api_name": "Address_1_Coordinates", "id": "4832675000000710334", "name": "Address 1 - Coordinates" }, "pick_list_values": [ { "actual_value": "-None-", "colour_code": null, "display_value": "-None-", "id": "4832675000001312990", "maps": [ { "api_name": "Pick_List_2", "id": "4832675000001313017", "pick_list_values": [ { "actual_value": "-None-", "colour_code": null, "display_value": "-None-", "id": "4832675000001313021" } ] } ], "reference_value": "-None-", "sequence_number": 1, "type": "used" }, { "actual_value": "Option 1", "colour_code": "#f6c1ff", "display_value": "Option 1", "id": "4832675000001312983", "maps": [ { "api_name": "Pick_List_2", "id": "4832675000001313017", "pick_list_values": [ { "actual_value": "Option 1", "colour_code": "#c9651a", "display_value": "Option 1", "id": "4832675000001313016" } ] } ], "reference_value": "Option 1", "sequence_number": 2, "type": "used" }, { "actual_value": "Qualification", "colour_code": "#ffc6c6", "deal_category": "Open", "display_value": "Qualification", "forecast_category": { "id": "4832675000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "4832675000000007104", "maps": [], "probability": 10, "reference_value": "Qualification", "sequence_number": 1, "type": "used" } ], "pick_list_values_sorted_lexically": false, "private": { "export": false, "restricted": false, "type": "High" }, "profiles": [ { "id": "111111000000000497", "name": "Administrator", "permission_type": "read_write" }, { "id": "111111000000000499", "name": "Standard", "permission_type": "read_write" } ], "public": false, "quick_sequence_number": "10", "range": { "from": 0, "to": 99 }, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": { "based_on_module": { "api_name": "Calls", "id": "4832675000000017015" }, "expression": { "criteria": null, "function": "SUM", "function_parameters": [ { "api_name": "Call_Duration_in_seconds" } ] }, "related_list": null, "return_type": "longinteger", "rollup_based_on": "module" }, "searchable": true, "section_id": 3, "separator": false, "sequence_number": 3, "show_type": 7, "sortable": true, "system_mandatory": false, "textarea": { "type": "large" }, "tooltip": null, "type": "used", "ui_type": 1, "unique": { "case_sensitive": false }, "validation_rule": { "id": "4832675000001313074" }, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "default", "id": "111111000000028086", "isSubformSection": false, "mode": "default_create", "name": "Description Information", "properties": null, "sequence_number": 5, "tab_traversal": "top_to_bottom", "type": "used" }, { "actions_allowed": { "add_field": true, "change_column_count": true, "change_tab_traversal": true, "delete": true, "remove_field": true, "rename": true, "reorder": true }, "api_name": "New_Section_1", "column_count": 2, "display_label": "New Section 1", "fields": [ { "additional_column": null, "address": null, "api_name": "Single_Line_2", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "category": 0, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF3", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2025-11-25T09:59:10+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory", "fieldlabel", "max_length_digits", "unique", "encrypted", "removal", "deletion", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts", "external_field", "field_masking" ], "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Single Line 2", "display_type": -1, "element_type": "field", "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Single Line 2 renamed", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "3722469000001341019", "json_type": "string", "length": 255, "lookup": {}, "mass_update": true, "modified_time": "2025-11-25T09:59:27+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "profiles": [ { "id": "3722469000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "3722469000000015975", "name": "Standard", "permission_type": "read_write" }, { "id": "3722469000001196003", "name": "Admin Clone 1", "permission_type": "read_write" }, { "id": "3722469000001196033", "name": "Admin Clone 2", "permission_type": "read_write" }, { "id": "3722469000001196061", "name": "Standard Clone 1", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "refer_from_field": null, "required": false, "rollup_summary": {}, "searchable": true, "section_id": 6, "separator": false, "sequence_number": 1, "show_type": 7, "sortable": true, "subform_properties": { "custom_width": 265, "pinned_column": false }, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "validation_rule": null, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ], "generated_type": "custom", "id": "3722469000001636090", "isSubformSection": false, "is_parent_section": false, "mode": "default_create", "name": "New Section 1", "parent_section": null, "properties": { "preference": [ { "comparator": "not_equal", "field": { "api_name": "Quoted_Items", "id": "4480493000000272734" }, "type": "value", "value": "${EMPTY}" } ] }, "sequence_number": 5, "tab_traversal": "left_to_right", "type": "used" } ], "show_business_card": true, "source": "crm", "status": "active", "visible": true }, { "actions_allowed": { "clone": false, "deactivate": false, "delete": false, "downgrade": false, "edit": true, "rename": false, "set_layout_permissions": true }, "api_name": "Standard__s", "created_by": null, "created_for": null, "created_time": null, "display_label": "Standard", "generated_type": "system", "has_more_profiles": false, "id": "111111000000003690", "modified_by": null, "modified_time": null, "name": "Standard", "profiles": [ { "_default_assignment_view": { "id": "111111000000003690", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000003690", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000497", "name": "Administrator" } ], "sections": [], "show_business_card": true, "source": "crm", "status": "active", "visible": true } ] } }, "WithIncludeAndFieldsFilter": { "description": "Example response demonstrating the `include` and `fields` query parameters. `include=profiles.type` adds the `type` field to each profile object. `include=total_profiles` adds `total_profiles` at the layout level. `fields` filters which top-level layout properties are returned — properties not listed (e.g. `convert_mapping`) are omitted from the response. Sections are truncated for brevity.", "summary": "Layout response with include and fields query params", "value": { "layouts": [ { "actions_allowed": { "clone": false, "deactivate": false, "delete": false, "downgrade": false, "edit": true, "rename": true, "set_layout_permissions": true }, "api_name": "Standard", "created_by": { "id": "4150868000000419001", "name": "Patricia Boyle" }, "created_for": null, "created_time": "2024-10-23T21:02:52+05:30", "display_label": "Standard", "generated_type": "system", "has_more_profiles": false, "id": "4150868000000095005", "modified_by": { "id": "4150868000000419001", "name": "Patricia Boyle" }, "modified_time": "2025-07-01T14:07:10+05:30", "name": "Standard", "profiles": [ { "_default_assignment_view": { "id": "4150868000000095005", "name": "Standard", "type": "layout" }, "_default_view": { "id": "4150868000000095005", "name": "Standard", "type": "layout" }, "default": true, "id": "4150868000000015972", "name": "Administrator", "type": "normal_profile" }, { "_default_assignment_view": { "id": "4150868000000095005", "name": "Standard", "type": "layout" }, "_default_view": { "id": "4150868000000095005", "name": "Standard", "type": "layout" }, "default": true, "id": "4150868000000015975", "name": "Standard", "type": "normal_profile" } ], "sections": [ { "actions_allowed": { "add_field": true, "change_column_count": true, "change_tab_traversal": true, "delete": false, "remove_field": true, "rename": true, "reorder": true }, "api_name": "LeadInformation1", "column_count": 2, "display_label": "Lead Information", "fields": [], "generated_type": "default", "id": "4150868000000095025", "isSubformSection": false, "is_parent_section": false, "mode": "all", "name": "Lead Information", "parent_section": null, "properties": null, "sequence_number": 1, "tab_traversal": "left_to_right", "type": "used" } ], "show_business_card": true, "source": "crm", "status": "active", "total_profiles": 3, "visible": true } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/LayoutResponseSchema" }, { "$ref": "#/components/schemas/LayoutFieldsResponseSchema" } ], "x-zs-$id": "LayoutSuccessResponseSchema" } } }, "description": "Successful response returned when the API retrieves layout configurations for the specified module, containing the full array of layout objects." }, "LayoutsBadRequest": { "content": { "application/json": { "examples": { "InvalidModule": { "description": "Returned when the module name provided does not exist or is not accessible in the Zoho CRM organization.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "description": "Returned when an HTTP method other than the supported method applies to this endpoint.", "summary": "Invalid HTTP method used", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MissingModuleParam": { "description": "Returned when the required module query parameter is absent from the request.", "summary": "Missing required module parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } }, "PatternNotMatched": { "description": "Returned when the mode parameter value is case-sensitive and does not match any of the accepted values.", "summary": "Invalid mode parameter value", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "mode" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when a request is rejected due to invalid parameters, missing required inputs, or unsupported operations.", "properties": { "code": { "description": "Represents the error classification for the bad request. Possible values: `REQUIRED_PARAM_MISSING` — a required parameter was absent from the request; `INVALID_MODULE` — the specified module does not exist or is not accessible; `INVALID_REQUEST_METHOD` — the HTTP method used is not supported for this endpoint; `PATTERN_NOT_MATCHED` — a parameter value did not conform to the expected format; `NOT_SUPPORTED` — the requested operation is not supported.", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_MODULE", "INVALID_REQUEST_METHOD", "PATTERN_NOT_MATCHED", "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains supplementary information about the bad request error, identifying the specific parameter or condition responsible for the failure.", "properties": { "param_name": { "description": "Represents the name of the request parameter that triggered the bad request error.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Represents a plain-language description of the bad request error, suitable for logging or surfacing to an end user.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the outcome of the request. Possible values: `error` — the request was not processed successfully due to a bad request condition.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseStructure" } } }, "description": "Bad request response returned when the request contains invalid or missing parameters." }, "LayoutsInternalServerErrorResponse": { "content": { "application/json": { "examples": { "InternalError": { "summary": "Server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/LayoutsErrorResponse" } } }, "description": "Internal server error response returned when an unexpected failure occurs on the server side while processing the request." }, "LayoutsNotFound": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Returned when the request URL does not match the expected endpoint pattern for this API.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when the requested endpoint URL does not match any recognised API route.", "properties": { "code": { "description": "Represents the error classification for the not-found condition. Possible values: `INVALID_URL_PATTERN` — the request URL does not match any recognised endpoint pattern.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains supplementary information about the not-found error, providing additional context about the unrecognised URL.", "type": "object" }, "message": { "description": "Contains a descriptive explanation of why the requested resource could not be found, intended to aid in diagnosing the cause of the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the outcome classification of the response. Possible values: `error` — the request did not complete successfully and the response body contains error details.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidUrlPatternErrorResponse" } } }, "description": "Not-found response returned when the requested URL does not match any recognised API endpoint pattern." }, "LayoutsUnauthorizedResponse": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/LayoutsErrorResponse" } } }, "description": "Unauthorized response returned when authentication fails or the provided credentials are invalid or missing." }, "MapDependencyForbiddenError": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have the required permissions to perform this operation.", "properties": { "code": { "description": "Represents the error code for the response. Possible values: **NO_PERMISSION**. \n", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the missing permissions. ", "properties": { "permissions": { "description": "Lists the permissions required to perform this operation. " } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Describes the reason for the permission error. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**. \n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ForbiddenErrorResponse" } } }, "description": "The user does not have the required permission to perform this operation.\n**Resolution:** The CRM administrator must grant the user's profile the required permissions listed in the **details.permissions** array.\n" }, "MapDependencyInternalServerError": { "content": { "application/json": { "examples": { "ErrorExample": { "description": "Shows the standard error response returned when an unexpected server-side error occurs.", "summary": "Example of an internal server error.", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when an unexpected server-side error occurs.", "properties": { "code": { "description": "Represents the error code indicating the type of internal server error. ", "maxLength": 500, "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the internal server error. ", "type": "object" }, "message": { "description": "Describes the internal server error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**. \n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InternalServerErrorResponse" } } }, "description": "An unexpected error occurred on the server.\n**Resolution:** Retry the request. If the error persists, contact Zoho CRM support.\n" }, "NoPermissionForbidden": { "content": { "application/json": { "examples": { "NoPermission": { "summary": "No permission to access resource", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Please contact your admin", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Permission error response returned when the caller lacks required permissions.", "properties": { "code": { "description": "Error code identifying the permission error.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Optional object containing additional details about the error.", "type": "object" }, "message": { "description": "Human-readable message describing the permission error.", "maxLength": 512, "type": "string" }, "status": { "description": "High-level status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "NoPermissionForbiddenResponse" } } }, "description": "Forbidden - the user does not have permission to perform the operation." }, "NotFoundError": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "Represents the error response returned when the request URL does not match a valid endpoint pattern.", "properties": { "code": { "description": "Represents the error code for this response. ", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error. ", "type": "object" }, "message": { "description": "Describes the reason the requested resource could not be found. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "NotFoundErrorResponse" } } }, "description": "The request URL does not match a valid endpoint pattern.\n**Resolution:** Verify the request URL and ensure all path parameter IDs are valid.\n" }, "NotesInternalServerError": { "content": { "application/json": { "examples": { "InternalError": { "summary": "Internal server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response for internal server errors", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InternalServerErrorResponse" } } }, "description": "Internal Server Error - An unexpected error occurred on the server" }, "NotesNoContent": { "description": "No content - The request was successful but there are no records to return" }, "NotesNotFound": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response for not found requests", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotFoundErrorResponse" } } }, "description": "Not Found - The requested resource does not exist" }, "NotesUnauthorized": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failed", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response for authentication failures", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "AUTHENTICATION_FAILURE", "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UnauthorizedErrorResponse" } } }, "description": "Unauthorized - Authentication failed" }, "NotificationsBadRequest": { "content": { "application/json": { "examples": { "AmbiguityWhileProcessingModuleApiNameAndIdInNotificationCondition": { "description": "Shows an AMBIGUITY_DURING_PROCESSING error response indicating both api_name and the module ID were provided in the notification condition, creating ambiguity.", "summary": "Ambiguity between api_name and module ID in the notification condition", "value": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "api_name", "json_path": "$.watch[0].notification_condition[0].module.api_name" }, { "api_name": "id", "json_path": "$.watch[0].notification_condition[0].module.id" } ] }, "message": "AMBIGUITY_DURING_PROCESSING", "status": "error" } }, "BothApiNameAndIdIsMissingInModuleOfNotificationCondition": { "description": "Shows an EXPECTED_FIELD_MISSING error response indicating that at least one of api_name or module ID must be present in the notification condition module.", "summary": "Both api_name and module ID missing from the notification condition", "value": { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.watch[0].notification_condition[0].module.api_name" }, { "api_name": "id", "json_path": "$.watch[0].notification_condition[0].module.id" } ] }, "message": "Specify atleast one field", "status": "error" } }, "DependentFieldMissingInModuleOfNotificationCondition": { "description": "Shows a DEPENDENT_FIELD_MISSING error response indicating the field_selection field is required in the notification condition when the type field is present.", "summary": "Dependent field field_selection missing from the notification condition", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "field_selection", "dependee": { "api_name": "type", "json_path": "$.watch[0].notification_condition[0].type" }, "json_path": "$.watch[0].notification_condition[0].field_selection" }, "message": "DEPENDENT_FIELD_MISSING", "status": "error" } }, "InvalidDataTypeForApiNameInModuleOfNotificationCondition": { "description": "Shows an INVALID_DATA error response indicating the api_name field inside the notification condition module must be a string.", "summary": "Invalid data type for api_name in the notification condition module", "value": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "string", "json_path": "$.watch[0].notification_condition[0].module.api_name" }, "message": "invalid data", "status": "error" } }, "InvalidDataTypeForFieldSelection": { "description": "Shows an INVALID_DATA error response indicating the field_selection field in notification_condition must be a JSON object.", "summary": "Invalid data type for the field_selection field", "value": { "code": "INVALID_DATA", "details": { "api_name": "field_selection", "expected_data_type": "jsonobject", "json_path": "$.watch[0].notification_condition[0].field_selection" }, "message": "invalid data", "status": "error" } }, "InvalidDataTypeForGroupOperator": { "description": "Shows an INVALID_DATA error response indicating the group_operator field in field_selection must be a string value.", "summary": "Invalid data type for the group_operator field", "value": { "code": "INVALID_DATA", "details": { "api_name": "group_operator", "expected_data_type": "text", "json_path": "$.watch[0].notification_condition[0].field_selection.group_operator" }, "message": "invalid data", "status": "error" } }, "InvalidDataTypeForIdInModuleOfNotificationCondition": { "description": "Shows an INVALID_DATA error response indicating the ID field inside the notification condition module must be a string.", "summary": "Invalid data type for the module ID field in the notification condition", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "string", "json_path": "$.watch[0].notification_condition[0].module.api_name" }, "message": "invalid data", "status": "error" } }, "InvalidDataTypeForModuleInNotificationCondition": { "description": "Shows an INVALID_DATA error response indicating the module field inside notification_condition must be a JSON object.", "summary": "Invalid data type for the module field in the notification condition", "value": { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.watch[0].notification_condition[0].module" }, "message": "invalid data", "status": "error" } }, "InvalidDataTypeForType": { "description": "Shows an INVALID_DATA error response indicating the type field in notification_condition must be a string.", "summary": "Invalid data type for the type field", "value": { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.watch[0].notification_condition[0].type" }, "message": "invalid data", "status": "error" } }, "InvalidDataTypeForUnderscoreDelete": { "description": "Shows an INVALID_DATA error response indicating the _delete field must be a Boolean value.", "summary": "Invalid data type for the _delete field", "value": { "code": "INVALID_DATA", "details": { "api_name": "_delete", "expected_data_type": "boolean", "json_path": "$.watch[0]._delete" }, "message": "invalid data", "status": "error" } }, "InvalidFieldInFields": { "description": "Shows an INVALID_DATA error response indicating an invalid field name was specified in the fields parameter of the notification channel.", "summary": "Invalid field reference in the fields parameter", "value": { "code": "INVALID_DATA", "details": { "api_name": "fields", "json_path": "$.watch[0].fields[1]" }, "message": "invalid data", "status": "error" } }, "InvalidNotificationConditionDataType": { "description": "Shows an INVALID_DATA error response indicating the notification_condition field contains a value of an incorrect data type.", "summary": "Invalid data type for the notification_condition field", "value": { "code": "INVALID_DATA", "details": { "api_name": "notification_condition", "json_path": "$.watch[0].notification_condition" }, "message": "invalid data", "status": "error" } }, "MandatoryFieldOrGroupNotFound": { "description": "Shows a MANDATORY_NOT_FOUND error response indicating the field array is required in the field_selection object of the notification condition.", "summary": "Required field or group array missing from the notification condition", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.watch[0].notification_condition.field_selection.field" }, "message": "required field not found", "status": "error" } }, "MandatoryGroupOperatorNotFound": { "description": "Shows a MANDATORY_NOT_FOUND error response indicating the group_operator field is required in the field_selection object of a notification condition.", "summary": "Required group_operator field missing from the field_selection", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "group_operator", "json_path": "$.watch[0].notification_condition[0].field_selection.group_operator" }, "message": "required field not found", "status": "error" } }, "MandatoryNotFound": { "description": "Shows a MANDATORY_NOT_FOUND error response indicating the required notify_url field is missing from the request body.", "summary": "Required field notify_url missing from the request", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "notify_url" }, "message": "required field not found", "status": "error" } }, "MandatoryTypeNotFound": { "description": "Shows a MANDATORY_NOT_FOUND error response indicating the type field is required in each notification_condition entry.", "summary": "Required type field missing from the notification condition", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.watch[0].notification_condition[0].type" }, "message": "required field not found", "status": "error" } }, "ModuleNotSupported": { "description": "Shows an INVALID_DATA error response indicating the events field references a CRM module that is not supported for notifications.", "summary": "Unsupported module referenced in the events field", "value": { "code": "INVALID_DATA", "details": { "api_name": "events" }, "message": "invalid data", "status": "error" } }, "NotificationCriteriaLimitExceeded": { "description": "Shows an INVALID_DATA error response indicating the number of field references in field_selection exceeds the maximum allowed limit of 10.", "summary": "Field reference limit exceeded in the field_selection", "value": { "code": "INVALID_DATA", "details": { "api_name": "field_selection", "json_path": "$.watch[0].notification_condition.field_selection", "maximum_length": 10 }, "message": "invalid data", "status": "error" } }, "RequestFieldModuleNotAvailableInNotificationCondition": { "description": "Shows an INVALID_DATA error response indicating the module referenced in notification_condition is not available for use as a field-selection condition.", "summary": "Specified module is not available in the notification condition", "value": { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.watch[0].notification_condition[0].module" }, "message": "required field not found", "status": "error" } }, "UnsupportedValueForGroupOperator": { "description": "Shows an INVALID_DATA error response indicating the group_operator field contains an unsupported value. The valid values are and and or.", "summary": "Unsupported value for the group_operator field", "value": { "code": "INVALID_DATA", "details": { "api_name": "group_operator", "json_path": "$.watch[0].notification_condition[0].field_selection.group_operator", "supported_values": [ "or", "and" ] }, "message": "invalid data", "status": "error" } }, "UnsupportedValueForType": { "description": "Shows an INVALID_DATA error response indicating the type field contains an unsupported value. The only valid value is field_selection.", "summary": "Unsupported value for the type field", "value": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.watch[0].notification_condition[0].type", "supported_values": [ "field_selection" ] }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotificationsErrorResponse" }, { "additionalProperties": false, "description": "Represents a batch error response containing a list of validation errors.", "properties": { "watch": { "description": "Represents the list of error entries returned when a batch operation encounters validation errors.", "items": { "$ref": "#/components/schemas/NotificationsErrorResponse" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "WatchErrorResponse" } ], "x-zs-$id": "ErrorResponses" } } }, "description": "One or more request parameters are invalid or missing." }, "NotificationsInternalServerError": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows an INTERNAL_ERROR response indicating an unexpected error occurred on the server while processing the request.", "summary": "Unexpected internal server error", "value": { "code": "INTERNAL_ERROR", "message": "An unexpected error occurred.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NotificationsErrorResponse" } } }, "description": "An unexpected error occurred while processing the request." }, "NotificationsMultiStatus": { "content": { "application/json": { "examples": { "MultiStatusResponse": { "value": { "watch": [ { "code": "SUCCESS", "details": { "events": [ { "channel_expiry": "2025-12-18 20:33:55+05:30", "channel_id": "175720435875", "resource_id": "4794080000000000125", "resource_name": "Leads", "resource_uri": "https://www.zohoapis.com/crm/v2/Leads" } ] }, "message": "Successfully subscribed for actions-watch of the given module", "status": "success" }, { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "channel_id", "json_path": "$.watch[1].channel_id" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the partial create results, where each entry in the watch array is either a success or an error.", "properties": { "watch": { "description": "Represents the list of result entries, where each item is either a successful create result or an error response.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents a successful create result for a single notification channel.", "properties": { "code": { "description": "Represents the result code for a successful operation.\n**Possible values:**\n**SUCCESS** - The operation completed successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Created event channel details.", "type": "object" }, "message": { "description": "Result message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status string.", "enum": [ "success" ], "type": "string" } }, "type": "object", "x-zs-$id": "SuccessResponse" }, { "$ref": "#/components/schemas/NotificationsErrorResponse" } ] }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "CreateNotificationsPartialResponse" } } }, "description": "Returns a mix of success and error results when some notification channels were created successfully and others failed." }, "NotificationsTooManyRequests": { "content": { "application/json": { "examples": { "RateLimitExceeded": { "description": "Shows a RATE_LIMIT_EXCEEDED error response indicating the number of requests has exceeded the allowed rate limit for the API.", "summary": "API rate limit exceeded", "value": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please try again later.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NotificationsErrorResponse" } } }, "description": "The request rate limit has been exceeded." }, "NotificationsUnauthorized": { "content": { "application/json": { "examples": { "OauthScopeMismatch": { "description": "Shows an OAUTH_SCOPE_MISMATCH error response indicating the access token does not have the required scope for this operation.", "summary": "Missing required OAuth scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NotificationsErrorResponse" } } }, "description": "The access token is missing, invalid, or does not have the required OAuth scope." }, "PayloadTooLarge": { "content": { "application/json": { "examples": { "FileSizeExceeded": { "description": "Error response returned when the file size exceeds the 100MB limit.", "summary": "File size exceeds allowed limit", "value": { "code": "FILE_SIZE_MORE_THAN_ALLOWED_SIZE", "details": {}, "message": "Please check if the size of the file is in the correct range", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/BodySizeLimitError" } } }, "description": "Request entity is too large, file size exceeds 100MB limit" }, "ProfilesForbiddenResponse": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Returned when the user does not have the CRM profiles permission required for the requested operation.", "summary": "No permission to manage profiles", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Profiles" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/PermissionErrorResponse" } ], "description": "Forbidden error response body.", "x-zs-$id": "ForbiddenError" } } }, "description": "Forbidden - the authenticated user lacks the required permission to perform this operation." }, "ProfilesInternalServerErrorResponse": { "content": { "application/json": { "examples": { "InternalError": { "description": "Returned when the server encounters an unexpected error that prevents the request from completing.", "summary": "Unexpected server-side error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Problem occurred internally", "status": "error" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/ProfilesInternalServerError" } ], "description": "Internal server error response body.", "x-zs-$id": "InternalServerErrorWrapper" } } }, "description": "Internal server error - an unexpected error occurred while processing the request." }, "ProfilesUnauthorizedResponse": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Returned when the OAuth token is missing, expired, or does not match the required scope.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/ProfilesAuthenticationFailureError" } ], "description": "Authentication failure error schema.", "x-zs-$id": "AuthenticationFailureWrapper" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesOAuthScopeMismatchError" } ], "description": "OAuth scope mismatch error schema.", "x-zs-$id": "OAuthScopeMismatchWrapper" } ], "description": "Unauthorized error response body.", "x-zs-$id": "UnauthorizedError" } } }, "description": "Unauthorized - authentication failed or the access token lacks the required OAuth scope." }, "RecycleBinBadRequest": { "content": { "application/json": { "examples": { "Error": { "value": { "code": "INVALID_DATA", "details": { "api_name": "comparator", "json_path": "$.comparator", "param_name": "filters" }, "message": "Please provide a valid comparator", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecycleBinErrorResponse" }, { "additionalProperties": false, "description": "Wrapper that returns multiple error entries under the **recycle_bin** array when more than one input item is invalid.", "properties": { "recycle_bin": { "description": "Represents the list of error entries, one per invalid input item, with at least one entry and at most 200 entries.", "items": { "$ref": "#/components/schemas/RecycleBinErrorResponse" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "WrappedErrorResponse" } ], "x-zs-$id": "BadRequestErrorResponse" } } }, "description": "The request contains invalid parameters or payload. See the response body for the specific error code, message, and offending field. **Resolution:** The caller must inspect the **code** and **details** fields, correct the offending input, and reissue the request." }, "RecycleBinMultiStatus": { "content": { "application/json": { "examples": { "MultiStatusResponse": { "value": { "recycle_bin": [ { "code": "SUCCESS", "details": { "id": "4794080000003274845" }, "message": "record restored", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "1000000000000" }, "message": "the id given seems to be invalid", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Multi-status payload that combines per-item success and error entries when a bulk request partially succeeds.", "properties": { "recycle_bin": { "description": "Represents the list of per-item results, where each entry is either a **SuccessResponse** for a successful item or an **ErrorResponse** for a failed item.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecycleBinSuccessResponse" }, { "$ref": "#/components/schemas/RecycleBinErrorResponse" } ] }, "maxItems": 200, "type": "array" } }, "required": [ "recycle_bin" ], "type": "object", "x-zs-$id": "MultiStatusResponse" } } }, "description": "Returns a per-item multi-status response when some records in the bulk request succeeded and others failed. The **recycle_bin** array contains both success and error entries." }, "RelatedListsUnauthorizedResponse": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows the INVALID_TOKEN error returned when the provided OAuth token is missing, expired, or not valid.", "summary": "Invalid or expired OAuth token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "invalid oauth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows the OAUTH_SCOPE_MISMATCH error returned when the access token does not include the required scope for this API.", "summary": "OAuth token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedListsAuthenticationFailureError" }, { "$ref": "#/components/schemas/RelatedListsOAuthScopeMismatchError" } ], "description": "Error response returned when authentication fails. Contains the error code, message, and status.", "x-zs-$id": "UnauthorizedResponseSchema" } } }, "description": "The access token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this API." }, "RelatedNotesInternalServerError": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows an INTERNAL_ERROR response when an unexpected error occurs on the server.", "summary": "INTERNAL_ERROR error: internal server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 500 Internal Server Error responses.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Specifies the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InternalServerErrorResponse" } } }, "description": "An unexpected error occurred on the server. Resolution: Retry the request after a brief delay. If the error persists, contact Zoho CRM support." }, "RelatedNotesNoContent": { "description": "The request was successful but there are no notes to return for the specified parent record." }, "RelatedNotesNotFound": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows an INVALID_URL_PATTERN error when the request URL does not match a valid API endpoint pattern.", "summary": "INVALID_URL_PATTERN error: invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 404 Not Found responses.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotFoundErrorResponse" } } }, "description": "The requested resource could not be found. Resolution: Verify that the URL pattern in the request is correct." }, "RelatedNotesUnauthorized": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an AUTHENTICATION_FAILURE error when the provided OAuth token is invalid or expired.", "summary": "AUTHENTICATION_FAILURE error: authentication failed", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAUTH_SCOPE_MISMATCH error when the OAuth token does not include the required scope for this API.", "summary": "OAUTH_SCOPE_MISMATCH error: OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 401 Unauthorized responses.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "AUTHENTICATION_FAILURE", "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UnauthorizedErrorResponse" } } }, "description": "Authentication failed. Resolution: Verify that the OAuth token is valid and that the required scope is included." }, "ServiceUnavailable": { "content": { "application/json": { "examples": { "Maintenance": { "description": "Error response returned when the service is temporarily unavailable.", "summary": "Service under maintenance", "value": { "code": "SERVICE_UNAVAILABLE", "details": {}, "message": "Service temporarily unavailable. Please try again later", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AttachmentsErrorResponse" } } }, "description": "Service unavailable - server is temporarily unable to handle the request" }, "ShiftHoursForbiddenResponse": { "content": { "application/json": { "examples": { "Default": { "description": "Example response when the requesting user lacks the CRM profile permission required to manage shift hours.", "summary": "An example of error response where the user does not have enough permission to perform this request.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Users" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the forbidden response returned when the requesting user does not hold the CRM profile permission required to manage shift hours.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "permissions": { "description": "Lists the CRM profile permissions that the user must hold to access this API.", "items": { "description": "Each object represents a CRM profile permission missing from the requesting user's profile.", "enum": [ "Crm_Implied_Manage_Users" ], "type": "string" }, "maxItems": 50, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseForbidden" } } }, "description": "Returned when the requesting user does not hold the CRM profile permission required to manage shift hours." }, "ShiftHoursMultiStatusResponse": { "content": { "application/json": { "examples": { "Default": { "description": "Example multi-status response where some items succeed and others fail.", "summary": "An example multi-status response.", "value": { "shift_hours": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Success", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ShiftHoursSuccessResponse" } } }, "description": "Returned when a batch request partially succeeds where some items succeed and some fail. Each item in the shift_hours array carries its own code, status, message, and details." }, "ShiftHoursNoContentResponse": { "description": "Returned when no shift hours are configured for the organization, or when the requested shift hour does not exist." }, "ShiftHoursSuccessResponse": { "content": { "application/json": { "examples": { "Default": { "description": "Example success response returned after a shift hour create, update, or delete operation.", "summary": "An example success response.", "value": { "shift_hours": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Success", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ShiftHoursSuccessResponse" } } }, "description": "Returned when the shift hour create, update, or delete operation completes successfully." }, "UnauthorizedError": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication Failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "summary": "OAuth Scope Mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the access token is not passed in the Authorization header of the request. Include a valid Zoho OAuth access token to resolve.", "properties": { "code": { "description": "Error code indicating that the request failed authentication because no valid access token was provided in the Authorization header.", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "A message describing the authentication failure.", "maxLength": 500, "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AuthenticationFailureErrorResponse" }, { "additionalProperties": false, "description": "Returned when the OAuth token does not include the required scope. The required scope is ZohoCRM.modules.ALL or ZohoCRM.modules.{module_name}.READ. Generate a new token with a valid scope to resolve.", "properties": { "code": { "description": "Error code indicating that the OAuth token does not include the required scope (ZohoCRM.modules.ALL or ZohoCRM.modules.{module_name}.READ) to access this endpoint.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "A message describing the OAuth scope mismatch.", "maxLength": 500, "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "OAuthScopeMismatchErrorResponse" } ], "description": "Unauthorized error response. Contains either an AUTHENTICATION_FAILURE error when no valid access token is provided, or an OAUTH_SCOPE_MISMATCH error when the token lacks the required scope (ZohoCRM.modules.ALL or ZohoCRM.modules.{module_name}.READ).", "x-zs-$id": "UnauthorizedErrorResponse" } } }, "description": "Unauthorized. Returned when the access token is missing or invalid (AUTHENTICATION_FAILURE), or when the OAuth token does not include the required scope ZohoCRM.modules.ALL or ZohoCRM.modules.{module_name}.READ (OAUTH_SCOPE_MISMATCH). Generate a new token with the correct scope to resolve." } }, "schemas": { "ActionEntityReference": { "additionalProperties": false, "description": "Reference to the entity affected by an operation, containing its unique identifier.", "properties": { "id": { "$ref": "#/components/schemas/UnsubscribeLinkId", "description": "The unique identifier of the affected unsubscribe link" } }, "title": "Action Entity Reference", "type": "object" }, "ActionNested": { "anyOf": [ { "$ref": "#/components/schemas/CadencesTaskTypeFollowupActionRequestObject" }, { "$ref": "#/components/schemas/EmailNotificationTypeFollowupActionRequestObject" }, { "$ref": "#/components/schemas/ScheduleCallTypeFollowupActionRequestObject" }, { "$ref": "#/components/schemas/WhatsappMessageNotificationTypeFollowupActionRequestObject" } ], "description": "Represents a follow-up action in a Cadence, including its type, identifier, and configuration details." }, "ActionResponse": { "additionalProperties": false, "description": "Generic wrapper for multiple record action responses.", "properties": { "Emails": { "description": "Array of result statuses for each email association operation.", "items": { "additionalProperties": false, "description": "Individual result for a specific email association.", "properties": { "code": { "description": "Status code indicating the result of the operation. Possible values:SUCCESS, ERROR.", "enum": [ "SUCCESS" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual details about the operation result.", "properties": { "message_id": { "description": "The original message ID of the email that was processed.", "maxLength": 255, "type": "string" } }, "required": [ "message_id" ], "type": "object" }, "message": { "description": "Human-readable message describing the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Operation status. Possible values:success, error.", "enum": [ "success" ], "maxLength": 50, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ActionResponse" }, "ActionResultDetails": { "additionalProperties": false, "description": "Details object within an action result, containing the server-generated unique identifier of the created, updated, or deleted field update action.", "properties": { "id": { "description": "Unique identifier of the field update action that was created, updated, or deleted.", "example": "3361265000006103128", "maxLength": 255, "type": "string", "x-zs-$id": "FieldUpdateActionResultId" } }, "required": [ "id" ], "title": "Action Result Details", "type": "object", "x-zs-llm-description": "Contains the server-generated unique ID of the created, updated, or deleted field update. Use this ID for subsequent operations." }, "ActionUsageMetricsSchema": { "additionalProperties": false, "description": "Represents usage metrics for a single workflow action, including its identifier, display name, action type, execution success and failure counts within a queried date range, and the timestamp of its last association.", "properties": { "associated_time": { "description": "Represents the ISO 8601 timestamp indicating when this action was last associated with or modified on a workflow rule.", "maxLength": 255, "type": "string" }, "failure_count": { "description": "Represents the total number of failed executions recorded for this action within the queried date range.", "format": "int32", "type": "integer" }, "id": { "description": "Represents the unique ID of the workflow action.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the workflow rule or its associated action as configured in Zoho CRM.", "maxLength": 255, "type": "string" }, "success_count": { "description": "Represents the total number of successful executions recorded for this action within the queried date range.", "format": "int32", "type": "integer" }, "type": { "description": "Represents the category of workflow action executed by the rule.", "maxLength": 255, "type": "string" } }, "required": [ "associated_time", "failure_count", "id", "name", "success_count", "type" ], "title": "Action Usage Metrics", "type": "object", "x-zs-$id": "ActionUsageMetricsSchema", "x-zs-llm-description": "Basic action usage entry without queue or email details. Contains name, type, id, success_count, failure_count, and associated_time." }, "ActionsAllowed": { "additionalProperties": false, "description": "Represents the set of Boolean permission flags indicating which modification operations are permitted on a layout section, such as adding fields, renaming, reordering, and deleting.", "properties": { "add_field": { "description": "Indicates whether new fields may be introduced into the layout section. Possible values: `true` — adding fields to the section is permitted; `false` — adding fields to the section is not permitted.", "type": "boolean" }, "change_column_count": { "description": "Indicates whether the number of columns displayed within the layout section may be modified. Possible values: `true` — adjusting the column count for the section is permitted; `false` — adjusting the column count for the section is not permitted.", "type": "boolean" }, "change_tab_traversal": { "description": "Indicates whether the keyboard tab traversal order of fields within the layout section may be modified. Possible values: `true` — changing the tab traversal order is permitted; `false` — changing the tab traversal order is not permitted.", "type": "boolean" }, "delete": { "description": "Indicates whether the layout section may be permanently removed from the layout. Possible values: `true` — deleting the section is permitted; `false` — deleting the section is not permitted.", "type": "boolean" }, "remove_field": { "description": "Indicates whether existing fields may be detached from the layout section. Possible values: `true` — removing fields from the section is permitted; `false` — removing fields from the section is not permitted.", "type": "boolean" }, "rename": { "description": "Indicates whether the display name of the layout section may be changed. Possible values: `true` — renaming the section is permitted; `false` — renaming the section is not permitted.", "type": "boolean" }, "reorder": { "description": "Indicates whether the relative ordering of sections or fields within the layout may be changed. Possible values: `true` — reordering is permitted; `false` — reordering is not permitted.", "type": "boolean" } }, "required": [ "add_field", "rename", "change_tab_traversal", "reorder", "delete", "remove_field", "change_column_count" ], "type": "object" }, "ActionsCountSummarySchema": { "additionalProperties": false, "description": "Represents a summary of execution count entries for instant actions in a workflow rule condition, categorized by action type.", "properties": { "actions_count": { "description": "Represents the list of action count entries, each categorized by action type, for the workflow rule.", "items": { "additionalProperties": false, "description": "Represents a single action type entry containing the action name and its associated execution counts.", "properties": { "type": { "description": "Represents the category of workflow action to which the execution count applies, such as email notifications, field updates, or webhooks.", "enum": [ "create_record", "add_meeting", "schedule_call", "assign_owner", "add_tags", "remove_tags", "convert", "email_notifications", "field_updates", "tasks", "webhooks", "functions", "sms", "whatsapp", "flow", "circuits", "slack_notifications", "cliq_notifications", "cisco_notifications", "google_chat_notifications", "microsoft_teams_notifications", "create_record_email", "create_connected_record", "comment_to_post", "reply_to_comment", "like_to_comment", "reply_to_message", "retweet", "reply_to_tweet" ], "type": "string" }, "value": { "description": "Represents the total execution count for the specified action type within the queried date range.", "format": "int32", "type": "integer" } }, "required": [ "type", "value" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "actions_count" ], "title": "Instant Actions Count Summary", "type": "object", "x-zs-$id": "ActionsCountSummarySchema", "x-zs-llm-description": "Collection of action-type-to-count pairs within a condition. Contains actions_count array where each entry maps an action type to its configured count." }, "ActivationStatusSchema": { "additionalProperties": false, "description": "Represents the activation state of a workflow rule, indicating whether the rule is currently active.", "properties": { "active": { "description": "Indicates whether the workflow rule is currently active.\n\nPossible values:\ntrue - The workflow rule is active and executes its configured actions when trigger conditions are met.\nfalse - The workflow rule is inactive and does not execute, even when trigger conditions are met.", "type": "boolean" } }, "title": "Activation Status", "type": "object", "x-zs-llm-description": "Activation state as returned in GET responses. Contains active (boolean). Used in the status property of the rule entity. To change: PUT with status.active=true/false." }, "ActiveServicesLimitExceededError": { "additionalProperties": false, "description": "Error response returned when the request exceeds the maximum number of active services.", "properties": { "code": { "description": "Error response returned when the module name in the request URL is invalid or a required query parameter is missing from the request. Contains one of: `InvalidModuleNameError` or `RequiredParamMissingError`.\n", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing additional context about the active services limit violation.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the maximum number of active services permitted for the organization.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the active services limit violation.", "enum": [ "You cannot create more than 500 active services" ], "type": "string" }, "status": { "description": "Represents the status of the response, indicating that an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ActiveServicesLimitExceededError" }, "ActiveStateLimitErrorResponse": { "additionalProperties": false, "description": "Represents an error response returned when the number of active Scoring Rules for a layout has reached the maximum limit of 5.", "properties": { "code": { "description": "Represents the error code **ACTIVE_STATE_LIMIT_EXCEEDED**.", "enum": [ "ACTIVE_STATE_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional validation details about the active state limit error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the active state limit error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that triggered the active state limit error.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the maximum number of active Scoring Rules allowed per layout.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the active Scoring Rule limit has been reached.", "enum": [ "More than 5 active scoring rules cannot be created for a layout" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Active State Limit Exceeded Error Response", "type": "object", "x-zs-$id": "ActiveStateLimitErrorResponse" }, "ActivityModuleRelatedIssueErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when **share_related_records** is set on a module that does not support sharing related records.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "cannot share the related records" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ActivityModuleRelatedIssueErrorResponse" }, "AddMeetingActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that schedules a meeting when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this add-meeting action should be removed from the workflow rule when set in a PUT request. When this field is provided with a null value, the platform interprets it as a deletion signal and removes the action from the rules action list.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationAddMeetingDetails", "description": "Configuration for the add_meeting action. Requires the Events module, a layout, and field mappings that include the event title and start date and time. Also requires the meeting duration, unless the event is set to all day, and specifies whether the record owner or another assigned user hosts the meeting. Optionally restricts creation to prevent duplicate records.\n" }, "id": { "description": "Represents the unique ID of the add-meeting action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the add-meeting action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. For add_meeting, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only)." }, "type": { "const": "add_meeting", "description": "Represents the action type discriminator that identifies this action as an add-meeting action within the workflow rule. The value is fixed for this action type and must correspond to a type supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "AddMeetingActionSchema", "x-zs-llm-description": "Inline action type='add_meeting'. Creates an Event record. Requires module (Events), layout, field_mappings (must include Event_Title, Start_DateTime), meeting_duration ({value, period} - not when All_Day=true), and host_unavailable (either assign_record_owner_as_host:true or assign_task:{id}). Optional: apply_restriction." }, "AddTagsActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that adds pre-existing tags to the triggering record when the workflow rule condition is met.", "properties": { "_delete": { "description": "Indicates that this add-tags action should be removed from the workflow rule when set in a PUT request. When this field is provided with a null value, the platform interprets it as a deletion signal and removes the action from the rules action list.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationAddTagsDetails", "description": "" }, "id": { "description": "Represents the unique ID of the add-tags action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the add-tags action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. For add_tags, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only)." }, "type": { "const": "add_tags", "description": "Represents the action type discriminator that identifies this action as an add-tags action within the workflow rule. The value is fixed for this action type and must correspond to a type supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "AddTagsActionSchema", "x-zs-llm-description": "Inline action type='add_tags'. Adds pre-existing tags to the triggering record. Requires details.tags array (1-10 entries, each {id, name}). Optional: over_write (bool - true replaces all existing tags). Cannot coexist with convert action on Leads. Tags must be pre-created via getTags/POST." }, "AllErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the API request fails due to validation errors or unsupported operations.", "properties": { "code": { "description": "Represents a machine-readable error code; branch on this value, not on message.", "enum": [ "EXPECTED_FIELD_MISSING", "INVALID_DATA", "MANDATORY_NOT_FOUND", "DEPENDENT_MISMATCH", "NOT_ALLOWED", "NO_PERMISSION", "ALREADY_ACTIVATED", "ALREADY_DEACTIVATED", "LIMIT_EXCEEDED", "NOT_SUPPORTED", "DEPENDENT_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING", "EXPECTED_DEPENDENT_FIELD_MISSING", "ALREADY_USED", "DUPLICATE_DATA", "INVALID_MODULE", "REQUIRED_PARAM_MISSING", "DEPENDENT_PARAM_MISSING" ], "type": "string", "x-zs-llm-description": "Machine-readable error code. Integrators should branch on code, not message. EXPECTED_FIELD_MISSING - one of several alternatives must be supplied. MANDATORY_NOT_FOUND - a required field is absent. INVALID_DATA - field value or type is invalid. DEPENDENT_FIELD_MISSING - a field required by another field's value is absent. DEPENDENT_MISMATCH - dependent field's value conflicts with parent field. EXPECTED_DEPENDENT_FIELD_MISSING - one of several fields dependent on a parent is required. AMBIGUITY_DURING_PROCESSING - request carries mutually exclusive fields. ALREADY_USED - duplicate value in the same request. DUPLICATE_DATA - duplicate against existing data. LIMIT_EXCEEDED - array/value above allowed limit. NOT_ALLOWED / NOT_SUPPORTED - operation forbidden in the current state or edition. NO_PERMISSION - user lacks the required permission. ALREADY_ACTIVATED / ALREADY_DEACTIVATED - idempotency errors on activate/deactivate. INVALID_MODULE - module name invalid. REQUIRED_PARAM_MISSING / DEPENDENT_PARAM_MISSING - missing query parameter." }, "details": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedFieldMissingDetails" }, { "$ref": "#/components/schemas/ExpectedDependentFieldMissingDetails" }, { "$ref": "#/components/schemas/CadencesInvalidDataWithId" }, { "$ref": "#/components/schemas/CadencesInvalidDataWithSupportedValues" }, { "$ref": "#/components/schemas/InvalidDataWithDataType" }, { "$ref": "#/components/schemas/InvalidDataWithDataTypeAndSupportedValues" }, { "$ref": "#/components/schemas/MandatoryInvalidDataCommonApiNameJsonPath" }, { "$ref": "#/components/schemas/DependentMismatchDetails" }, { "$ref": "#/components/schemas/DependencyFieldMissingDetails" }, { "$ref": "#/components/schemas/ResourcePathIndex" }, { "$ref": "#/components/schemas/IdDetails" }, { "$ref": "#/components/schemas/ParamNameDetails" }, { "$ref": "#/components/schemas/ParamNameWithEnumDetails" }, { "$ref": "#/components/schemas/ApiNameLimit" }, { "$ref": "#/components/schemas/DetailsPermission" }, { "$ref": "#/components/schemas/EmptyDetails" }, { "$ref": "#/components/schemas/ApiNameLimitJsonPath" }, { "$ref": "#/components/schemas/AmbiguityDetails" }, { "$ref": "#/components/schemas/ApiNameExistsInJsonPath" }, { "$ref": "#/components/schemas/MaximumLengthApiNameJsonPath" } ], "description": "Represents additional details providing context about the error." }, "message": { "description": "Represents the error message describing the validation failure.", "format": "error message", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the API response.", "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "AllErrorResponse" }, "AlreadyUsedSchema": { "additionalProperties": false, "description": "Represents the error response returned when the resource or value you are trying to create already exists in the system.", "properties": { "code": { "description": "Represents the error code returned when a resource or value is already in use and cannot be reused in the requested operation.", "enum": [ "ALREADY_USED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 50, "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Represents the **exists_in** value from the error detail object.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "duplicate criteria details.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleAlreadyUsedErrorResponses", "x-zs-llm-description": "Error code: ALREADY_USED. Returned when attempting to create a workflow rule with a name that already exists in the same module, or adding a duplicate action entry. Fix: use a unique name or update the existing rule instead of creating a duplicate." }, "AmbiguityDetails": { "additionalProperties": false, "description": "Represents error details for ambiguity, listing the fields that caused the ambiguity.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields that caused the ambiguity during processing.", "items": { "additionalProperties": false, "description": "Represents a field that contributed to the ambiguity, identified by its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the ambiguity.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the ambiguity.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object", "x-zs-$id": "AmbiguityDetails" }, "AmbiguityDuringProcessing": { "additionalProperties": false, "description": "Represents the error response when an ambiguity is encountered during territory processing.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the ambiguity error details returned when the run-rules operation encounters conflicting assignment criteria.", "properties": { "code": { "description": "Represents the error code returned when ambiguity is detected during run-rules processing.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the fields causing ambiguity during processing.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields causing ambiguity.", "items": { "additionalProperties": false, "description": "Represents the details of a field that caused ambiguity during run-rules processing.", "properties": { "api_name": { "description": "Represents the API name of the conflicting or ambiguous field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the ambiguous field in the request.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "minItems": 2, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message returned when ambiguity is encountered during processing.", "enum": [ "Ambiguity while processing the request" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" } }, "required": [ "run_rules" ], "type": "object", "x-zs-$id": "AmbiguityDuringProcessing" }, "AmbiguityDuringProcessingGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a ambiguity during processing GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "ambiguity_due_to": { "description": "Contains additional context about the error.", "items": { "additionalProperties": false, "description": "Represents a single item in the AmbiguityDuringProcessingGETError array.", "properties": { "param_name": { "description": "Parameter name of the ambiguous field.", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AmbiguityDuringProcessingGETError" }, "AmbiguityDuringProcessingSchema": { "additionalProperties": false, "description": "Represents the error response returned when the system encounters ambiguity during processing due to conflicting field references.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "ambiguity_due_to": { "description": "Represents the **ambiguity_due_to** value from the error detail object.", "items": { "additionalProperties": false, "description": "Represents a conflicting field entry, including its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the conflicting field that caused the ambiguity.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the conflicting field that caused the ambiguity.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "action not supported for this trigger", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleAmbiguityDuringProcessingErrorResponses", "x-zs-llm-description": "Error code: AMBIGUITY_DURING_PROCESSING. Returned when two identifying fields point to different entities. Common cases: (1) module.api_name and module.id refer to different modules, (2) associate action created for wrong module vs module_selection context, (3) add_tags/remove_tags used alongside convert on Leads. Fix: ensure all identifiers are consistent and refer to the same entity." }, "AmbiguityError": { "additionalProperties": false, "description": "Represents the error returned when conflicting fields are sent in the same request — specifically when calendar_type is set to gregorian while also providing fields that are only valid for a custom calendar, such as structure, start_date, interval_display_option, or surplus_week.", "properties": { "code": { "description": "Represents the error code. Possible values: `AMBIGUITY_DURING_PROCESSING`.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the fields that caused the ambiguity.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields that caused the ambiguity during processing.", "items": { "additionalProperties": false, "description": "Represents a field that caused the ambiguity during processing.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the ambiguity.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the ambiguity.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Ambiguity while processing`.", "enum": [ "Ambiguity while processing" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "AmbiguityError" }, "AmbiguityProcessingErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when both module id and api_name are provided but refer to different modules.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**AMBIGUITY_DURING_PROCESSING** - Ambiguity was encountered while processing the request.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field that caused the ambiguity.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields that caused the ambiguity in the request.", "items": { "additionalProperties": false, "description": "Represents an individual field object that contributed to the ambiguity, including its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the dependee or conflicting field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependee or conflicting field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Ambiguity while processing the request** - Multiple conflicting fields were detected.\n**The given module api_name seems to be invalid** - The module API name provided is not recognized.", "enum": [ "Ambiguity while processing the request", "The given module api_name seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Ambiguity During Processing Error Response", "type": "object", "x-zs-$id": "AmbiguityProcessingErrorResponse", "x-zs-llm-description": "Module ID and api_name do not refer to the same module. Supply only one identifier." }, "AmbiguousShareErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when a public share request contains more than one JSON object, which causes ambiguity during processing.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "properties": { "ambiguity_due_to": { "description": "Represents the list of reasons that caused the ambiguity during processing.", "items": { "additionalProperties": false, "description": "Each object represents a single reason for the ambiguity during processing.", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" } }, "type": "object" }, "maxItems": 20, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "For public sharing more than one json object is given" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "AmbiguousShareErrorResponse" }, "ApiNameDetail": { "additionalProperties": false, "description": "Represents the API name details for a field in the request or response.", "properties": { "api_name": { "description": "Represents the API name of the field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "ApiNameDetail" }, "ApiNameExistsInJsonPath": { "additionalProperties": false, "description": "Represents error details when an API name already exists at the specified JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that already exists in the specified JSON path.", "maxLength": 255, "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Represents the location where the API name already exists, identified by its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name at the existing location.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the existing field location.", "maxLength": 500, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path of the duplicate field in the request payload.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "exists_in", "json_path" ], "type": "object", "x-zs-$id": "ApiNameExistsInJsonPath" }, "ApiNameGenerationRequestAlt": { "additionalProperties": false, "description": "Represents the request body for the generate API name operation.", "properties": { "variable_groups": { "description": "Represents an array containing a single variable group item submitted for API name generation.", "items": { "$ref": "#/components/schemas/VariableGroupApiNameGenerationItemAlt" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "variable_groups" ], "title": "API Name Generation Request (Alternate)", "type": "object" }, "ApiNameGenerationRequestBody": { "additionalProperties": false, "description": "Alternate request payload wrapper containing items used to generate API names.", "properties": { "variables": { "description": "Array of variable definitions. Mandatory.", "items": { "$ref": "#/components/schemas/ApiNameGenerationRequestBodyItem" }, "maxItems": 1, "type": "array" } }, "required": [ "variables" ], "title": "API Name Generation Request V2", "type": "object" }, "ApiNameGenerationRequestBodyItem": { "additionalProperties": false, "description": "Alternate input item for API name generation, specifying the variable name and group.", "properties": { "name": { "description": "The display name for the variable. Mandatory.", "maxLength": 50, "type": "string" }, "variable_group": { "$ref": "#/components/schemas/VariableGroupSchema", "description": "The variable group to which this variable belongs. Mandatory." } }, "required": [ "name", "variable_group" ], "title": "API Name Generation Item V2", "type": "object" }, "ApiNameLimit": { "additionalProperties": false, "description": "Represents error details when a field exceeds its maximum allowed count.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeded the limit.", "maxLength": 255, "type": "string" }, "limit": { "description": "Represents the maximum allowed count for the field.", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object", "x-zs-$id": "ApiNameLimit" }, "ApiNameLimitJsonPath": { "additionalProperties": false, "description": "Represents error details when a field at a specific JSON path exceeds its maximum allowed count.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeded the limit.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that exceeded the limit.", "maxLength": 500, "type": "string" }, "limit": { "description": "Represents the maximum allowed count for the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "limit", "json_path" ], "type": "object", "x-zs-$id": "ApiNameLimitJsonPath" }, "ApiNamePatternMismatchError": { "additionalProperties": false, "description": "Represents an error response returned when the `api_name` value does not comply with the required naming pattern.", "properties": { "code": { "description": "Represents the error code **PATTERN_NOT_MATCHED**.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the field that caused the pattern mismatch error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the pattern mismatch.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the pattern mismatch.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the input value does not match the required naming pattern.", "enum": [ "Please check whether the input values are correct" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "API Name Pattern Mismatch Error", "type": "object", "x-zs-$id": "ErrorResponseCore1651416813" }, "ApiNotSupportedForClientPortalUserError": { "additionalProperties": false, "description": "Returned when the API operation is not supported for portal users. This error applies when the request is made in a context that is incompatible with client portal user access.", "properties": { "code": { "description": "Represents the error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "unsupported_login_user_type": { "description": "Represents the login user type that should not be supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_login_user_type" ], "type": "object" }, "message": { "description": "Represents the error message that Zoho CRM returned, describing what went wrong.", "enum": [ "api not supported for client portal user" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ApiNotSupportedForClientPortalUserError" }, "ApiNotSupportedForDomainError": { "additionalProperties": false, "description": "Returned when the Portal User Types API is not supported for the specified domain configuration.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "supported_domains": { "description": "The list of domain configurations that are supported for this operation.", "items": { "description": "Each item represents the supported domain.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "supported_domains" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "api not supported" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ApiNotSupportedForDomainError" }, "ApiNotSupportedInSandboxError": { "additionalProperties": false, "description": "Returned when the Portal User Types API is called in a Zoho CRM sandbox environment, where this API is not available.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "unsupported_environment": { "description": "Represents the environment that should not be supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ApiNotSupportedInSandboxError" }, "ApisErrorResponse": { "additionalProperties": false, "description": "Represents the standard error response returned by the API when a request fails.", "properties": { "code": { "description": "Returns the error code generated by the API.", "maxLength": 64, "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the error, such as the field or JSON path of the field that caused the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 512, "type": "string" }, "status": { "description": "status", "maxLength": 64, "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponse" }, "AppointmentForNested": { "additionalProperties": false, "description": "Represents the customer for whom the appointment is created, including the record ID, name, and module API name. Test4", "properties": { "id": { "description": "Represents the list of result objects for each appointment deletion is attempted. Each item is either a success confirmation or an error response.\nTest7", "maxLength": 18, "type": [ "string", "null" ] }, "module": { "$ref": "#/components/schemas/ModuleNested", "description": "module name" }, "name": { "description": "Represents the full name of the customer record in the associated module.\n", "maxLength": 2, "type": [ "string", "null" ] } }, "type": "object" }, "AppointmentsCreatedByNested": { "additionalProperties": false, "description": "Represents the user who created the appointment record, including the user ID, full name, and email address.", "properties": { "email": { "description": "Represents the email address of the user who created the appointment record.\n", "format": "email", "maxLength": 33, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique identifier of the user who created the appointment record.\n", "maxLength": 255, "type": [ "string", "null" ] }, "name": { "description": "Represents the full name of the user who created the appointment record.\n", "maxLength": 255, "type": [ "string", "null" ] } }, "type": "object" }, "AppointmentsDataNested": { "additionalProperties": false, "description": "Represents a single appointment record object in the request, containing all appointment fields for creating or updating the record.", "properties": { "$currency_symbol": { "description": "Represents the currency symbol associated with the CRM organization's primary currency.\n", "maxLength": 1, "type": [ "string", "null" ] }, "$editable": { "description": "Indicates whether the current user has permission to edit the appointment record.\n**Possible Values**:\n- true - The current user has edit access to the appointment record.\n- false - The current user does not have edit access to the appointment record.", "type": [ "boolean", "null" ] }, "$field_states": { "description": "Represents the state of fields that have conditional visibility or special behavioral rules applied within the appointment record.", "maxLength": 255, "type": [ "null", "string" ] }, "$sharing_permission": { "description": "Represents the sharing permission level granted to the current user for the appointment record.", "maxLength": 11, "type": [ "string", "null" ] }, "$state": { "description": "Represents the save state of the appointment record, indicating whether the record is in a draft, saved, or transitional state.", "maxLength": 4, "type": [ "string", "null" ] }, "$status": { "description": "The request could not be processed due to an invalid appointment ID, an invalid module name, or an unsupported HTTP request method.\n\n**Resolution:** For INVALID_DATA, make a GET Appointments API call and provide a valid appointment ID. For INVALID_REQUEST_METHOD, use only the DELETE method. For INVALID_MODULE, verify that the module API name in the request is correct.", "maxLength": 7, "type": [ "string", "null" ] }, "Additional_Information": { "description": "Represents any supplementary details about the appointment or specific customer requirements that do not belong to a standard field.", "maxLength": 32000, "type": [ "null", "string" ] }, "Address": { "description": "All three appointment records deleted successfully.\n", "maxLength": 255, "type": [ "null", "string" ] }, "Appointment_End_Time": { "description": "Represents the scheduled end date and time of the appointment, expressed in ISO 8601 format.", "format": "date-time", "maxLength": 120, "type": [ "string", "null" ] }, "Appointment_For": { "$ref": "#/components/schemas/AppointmentForNested", "description": "Contains the name, ID and the module's API name of the customer for whom you are creating the appointment. (Required)" }, "Appointment_Name": { "description": "Partial deletion where one record deleted, one failed with INVALID_DATA\n", "maxLength": 225, "type": [ "string", "null" ] }, "Appointment_Start_Time": { "description": "Represents the scheduled start date and time of the appointment, expressed in ISO 8601 format.", "format": "date-time", "maxLength": 120, "type": "string" }, "Cancellation_Note": { "description": "INVALID_DATA error where appointment ID is invalid or already deleted.\n", "maxLength": 2000, "type": [ "null", "string" ] }, "Cancellation_Reason": { "description": "Represents who cancelled the appointment.\n**Possible values**:\n- By Customer - The appointment was cancelled by the customer.\n- By Team - The appointment was cancelled by the service team.", "maxLength": 120, "type": [ "null", "string" ] }, "Cancelled_By": { "description": "Invalid module API name provided in the request.\n", "type": [ "null", "object" ] }, "Cancelled_Time": { "description": "Represents the date and time when the appointment was cancelled.", "maxLength": 120, "type": [ "null", "string" ] }, "Created_By": { "$ref": "#/components/schemas/AppointmentsCreatedByNested", "description": "appointment created by" }, "Created_Time": { "description": "Invalid HTTP request method type used in the request.\n", "format": "date-time", "maxLength": 120, "type": [ "string", "null" ] }, "Date_1": { "description": "Delete one or more appointment records.\n", "maxLength": 20, "type": [ "null", "string" ] }, "Duration": { "description": "Represents the duration of the appointment in minutes.", "format": "int32", "type": [ "integer", "null" ] }, "Job_Sheet_Created__s": { "description": "Indicates whether a job sheet has been created for this appointment.\n**Possible values**:\n- true - A job sheet has been created and is associated with the appointment.\n- false - No job sheet has been created for the appointment.", "type": [ "boolean", "null" ] }, "Job_Sheet_Description__s": { "description": "Represents the description of the job sheet associated with the completed appointment.", "maxLength": 32000, "type": [ "string", "null" ] }, "Job_Sheet_Name__s": { "description": "Represents the name of the job sheet created for the completed appointment.", "maxLength": 120, "type": [ "string", "null" ] }, "Job_Sheet_Section__s": { "description": "Represents the job sheet section displayed to the user for a completed appointment.", "maxLength": 120, "type": [ "string", "null" ] }, "Last_Activity_Time": { "description": "Represents the date and time of the last activity recorded on the appointment.", "maxLength": 120, "type": [ "null", "string" ] }, "Location": { "description": "Represents the location where the appointment service is offered.\nPossible values:\n**Client Address** - The service is delivered at the customer's address.\n**Business Address** - The service is delivered at the business location.", "enum": [ "Client Address", "Business Address" ], "maxLength": 120, "type": [ "string", "null" ] }, "Modified_By": { "$ref": "#/components/schemas/AppointmentsModifiedByNested", "description": "modified by" }, "Modified_Time": { "description": "Represents the date and time when the appointment record was last modified.", "format": "date-time", "maxLength": 120, "type": [ "string", "null" ] }, "Owner": { "$ref": "#/components/schemas/AppointmentsOwnerNested", "description": "Represents the ID of the service member who will provide the service for this appointment. (Required)" }, "Record_Status__s": { "description": "Represents the availability status of the appointment record.", "maxLength": 9, "type": [ "string", "null" ] }, "Remind_At": { "description": "Contains the list of reminder configurations for the appointment, each specifying a time unit and reminder period.", "items": { "additionalProperties": false, "description": "Each object represents a single reminder configuration, including the time unit and reminder period.", "properties": { "period": { "description": "Represents the unit of time for the reminder.\nPossible values:\n**minutes** - Reminder in minutes.\n**hours** - Reminder in hours.\n**days** - Reminder in days.", "enum": [ "minutes", "hours", "days" ], "type": "string" }, "unit": { "description": "Represents the numeric value of the reminder time.", "format": "int32", "type": "integer" } }, "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "Reschedule_Count": { "description": "Represents the number of times the appointment has been rescheduled.", "format": "int32", "type": [ "integer", "null" ] }, "Reschedule_Note": { "description": "Represents the note explaining the reason for rescheduling the appointment.", "maxLength": 2000, "type": [ "null", "string" ] }, "Reschedule_Reason": { "description": "Represents who rescheduled the appointment.\n**Possible values**:\n- By Customer - The appointment was rescheduled by the customer.\n- By Team - The appointment was rescheduled by the service team.", "maxLength": 120, "type": [ "null", "string" ] }, "Rescheduled_By": { "description": "Represents the user who rescheduled the appointment.", "properties": { "email": { "description": "Represents the email address of the user who rescheduled the appointment.", "format": "email", "maxLength": 33, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique identifier of the user who rescheduled the appointment.", "maxLength": 255, "type": [ "string", "null" ] }, "name": { "description": "Represents the full name of the user who rescheduled the appointment.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": [ "null", "object" ] }, "Rescheduled_From": { "description": "Represents the previous start time of the appointment before it was rescheduled, expressed in ISO 8601 format.", "maxLength": 120, "type": [ "null", "string" ] }, "Rescheduled_Time": { "description": "Represents the date and time when the appointment was rescheduled.", "maxLength": 120, "type": [ "null", "string" ] }, "Rescheduled_To": { "description": "Represents the new start time of the appointment after rescheduling, expressed in ISO 8601 format.", "maxLength": 120, "type": [ "null", "string" ] }, "Service_Name": { "$ref": "#/components/schemas/ServiceNameNested", "description": "Contains the name and distinctive ID of the service for which you are creating the appointment. (Required)" }, "Status": { "description": "Represents the current status of the appointment.\nPossible values:\n**Scheduled** - The appointment is booked and upcoming.\n**Overdue** - The appointment has passed its scheduled time without completion.\n**Completed** - The appointment has been completed.\n**Cancelled** - The appointment has been cancelled.", "maxLength": 120, "type": [ "string", "null" ] }, "Tag": { "description": "Represents the list of tags associated with the appointment record.", "items": { "description": "Each string represents a single tag name associated with the appointment.", "maxLength": 2000, "type": "string" }, "maxItems": 100, "type": [ "array", "null" ] }, "id": { "description": "Represents the unique identifier of the appointment record.", "maxLength": 18, "readOnly": true, "type": [ "string", "null" ] } }, "required": [ "Appointment_For", "Appointment_Start_Time", "Owner", "Service_Name" ], "type": "object" }, "AppointmentsDataNested1": { "additionalProperties": false, "description": "Represents a single item in the response, containing the operation outcome code, details, message, and status.", "properties": { "code": { "description": "Represents the result code for the operation.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/AppointmentsDetailsNested" }, "message": { "description": "Represents the result message for the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the operation.", "maxLength": 255, "type": "string" } }, "type": "object" }, "AppointmentsDetailsNested": { "additionalProperties": false, "description": "Represents the details of an appointment record, including its ID, creation timestamp, and last modification timestamp.", "properties": { "Created_By": { "$ref": "#/components/schemas/AppointmentsCreatedByNested" }, "Created_Time": { "description": "Represents the date and time when the appointment record was created.", "maxLength": 120, "type": "string" }, "Modified_By": { "$ref": "#/components/schemas/AppointmentsModifiedByNested" }, "Modified_Time": { "description": "Represents the date and time when the appointment record was last modified.", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of the appointment record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "AppointmentsGETCreatedByNested": { "additionalProperties": false, "description": "Represents the user who created the appointment record, including the user ID, full name, and email address.", "properties": { "email": { "description": "Represents the email address of the user who created the appointment record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the user who created the record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the full name of the user who created the record.", "maxLength": 255, "type": "string" } }, "required": [ "email", "id", "name" ], "type": "object" }, "AppointmentsGETDataNested": { "additionalProperties": true, "description": "Represents a single appointment record returned in the GET response, containing all appointment details and status information.", "properties": { "$currency_symbol": { "description": "Represents the currency symbol for the CRM organization's primary currency.", "maxLength": 255, "type": "string" }, "$editable": { "description": "Indicates whether the current user has permission to edit the appointment record.", "type": "boolean" }, "$field_states": { "description": "Represents the state of fields with conditional visibility or special behavior.", "maxLength": 255, "type": [ "null", "string" ] }, "$sharing_permission": { "description": "Represents the sharing permission level of the appointment record for the current user.", "maxLength": 255, "type": "string" }, "$status": { "description": "Represents the Custom View status indicator for the appointment record.", "maxLength": 120, "type": "string" }, "Additional_Information": { "description": "Represents any additional details about the appointment or customer requirements.", "maxLength": 32000, "type": [ "null", "string" ] }, "Address": { "description": "Represents the address where the service is delivered when the appointment location is Client Address.", "maxLength": 255, "type": [ "null", "string" ] }, "Appointment_End_Time": { "description": "Represents the scheduled end date and time of the appointment.", "maxLength": 120, "type": "string" }, "Appointment_For": { "$ref": "#/components/schemas/GETAppointmentForNested" }, "Appointment_Name": { "description": "Represents the name of the appointment record.", "maxLength": 255, "type": "string" }, "Appointment_Start_Time": { "description": "Represents the scheduled start date and time of the appointment.", "maxLength": 120, "type": "string" }, "Cancellation_Note": { "description": "Represents the note explaining the reason for cancelling the appointment.", "maxLength": 2000, "type": [ "null", "string" ] }, "Cancellation_Reason": { "description": "Denotes who cancelled the appointment.\nPossible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'.", "maxLength": 120, "type": [ "null", "string" ] }, "Cancelled_By": { "description": "Represents the user who cancelled the appointment.", "type": [ "null", "object" ] }, "Cancelled_Time": { "description": "Represents the date and time when the appointment was cancelled.", "maxLength": 120, "type": [ "null", "string" ] }, "Contact_Name__s": { "description": "Represents the name and unique ID of the contact associated with the appointment.", "maxLength": 255, "type": [ "null", "string" ] }, "Created_By": { "$ref": "#/components/schemas/AppointmentsGETCreatedByNested" }, "Created_Time": { "description": "Represents the date and time when the appointment record was created.", "maxLength": 120, "type": "string" }, "Date_1": { "description": "Represents an additional date field for the appointment record.", "maxLength": 20, "type": [ "null", "string" ] }, "Duration": { "description": "Represents the duration of the appointment in minutes.", "format": "int32", "type": "integer" }, "Job_Sheet_Created__s": { "description": "Indicates whether a job sheet has been created for this appointment. \n**Possible values**:\n- true - A job sheet has been created.\n- false - No job sheet has been created.", "type": "boolean" }, "Job_Sheet_Description__s": { "description": "Represents the description of the job sheet associated with the completed appointment.", "maxLength": 32000, "type": [ "null", "string" ] }, "Job_Sheet_Name__s": { "description": "Represents the name of the job sheet created for the completed appointment.", "maxLength": 255, "type": [ "null", "string" ] }, "Job_Sheet_Section__s": { "description": "Represents the job sheet section displayed to the user for a completed appointment.", "maxLength": 120, "type": [ "string", "null" ] }, "Last_Activity_Time": { "description": "Represents the date and time of the last activity on the appointment record.", "maxLength": 120, "type": [ "null", "string" ] }, "Location": { "description": "Represents the location where the appointment service is offered.", "maxLength": 120, "type": "string" }, "Modified_By": { "$ref": "#/components/schemas/AppointmentsGETModifiedByNested" }, "Modified_Time": { "description": "Represents the date and time when the appointment record was last modified.", "maxLength": 120, "type": "string" }, "Owner": { "$ref": "#/components/schemas/AppointmentsGETOwnerNested" }, "Record_Status__s": { "description": "Represents the availability status of the appointment record.", "maxLength": 255, "type": "string" }, "Remind_At": { "description": "Represents the list of reminder configurations for the appointment.", "items": { "description": "Each object represents a single reminder configuration, including the time unit and numeric value.", "properties": { "period": { "description": "Represents the unit of time for the reminder.\n**Possible values**:\n- minutes - The reminder is sent a specified number of minutes before the appointment.\n- hours - The reminder is sent a specified number of hours before the appointment.\n- days - The reminder is sent a specified number of days before the appointment.", "enum": [ "minutes", "hours", "days" ], "type": "string" }, "unit": { "description": "Represents the numeric value of the reminder time. The value of a unit key can be only from **0 to 100**.", "format": "int32", "type": "integer" } } }, "maxItems": 100, "type": [ "array", "null" ] }, "Reschedule_Count": { "description": "Represents the number of times the appointment has been rescheduled.", "format": "int32", "type": "integer" }, "Reschedule_Note": { "description": "Represents the note explaining the reason for rescheduling the appointment.", "maxLength": 2000, "type": [ "null", "string" ] }, "Reschedule_Reason": { "description": "Denotes who rescheduled the appointment.\nPossible Values: 'By Customer' and 'By Team'. The default value is 'By Customer'.", "maxLength": 120, "type": [ "null", "string" ] }, "Rescheduled_By": { "description": "Represents the user who rescheduled the appointment.", "type": [ "null", "object" ] }, "Rescheduled_From": { "description": "Denotes the previous appointment time from which the appointment was rescheduled to the new time. The Rescheduled_From time should be lesser than the new appointment time. The value should be given in the ISO 8601 format.", "maxLength": 120, "type": [ "null", "string" ] }, "Rescheduled_Time": { "description": "Represents the date and time when the appointment was rescheduled.", "maxLength": 120, "type": [ "null", "string" ] }, "Rescheduled_To": { "description": "Represents the new appointment start time after rescheduling.", "maxLength": 120, "type": [ "null", "string" ] }, "Service_Name": { "$ref": "#/components/schemas/GETServiceNameNested" }, "Status": { "description": "Represents the current status of the appointment.", "maxLength": 120, "type": "string" }, "Tag": { "description": "Represents the list of tags associated with the appointment record.", "items": { "description": "Represents a single tag name associated with the appointment.", "maxLength": 2000, "type": "string" }, "maxItems": 10, "type": "array" }, "id": { "description": "Represents the unique ID of the appointment record.", "maxLength": 255, "type": "string" } }, "required": [ "Appointment_Name", "Appointment_For", "Service_Name", "Appointment_Start_Time", "Location", "Owner" ], "type": "object" }, "AppointmentsGETModifiedByNested": { "additionalProperties": false, "description": "Represents the user who last modified the appointment record, including the user ID, full name, and email address.", "properties": { "email": { "description": "Represents the email address of the user who last modified the appointment record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the user who last modified the record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the full name of the user who last modified the record.", "maxLength": 255, "type": "string" } }, "required": [ "email", "id", "name" ], "type": "object" }, "AppointmentsGETOwnerNested": { "additionalProperties": false, "description": "Represents the service member assigned as the appointment owner, including the user ID, full name, and email address.", "properties": { "email": { "description": "Represents the email address of the appointment owner.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the appointment owner.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the full name of the appointment owner.", "maxLength": 255, "type": "string" } }, "required": [ "email", "id", "name" ], "type": "object" }, "AppointmentsModifiedByNested": { "additionalProperties": false, "description": "Represents the user who last modified the appointment record, including the user ID, full name, and email address.", "properties": { "email": { "description": "Represents the email address of the user who last modified the appointment record.", "format": "email", "maxLength": 33, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the user who last modified the appointment record.", "maxLength": 255, "type": [ "string", "null" ] }, "name": { "description": "Represents the full name of the user who last modified the appointment record.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": "object" }, "AppointmentsOwnerNested": { "additionalProperties": false, "description": "Represents the user assigned as the appointment owner, including the user ID, full name, and email address.", "properties": { "email": { "description": "Represents the email address of the appointment owner.", "format": "email", "maxLength": 100, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the appointment owner.", "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Represents the full name of the appointment owner.", "maxLength": 100, "type": [ "string", "null" ] } }, "type": "object" }, "AppointmentsPost207multistatusResponse207": { "additionalProperties": false, "description": "Represents a successful result item in the Multi-Status response, containing the result code, details, message, and status.", "properties": { "code": { "description": "Represents the result code for the appointment record operation.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/AppointmentsDetailsNested" }, "message": { "description": "Represents the result message for the appointment record operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the result status of the appointment record operation.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "Post207multistatusResponse207" }, "ArrayOfDuplicateSchema": { "description": "Contains the list of duplicate data errors for contact role operations.", "items": { "additionalProperties": false, "description": "Represents a duplicate data error for a contact role field.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **DUPLICATE_DATA** - A contact role with the same name already exists.\n", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents duplicate data error details that include the ID of the conflicting record.", "properties": { "api_name": { "description": "Represents the API name of the field that contains a duplicate value.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the ID of the existing contact role that conflicts with the duplicate name.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains a duplicate value.", "maxLength": 255, "type": "string" } }, "required": [ "id", "api_name", "json_path" ], "type": "object", "x-zs-$id": "DuplicatedataerrordetailswithID" }, { "additionalProperties": false, "description": "Represents duplicate data error details that include the API name and JSON path of the conflicting field.", "properties": { "api_name": { "description": "Represents the API name of the field that contains a duplicate value.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains a duplicate value.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "DuplicatedataerrordetailswithoutID" } ], "description": "Represents the error details for the duplicate data." }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "Arrayofduplicatedataerrors" }, "AssignOwnerActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that assigns or reassigns the record owner when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationAssignOwnerDetails", "description": "Configuration for the assign_owner action. Requires a module reference and an assign_to array with one to five entries, each specifying who to assign the record to — a user, role, group, assignment rule, or profile, a merge field, or matching criteria. Optionally sends a notification, includes related records, applies an assignment threshold, or bases assignment on user availability." }, "id": { "description": "Represents the unique ID of the AssignOwner action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the AssignOwner action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. For assign_owner, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only)." }, "type": { "const": "assign_owner", "description": "Represents the action type discriminator that identifies this as a AssignOwner action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "AssignOwnerActionSchema", "x-zs-llm-description": "Inline action type='assign_owner'. Requires module and assign_to array (1-5 entries). assign_to discriminates on type: user/role/group/profile/assignment_rule need resource.id; merge_field needs details.api_name (user-type field); criteria needs criteria array. Optional: notify (trigger notification), related_records (transfer child record ownership), apply_assignment_threshold." }, "AssignTerritoryAssignErrorDataObject": { "additionalProperties": false, "description": "Represents the error details object for a limit exceeded error on a territory assignment operation.", "properties": { "data": { "description": "Represents the array of record-territory association objects with assignment or removal error details.", "items": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryLimitExceededError" }, { "$ref": "#/components/schemas/TerritoryLimitExceededErrorWithField" } ], "description": "Represents the limit exceeded error details for a single record-territory association, with either basic or field-specific context." }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "AssignTerritoryAssignErrorDataObject" }, "AssignToRequestObject": { "anyOf": [ { "$ref": "#/components/schemas/ZiaSuggestedUsersTypeAssignToRequestObject" }, { "$ref": "#/components/schemas/RoleTypeAssignToRequestObject" }, { "$ref": "#/components/schemas/GroupTypeAssignToRequestObject" }, { "$ref": "#/components/schemas/ProfileTypeAssignToRequestObject" }, { "$ref": "#/components/schemas/UsersTypeAssignToRequestObject" }, { "$ref": "#/components/schemas/CriteriaTypeAssignToRequestObject" } ], "description": "Assign to request object schema.", "title": "Assign to request object" }, "AssignToResponseObject": { "anyOf": [ { "$ref": "#/components/schemas/ZiaSuggestedUsersTypeAssignToObject" }, { "$ref": "#/components/schemas/UsersTypeAssignToResponseObject" }, { "$ref": "#/components/schemas/RoleGroupProfileTypeAssignToResponseObject" }, { "$ref": "#/components/schemas/CriteriaTypeAssignToResponseObject" } ], "description": "Assign to response object schema.", "title": "Assign to response object", "x-zs-$id": "AssignToResponseObject" }, "AssignmentRuleResponseObject": { "additionalProperties": false, "description": "Details of the Assignment Rule.", "properties": { "api_name": { "description": "Represents the API name of the rule. ", "maxLength": 100, "minLength": 1, "type": "string", "x-zs-$id": "AssignmentRuleApiName" }, "created_by": { "$ref": "#/components/schemas/ResourceResponseObject" }, "created_time": { "description": "Represents the date and time of Assignment Rule creation. ", "format": "date-time", "maxLength": 255, "type": "string" }, "default_assignee": { "$ref": "#/components/schemas/DefaultAssigneeResponseObject", "description": "Defines the details of the fall back user to whom the records will be assigned when owner couldn't be assigned by any of the rule entries defined. (Required)" }, "description": { "description": "Purpose of the Assignment Rule.", "maxLength": 250, "type": [ "string", "null" ] }, "id": { "$ref": "#/components/schemas/IdSchema", "x-zs-$id": "AssignmentRuleId" }, "modified_by": { "$ref": "#/components/schemas/ResourceResponseObject" }, "modified_time": { "description": "Represents the date and time of Assignment Rule recent modification. ", "format": "date-time", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/ResourceResponseObject" }, "name": { "description": "Represents the name to be displayed for the Assignment Rule. ", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "id", "name", "api_name", "description", "created_by", "created_time", "modified_by", "modified_time", "default_assignee" ], "title": "Assignment Rule Response Object", "type": "object", "x-zs-$id": "AssignmentRuleResponseObject" }, "AssignmentRuleResponseObjectWithRuleEntries": { "additionalProperties": false, "description": "Details of the Assignment Rule.", "properties": { "api_name": { "description": "Represents the aPI name of the rule. ", "maxLength": 100, "minLength": 1, "type": "string" }, "created_by": { "$ref": "#/components/schemas/ResourceResponseObject" }, "created_time": { "description": "Represents the date and time of Assignment Rule creation. ", "format": "date-time", "maxLength": 255, "type": "string" }, "default_assignee": { "$ref": "#/components/schemas/DefaultAssigneeResponseObject", "description": "Defines the details of the fall back user to whom the records will be assigned when owner couldn't be assigned by any of the rule entries defined. (Required)" }, "description": { "description": "Purpose of the Assignment Rule.", "maxLength": 250, "type": [ "string", "null" ] }, "id": { "$ref": "#/components/schemas/IdSchema" }, "modified_by": { "$ref": "#/components/schemas/ResourceResponseObject" }, "modified_time": { "description": "Represents the date and time of Assignment Rule recent modification. ", "format": "date-time", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/ResourceResponseObject" }, "name": { "description": "Represents the name to be displayed for the Assignment Rule. ", "maxLength": 100, "minLength": 1, "type": "string" }, "rule_entries": { "description": "Defines the list of rules entries with record matching logic and assignment logic. ", "items": { "$ref": "#/components/schemas/RuleEntryResponseObject" }, "maxItems": 200, "type": "array" } }, "required": [ "id", "name", "api_name", "description", "created_by", "created_time", "modified_by", "modified_time", "default_assignee", "rule_entries" ], "title": "Assignment Rule Response Object", "type": "object", "x-zs-$id": "AssignmentRuleResponseObjectWithRuleEntries" }, "AssignmentRulesErrorResponseMandatoryNotFound": { "additionalProperties": false, "description": "Mandatory not found.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**MANDATORY_NOT_FOUND** - Represents mandatory not found.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Mandatory not found", "type": "object", "x-zs-$id": "ErrorResponseMandatoryNotFound" }, "AssignmentRulesErrorResponseNotAllowed": { "additionalProperties": false, "description": "Invalid data.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**NOT_ALLOWED** - Represents not allowed.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/DetailsWithResourcePathIndexInfo", "description": "Error details" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Invalid Data", "type": "object", "x-zs-$id": "ErrorResponseNotAllowed" }, "AssignmentRulesSuccessResponse": { "additionalProperties": false, "description": "Successful API operation completed.", "properties": { "assignment_rules": { "description": "Represents the Assignment Rules returned for the Assignment Rule operation.", "items": { "$ref": "#/components/schemas/SuccessObject", "description": "details of assignment rule created/cloned/updated/deleted" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "title": "Assignment Rule Success Response Schema", "type": "object", "x-zs-$id": "SuccessResponse" }, "AssignmentRulesTaskTypeFollowupActionRequestObject": { "additionalProperties": false, "description": "Followup action that creates a task after ownership assignment.", "properties": { "resources": { "description": "Specify the list of task resources to execute as followup.", "items": { "$ref": "#/components/schemas/TaskResourceRequestObject" }, "maxItems": 1, "minItems": 1, "type": "array" }, "type": { "description": "Followup action type. Must be 'tasks'.\nPossible values:\n**tasks** - Represents tasks.", "enum": [ "tasks" ], "type": "string" } }, "required": [ "type" ], "title": "Task type followup action request object", "type": "object", "x-zs-$id": "TaskTypeFollowupActionRequestObject" }, "AssociateActionsNestedSchema": { "anyOf": [ { "$ref": "#/components/schemas/EmailNotificationAssociateActionSchema" }, { "$ref": "#/components/schemas/FieldUpdateAssociateActionSchema" }, { "$ref": "#/components/schemas/TaskAssociateActionSchema" }, { "$ref": "#/components/schemas/SimpleAssociateActionSchema" } ], "description": "Represents an associate action that references a pre-configured action entity by its unique ID. Use the appropriate entity API to retrieve valid IDs.", "discriminator": { "propertyName": "type" }, "x-zs-$id": "AssociateActionsNestedSchema", "x-zs-llm-description": "Union (oneOf) for pre-configured action references. Routes to: EmailNotificationAssociateActionSchema, FieldUpdateAssociateActionSchema, TaskAssociateActionSchema, or SimpleAssociateActionSchema based on type value. Associate actions reference an entity created via its own API - they carry type + id (and optionally related_details)." }, "AssociateEmailInvalidDataError": { "additionalProperties": false, "description": "Details about a failed API request.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Detailed error context, including field-specific validation information.", "type": "object" }, "message": { "description": "Human-readable error message describing the issue.", "enum": [ "the related id given seems to be invalid" ], "maxLength": 255, "type": "string" }, "status": { "description": "Error status. Always \"error\".", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "InvalidDataError" }, "AssociateEmailInvalidModuleError": { "additionalProperties": false, "description": "Error response returned when the module name provided in the request path does not exist or is invalid.", "properties": { "code": { "description": "Error code indicating the type of failure. Always INVALID_MODULE for this error.", "enum": [ "INVALID_MODULE" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Details providing additional context about the invalid module error.", "properties": { "resource_path_index": { "description": "The zero-based index position in the resource path where the invalid module name was detected.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable message describing the invalid module error.", "enum": [ "the module name given seems to be invalid" ], "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation. Always \"error\" for this failure.", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "InvalidModuleError" }, "AssociateEmailMandatoryNotFoundError": { "additionalProperties": false, "description": "Error response returned when a required field is missing in the request payload. The Emails array contains per-item error details.", "properties": { "Emails": { "description": "Array of per-email error results indicating which required fields are missing.", "items": { "additionalProperties": false, "description": "Individual error entry for a specific email item.", "properties": { "code": { "description": "Error code indicating the type of validation failure. For example, MANDATORY_NOT_FOUND.", "enum": [ "MANDATORY_NOT_FOUND" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Detailed error context identifying the missing required field.", "properties": { "api_name": { "description": "The API name of the missing required field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "The JSON path of the missing required field in the request payload.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable message describing the validation error.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation. Always \"error\" for validation failures.", "maxLength": 50, "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, "AssociateEmailRequest": { "additionalProperties": false, "description": "Request body for associating an email with a record.", "properties": { "data": { "description": "List of email objects to associate with the record.", "items": { "$ref": "#/components/schemas/EmailObject" }, "maxItems": 50, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" }, "AssociatedFieldUpdateNotAllowedError": { "additionalProperties": false, "description": "Field update deletion is not allowed because it is associated with an automation feature.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Index of the field update entry in the request array that is associated with an automation feature.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "This field update is associated with at least one of Approval Process/Workflow Rules/Blueprint", "This key is not supported for this particular action" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Associated Field Update Not Allowed Error", "type": "object", "x-zs-$id": "AssociatedFieldUpdateNotAllowedError", "x-zs-llm-description": "Cannot delete the field update is associated with an automation feature. Remove the association first." }, "AssociatedModuleReference": { "additionalProperties": false, "description": "Represents a CRM module reference that has at least one webhook associated.", "properties": { "api_name": { "description": "Represents the API name of the CRM module.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique module identifier. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-llm-description": "Reference to a CRM module associated with webhooks. Contains api_name and id." }, "AssociatedModulesResponse": { "additionalProperties": false, "description": "Represents the response listing CRM modules that have at least one webhook associated.", "properties": { "associated_modules": { "description": "Represents the list of module references that have at least one webhook associated.", "items": { "$ref": "#/components/schemas/AssociatedModuleReference" }, "maxItems": 2, "type": "array" } }, "type": "object", "x-zs-$id": "AssociatedModulesResponse", "x-zs-llm-description": "List of CRM modules that have at least one webhook configured. Use to discover which modules have webhook integrations." }, "AssociationResourceModuleDetails": { "additionalProperties": false, "description": "Minimal reference to a module used in association details, containing id and apiName.", "properties": { "api_name": { "description": "The API name of the CRM module.", "maxLength": 255, "type": "string", "x-zs-$id": "AssociationResourceModuleApiName" }, "id": { "description": "The unique ID of the CRM module.", "format": "int64", "type": "string", "x-zs-$id": "AssociationResourceModuleId" } }, "required": [ "api_name", "id" ], "title": "Module Reference", "type": "object" }, "AssociationSchema": { "additionalProperties": false, "description": "List of features in which Assignment Rule is associated.", "properties": { "resources": { "description": "Represents the list of features in which Assignment Rule is associated.", "items": { "$ref": "#/components/schemas/ResourceResponseObject" }, "maxItems": 1, "type": "array" }, "type": { "description": "Represents the type returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" } }, "title": "Generated Schema", "type": "object", "x-zs-$id": "AssociationSchema" }, "AsyncJobDetails": { "additionalProperties": false, "description": "Contains the scheduler job identifier for an asynchronous operation that was accepted for processing.", "properties": { "job_id": { "description": "scheduler jobid", "format": "int64", "maxLength": 20, "minLength": 13, "type": "string" } }, "required": [ "job_id" ], "title": "Asynchronous Job Details", "type": "object" }, "AttachmentListResponse": { "additionalProperties": false, "description": "Response containing list of attachments for a record", "properties": { "data": { "description": "Array of attachment objects", "items": { "$ref": "#/components/schemas/AttachmentObject" }, "maxItems": 1000, "type": "array" }, "info": { "$ref": "#/components/schemas/AttachmentsInfo" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "AttachmentListResponse" }, "AttachmentObject": { "additionalProperties": false, "description": "Individual attachment metadata", "properties": { "$editable": { "description": "Indicates if the attachment is editable", "examples": [ true, false ], "type": "boolean" }, "$field_states": { "description": "Represents the field states metadata", "examples": [ null ], "type": [ "object", "null" ] }, "$file_id": { "description": "Represents the file identifier for the attachment", "examples": [ null, "file123" ], "maxLength": 255, "type": [ "string", "null" ] }, "$link_url": { "description": "Represents the URL for link-type attachments. Null for file attachments.", "examples": [ "https://www.google.com", null ], "format": "uri", "maxLength": 2000, "type": [ "string", "null" ] }, "$se_module": { "description": "Represents the source module name", "examples": [ "Leads", "Contacts", "Accounts" ], "maxLength": 100, "type": "string" }, "$sharing_permission": { "description": "Represents the sharing permission level for the attachment", "examples": [ "full_access", "read_only" ], "maxLength": 50, "type": "string" }, "$state": { "description": "Represents the current state of the attachment", "examples": [ "save" ], "maxLength": 50, "type": "string" }, "$type": { "description": "Represents the type of the attachment. Possible values: `File` for uploaded files, or `Link URL` for URL-based attachments.", "examples": [ "Link URL", "File" ], "maxLength": 50, "type": "string" }, "Created_By": { "additionalProperties": false, "description": "User who created the attachment.", "properties": { "email": { "description": "Represents the user email address", "examples": [ "user@zohocorp.com" ], "format": "email", "maxLength": 100, "type": "string" }, "id": { "description": "User ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs.\n", "examples": [ "2876819000000511001" ], "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the user display name", "examples": [ "John CRM" ], "maxLength": 250, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Created_Time": { "description": "Represents the timestamp when the attachment was created (ISO 8601 with timezone)", "examples": [ "2025-12-11T11:34:53+05:30" ], "format": "date-time", "type": "string" }, "File_Name": { "description": "Represents the name of the attached file", "examples": [ "Q4_Report.pdf" ], "maxLength": 250, "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "User who last modified the attachment.", "properties": { "email": { "description": "Represents the user email address", "examples": [ "user@zohocorp.com" ], "format": "email", "maxLength": 100, "type": "string" }, "id": { "description": "User ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs.\n", "examples": [ "2876819000000511001" ], "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the user display name", "examples": [ "John CRM" ], "maxLength": 250, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Modified_Time": { "description": "Represents the timestamp when the attachment was last modified (ISO 8601 with timezone)", "examples": [ "2025-12-11T11:34:53+05:30" ], "format": "date-time", "type": "string" }, "Owner": { "additionalProperties": false, "description": "Owner of the attachment", "properties": { "email": { "description": "Represents the owner email address", "examples": [ "sangarprasanth.st@zohocorp.com" ], "format": "email", "maxLength": 100, "type": "string" }, "id": { "description": "Owner user ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs.\n", "examples": [ "2167200000000463001" ], "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the owner display name", "examples": [ "sangarprasanth.st sangarprasanth.st" ], "maxLength": 250, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Parent_Id": { "additionalProperties": false, "description": "Parent record information", "properties": { "id": { "description": "Parent record ID. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.\n", "examples": [ "2167200000004094197" ], "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the parent record name", "examples": [ "Rod Alderton" ], "maxLength": 250, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Size": { "description": "Represents the size of the attachment in bytes", "examples": [ "1048576", "0" ], "maxLength": 50000, "pattern": "^[0-9]+$", "type": "string" }, "id": { "description": "Represents the unique numeric identifier of the attachment", "examples": [ "2876819000001935002" ], "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id", "Created_Time", "Created_By", "Modified_Time", "Modified_By" ], "type": "object" }, "AttachmentRef": { "additionalProperties": false, "description": "Reference to an email attachment.", "properties": { "id": { "description": "The attachment ID. Use the [Files API](files.yaml#$.paths./files.get) to retrieve attachment IDs.\n", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "AttachmentSuccessResponse": { "additionalProperties": false, "description": "Successful attachment operation response", "properties": { "data": { "description": "Array of upload results", "items": { "additionalProperties": false, "description": "Upload status details", "properties": { "code": { "description": "Represents the response code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the uploaded attachment", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the user who created the attachment", "properties": { "id": { "description": "User ID. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs.\n", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the user display name", "maxLength": 250, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Created_Time": { "description": "Represents the creation timestamp", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified the attachment", "properties": { "id": { "description": "Represents the user ID", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the user display name", "maxLength": 250, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Modified_Time": { "description": "Represents the last modification timestamp", "format": "date-time", "type": "string" }, "id": { "description": "Represents the attachment identifier", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Modified_By", "Created_By" ], "type": "object" }, "message": { "description": "Represents the success message", "enum": [ "attachment uploaded successfully" ], "type": "string" }, "status": { "description": "Represents the operation status", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "AttachmentSuccessResponse" }, "AttachmentsErrorResponse": { "additionalProperties": false, "description": "Generic error response structure", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_URL_PATTERN", "MANDATORY_NOT_FOUND", "INVALID_DATA", "REQUIRED_PARAM_MISSING", "INVALID_MODULE", "INVALID_TOKEN", "OAUTH_SCOPE_MISMATCH", "RATE_LIMIT_EXCEEDED", "INTERNAL_ERROR", "SERVICE_UNAVAILABLE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details.", "properties": { "param_name": { "description": "Represents the name of the parameter causing the error.", "maxLength": 100, "type": "string" }, "resource_path_index": { "description": "Represents the index of the resource path causing the error", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "the given attachment URL is incorrect", "required field not found", "invalid data provided", "One of the expected parameter is missing", "the related id given seems to be invalid", "the module name given seems to be invalid", "invalid oauth token", "required oauth scope is missing", "the id given seems to be invalid", "API rate limit exceeded. Please retry after some time", "Internal Server Error", "Service temporarily unavailable. Please try again later" ], "type": "string" }, "status": { "description": "Represents the error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ErrorResponse" }, "AttachmentsInfo": { "additionalProperties": false, "description": "Pagination information for list responses", "properties": { "count": { "description": "Represents the number of records returned in the current response", "examples": [ 1 ], "format": "int32", "minimum": 0, "type": "integer" }, "more_records": { "description": "Indicates whether more records are available", "examples": [ false ], "type": "boolean" }, "next_page_token": { "description": "Represents the token to retrieve the next page of results", "examples": [ null, "eyJvZmZzZXQiOjIwMH0" ], "maxLength": 1024, "type": [ "string", "null" ] }, "page": { "description": "Represents the current page number", "examples": [ 1 ], "format": "int32", "minimum": 1, "type": "integer" }, "page_token_expiry": { "description": "Represents the expiry timestamp for the page tokens", "examples": [ null, "2025-12-19T14:30:00+05:30" ], "format": "date-time", "type": [ "string", "null" ] }, "per_page": { "description": "Represents the number of records per page", "examples": [ 200 ], "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" }, "previous_page_token": { "description": "Represents the token to retrieve the previous page of results", "examples": [ null, "eyJvZmZzZXQiOjB9" ], "maxLength": 1024, "type": [ "string", "null" ] } }, "required": [ "per_page", "next_page_token", "count", "page", "previous_page_token", "page_token_expiry", "more_records" ], "type": "object" }, "AuditLogActionEqualCriterion": { "additionalProperties": false, "description": "Match audit log entries whose action equals a single value.", "properties": { "comparator": { "description": "Comparison operator.", "enum": [ "equal" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter on.", "properties": { "api_name": { "description": "API name of the field.", "enum": [ "action" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Action to match.", "enum": [ "added", "updated", "deleted" ], "type": "string" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "AuditLogActionEqualCriterion" }, "AuditLogActionInCriterion": { "additionalProperties": false, "description": "Match audit log entries whose action is one of several values.", "properties": { "comparator": { "description": "Comparison operator.", "enum": [ "in" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter on.", "properties": { "api_name": { "description": "API name of the field.", "enum": [ "action" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Actions to match.", "items": { "description": "Action to match.", "enum": [ "added", "updated", "deleted" ], "type": "string" }, "maxItems": 3, "minItems": 1, "type": "array" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "AuditLogActionInCriterion" }, "AuditLogAuditedTimeBetweenCriterion": { "additionalProperties": false, "description": "Match audit log entries audited within a time range. The range must not exceed 180 days.", "properties": { "comparator": { "description": "Comparison operator.", "enum": [ "between" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter on.", "properties": { "api_name": { "description": "API name of the field.", "enum": [ "audited_time" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Start and end of the range, as exactly two ISO 8601 timestamps.", "items": { "description": "An ISO 8601 timestamp.", "format": "date-time", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "AuditLogAuditedTimeBetweenCriterion" }, "AuditLogCriterion": { "anyOf": [ { "$ref": "#/components/schemas/AuditLogSimpleCriterion" }, { "$ref": "#/components/schemas/AuditLogGroupedCriterion" } ], "description": "Filter criteria for an audit log export job.", "x-zs-$id": "AuditLogCriterion" }, "AuditLogCriterionNullable": { "anyOf": [ { "$ref": "#/components/schemas/AuditLogCriterion" }, { "description": "No criteria were stored for this export job.", "type": "null", "x-zs-$id": "AuditLogCriterionNull" } ], "description": "Filter criteria stored for this export job. Null when the job was created without criteria.", "x-zs-$id": "AuditLogCriterionNullable" }, "AuditLogDoneByEqualCriterion": { "additionalProperties": false, "description": "Match audit log entries performed by a single user.", "properties": { "comparator": { "description": "Comparison operator.", "enum": [ "equal" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter on.", "properties": { "api_name": { "description": "API name of the field.", "enum": [ "done_by" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Exactly one user reference.", "items": { "$ref": "#/components/schemas/AuditLogDoneByValue" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "AuditLogDoneByEqualCriterion" }, "AuditLogDoneByInCriterion": { "additionalProperties": false, "description": "Match audit log entries performed by any of several users.", "properties": { "comparator": { "description": "Comparison operator.", "enum": [ "in" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter on.", "properties": { "api_name": { "description": "API name of the field.", "enum": [ "done_by" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "User references to match.", "items": { "$ref": "#/components/schemas/AuditLogDoneByValue" }, "maxItems": 500, "minItems": 1, "type": "array" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "AuditLogDoneByInCriterion" }, "AuditLogDoneByValue": { "additionalProperties": false, "description": "User reference for the done_by filter.", "properties": { "id": { "description": "Unique identifier of the user.", "maxLength": 64, "type": "string" }, "name": { "description": "Display name of the user.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "AuditLogDoneByValue" }, "AuditLogExportErrorFieldPointer": { "additionalProperties": false, "description": "Pointer to the request field that caused the error.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 64, "type": "string" }, "json_path": { "description": "JSON path of the field within the request body.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "AuditLogExportErrorFieldPointer" }, "AuditLogExportForbiddenResponse": { "additionalProperties": false, "description": "Error returned when the user lacks an administrator profile or the Audit Logs feature is unavailable.", "properties": { "code": { "description": "Error code.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Permissions the current user is missing.", "properties": { "permissions": { "description": "Permissions required to perform this operation.", "items": { "description": "A required permission.", "maxLength": 128, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "AuditLogExportForbiddenResponse" }, "AuditLogGroupedCriterion": { "additionalProperties": false, "description": "A group of filter conditions combined with a logical operator.", "properties": { "group": { "description": "Conditions to combine.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AuditLogSimpleCriterion" }, { "$ref": "#/components/schemas/AuditLogGroupedCriterion" } ], "description": "A condition within the group.", "x-zs-$id": "AuditLogGroupedCriterionItem" }, "maxItems": 2, "minItems": 1, "type": "array" }, "group_operator": { "description": "Logical operator applied between the grouped conditions.", "enum": [ "and" ], "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object", "x-zs-$id": "AuditLogGroupedCriterion" }, "AuditLogModuleEqualCriterion": { "additionalProperties": false, "description": "Match audit log entries belonging to a single module.", "properties": { "comparator": { "description": "Comparison operator.", "enum": [ "equal" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter on.", "properties": { "api_name": { "description": "API name of the field.", "enum": [ "module" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Exactly one module reference.", "items": { "$ref": "#/components/schemas/AuditLogModuleValue" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "AuditLogModuleEqualCriterion" }, "AuditLogModuleInCriterion": { "additionalProperties": false, "description": "Match audit log entries belonging to any of several modules.", "properties": { "comparator": { "description": "Comparison operator.", "enum": [ "in" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter on.", "properties": { "api_name": { "description": "API name of the field.", "enum": [ "module" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Module references to match.", "items": { "$ref": "#/components/schemas/AuditLogModuleValue" }, "maxItems": 500, "minItems": 1, "type": "array" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "AuditLogModuleInCriterion" }, "AuditLogModuleValue": { "additionalProperties": false, "anyOf": [ { "required": [ "api_name" ] }, { "required": [ "id" ] } ], "description": "Module reference. Supply api_name, id, or both.", "properties": { "api_name": { "description": "API name of the module.", "maxLength": 128, "type": "string" }, "id": { "description": "Unique identifier of the module.", "maxLength": 64, "type": "string" } }, "type": "object", "x-zs-$id": "AuditLogModuleValue" }, "AuditLogSimpleCriterion": { "anyOf": [ { "$ref": "#/components/schemas/AuditLogActionEqualCriterion" }, { "$ref": "#/components/schemas/AuditLogActionInCriterion" }, { "$ref": "#/components/schemas/AuditLogModuleEqualCriterion" }, { "$ref": "#/components/schemas/AuditLogModuleInCriterion" }, { "$ref": "#/components/schemas/AuditLogDoneByEqualCriterion" }, { "$ref": "#/components/schemas/AuditLogDoneByInCriterion" }, { "$ref": "#/components/schemas/AuditLogAuditedTimeBetweenCriterion" } ], "description": "A single field-level filter condition.", "x-zs-$id": "AuditLogSimpleCriterion" }, "AuthenticationError": { "additionalProperties": false, "description": "Represents the error response returned when the authentication ticket is invalid or missing.", "properties": { "code": { "description": "Represents the error code for the authentication failure.\nPossible values:\n**AUTHENTICATION_FAILURE** - The authentication ticket is invalid or missing.", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing validation information about the authentication failure.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message for the authentication failure.\nPossible values:\n**Authentication failed** - The provided authentication credentials are invalid or missing.", "enum": [ "Authentication failed" ], "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an authentication error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response", "type": "object", "x-zs-$id": "AuthenticationError" }, "AuthenticationFailureErrorResponse": { "additionalProperties": false, "description": "Error response when authentication token is invalid or missing.", "properties": { "code": { "description": "Error code", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": {}, "type": "object" }, "message": { "description": "Error message", "example": "Authentication failed", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Authentication Failure Error Response", "type": "object", "x-zs-$id": "AuthenticationFailureErrorResponse", "x-zs-llm-description": "Authentication token is invalid, expired, or missing. Refresh the token and retry." }, "AuthorizationDependentMismatchError": { "additionalProperties": false, "description": "Represents the error returned when authentication.type is general but a connection_name is also provided, or when type is connection but connection_name is absent.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**DEPENDENT_MISMATCH** - A required dependent field value does not match the expected configuration.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field that triggered the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field configuration that conflicts with the submitted value, including its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the dependee or conflicting field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependee or conflicting field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**provide appropriate authentication type** - The authentication type configured does not match the expected dependent field configuration.", "enum": [ "provide appropriate authentication type" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AuthorizationDependentMismatchError", "x-zs-llm-description": "Authentication type 'general' conflicts with connection_name, or vice versa. Use only one approach." }, "AuthorizationError": { "additionalProperties": false, "description": "Locked task cannot be edited", "properties": { "code": { "description": "Error code", "enum": [ "AUTHORIZATION_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": {}, "type": "object" }, "message": { "description": "Error message", "example": "Insufficient privileges to perform this operation", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Authorization Error", "type": "object", "x-zs-$id": "AuthorizationError", "x-zs-llm-description": "The task is locked and cannot be edited. Unlock from the parent automation (approval/blueprint) before modifying." }, "AutomationAddMeetingDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for add_meeting action. Creates an Event record when workflow fires. PREREQUISITES: GET /settings/layouts?module=Events for layout + mandatory fields. GET /settings/fields?module=Events for field ids. MANDATORY: module ({api_name: 'Events', id}), layout ({id}), field_mappings (array 1-25, include Event_Title, Start_DateTime), meeting_duration ({unit: int, period: 'hours'|'minutes'} - NOT when All_Day=true), host_unavailable ({assign_record_owner_as_host: true} or {assign_task: {id}}). OPTIONAL: apply_restriction (bool).", "properties": { "apply_restriction": { "default": false, "description": "Whether to enforce assignment-threshold rules (record count limits per user) on the record owner when creating the Event record. When true, the system checks whether the owner has reached their record limit before creating the record. Only effective when the org has assignment thresholds configured.", "type": [ "boolean", "null" ] }, "field_mappings": { "description": "Field mappings for the new Event. Each entry: {\"field\": {\"api_name\": \"Event_Title\"}, \"type\": \"static\", \"value\": \"Meeting\"}. Must include all mandatory fields from GET /settings/layouts?module=Events. Common fields: Event_Title, Start_DateTime, All_Day, Participants (composite type), Remind_At. End_DateTime is auto-computed from Start_DateTime + meeting_duration - do NOT provide it. Mapping types: static - literal values for text, picklist fields; NOT for DateTime/ALARM (DEPENDENT_MISMATCH). merge_field - runtime tokens like ${!Leads.Company} for text-based fields; NOT for lookup/owner (DEPENDENT_MISMATCH). execution_time - REQUIRED for Start_DateTime and Remind_At; sign required for datetime; periods: days, business_days, hours, minutes. When All_Day=true, period must be \"days\" and omit meeting_duration.", "items": { "$ref": "#/components/schemas/AutomationFieldMappings", "description": "Represents a single field-to-value mapping entry for the new Event record, conforming to the AutomationFieldMappings schema. Each entry identifies a target Event field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved DateTime and ALARM fields." }, "maxItems": 25, "minItems": 1, "type": "array" }, "host_unavailable": { "$ref": "#/components/schemas/AutomationHostUnavailable", "description": "Fallback behavior when the designated meeting host is unavailable. Either assign the record owner as host (assign_record_owner_as_host=true) or create a follow-up task (assign_task with a pre-configured task ID). Exactly one option must be specified; providing both returns INVALID_DATA with field1/field2 conflict, providing neither returns EXPECTED_FIELD_MISSING." }, "id": { "description": "Server-generated unique identifier for this add meeting action. Present only in GET responses; not required in POST requests.", "example": "111111000000002418", "maxLength": 20, "type": "string" }, "layout": { "$ref": "#/components/schemas/AutomationLayoutRef", "description": "Layout to use when creating the Event record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module=Events. The layout.id is required." }, "meeting_duration": { "$ref": "#/components/schemas/AutomationMeetingDuration", "description": "Duration of the meeting. Specifies a numeric value and time period (e.g., 1 hour, 30 minutes). Required when All_Day is not set to true in field_mappings. If All_Day is true, meeting_duration must not be provided - the API returns INVALID_DATA with field1/field2 conflict details." }, "module": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Target module for the meeting. Must be the Events module. Provide either api_name (\"Events\") or the Events module id." } }, "required": [ "module", "layout", "field_mappings", "meeting_duration" ], "title": "Automation Add Meeting Details", "type": "object", "x-zs-$id": "AutomationAddMeetingDetails", "x-zs-llm-description": "Details for type='add_meeting'. Creates an Event record. Requires module (Events), layout, field_mappings (must include Event_Title, Start_DateTime), meeting_duration ({unit, period} omit when All_Day=true), host_unavailable (exactly one of: assign_record_owner_as_host=true OR assign_task={id}). Optional: apply_restriction." }, "AutomationAddTagsDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for add_tags action. Adds pre-existing tags to the triggering record. PREREQUISITES: Tags must exist - GET /settings/tags?module={api_name} to list, POST to create first. MANDATORY: tags (array 1-10, each {id, name}). OPTIONAL: over_write (bool, default false - true replaces ALL existing tags), module ({api_name, id}). CONSTRAINTS: Not allowed with convert on Leads (AMBIGUITY_DURING_PROCESSING). over_write=true + remove_tags in same rule = INVALID_DATA. Unsupported: Visits, Users, LinkingModules (NOT_ALLOWED).", "properties": { "id": { "description": "Server-generated unique identifier for this add tags action. Present only in GET responses; not required in POST requests.", "example": "111111000000002440", "maxLength": 20, "type": "string" }, "module": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Target module for the tag action. Must match the workflow rule's trigger module. Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, and custom modules. Unsupported modules (Visits, Users, LinkingModules) return NOT_ALLOWED." }, "over_write": { "default": false, "description": "Whether to overwrite all existing tags on the record with the specified tags (true) or append to existing tags (false). Default is false. When set to true, any RemoveTags action in the same workflow rule becomes invalid and returns INVALID_DATA ('Remove tag not supported with Overwrite Add Tag').", "type": "boolean" }, "tags": { "description": "List of tags to add to the record. All tags must pre-exist in the org - fetch available tags from GET /settings/tags?module={module_api_name}. To create new tags: POST /settings/tags?module={module_api_name}. If the list is empty after parsing, the API returns FAILURE ('Empty Tag'). If the tag count exceeds the edition limit, the API returns FAILURE ('Invalid Tag Count').", "items": { "$ref": "#/components/schemas/AutomationTagRef", "description": "Represents a tag reference, conforming to the AutomationTagRef schema, that identifies a pre-existing org tag to be added to the record. Both id and name are mandatory fields on each entry; the referenced tag must already exist in the org before the action executes." }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "tags" ], "title": "Automation Add Tags Details", "type": "object", "x-zs-$id": "AutomationAddTagsDetails", "x-zs-llm-description": "Details for type='add_tags'. Requires tags array (1-10, each {id, name}). Optional: over_write (true replaces all existing tags), module ({api_name, id}). Cannot coexist with convert on Leads. over_write=true + remove_tags in same rule = INVALID_DATA. Tags must pre-exist discover via getTags or create via POST." }, "AutomationAssignOwnerDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for assign_owner action. Assigns/reassigns record owner via user, role, group, profile, assignment_rule, merge_field, or criteria. MANDATORY: module ({api_name, id} - must match trigger module), assign_to (array 1-5 entries). OPTIONAL: notify (bool), related_records ([{api_name, id}] - Tasks/Calls/Events), apply_assignment_threshold (bool), user_availability_based_on, lookup_field (for cross-module). EXAMPLE: {\"module\": {\"api_name\": \"Leads\", \"id\": \"111111000000000175\"}, \"assign_to\": [{\"type\": \"user\", \"resource\": {\"id\": \"111111000000050001\", \"name\": \"John\"}}], \"notify\": true}", "properties": { "apply_assignment_threshold": { "default": false, "description": "Whether to enforce assignment-threshold rules (record count limits per user) when assigning ownership. When true, the system checks whether the new owner has reached their record limit before applying the assignment. Only effective when the org has assignment thresholds configured.", "type": "boolean" }, "assign_to": { "description": "Specifies how the new owner is determined. Each entry defines an assignment method - a specific user, role, group, assignment rule, profile, merge field, or criteria-based filter. For round-robin assignment across multiple users, provide multiple entries of type=user. For criteria-based assignment, provide a single entry of type=criteria with filter conditions.", "items": { "anyOf": [ { "$ref": "#/components/schemas/AutomationAssignToResourceEntry" }, { "$ref": "#/components/schemas/AutomationAssignToMergeFieldEntry" }, { "$ref": "#/components/schemas/AutomationAssignToCriteriaEntry" } ], "description": "Represents a single owner-assignment entry that determines how the new record owner is resolved. Each entry is one of three variants: AutomationAssignToResourceEntry (assigns ownership to a specific user, role, group, assignment rule, or profile), AutomationAssignToMergeFieldEntry (resolves the owner at runtime from a user-type lookup field on the trigger record), or AutomationAssignToCriteriaEntry (determines the owner by evaluating filter criteria at runtime)." }, "maxItems": 5, "minItems": 1, "type": "array" }, "id": { "description": "Server-generated unique identifier for this assign owner action. Present only in GET responses; not required in POST or PUT requests.", "example": "111111000000002412", "maxLength": 20, "type": "string" }, "lookup_field": { "$ref": "#/components/schemas/AutomationLookupFieldRef", "description": "The lookup field linking the trigger module to the target module. Required only for cross-module assign owner actions (where the action's module differs from the workflow rule's trigger module). For same-module assignments, this field is omitted and the action operates directly on the triggering record." }, "module": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Target module for the ownership assignment. Must match the workflow rule's trigger module for direct assignments, or the lookup field's related module for cross-module assignments. At least api_name or id must be provided; if both are given and they do not match, the API returns AMBIGUITY_DURING_PROCESSING." }, "notify": { "default": false, "description": "Whether to send an email notification to the new owner when the record is reassigned. When true, the newly assigned owner receives an email informing them of the ownership change.", "type": "boolean" }, "related_records": { "description": "Related modules whose open record ownership should also be transferred when the parent record is reassigned. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional modules depend on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Null when no related modules are selected for ownership transfer.", "items": { "$ref": "#/components/schemas/AutomationRelatedRecord" }, "maxItems": 5, "type": [ "array", "null" ] }, "user_availability_based_on": { "description": "Restricts assignment to users who are currently available. When set to [\"online_status\"], only users logged in to the Zoho CRM web interface are eligible for assignment. If the selected user is offline, the assignment is skipped or deferred. Null means no availability check is applied.", "items": { "description": "Availability criterion. Currently only \"online_status\" is supported - restricts to users currently logged in to Zoho CRM web interface.", "enum": [ "online_status" ], "type": "string" }, "maxItems": 1, "type": [ "array", "null" ] } }, "required": [ "module", "assign_to" ], "title": "Automation Assign Owner Details", "type": "object", "x-zs-$id": "AutomationAssignOwnerDetails", "x-zs-llm-description": "Details for type='assign_owner'. assign_to array (1-5 entries) discriminates on type field: user/role/group/profile/assignment_rule require resource.id; merge_field requires details.api_name (user-type lookup field); criteria requires a criteria array evaluated at runtime. Optional: notify (bool), related_records (transfer child ownership), apply_assignment_threshold (bool). Module reference required." }, "AutomationAssignOwnerResource": { "additionalProperties": false, "description": "PURPOSE: Resource reference for assign_to entry. MANDATORY: id (string). OPTIONAL: name, type. Obtain from GET /settings/users (user), /settings/roles (role), /settings/user_groups (group), /settings/automation/assignment_rules (assignment_rule), /settings/profiles (profile). If both id and name given, must match (AMBIGUITY_DURING_PROCESSING).", "properties": { "id": { "description": "Unique identifier of the target entity. Obtain from the corresponding API: GET /settings/users (for user), GET /settings/roles (for role), GET /settings/user_groups (for group), GET /settings/automation/assignment_rules (for assignment_rule), or GET /settings/profiles (for profile).", "example": "111111000000053889", "maxLength": 255, "type": "string" }, "name": { "description": "Display name of the target entity. Optional in POST/PUT requests (server resolves from id); always present in GET responses.", "example": "Sri", "maxLength": 255, "type": "string" }, "type": { "description": "Type of the target entity. Present in GET responses; not required in POST/PUT requests.", "enum": [ "user", "role", "group", "assignment_rule", "profile" ], "type": "string" } }, "required": [ "id" ], "title": "Assign Owner Resource", "type": "object", "x-zs-$id": "AutomationAssignOwnerResource", "x-zs-llm-description": "Resource reference within an assign_to entry. id is mandatory (DEPENDENT_FIELD_MISSING if absent). name is optional (server resolves from id). type indicates resource kind when present. Obtain IDs from: getUsers (user), getRoles (role), getUserGroups (group), getAssignmentRules (assignment_rule), getProfiles (profile)." }, "AutomationAssignToCriteriaEntry": { "additionalProperties": false, "description": "PURPOSE: assign_to entry for criteria-based ownership. Evaluates filter criteria against the triggering record at execution time. MANDATORY: type (const 'criteria'), details.criteria (filter condition - simple or grouped with AND/OR). Criteria fields must reference valid trigger module fields - GET /settings/fields?module={api_name}.", "properties": { "allow_agent_user": { "default": false, "description": "Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule.", "type": "boolean" }, "details": { "additionalProperties": false, "description": "Contains the filter criteria to evaluate against the triggering record.", "properties": { "criteria": { "$ref": "#/components/schemas/FilterCriterionRequest", "description": "Filter criteria defining when this assignment applies. Can be a simple condition (field + comparator + value) or a grouped condition (group_operator + group array). The field references in criteria must be valid fields of the trigger module - fetch available fields from GET /settings/fields?module={module_api_name}. For example: {\"field\": {\"api_name\": \"Department\"}, \"comparator\": \"equal\", \"value\": \"Engineering\"} assigns ownership when the record's Department is Engineering." } }, "required": [ "criteria" ], "type": "object" }, "resource": { "description": "Always null for criteria-based assignments. The owner is determined by the criteria evaluation logic.", "type": "null" }, "type": { "const": "criteria", "description": "Assignment method indicating criteria-based evaluation.", "type": "string" } }, "required": [ "type", "details" ], "title": "Assign To Criteria Entry", "type": "object", "x-zs-$id": "AutomationAssignToCriteriaEntry", "x-zs-llm-description": "assign_to entry where ownership is determined by evaluating filter criteria at runtime. type must be 'criteria'. criteria array defines the conditions the first user matching all criteria becomes the owner. If no user matches, the action silently skips assignment." }, "AutomationAssignToMergeFieldEntry": { "additionalProperties": false, "description": "PURPOSE: assign_to entry for merge-field-based ownership. Resolves to a user at execution time from a user-type field. MANDATORY: type (const 'merge_field'), details.api_name (merge field token e.g., '${!Leads.Created_By}'). Field must be data_type=ownerlookup or userlookup. GET /settings/fields?module={api_name} to discover.", "properties": { "allow_agent_user": { "default": false, "description": "Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule.", "type": "boolean" }, "details": { "additionalProperties": false, "description": "Contains the merge field reference that resolves to a user at execution time.", "properties": { "api_name": { "description": "Merge field token referencing a user-type field. Must use the format ${!Module.User_Field} ,${!Module.Lookup_Field_API_Name.User_Field} where Field is a user-type field (data_type=ownerlookup or userlookup) from the trigger module. Fetch valid fields from GET /settings/fields?module={module_api_name}. Common user-type fields: Owner, Created_By, Modified_By. Examples: ${!Leads.Created_By}, ${!Deals.Owner}, ${!Contacts.Account_Manager}.", "example": "${!Leads.Created_By}", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "resource": { "description": "Always null for merge field assignments. The owner is resolved dynamically from the merge field at execution time.", "type": "null" }, "type": { "const": "merge_field", "description": "Assignment method indicating merge field resolution.", "type": "string" } }, "required": [ "type", "details" ], "title": "Assign To Merge Field Entry", "type": "object", "x-zs-$id": "AutomationAssignToMergeFieldEntry", "x-zs-llm-description": "assign_to entry where ownership resolves at runtime from a user-type lookup field on the trigger record. type must be 'merge_field'. details.api_name specifies the field (e.g., a custom user lookup). The field must be a user-type field non-user fields return INVALID_DATA." }, "AutomationAssignToResourceEntry": { "additionalProperties": false, "description": "PURPOSE: assign_to entry for resource-based ownership. MANDATORY: type (user|role|group|assignment_rule|profile), resource ({id, name}). For type=profile: associated_to must be 'team_profile'. For round-robin: use multiple entries of type=user.", "properties": { "allow_agent_user": { "default": false, "description": "Whether to allow assignment to an agent user or not. When true, the record can be assigned to an agent user also. When false, agent users are excluded from assignment. Applicable only for types: role, group, profile, merge_field, criteria. Not supported for types user and assignment_rule.", "type": "boolean" }, "associated_to": { "description": "Association context for profile-based assignment. Must be \"team_profile\" when type=profile. Not applicable for other assignment types; if provided for a non-profile type, the API returns DEPENDENT_MISMATCH.", "enum": [ "team_profile", null ], "type": [ "string", "null" ] }, "details": { "description": "Always null for resource-based assignments. Present in GET responses for schema consistency with other assign_to types.", "type": "null" }, "resource": { "$ref": "#/components/schemas/AutomationAssignOwnerResource", "description": "Identifies the target user, role, group, assignment rule, or profile by ID and/or name. At least one of id or name must be provided; if both are given and they do not match, the API returns AMBIGUITY_DURING_PROCESSING." }, "type": { "description": "Assignment method. Determines what kind of entity receives ownership. Values: \"user\" - assign to a specific CRM user (GET /settings/users), for round-robin include multiple assign_to entries of type=user; \"role\" - assign to a user holding the specified role (GET /settings/roles), system picks an eligible user at execution time; \"group\" - assign to a member of the specified user group (GET /settings/user_groups); \"assignment_rule\" - assign using a pre-configured assignment rule (GET /settings/automation/assignment_rules), the rule's criteria and round-robin logic determine the final owner; \"profile\" - assign to a user matching the specified profile (GET /settings/profiles), must include associated_to=team_profile.", "enum": [ "user", "role", "group", "assignment_rule", "profile" ], "type": "string" } }, "required": [ "type", "resource" ], "title": "Assign To Resource Entry", "type": "object", "x-zs-$id": "AutomationAssignToResourceEntry", "x-zs-llm-description": "assign_to entry where ownership is assigned to a specific resource. type selects the resource kind: user, role, group, assignment_rule, or profile. resource object provides the target's id and optionally name. For profile type: associated_to must be 'team_profile'. Returns DEPENDENT_FIELD_MISSING if resource is omitted." }, "AutomationChatNotificationDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for chat notification actions (slack/cliq/cisco/google_chat/microsoft_teams_notifications). Sends a message to a channel, user, or field-based recipient. Limit: 1 per type per rule. MANDATORY: message (string, supports ${Module.Field} merge fields), notify_to (object with type: 'user'|'channel'|'fields'). For user/channel: provide id + name. For fields: provide module + notify_fields.fields array. EXAMPLE: {\"message\": \"New deal ${Deals.Deal_Name}\", \"notify_to\": {\"type\": \"channel\", \"id\": \"C0123\", \"name\": \"#sales\"}}", "properties": { "id": { "description": "Read-only. Unique identifier for the action, returned in GET responses.", "maxLength": 20, "type": "string" }, "message": { "description": "REQUIRED. Notification message body. Supports merge fields in ${Module.Field} format (e.g., \"New deal ${Deals.Deal_Name} created by ${Deals.Owner}!\").", "maxLength": 5000, "type": "string" }, "notify_to": { "additionalProperties": false, "description": "REQUIRED. Notification target - a channel, user, or field-based recipient.", "properties": { "id": { "description": "Required for user/channel types. The integration-specific user or channel ID.", "maxLength": 255, "type": "string" }, "module": { "additionalProperties": false, "description": "Required for type='fields'. The CRM module to resolve field values from. Use GET /settings/modules to discover api_name and id.", "properties": { "api_name": { "description": "Module API name.", "maxLength": 255, "type": "string" }, "id": { "description": "Module ID.", "format": "int64", "type": "string" } }, "type": "object" }, "name": { "description": "Required for user/channel types. Display name of the user or channel (e.g., '#sales-alerts').", "maxLength": 255, "type": "string" }, "notify_fields": { "additionalProperties": false, "description": "Required for type='fields'. Field references to resolve notification recipients.", "properties": { "fields": { "description": "Array of field references. Each must have api_name and optionally id. If both given, cross-validated for consistency (AMBIGUITY_DUE_TO if mismatch).", "items": { "additionalProperties": false, "description": "A field reference with api_name and optional id.", "properties": { "api_name": { "description": "Field API name. Use GET /settings/fields?module={api_name} to discover.", "maxLength": 255, "type": "string" }, "id": { "description": "Field ID.", "format": "int64", "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" }, "static_fields": { "description": "Array of static field references.", "items": { "additionalProperties": false, "description": "A static field reference with api_name and optional id.", "properties": { "api_name": { "description": "Static field API name.", "maxLength": 255, "type": "string" }, "id": { "description": "Static field ID.", "format": "int64", "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "type": { "description": "Target type. 'user' - send to a specific chat user. 'channel' - send to a chat channel. 'fields' - send to users resolved from CRM field values.", "enum": [ "user", "channel", "fields" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "required": [ "message", "notify_to" ], "type": "object", "x-zs-$id": "AutomationChatNotificationDetails", "x-zs-llm-description": "Details for chat notification actions (type=slack_notifications|cliq_notifications|cisco_notifications|google_chat_notifications|microsoft_teams_notifications). Requires message (string, supports ${Module.Field} merge tokens) and notify_to ({type: user|channel|fields}). For user/channel: provide id + name. For fields: provide module + notify_fields.fields array. Limit 1 per chat type per rule." }, "AutomationCircuitsDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for circuits action. Executes a Zoho Circuits workflow. Limit: 1/rule. MANDATORY: circuit_id (string). EXAMPLE: {\"circuit_id\": \"7389640000001234\"}", "properties": { "circuit_id": { "description": "REQUIRED. Zoho Circuits circuit ID.", "maxLength": 255, "type": "string" }, "id": { "description": "Read-only. Unique identifier for the action.", "maxLength": 20, "type": "string" } }, "required": [ "circuit_id" ], "type": "object", "x-zs-$id": "AutomationCircuitsDetails", "x-zs-llm-description": "Details for type='circuits'. Executes a Zoho Circuits workflow. Requires circuit_id (string the Circuits workflow identifier). Limit 1/rule. Verify 'circuits' is enabled via getWorkflowConfigurations before using." }, "AutomationConvertChangeOwner": { "additionalProperties": false, "description": "PURPOSE: Owner assignment during convert action. MANDATORY: id (user ID from GET /users). OPTIONAL: name, related_modules ([{api_name, id}] - which converted modules get new owner), apply_assignment_threshold (bool). For Leads: related_modules can include Events, Calls, Tasks, Contacts, Deals.", "properties": { "apply_assignment_threshold": { "default": false, "description": "Whether to enforce assignment-threshold rules (record count limits per user) on the new owner for each converted module. When true, the system checks whether the new owner has reached their record limit before assigning ownership.", "type": "boolean" }, "id": { "description": "Unique user ID of the new owner. Obtain from GET /users. Must be an active user with permissions on the target modules.", "example": "111111000000002005", "maxLength": 20, "type": "string" }, "name": { "description": "Full name of the new owner. Optional - present in GET responses for display purposes.", "example": "Patricia Boyle", "maxLength": 255, "type": "string" }, "related_modules": { "description": "List of target modules whose records should receive the new owner during conversion. Reuses the same related-record concept as assign_owner. For Leads conversion: Events, Calls, Tasks, Contacts, Deals are valid. For Quotes/SalesOrders conversion: only Events, Calls, Tasks are valid.", "items": { "$ref": "#/components/schemas/AutomationRelatedRecord", "description": "Represents a related module reference, conforming to the AutomationRelatedRecord schema, that identifies a child module whose records should also receive the new owner assignment during the conversion operation. At least one of api_name or id is required to identify the child module." }, "maxItems": 10, "type": "array" } }, "required": [ "id" ], "title": "Automation Convert Change Owner", "type": "object", "x-zs-$id": "AutomationConvertChangeOwner", "x-zs-llm-description": "Owner configuration during convert action. id (user ID) is mandatory specifies who receives ownership of converted records. Optional: name, related_modules (which converted childmodules get new owner e.g., Events, Calls, Tasks for Leads), apply_assignment_threshold (enforce per-user record limits). Obtain user ID from getUsers." }, "AutomationConvertDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for convert action. Converts records - Leads to Contacts+Accounts+Deals, Quotes to SalesOrders/Invoices, SalesOrders to Invoices. PREREQUISITES: criteria_details.criteria MUST be non-null (NOT_ALLOWED otherwise). Module MUST be Leads/Quotes/Sales_Orders. MANDATORY (Leads): add_to_existing_contact (bool), add_to_existing_account (bool). MANDATORY (Quotes/Sales_Orders): convert_to ({api_name, id}). OPTIONAL: change_owner, carry_tags (ARRAY [{api_name, id}] NOT boolean), field_mappings (max 25), move_attachment_to, create_deal (Leads only), contact_role (with create_deal). CONSTRAINTS: No add_tags/remove_tags with convert on Leads. No scheduled actions with convert.", "properties": { "add_to_existing_account": { "default": false, "description": "MANDATORY for Leads conversion (omitting returns MANDATORY_NOT_FOUND). Whether to link the converted record to an existing Account instead of creating a new one. Only applicable for Leads module. When true, if a matching Account exists (based on Company name), the Lead is linked to it rather than creating a new Account. Not applicable for Quotes or Sales_Orders conversions.", "type": "boolean" }, "add_to_existing_contact": { "default": false, "description": "MANDATORY for Leads conversion (omitting returns MANDATORY_NOT_FOUND). Whether to link the converted record to an existing Contact instead of creating a new one. Only applicable for Leads module. When true, if a matching Contact exists (based on duplicate-check criteria), the Lead is merged into it rather than creating a new Contact. Not applicable for Quotes or Sales_Orders conversions.", "type": "boolean" }, "apply_restriction": { "default": false, "description": "Whether to enforce assignment-threshold rules on the record owner during conversion. Present in GET responses.", "type": [ "boolean", "null" ] }, "carry_tags": { "description": "List of target modules that should inherit tags from the source record during conversion. For Leads: may include Contacts, Accounts, Deals. Each entry identifies a module by api_name and/or id.", "items": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Represents a module reference, conforming to the AutomationModuleRef schema, that identifies a target module whose records should inherit tags from the source record during conversion. At least one of api_name or id is required to identify the module; valid values are obtainable from GET /settings/modules." }, "maxItems": 10, "type": "array" }, "change_owner": { "$ref": "#/components/schemas/AutomationConvertChangeOwner", "description": "New owner assignment for the converted records. Specifies the user (by id) who should own the converted records, which modules should receive the new owner (via related_modules), and whether to enforce assignment thresholds. When omitted, the source record's owner is retained." }, "contact_role": { "description": "Unique ID of the Contact Role to assign when a Deal is created during Leads conversion. Only applicable when create_deal=true. Obtain valid Contact Role IDs from GET /Contacts/roles.", "example": "111111000000002174", "maxLength": 20, "type": "string" }, "convert_to": { "additionalProperties": false, "description": "MANDATORY for Quotes and Sales_Orders conversion (omitting returns MANDATORY_NOT_FOUND). Identifies the target module for conversion as an object with api_name and id. For Quotes: convert_to can be {api_name: 'SalesOrders', id: ''} or {api_name: 'Invoices', id: ''}. For Sales_Orders: convert_to must be {api_name: 'Invoices', id: ''}. Obtain the module id from GET /settings/modules. Not applicable for Leads conversion (Leads always convert to Contacts+Accounts, optionally +Deals).", "properties": { "api_name": { "description": "API name of the target module. For Quotes: 'SalesOrders' or 'Invoices'. For Sales_Orders: 'Invoices'.", "example": "SalesOrders", "maxLength": 50, "type": "string" }, "id": { "description": "Unique 19-digit module ID of the target module. Obtain from GET /settings/modules. Always use the full 19-digit ID as returned by the API; truncated IDs cause INVALID_DATA.", "example": "1189654000000000109", "maxLength": 20, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "create_deal": { "default": false, "description": "Whether to create a Deal record as part of Leads conversion. Only applicable when the trigger module is Leads. When true, the Deal module field mappings in field_mappings are used to populate the new Deal.", "type": "boolean" }, "field_mappings": { "description": "List of field-value pairs to populate in the converted record(s). Each entry maps a target field to a value using one of the supported types: static, merge_field, or execution_time. For Leads conversion, field mappings can target Contacts, Accounts, and Deals modules. Fetch available fields from GET /settings/fields?module={target_module_api_name}.", "items": { "$ref": "#/components/schemas/AutomationFieldMappings", "description": "Represents a single field-to-value mapping entry for the converted record, conforming to the AutomationFieldMappings schema. Each entry identifies the target field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved values." }, "maxItems": 25, "type": "array" }, "id": { "description": "Server-generated unique identifier for this convert action. Present only in GET responses; not required in POST requests.", "example": "111111000000002430", "maxLength": 20, "type": "string" }, "move_attachment_to": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Target module to which attachments from the source record should be moved during conversion. For Leads: typically Contacts or Accounts. For Quotes/SalesOrders: the target conversion module. Provide api_name and/or id." }, "portal_user_type": { "additionalProperties": false, "description": "Portal user type to assign during Leads conversion. Only applicable when the org has portals configured and the converted Contact should be provisioned as a portal user. The id and name must match an existing portal user type - validated against the org's portal metadata (CrmClientPortalFilterUtil). Not applicable for Quotes or Sales_Orders conversions.", "properties": { "id": { "description": "Unique identifier of the portal user type. Must match an existing portal user type in the org's portal configuration.", "example": "1189654000000007039", "maxLength": 20, "type": "string" }, "name": { "description": "Display name of the portal user type.", "example": "Standard", "maxLength": 100, "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "title": "Automation Convert Details", "type": "object", "x-zs-$id": "AutomationConvertDetails", "x-zs-llm-description": "Details for type='convert'. Converts records across modules (Leads→Contacts+Accounts+Deals, Quotes→SalesOrders/Invoices, SalesOrders→Invoices). Limit 1/rule. For Leads: add_to_existing_contact, add_to_existing_account, change_owner mandatory. For Quotes/SalesOrders: convert_to required. Optional: create_deal, carry_tags (array not boolean), field_mappings, move_attachment_to, contact_role. No scheduled actions allowed alongside convert." }, "AutomationCreateConnectedRecordDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for create_connected_record action. Same as create_record but module must be a connected-record child of the rule's module. Requires ManageAutomation or ManageConnectedWorkflow permission. Not for Notes, Rebuy, Competitor Mentions. Limit: 1/rule. MANDATORY: module ({api_name, id} of child), layout ({id}), field_mappings (array 1-25, include all mandatory fields). OPTIONAL: apply_restriction (bool).", "properties": { "apply_restriction": { "description": "Apply assignment/workflow restrictions. Default true.", "type": "boolean" }, "field_mappings": { "description": "REQUIRED. Field mapping array (1-25 entries). Use GET /settings/fields?module={api_name} to discover field api_name and id. All mandatory fields for the target module/layout must be included.", "items": { "$ref": "#/components/schemas/AutomationFieldMappings", "description": "Represents a single field-to-value mapping entry for the new connected record, conforming to the AutomationFieldMappings schema. Each entry identifies a target field via its api_name and id, and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, execution_time for dynamically resolved values, or composite for compound values." }, "maxItems": 25, "type": "array" }, "id": { "description": "Read-only. Unique identifier for the action.", "maxLength": 20, "type": "string" }, "layout": { "$ref": "#/components/schemas/AutomationLayoutRef", "description": "Represents a layout reference, conforming to the AutomationLayoutRef schema, that determines which layout is applied when creating the connected record. The id field is mandatory and governs which fields are available and required for the target module; valid layout identifiers are obtainable from GET /settings/layouts?module={api_name}." }, "module": { "additionalProperties": false, "description": "REQUIRED. Target child module for connected record creation. Must be a valid connected-record child module of the rule's module. Use GET /settings/modules to discover api_name and id.", "properties": { "api_name": { "description": "Module API name.", "maxLength": 255, "type": "string" }, "id": { "description": "Module ID.", "format": "int64", "type": "string" } }, "required": [ "api_name" ], "type": "object" } }, "required": [ "module", "layout", "field_mappings" ], "type": "object", "x-zs-$id": "AutomationCreateConnectedRecordDetails", "x-zs-llm-description": "Details for type='create_connected_record'. Same structure as create_record but module must be a connected-record child. Requires module, layout, field_mappings. Not for Notes, Rebuy, or Competitor Mentions. Requires ManageAutomation or ManageConnectedWorkflow permission. Limit 1/rule." }, "AutomationCreateRecordDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for create_record action. Creates a record in a module with field values from static data, merge fields, or execution-time refs. NOT for Tasks/Events/Calls (use tasks, add_meeting, schedule_call). PREREQUISITES: GET /settings/modules for id. GET /settings/layouts?module={api_name} for layout + mandatory fields. GET /settings/fields?module={api_name} for field ids. MANDATORY: module ({api_name, id}), layout ({id}), field_mappings (array 1-25, include all mandatory fields). OPTIONAL: apply_restriction (bool). EXAMPLE: {\"module\": {\"api_name\": \"Contacts\", \"id\": \"111111000000000129\"}, \"layout\": {\"id\": \"111111000000000403\"}, \"field_mappings\": [{\"field\": {\"api_name\": \"Last_Name\"}, \"type\": \"merge_field\", \"value\": \"${!Leads.Last_Name}\"}]}", "properties": { "apply_restriction": { "default": false, "description": "Whether to enforce assignment-threshold rules (record count limits per user) on the record owner when creating the record. When true, the system checks whether the owner has reached their record limit before creating the record. Only effective when the org has assignment thresholds configured.", "type": [ "boolean", "null" ] }, "field_mappings": { "description": "Field mappings for the new record. Each entry: {\"field\": {\"api_name\": \"Last_Name\"}, \"type\": \"static\", \"value\": \"Test\"}. Must include all mandatory fields (system_mandatory=true or api_mandatory=true from GET /settings/layouts?module={module}) - missing ones cause REQUIRED_DATA_NOT_FOUND. Mapping types: static - literal values for text, picklist, phone, number fields; NOT for Date/DateTime/ALARM (DEPENDENT_MISMATCH) or unique fields (INVALID_DATA, check unique=true in GET /settings/fields). merge_field - runtime tokens like ${!Leads.Company} for text-based fields; NOT for lookup/owner fields (DEPENDENT_MISMATCH). execution_time - REQUIRED for Date/DateTime/ALARM fields; periods: days, business_days, hours, minutes; sign required for datetime fields.", "items": { "$ref": "#/components/schemas/AutomationFieldMappings", "description": "Represents a single field-to-value mapping entry for the new record, conforming to the AutomationFieldMappings schema. Each entry identifies the target field via a field reference and specifies the value resolution strategy through a type discriminator: static for literal values, merge_field for runtime token substitution, execution_time for dynamically resolved values, or composite for compound values." }, "maxItems": 25, "minItems": 1, "type": "array" }, "id": { "description": "Server-generated unique identifier for this create record action. Present only in GET responses; not required in POST requests.", "example": "111111000000002415", "maxLength": 20, "type": "string" }, "layout": { "$ref": "#/components/schemas/AutomationLayoutRef", "description": "Layout to use when creating the record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module={module_api_name}. The layout.id is required." }, "module": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Target module in which the new record will be created. Supported modules: Leads, Contacts, Potentials (Deals), Accounts, Products, Cases, custom modules, and team modules. NOT supported: Tasks, Events, Calls - use add_meeting for Events and schedule_call for Calls. Fetch available modules from GET /settings/modules. At least api_name or id must be provided; always use the full 19-digit module ID as returned by the modules API." } }, "required": [ "module", "layout", "field_mappings" ], "title": "Automation Create Record Details", "type": "object", "x-zs-$id": "AutomationCreateRecordDetails", "x-zs-llm-description": "Details for type='create_record'. Creates a record in a module (NOT Tasks/Events/Calls use dedicated action types). Requires module ({api_name, id}), layout ({id}), field_mappings (1-25 entries covering all mandatory fields). Each mapping has field reference, type (static|merge_field|execution_time|composite), and typed value. Optional: apply_restriction (bool)." }, "AutomationCreatedByResponse": { "additionalProperties": false, "description": "Represents the CRM user who created the webhook.", "properties": { "id": { "description": "Represents the unique identifier of the user who created the webhook. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who created the webhook.", "maxLength": 255, "type": "string" } }, "title": "Automation Created By Response", "type": "object", "x-zs-llm-description": "Read-only audit field showing who created this webhook." }, "AutomationEmailCreateRecordDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for create_record_email action. Creates a record via email for Leads or Contacts only. Limit: 1/rule. MANDATORY: module ({api_name: 'Leads'|'Contacts'}), field_mappings (exactly 1 entry with field + value for owner assignment). value.type: 'user'|'role'|'group'|'country'. Errors: no_data if empty, too_many_records if >1.", "properties": { "field_mappings": { "description": "REQUIRED. Exactly 1 field mapping entry. More than 1 returns too_many_records, none returns no_data.", "items": { "additionalProperties": false, "description": "A field-to-value mapping entry for email-based record creation.", "properties": { "field": { "additionalProperties": false, "description": "Field reference. Use GET /settings/fields?module={api_name} to discover.", "properties": { "api_name": { "description": "Field API name.", "maxLength": 255, "type": "string" }, "id": { "description": "Field ID.", "format": "int64", "type": "string" } }, "type": "object" }, "value": { "additionalProperties": false, "description": "Owner assignment details.", "properties": { "resource": { "additionalProperties": false, "description": "Assignment target reference.", "properties": { "id": { "description": "Resource ID.", "format": "int64", "type": "string" } }, "type": "object" }, "type": { "description": "Owner assignment type.", "enum": [ "user", "role", "group", "country" ], "type": "string" } }, "required": [ "type" ], "type": "object" } }, "required": [ "field", "value" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" }, "id": { "description": "Read-only. Unique identifier for the action.", "maxLength": 20, "type": "string" }, "module": { "additionalProperties": false, "description": "REQUIRED. Target module - only 'Leads' or 'Contacts' allowed.", "properties": { "api_name": { "description": "Module API name. Must be 'Leads' or 'Contacts'.", "enum": [ "Leads", "Contacts" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" } }, "required": [ "module", "field_mappings" ], "type": "object", "x-zs-$id": "AutomationEmailCreateRecordDetails", "x-zs-llm-description": "Details for type='create_record_email'. Creates a Leads or Contacts record via email. Requires module ({api_name} must be 'Leads' or 'Contacts') and field_mappings (exactly 1 entry for owner assignment: field={api_name, id}, value={type: user|role|group|country, resource: {id}}). Limit 1/rule." }, "AutomationFieldAttributes": { "additionalProperties": false, "description": "Identifies the target CRM field to which a mapping value is applied within an automation rule. The api_name and ID properties must both be supplied and must refer to the same field; a mismatch between the two causes an AMBIGUITY_DURING_PROCESSING error. Available fields for a given module can be discovered via GET /settings/fields?module={api_name}.", "properties": { "api_name": { "description": "Represents the API name of the target field in the destination module — for example, Subject, Due_Date, or Owner — used to identify the field receiving the mapped value within automation actions such as workflow tasks, create_record, and convert.", "example": "Subject", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the numeric identifier of the target CRM field. Used in conjunction with the field's API name, both of which must resolve to the same field for a mapping to be valid.", "example": "111111000000003529", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "title": "Automation Field Attributes", "type": "object", "x-zs-$id": "AutomationFieldAttributes", "x-zs-llm-description": "Target field identifier. Both api_name and id are mandatory providing only one still works but both should be given for reliability. If both provided and they refer to different fields: AMBIGUITY_DURING_PROCESSING. Obtain from getFields?module={module_api_name}. The field must be writable and compatible with mapping type." }, "AutomationFieldMappingDependentFieldMissingError": { "additionalProperties": false, "description": "Returned when a required sub-property is absent from an execution_time value object. This error occurs when type is set to execution_time but one or more of its dependent properties — such as period or unit — are not included in the submitted value payload.", "properties": { "code": { "description": "Identifies the error code for the condition in which a field mapping is rejected because a required dependent field is absent from the automation action payload.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured diagnostic information that identifies the absent dependent field and the field whose value or presence governs the dependency relationship.", "properties": { "api_name": { "description": "Indicates the API name of the dependent field that was expected but not found in the automation action payload, such as a unit or period qualifier associated with another field's value.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the field whose presence or selected value establishes a requirement for the missing or mismatched dependent field, providing context for resolving the dependency violation.", "properties": { "api_name": { "description": "Indicates the API name of the field that drives the dependency requirement, such as a type selector or a nested field identifier, enabling callers to locate the governing field within the automation mapping.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Indicates the path within the automation action request body that resolves to the dependee field, allowing callers to locate its exact position in the payload structure.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Indicates the path within the automation action request body pointing to the location where the absent dependent field was expected to appear.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Provides a descriptive explanation of the dependent-field-missing error, describing which field was absent and the context in which it was required.", "example": "Dependent Field missing", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the top-level outcome classification of the error response when a dependent field is absent from the automation field mapping payload.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Field Mapping Dependent Field Missing Error", "type": "object", "x-zs-$id": "AutomationFieldMappingDependentFieldMissingError", "x-zs-llm-description": "Error code: DEPENDENT_FIELD_MISSING. A required sub-field is missing in an execution_time value. Common: period, unit, or trigger_field absent when type=execution_time. Fix: provide all required execution_time value fields." }, "AutomationFieldMappingExpectedFieldMissingError": { "additionalProperties": false, "description": "Represents a validation error returned by the API when a field_mapping entry omits the field object entirely or provides a field object that contains neither api_name nor ID, leaving the target field unresolvable.", "properties": { "code": { "description": "Identifies the error code for the condition in which one or more expected field identifiers are absent from the request payload.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the structured breakdown of expected field identifiers that were absent from the request payload, enabling precise identification of which fields were anticipated but not received.", "properties": { "expected_fields": { "description": "A collection of field identifier objects, each representing an anticipated field — referenced by its api_name, ID, or both — that was not present in the submitted request.", "items": { "additionalProperties": false, "description": "Represents a single anticipated field identifier, pairing the identifier name with its precise JSON path location within the request payload where the value was expected to appear.", "properties": { "api_name": { "description": "Specifies the name of the field identifier that was expected, such as api_name or ID, indicating which identifier type was looked up during field resolution.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Provides the JSON path that pinpoints the exact location within the request payload where the missing identifier was expected to reside.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Provides a descriptive explanation of the expected-field-missing error, summarising why the operation could not be completed due to absent field identifiers.", "example": "Specify atleast one field", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the top-level outcome classification of the error response when expected field identifiers are absent from the request payload.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Field Mapping Expected Field Missing Error", "type": "object", "x-zs-$id": "AutomationFieldMappingExpectedFieldMissingError", "x-zs-llm-description": "Error code: EXPECTED_FIELD_MISSING. The field object in a mapping entry exists but contains neither api_name nor id. Fix: provide at least one field identifier. Different from MANDATORY_NOT_FOUND where the field object itself is absent." }, "AutomationFieldMappingRequiredDataNotFoundError": { "additionalProperties": false, "description": "Represents a validation error returned by the API when a field that the target module requires (such as Subject for Tasks) is absent from the field_mappings array. The details.value property identifies the missing field, and details.sub_json_path indicates the nested property path used to locate it.", "properties": { "code": { "description": "Identifies the error code for the condition in which required data is absent from the field_mappings payload.", "enum": [ "REQUIRED_DATA_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Supplies contextual information that pinpoints the specific field entry absent from the field_mappings collection, enabling precise identification of the missing data.", "properties": { "api_name": { "description": "Denotes the property name context, such as api_name, associated with the field entry where required data was not found in field_mappings.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Specifies the JSON path pointing to the position within the field_mappings array where the expected entry was not found.", "maxLength": 1000, "type": "string" }, "sub_json_path": { "description": "Indicates the nested property path, such as field.api_name, that further narrows the location of the missing field within the field_mappings structure.", "maxLength": 255, "type": "string" }, "value": { "description": "Holds the api_name of the field that was expected but not found in field_mappings, such as Subject for Tasks, enabling callers to identify exactly which field requires attention.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Provides a descriptive explanation of the error returned when required data is not found within the field_mappings payload.", "example": "The required data missing", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the top-level outcome classification of the error response when required data is absent from the field_mappings payload.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Field Mapping Required Data Not Found Error", "type": "object", "x-zs-$id": "AutomationFieldMappingRequiredDataNotFoundError", "x-zs-llm-description": "Error code: REQUIRED_DATA_NOT_FOUND. A mandatory field of the target module is not included in field_mappings. Common: Subject missing for Tasks, Event_Title missing for Events, Last_Name missing for Contacts. Fix: include all mandatory module fields in the field_mappings array." }, "AutomationFieldMappings": { "anyOf": [ { "$ref": "#/components/schemas/StaticFieldMapping" }, { "$ref": "#/components/schemas/MergeFieldMapping" }, { "$ref": "#/components/schemas/ExecutionTimeFieldMapping" }, { "$ref": "#/components/schemas/CompositeFieldMapping" } ], "description": "Represents a single field-to-value mapping used within automation actions such as workflow tasks, create_record, add_meeting, and schedule_call. Each mapping identifies a target field via api_name or ID, declares a type discriminator that determines value interpretation, and supplies a value whose shape varies by type: static supplies a literal value, merge_field supplies a runtime-resolved token string, execution_time supplies a date or datetime offset object, and composite supplies structured participant data for the Events Participants field. The field_mappings array must include all fields the target module requires; omitting any produces a REQUIRED_DATA_NOT_FOUND error.", "discriminator": { "mapping": { "composite": "#/components/schemas/CompositeFieldMapping", "execution_time": "#/components/schemas/ExecutionTimeFieldMapping", "merge_field": "#/components/schemas/MergeFieldMapping", "static": "#/components/schemas/StaticFieldMapping" }, "propertyName": "type" }, "title": "Automation Field Mappings", "x-zs-$id": "AutomationFieldMappings", "x-zs-llm-description": "A single field-to-value mapping entry used in create_record, add_meeting, schedule_call, convert, and workflow task actions. Each entry targets one field and assigns a typed value. The type field discriminates the value structure: static (literal), merge_field (runtime token), execution_time (date offset), composite (multi-value). field identifies the target, type selects the value schema, value provides the data." }, "AutomationHostUnavailable": { "additionalProperties": false, "description": "PURPOSE: Fallback when meeting host or caller is unavailable. Exactly ONE must be specified: assign_record_owner_as_host (bool) OR assign_task ({id}). Both = INVALID_DATA. Neither = EXPECTED_FIELD_MISSING.", "properties": { "assign_record_owner_as_host": { "description": "When true, the record owner is automatically assigned as the host/caller if the originally designated host is unavailable. Mutually exclusive with assign_task.", "type": "boolean" }, "assign_task": { "additionalProperties": false, "description": "A follow-up task to create when the host is unavailable. Mutually exclusive with assign_record_owner_as_host. The task must be pre-configured in the CRM.", "properties": { "id": { "description": "Unique ID of the pre-configured task.", "maxLength": 20, "type": "string" }, "name": { "description": "Name of the follow-up task.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": [ "object", "null" ] } }, "title": "Automation Host Unavailable", "type": "object", "x-zs-$id": "AutomationHostUnavailable", "x-zs-llm-description": "Fallback config when the meeting host or caller is unavailable. Exactly ONE option must be set: assign_record_owner_as_host (bool record owner becomes host) OR assign_task ({id} delegates to an existing task entity). Setting both or neither returns INVALID_DATA." }, "AutomationLayoutRef": { "additionalProperties": false, "description": "PURPOSE: Layout reference for create_record, add_meeting, schedule_call actions. MANDATORY: id (string). Determines field availability and validation rules. GET /settings/layouts?module={api_name} to discover.", "properties": { "display_label": { "description": "Human-readable label of the layout. Present in GET responses.", "example": "Standard", "maxLength": 50, "type": "string" }, "id": { "description": "Unique layout ID. Required. Obtain from GET /settings/layouts?module={module_api_name}.", "example": "111111000000000167", "maxLength": 20, "type": "string" }, "name": { "description": "Display name of the layout. Optional in requests; present in GET responses.", "example": "Standard", "maxLength": 50, "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "Automation Layout Reference", "type": "object", "x-zs-$id": "AutomationLayoutRef", "x-zs-llm-description": "Layout reference for create_record, add_meeting, schedule_call. id is mandatory determines which fields are available and required for the target module. Obtain from getLayouts?module={api_name}. Wrong layout returns INVALID_DATA." }, "AutomationLockStatusResponse": { "additionalProperties": false, "description": "Represents the lock status of the webhook. Locked webhooks cannot be edited or deleted.", "properties": { "locked": { "description": "Indicates whether the webhook is currently locked. Locked webhooks cannot be edited or deleted.\nPossible values:\n**true** - The webhook is locked.\n**false** - The webhook is not locked.", "type": "boolean" }, "message": { "description": "Represents the reason the webhook is locked. Returns null when the webhook is not locked.", "maxLength": 255, "type": [ "string", "null" ] } }, "title": "Automation Lock Status Response", "type": "object", "x-zs-llm-description": "Lock status. Locked webhooks cannot be edited or deleted typically locked by an active process." }, "AutomationLookupFieldRef": { "additionalProperties": false, "description": "Identifies a lookup field that links the workflow rule's trigger module to the target module of a cross-module action. For example, if the trigger module is Leads and the assign owner action targets Contacts, the lookup_field identifies which lookup field on Leads points to Contacts (e.g., Lookup_2_cont).", "minProperties": 1, "properties": { "api_name": { "description": "API name of the lookup field (e.g., Lookup_1_same, Lookup_2_cont).", "example": "Lookup_1_same", "maxLength": 255, "type": "string" }, "id": { "description": "Unique field ID of the lookup field.", "example": "111111000000070986", "maxLength": 20, "type": "string" } }, "title": "Automation Lookup Field Reference", "type": "object", "x-zs-$id": "AutomationLookupFieldRef", "x-zs-llm-description": "Identifies a lookup field linking the rule's trigger module to an action's target module. Required for cross-module field_updates (via related_details.lookup_field) and cross-module assign_owner (when targeting a different module). Both api_name and id should refer to the same lookup field mismatch returns AMBIGUITY_DURING_PROCESSING. Obtain from getFields filtered by field_type=lookup." }, "AutomationMeetingDuration": { "additionalProperties": false, "description": "PURPOSE: Meeting duration for add_meeting. MANDATORY unless All_Day=true. REQUIRED: unit (integer - quantity), period (string - 'hours' or 'minutes'). Must be a JSON object (not int/string - INVALID_DATA). Omitting returns MANDATORY_NOT_FOUND. If All_Day=true and provided, returns INVALID_DATA (field1/field2 conflict). EXAMPLE: {\"unit\": 1, \"period\": \"hours\"}", "properties": { "period": { "description": "The time unit for the duration. \"hours\" - duration in hours (e.g., unit=1, period=hours means a 1-hour meeting). \"minutes\" - duration in minutes (e.g., unit=30, period=minutes means a 30-minute meeting).", "enum": [ "hours", "minutes" ], "example": "hours", "maxLength": 10, "type": "string" }, "unit": { "description": "The numeric duration value (e.g., 1, 2, 30).", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "unit", "period" ], "title": "Automation Meeting Duration", "type": "object", "x-zs-$id": "AutomationMeetingDuration", "x-zs-llm-description": "Duration config for add_meeting. Required when All_Day is not true. unit is the quantity (integer), period is the time unit ('hours', 'minutes', or 'days'). Omit entirely when mapping All_Day=true (DEPENDENT_MISMATCH if both present)." }, "AutomationModifiedByResponse": { "additionalProperties": false, "description": "Represents the CRM user who last modified the webhook.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified the webhook. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who last modified the webhook.", "maxLength": 255, "type": "string" } }, "title": "Automation Modified By Response", "type": "object", "x-zs-llm-description": "Read-only audit field showing who last modified this webhook." }, "AutomationModuleDetailsResponse": { "additionalProperties": false, "description": "Represents the CRM module reference identifying the parent module associated with a webhook.", "properties": { "api_name": { "description": "Represents the API name of the CRM module (for example, Leads, Contacts, Deals).", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "title": "Automation Module Details Response", "type": "object", "x-zs-llm-description": "The parent CRM module this webhook monitors for trigger events." }, "AutomationModuleRef": { "additionalProperties": false, "description": "PURPOSE: Module reference used across non-associate actions. At least one of api_name or id required (EXPECTED_FIELD_MISSING if neither). If both given, must match (AMBIGUITY_DURING_PROCESSING). GET /settings/modules to discover. Always use full 19-digit module ID.", "minProperties": 1, "properties": { "api_name": { "description": "API name of the module (e.g., Leads, Contacts, Deals, Vendors).", "example": "Leads", "maxLength": 255, "type": "string" }, "id": { "description": "Unique module ID (19-digit format). Always use the full ID as returned by GET /settings/modules - truncated or shortened IDs return INVALID_DATA ('the tabId given seems to be invalid'). Optional in requests if api_name is provided; always present in responses.", "example": "1189654000000000037", "maxLength": 20, "type": "string" } }, "title": "Automation Module Reference", "type": "object", "x-zs-$id": "AutomationModuleRef", "x-zs-llm-description": "Module reference for action targeting. At least one of api_name or id required EXPECTED_FIELD_MISSING if neither is present. If both provided and they refer to different modules AMBIGUITY_DURING_PROCESSING. Obtain from getModules. Used in most non-associate action details to specify where the action operates." }, "AutomationRelatedRecord": { "additionalProperties": false, "description": "Identifies a related module whose open records' ownership should be transferred alongside the parent record. Used by assign_owner actions, field_updates (Owner field), and convert actions (change_owner.related_modules). Common activity modules (Tasks, Calls, Events) are available for all modules and actions. Contacts is available for assign_owner when parent is Accounts, and for convert when converting Leads. Deals is available for assign_owner when parent is Accounts or Contacts, and for convert when converting Leads (requires create_deal=true).", "properties": { "api_name": { "description": "API name of the related module. Events, Calls, Tasks - open activity records, available for all modules and actions (assign_owner, convert). Contacts - available for assign_owner when parent is Accounts, and for convert when converting Leads. Deals - available for assign_owner when parent is Accounts or Contacts, and for convert when converting Leads (requires create_deal=true).", "enum": [ "Events", "Calls", "Tasks", "Contacts", "Deals" ], "example": "Events", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the related module. This is the module ID corresponding to the api_name.", "example": "3361265000000000145", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "title": "Automation Related Record", "type": "object", "x-zs-$id": "AutomationRelatedRecord", "x-zs-llm-description": "Identifies a related module whose open records should also change ownership when the parent record's owner changes. Used by assign_owner (related_records array) and convert (change_owner.related_modules). Requires api_name and/or id to identify the child module. Valid modules depend on parent: for Leads Events, Calls, Tasks, Contacts, Deals." }, "AutomationRemoveTagsDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for remove_tags action. Removes tags from the triggering record. PREREQUISITES: Tags must exist - GET /settings/tags?module={api_name} to list. MANDATORY: tags (array 1-10, each {id, name}). OPTIONAL: module ({api_name, id}). CONSTRAINTS: Not allowed with convert on Leads (AMBIGUITY_DURING_PROCESSING). If same rule has add_tags with over_write=true, this returns INVALID_DATA. Unsupported: Visits, Users, LinkingModules (NOT_ALLOWED). Note: over_write field is type-checked but its value is ignored for remove_tags.", "properties": { "id": { "description": "Server-generated unique identifier for this remove tags action. Present only in GET responses; not required in POST or PUT requests.", "example": "111111000000002443", "maxLength": 20, "type": "string" }, "module": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Target module for the tag action. Must match the workflow rule's trigger module. Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, and custom modules. Unsupported modules (Visits, Users, LinkingModules) return NOT_ALLOWED." }, "over_write": { "default": false, "description": "Present in GET responses. Its value is ignored for remove_tags actions.", "type": "boolean" }, "tags": { "description": "List of tags to remove from the record. All tags must pre-exist in the org - fetch available tags from GET /settings/tags?module={module_api_name}. If the list is empty after parsing, the API returns FAILURE ('Empty Tag'). If the tag count exceeds the edition limit, the API returns FAILURE ('Invalid Tag Count').", "items": { "$ref": "#/components/schemas/AutomationTagRef", "description": "Represents a tag reference, conforming to the AutomationTagRef schema, that identifies a pre-existing org tag to be removed from the record. Both id and name are mandatory fields on each entry; the referenced tag must already exist in the org before the action executes." }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "tags" ], "title": "Automation Remove Tags Details", "type": "object", "x-zs-$id": "AutomationRemoveTagsDetails", "x-zs-llm-description": "Details for type='remove_tags'. Requires tags array (1-10, each {id, name}). Optional: module ({api_name, id}). Cannot coexist with convert on Leads. Invalid if same rule has add_tags with over_write=true. Tags must already exist on the record for removal to have effect." }, "AutomationScheduleCallDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for schedule_call action. Creates a Call record when workflow fires. PREREQUISITES: GET /settings/layouts?module=Calls for layout + mandatory fields. GET /settings/fields?module=Calls for field ids. MANDATORY: module ({api_name: 'Calls', id}), layout ({id}), field_mappings (array 1-25, include Subject, Call_Type). OPTIONAL: apply_restriction (bool). KEY FIELDS: Subject, Call_Type ('Outbound'|'Inbound'|'Missed'), Call_Purpose, Call_Start_Time, Remind_At.", "properties": { "apply_restriction": { "default": false, "description": "Whether to enforce assignment-threshold rules (record count limits per user) on the record owner when creating the Call record. When true, the system checks whether the owner has reached their record limit before creating the record. Only effective when the org has assignment thresholds configured.", "type": [ "boolean", "null" ] }, "field_mappings": { "description": "Field mappings for the new Call. Each entry: {\"field\": {\"api_name\": \"Subject\"}, \"type\": \"static\", \"value\": \"Follow-up\"}. Must include all mandatory fields from GET /settings/layouts?module=Calls. Call_Type is system-mandatory (values: \"Outbound\", \"Inbound\", \"Missed\") - omitting returns REQUIRED_DATA_NOT_FOUND. Common fields: Subject, Call_Type, Call_Purpose, Call_Start_Time, Remind_At. Mapping types: static - literal values for text, picklist fields; NOT for DateTime/ALARM (DEPENDENT_MISMATCH). merge_field - runtime tokens like ${!Leads.Phone} for text-based fields; NOT for lookup/owner (DEPENDENT_MISMATCH). execution_time - REQUIRED for Call_Start_Time and Remind_At; sign required for datetime; periods: days, business_days, hours, minutes.", "items": { "$ref": "#/components/schemas/AutomationFieldMappings", "description": "Represents a single field-to-value mapping entry for the new Call record, conforming to the AutomationFieldMappings schema. Each entry identifies a target Call field and specifies the value resolution strategy: static for literal values, merge_field for runtime token substitution, or execution_time for dynamically resolved DateTime and ALARM fields." }, "maxItems": 25, "minItems": 1, "type": "array" }, "id": { "description": "Server-generated unique identifier for this schedule call action. Present only in GET responses; not required in POST requests.", "example": "111111000000002421", "maxLength": 20, "type": "string" }, "layout": { "$ref": "#/components/schemas/AutomationLayoutRef", "description": "Layout to use when creating the Call record. Determines which fields are available and their validation rules. Fetch valid layouts from GET /settings/layouts?module=Calls. The layout.id is required." }, "module": { "$ref": "#/components/schemas/AutomationModuleRef", "description": "Target module for the call. Must be the Calls module. Provide either api_name (\"Calls\") or the Calls module id." } }, "required": [ "module", "layout", "field_mappings" ], "title": "Automation Schedule Call Details", "type": "object", "x-zs-$id": "AutomationScheduleCallDetails", "x-zs-llm-description": "Details for type='schedule_call'. Creates a Calls record. Requires module (Calls), layout, field_mappings (must include Subject). Key fields: Subject, Call_Purpose, Call_Type, Call_Start_Time, Remind_At. Same field_mapping structure as create_record. Optional: apply_restriction." }, "AutomationSocialDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for social actions (Facebook/Twitter). Available only with fb_*/tw_* triggers. Limit: 1 per type per rule. content is REQUIRED for comment_to_post, reply_to_comment, reply_to_message, reply_to_tweet. NOT required for like_to_comment, retweet. Supports ${Module.Field} merge fields. EXAMPLE: {\"content\": \"Thanks ${Leads.Full_Name}!\"}", "properties": { "content": { "description": "Message content. Supports merge fields in ${Module.Field} format. REQUIRED for: comment_to_post, reply_to_comment, reply_to_message, reply_to_tweet. NOT required for: like_to_comment, retweet (details can be empty).", "maxLength": 5000, "type": "string" }, "id": { "description": "Read-only. Unique identifier for the action.", "maxLength": 20, "type": "string" } }, "type": "object", "x-zs-$id": "AutomationSocialDetails", "x-zs-llm-description": "Details for social actions (Facebook: comment_to_post, reply_to_comment, like_to_comment, reply_to_message; Twitter: retweet, reply_to_tweet). content (string with ${Module.Field} merge tokens) required for comment/reply types, not needed for like/retweet. Available only with matching social triggers." }, "AutomationTagRef": { "additionalProperties": false, "description": "PURPOSE: Tag reference for add_tags/remove_tags. Tags must pre-exist - GET /settings/tags?module={api_name} to list, POST to create. MANDATORY: id, name. Both must resolve to same tag (AMBIGUITY_DURING_PROCESSING if mismatch). Non-existent = INVALID_DATA. Limits: 100 tags/module, 10 tags/record, name max 25 chars.", "properties": { "color_code": { "description": "Hex color code of the tag (e.g., '#879BFC'). Optional in requests; present in GET responses. Allowed values: #F17574, #F48435, #E7A826, #A8C026, #63C57E, #1DB9B4, #57B1FD, #879BFC, #D297EE, #FD87BD, #969696, #658BA8, #B88562.", "example": "#879BFC", "maxLength": 25, "type": "string" }, "id": { "description": "Unique identifier of the tag. Obtain from GET /settings/tags?module={module_api_name}. If provided alone, the tag is resolved by ID. If both id and name are provided, they must resolve to the same tag.", "example": "3361265000001715141", "maxLength": 20, "type": "string" }, "name": { "description": "Name of the tag. Obtain from GET /settings/tags?module={module_api_name}. If provided alone, the tag is resolved by name. Must match an existing tag - providing a non-existent name returns INVALID_DATA. Max 25 characters, cannot contain <, >, commas, or emojis.", "example": "criteria", "maxLength": 25, "type": "string" } }, "required": [ "id", "name" ], "title": "Automation Tag Reference", "type": "object", "x-zs-$id": "AutomationTagRef", "x-zs-llm-description": "Tag reference for add_tags/remove_tags. Both id and name are mandatory missing either returns MANDATORY_NOT_FOUND. Tags must pre-exist. Discover via getTags?module={api_name}, create via POST /settings/tags. Invalid tag id returns INVALID_DATA." }, "AutomationUsageDataEntry": { "additionalProperties": false, "description": "Represents a single daily usage data point capturing the execution count for an automation action. When the group_by parameter includes resource, the embedded resource object identifies the individual email notification or webhook. When group_by is date only, the resource object is omitted and the count reflects total executions across all actions for that day. The type field indicates the automation feature responsible for the executions, such as workflow_rules, approval_process, or Blueprint.\n", "properties": { "count": { "description": "Represents the number of times the automation action was executed on this date. When the group_by parameter is set to 'date' only, this value reflects the total across all actions.", "format": "int32", "minimum": 0, "type": "integer" }, "date": { "description": "Represents the date of this usage data point in YYYY-MM-DD format. All dates are evaluated in the organization's time zone.", "example": "2025-10-23", "format": "date", "maxLength": 10, "type": "string" }, "resource": { "$ref": "#/components/schemas/AutomationUsageResource", "description": "Reference to the specific automation action (email notification or webhook) that generated the usage count. Only present when group_by includes 'resource'." }, "type": { "description": "Represents the automation feature type associated with the reported executions. Values correspond to the filter types supported by the type query parameter, such as workflow_rules, approval_process, Blueprint, email_notifications, webhooks, and kiosks.\n", "maxLength": 50, "type": "string" } }, "title": "Automation Usage Data Entry", "type": "object", "x-zs-$id": "AutomationUsageDataEntry" }, "AutomationUsageInvalidDataError": { "additionalProperties": false, "description": "Represents the error envelope returned when an invalid value is supplied for a usage report query parameter. The details object identifies which parameter is invalid. Common causes include an unsupported type filter value, an invalid group_by combination, a malformed date, an invalid sort_order, or a non-numeric page or per_page value.", "properties": { "code": { "description": "Represents the error code identifying the invalid-data condition.\nPossible values:\nINVALID_DATA - The value supplied for the identified query parameter is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains details about the query parameter that failed validation.\n", "properties": { "param_name": { "description": "Represents the name of the query parameter that carried the invalid value, such as type, group_by, date, sort_order, page, or per_page.", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Represents a descriptive message explaining the error that caused the request to fail.\n", "example": "provided param is invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the outcome classification of the response.\nPossible values:\nerror - The request was not processed due to invalid input.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Automation Usage Invalid Data Error", "type": "object", "x-zs-$id": "AutomationUsageInvalidDataError" }, "AutomationUsageNoPermissionError": { "additionalProperties": false, "description": "Represents the error structure returned when the authenticated user lacks the required Manage Automation Actions privilege, or when the requested feature — email notifications or webhooks — is not available in the organization's current edition.\n", "properties": { "code": { "description": "Represents the error code identifying the permission-denied condition.\nPossible values:\nNO_PERMISSION - The user lacks the required privilege or the feature is unavailable in the current edition.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains details about the missing permission or unavailable feature that caused the error.", "properties": { "permissions": { "description": "Contains the list of required permissions that the caller lacks and that prevented the request from succeeding.", "items": { "description": "Represents a permission identifier denoting a specific access right required to perform the requested operation.", "maxLength": 255, "type": "string" }, "maxItems": 5, "type": "array" } }, "type": "object" }, "message": { "description": "Represents a descriptive message explaining the error that caused the request to fail.\n", "example": "permission denied", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the outcome classification of the response.\nPossible values:\nerror - The request was denied due to insufficient permission.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Automation Usage No Permission Error", "type": "object", "x-zs-$id": "AutomationUsageNoPermissionError" }, "AutomationUsagePaginationInfo": { "additionalProperties": false, "description": "Represents pagination metadata returned with automation usage report responses. Includes a max_limit value that reflects the edition-specific daily execution cap for the relevant action type, derived from the organization's feature limits.", "properties": { "count": { "description": "Represents the number of records included in the current page of results.", "example": 4, "format": "int32", "minimum": 0, "type": "integer" }, "max_limit": { "description": "Represents the edition-specific daily execution cap for the automation action type. For email notifications, this reflects the WORKFLOWALERT day limit; for webhooks, it reflects the WFWEBHOOK day limit. Lower-tier editions carry smaller caps.", "example": 2500, "format": "int32", "minimum": 0, "type": "integer" }, "more_records": { "description": "Indicates whether additional pages of results are available beyond the current page.\nPossible values:\ntrue - More records exist beyond the current page.\nfalse - The current page contains the last records.", "example": false, "type": "boolean" }, "page": { "description": "Represents the one-based index of the current page within the paginated result set.", "example": 1, "format": "int32", "minimum": 1, "type": "integer" }, "per_page": { "description": "Represents the number of records returned in each page of the result set.", "example": 200, "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" } }, "title": "Automation Usage Pagination Info", "type": "object", "x-zs-$id": "AutomationUsagePaginationInfo" }, "AutomationUsageReportResponse": { "additionalProperties": false, "description": "Represents a successful response from an automation usage report endpoint. Contains an array of daily usage data points alongside pagination metadata that includes the edition-specific daily execution cap. When no usage exists for the queried period, the endpoint returns an empty data array rather than null, and the response resolves with HTTP 200.\n", "properties": { "data_usage": { "description": "Contains the collection of usage data points for the queried period. Each entry represents the execution count for a specific automation action on a given date. Returns an empty array when no usage exists for the queried period.", "items": { "$ref": "#/components/schemas/AutomationUsageDataEntry" }, "maxItems": 200, "type": "array" }, "info": { "$ref": "#/components/schemas/AutomationUsagePaginationInfo", "description": "Pagination metadata including the edition-specific daily execution cap." } }, "title": "Automation Usage Report Response", "type": "object", "x-zs-$id": "AutomationUsageReportResponse" }, "AutomationUsageRequiredParamMissingError": { "additionalProperties": false, "description": "Represents the error structure returned when the group_by query parameter is omitted from the request. All automation usage report endpoints require group_by to be present and to include date as a mandatory grouping dimension.\n", "properties": { "code": { "description": "Indicates the error classification for a missing required parameter.\nPossible values:\nREQUIRED_PARAM_MISSING - A mandatory query parameter was omitted from the request.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains details about the missing request parameter that caused the error.\n", "properties": { "param_name": { "description": "Indicates the name of the required parameter that was absent from the request.\nPossible values:\ngroup_by - The group_by parameter was not included in the request.", "enum": [ "group_by" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents a descriptive message explaining the error that caused the request to fail.\n", "example": "One of the expected param is missing", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the outcome classification of the response.\nPossible values:\nerror - The request was not processed due to a missing required parameter.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Automation Usage Required Param Missing Error", "type": "object", "x-zs-$id": "AutomationUsageRequiredParamMissingError" }, "AutomationUsageResource": { "additionalProperties": false, "description": "Represents a reference to the specific automation action that generated usage. The identifier and name are resolved from the action's configuration record; for deleted actions, the name falls back to the corresponding automation audit log entry. When the include_inner_details parameter includes resource.layout_id and the action is associated with a wizard layout, a layout_id field is included in the representation.\n", "properties": { "id": { "description": "Represents the unique identifier of the automation action, such as an email notification ID or a webhook ID.", "example": "5586800000123001", "maxLength": 20, "type": "string" }, "layout_id": { "description": "Represents the identifier of the wizard layout associated with the automation action. Present only when the include_inner_details query parameter is set to resource.layout_id and the action is linked to a wizard layout.", "example": "738964000000100045", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the automation action. Falls back to the name recorded in the automation audit log when the action has been deleted.\n", "example": "Notify Deal Owner", "maxLength": 255, "type": "string" } }, "title": "Automation Usage Resource", "type": "object", "x-zs-$id": "AutomationUsageResource" }, "AutomationWebhooksResponse": { "additionalProperties": false, "description": "Represents the full webhook object returned by the list and get-by-ID operations, including all configuration fields, audit metadata, and status indicators.", "properties": { "associated": { "description": "Indicates whether this webhook is currently associated with at least one active Workflow Rule, Approval Process, or Blueprint.\nPossible values:\n**true** - The webhook is associated with at least one automation rule.\n**false** - The webhook is not associated with any automation rule.", "type": "boolean" }, "authentication": { "$ref": "#/components/schemas/WebhookAuthenticationDetails", "description": "Specify authentication details for the webhook endpoint. (Required)" }, "body": { "$ref": "#/components/schemas/WebhookRequestBody", "description": "Define the data that Zoho CRM sends in the body of the webhook request. This is applicable only for POST and PUT HTTP methods" }, "created_by": { "$ref": "#/components/schemas/AutomationCreatedByResponse", "description": "The CRM user who created this webhook." }, "created_time": { "description": "Represents the ISO 8601 timestamp of when the webhook was created.", "maxLength": 255, "type": "string" }, "date_time_format": { "$ref": "#/components/schemas/DateTimeFormatConfig", "description": "Date and time formatting configuration for this webhook's payloads. Null when no date/datetime merge-fields are used.", "type": [ "object", "null" ] }, "deletable": { "description": "Indicates whether the current user can delete this webhook. Returns false for marketplace and extension-created webhooks.\nPossible values:\n**true** - The webhook can be deleted.\n**false** - The webhook cannot be deleted.", "type": "boolean" }, "description": { "description": "Represents the optional user-provided description of the webhook purpose. Returns null when no description has been set.", "maxLength": 255, "type": [ "string", "null" ] }, "editable": { "description": "Indicates whether the current user can edit this webhook. Returns false for marketplace and extension-created webhooks.\nPossible values:\n**true** - The webhook can be edited.\n**false** - The webhook cannot be edited.", "type": "boolean" }, "feature_type": { "description": "Represents the automation feature type this webhook belongs to.\nPossible values:\n**workflow** - Workflow Rule.\n**approval_process** - Approval Process.\n**blueprint** - Blueprint.\n**kiosk** - Kiosk feature.\n**commandcenter_service** - CommandCenter service.", "maxLength": 255, "type": "string" }, "headers": { "$ref": "#/components/schemas/WebhookHeaders", "description": "Headers let you send extra information along with the webhook request. For example, API keys, authentication tokens, or custom values that the external application needs." }, "http_method": { "description": "Represents the HTTP method used when the webhook fires.\nPossible values:\n**GET** - Sends a GET request to the webhook URL.\n**POST** - Sends a POST request to the webhook URL.\n**PUT** - Sends a PUT request to the webhook URL.\n**DELETE** - Sends a DELETE request to the webhook URL.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the webhook.", "maxLength": 20, "type": "string", "x-zs-$id": "WebhooksId" }, "lock_status": { "$ref": "#/components/schemas/AutomationLockStatusResponse", "description": "Lock status of the webhook. Locked webhooks cannot be edited or deleted." }, "modified_by": { "$ref": "#/components/schemas/AutomationModifiedByResponse", "description": "The CRM user who last modified this webhook." }, "modified_time": { "description": "Represents the ISO 8601 timestamp of when the webhook was last modified.", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/AutomationModuleDetailsResponse", "description": "The parent CRM module that this webhook monitors for trigger events." }, "name": { "description": "Represents the display name of the webhook.", "maxLength": 50, "type": "string" }, "related_module": { "$ref": "#/components/schemas/RelatedModuleReference", "description": "The child or dependent CRM module linked to this webhook's parent module. Null when no related module is configured.", "type": [ "object", "null" ] }, "source": { "description": "Represents the origin of the webhook. Returns null for legacy webhooks.\nPossible values:\n**user** - Created by a CRM user.\n**crm** - Created by the CRM system.\n**extension** - Created by a Marketplace extension.", "maxLength": 255, "type": [ "string", "null" ] }, "url": { "description": "Represents the destination URL that Zoho CRM sends the webhook request to when triggered.", "maxLength": 255, "type": "string" }, "url_parameters": { "$ref": "#/components/schemas/WebhookUrlParameters", "description": "URL parameters for GET/DELETE webhook HTTP methods. Null when http_method is POST or PUT.", "type": [ "object", "null" ] } }, "required": [ "feature_type", "http_method", "module", "name", "url" ], "title": "Automation Webhooks Response", "type": "object", "x-zs-llm-description": "Full webhook object from GET list. Contains module, headers, body, url_params, authentication, and audit metadata." }, "AutomationZohoFlowDetails": { "additionalProperties": false, "description": "PURPOSE: Details object for flow action. Triggers a Zoho Flow custom action. Limit: 1/rule. Fetch values from `getCustomActions` (filter service_type='zoho_flow', component_type='workflow'): use response `id` as custom_action_id, `action_name` as custom_action_name. MANDATORY: custom_action_id (string), custom_action_name (string). EXAMPLE: {\"custom_action_id\": \"4839491000001566002\", \"custom_action_name\": \"Sync to ERP\"}", "properties": { "custom_action_id": { "description": "REQUIRED. Zoho Flow custom action ID. Value = `id` from `getCustomActions` response.", "format": "int64", "type": "string" }, "custom_action_name": { "description": "REQUIRED. Display name of the Zoho Flow action. Value = `action_name` from `getCustomActions` response.", "maxLength": 255, "type": "string" }, "id": { "description": "Read-only. Unique identifier for the action.", "maxLength": 20, "type": "string" } }, "required": [ "custom_action_id", "custom_action_name" ], "type": "object", "x-zs-$id": "AutomationZohoFlowDetails", "x-zs-llm-description": "Details for type='flow'. Triggers a Zoho Flow custom action. Requires custom_action_id and custom_action_name (obtain from getCustomActions filtered by service_type='zoho_flow', component_type='workflow'). Limit 1/rule. Verify 'flow' is enabled via getWorkflowConfigurations." }, "AvailableDatesInHolidayOrNonBusinessDayError": { "additionalProperties": false, "description": "Error response returned when an Available_Dates entry falls on a holiday or a non-business day.", "properties": { "code": { "description": "Represents the error code returned when available dates fall on a holiday or non-business day.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing additional context about the invalid availability date configuration.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field for which the validation failed.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the available dates fall on a holiday or outside business days.", "enum": [ "Available Dates value in holiday or Not in BusinessDays" ], "type": "string" }, "status": { "description": "Represents the status of the response, indicating that an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "AvailableDatesInHolidayOrNonBusinessDayError" }, "AvailableDaysNotInBusinessDaysError": { "additionalProperties": false, "description": "Error response returned when the Available_Days list contains a day that is not configured as a business day.", "properties": { "code": { "description": "Represents the error code returned when the available days are not within the configured business days.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field for which the validation failed.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the given available days are not within the configured business days.", "enum": [ "The given Available Days are not there in business days" ], "type": "string" }, "status": { "description": "Represents the status of the response, indicating that an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "AvailableDaysNotInBusinessDaysError" }, "AvailableStatusUnavailableFromFutureError": { "additionalProperties": false, "description": "Error response returned when the service Status is Available but Unavailable_From key's value is not later than the current date.", "properties": { "code": { "description": "Represents the error code returned when the Unavailable From date does not meet the required future date condition while the service status is available.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field for which the validation failed.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the Unavailable From date must be greater than the current date when the service status is available.", "enum": [ "When the service status is available, Unavailable From must be greater than current date" ], "type": "string" }, "status": { "description": "Represents the status of the response, indicating that an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Available Status Requires Future Unavailable From", "type": "object", "x-zs-$id": "AvailableStatusUnavailableFromFutureError" }, "AvailableStatusUnavailableWindowRuleError": { "additionalProperties": false, "description": "Error response returned when the service status is Available, but the values specified for the unavailable period are invalid. When the service status is Available, both Unavailable_From and Unavailable_Till must be null, or only Unavailable_From may be specified.", "properties": { "code": { "description": "Represents the error code returned when the unavailability window configuration violates the required rule while the service status is available.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field for which the validation failed.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that when the service status is available, either both Unavailable From and Unavailable Till must be null, or only Unavailable From can have a value.", "enum": [ "When the service status is available, either both Unavailable From and Unavailable Till must be null, or only Unavailable From can have a value." ], "type": "string" }, "status": { "description": "Represents the status of the response, indicating that an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Available Status Unavailable Window Rule Violation", "type": "object", "x-zs-$id": "AvailableStatusUnavailableWindowRuleError" }, "AvailableTimingsNested": { "additionalProperties": false, "description": "Represents a single availability time window for the service, defined by a start time (From) and an end time (To).", "properties": { "From": { "description": "Specify the start of the availability time window in HH:MM (24-hour) format.", "maxLength": 5, "type": [ "string", "null" ] }, "To": { "description": "Specify the end of the availability time window in HH:MM (24-hour) format.", "maxLength": 5, "type": [ "string", "null" ] } }, "type": "object" }, "BadRequest": { "additionalProperties": false, "description": "Represents the standard error response object returned for bad requests.", "properties": { "code": { "description": "Represents the error code identifying the category or type of the bad request failure, expressed as an uppercase underscore-delimited string.", "maxLength": 50, "pattern": "^[A-Z_]+$", "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error, including validation information.", "type": "object" }, "message": { "description": "Represents a descriptive error message conveying the reason for the bad request in a readable format.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the outcome status of the request, always set to \"error\" for bad request responses.", "maxLength": 50, "pattern": "^error$", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "BadRequest" }, "BadRequestError": { "additionalProperties": false, "description": "Error response schema for 400 bad request errors, covering INVALID_MODULE, INVALID_DATA, and NOT_SUPPORTED error codes.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_MODULE", "INVALID_DATA", "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RecentItemsErrorResponse" }, "BccEmailNested": { "additionalProperties": false, "description": "Represents a BCC recipient entry for a mail merge email, containing the address type and email value.", "properties": { "type": { "description": "Represents the type of the address.\nPossible values:\n**email** - Indicates that the value is an email address.\n", "enum": [ "email" ], "maxLength": 5, "type": "string" }, "value": { "description": "Represents the email address to include in the BCC list for the mail merge email.", "format": "email", "maxLength": 255, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "BetweenFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a filter criterion for the between and not_between comparators. The value must be an array of exactly two elements — [lower_bound, upper_bound]. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Resolve the data_type from the field's FieldSchema. For formula fields, use formula.return_type as the effective data_type; for rollup_summary fields, use rollup_summary.return_type.", "properties": { "comparator": { "description": "Represents the range comparison operator applied to the criterion, indicating whether the field value falls within or outside the specified bounds.\nPossible values:\nbetween - Matches records where the field value falls within the specified range.\nnot_between - Matches records where the field value falls outside the specified range.", "enum": [ "between", "not_between" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the range filter criterion.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the range filter criterion is applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "description": "Contains the two boundary values — [lower_bound, upper_bound] — against which the field is evaluated for the between or not_between comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" } ], "x-zs-$id": "BetweenFilterCriterionRequestValueArrayItems" }, "maxItems": 2, "minItems": 2, "type": "array", "x-zs-$id": "BetweenFilterCriterionRequestValueArray" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "BetweenFilterCriterionRequest" }, "BetweenFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the response for a filter criterion using the between and not_between comparators. The value is an array of exactly two elements — [lower_bound, upper_bound]. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields.", "properties": { "$disrupted": { "description": "Indicates whether the between filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.", "type": "boolean" }, "comparator": { "description": "Represents the range comparison operator returned for the criterion, indicating whether the field value falls within or outside the specified bounds.\nPossible values:\nbetween - Matches records where the field value falls within the specified range.\nnot_between - Matches records where the field value falls outside the specified range.", "enum": [ "between", "not_between" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the range filter criterion response.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the range filter criterion was applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "description": "Contains the two boundary values — [lower_bound, upper_bound] — against which the field was evaluated for the between or not_between comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" } ], "x-zs-$id": "BetweenFilterCriterionResponseValueArrayItems" }, "maxItems": 2, "minItems": 2, "type": "array", "x-zs-$id": "BetweenFilterCriterionResponseValueArray" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "BetweenFilterCriterionResponse" }, "BodySizeLimitError": { "additionalProperties": false, "description": "Error response for body size limit exceeded", "properties": { "code": { "description": "Represents the error code", "enum": [ "BODY_SIZE_REACHED", "FILE_SIZE_MORE_THAN_ALLOWED_SIZE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details", "type": "object" }, "message": { "description": "Represents the error message", "enum": [ "The request body limit reached", "Request body size exceeds the maximum limit of 100MB", "Please check if the size of the file is in the correct range" ], "type": "string" }, "status": { "description": "Represents the error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "BodySizeLimitError" }, "BulkDeleteAssociatedNotAllowedError": { "additionalProperties": false, "description": "Represents the error entry in a bulk delete response when a webhook in the request is associated with active automation rules and cannot be deleted.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The requested operation is not allowed because the webhook is associated with an active automation rule.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the ID of the webhook that cannot be deleted.", "properties": { "id": { "description": "Represents the ID of the webhook that cannot be deleted.", "maxLength": 20, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**This webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint** - The webhook cannot be deleted because it is actively associated with one or more automation rules.", "enum": [ "This webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "BulkDeleteAssociatedNotAllowedError", "x-zs-llm-description": "Bulk delete entry failed the webhook is associated with rules and cannot be deleted." }, "BulkDeleteErrorResponse": { "additionalProperties": false, "description": "Bulk delete error response where all provided field update IDs failed validation or association checks.", "properties": { "field_updates": { "description": "Per-ID failure results for the bulk request.", "items": { "$ref": "#/components/schemas/BulkDeleteFailureItem" }, "maxItems": 10, "type": "array" } }, "required": [ "field_updates" ], "title": "Bulk Delete Error Response", "type": "object", "x-zs-$id": "BulkDeleteErrorResponse", "x-zs-llm-description": "All IDs in the bulk delete request failed. Check each item's error code." }, "BulkDeleteFailureItem": { "additionalProperties": false, "description": "Result item for a field update ID that failed during bulk delete. INVALID_DATA indicates the ID does not exist; NOT_ALLOWED indicates the field update is associated with a workflow rule, blueprint, or approval process.", "properties": { "code": { "description": "Failure code.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/BulkDeleteResultDetails" }, "message": { "description": "Failure message.", "example": "the id given seems to be invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Operation status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Bulk Delete Failure Item", "type": "object", "x-zs-$id": "BulkDeleteFailureItem", "x-zs-llm-description": "Single item showing a field update failed to delete. INVALID_DATA = ID not found; NOT_ALLOWED = associated with automation." }, "BulkDeleteInvalidIdParamError": { "additionalProperties": false, "description": "Returned when a single non-existent field update ID is supplied via the ids query parameter on the bulk delete endpoint. The error carries details.param_name='ids' (not resource_path_index) to indicate the failure is tied to the bulk query parameter, not a URL path segment.", "properties": { "code": { "description": "Error code indicating the data provided is invalid", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying which parameter caused the error", "properties": { "param_name": { "description": "The query parameter whose value is invalid (ids)", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "example": "the id given seems to be invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Bulk Delete Invalid Id Param Error", "type": "object", "x-zs-$id": "BulkDeleteInvalidIdParamError", "x-zs-llm-description": "A single non-existent ID was passed via the ids query param on the bulk delete endpoint. The error details identify the ids parameter, not a path index." }, "BulkDeleteLimitExceededError": { "additionalProperties": false, "description": "Represents the error returned when more than 10 webhook IDs are provided in a bulk DELETE request.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The number of webhook IDs in the request exceeds the allowed limit.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the parameter name and the maximum allowed count.", "properties": { "limit": { "description": "Represents the maximum number of webhook IDs allowed in a single bulk delete request.", "format": "int32", "type": "integer" }, "param_name": { "description": "Represents the name of the parameter that exceeded the allowed limit.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\n\nPossible values:\n**Bulk deletion of records limit reached** - The number of webhook IDs in the request exceeds the maximum allowed limit.", "enum": [ "Bulk deletion of records limit reached" ], "type": "string" }, "status": { "description": "Represents the error status.\n\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "BulkDeleteLimitExceededError", "x-zs-llm-description": "Too many IDs maximum is 10 per bulk delete request. Split into multiple calls." }, "BulkDeleteMixedResponse": { "additionalProperties": false, "description": "Bulk delete partial-success response. Contains mixed success and failure items for the requested field update IDs.", "properties": { "field_updates": { "description": "Per-ID deletion results for the bulk request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/BulkDeleteSuccessItem" }, { "$ref": "#/components/schemas/BulkDeleteFailureItem" } ] }, "maxItems": 10, "type": "array" } }, "required": [ "field_updates" ], "title": "Bulk Delete Mixed Response", "type": "object", "x-zs-$id": "BulkDeleteMixedResponse", "x-zs-llm-description": "Partial-success response some IDs deleted, others failed. Check each item's status." }, "BulkDeletePartialSuccessResponse": { "additionalProperties": false, "description": "Represents the HTTP Multi-Status response for bulk webhook deletion when results are mixed, indicating that at least one webhook was deleted and at least one deletion failed.", "properties": { "webhooks": { "description": "Represents the list of operation results, containing a mix of success and error entries for each webhook deletion attempt.", "items": { "$ref": "#/components/schemas/WebhookStatusResponse" }, "maxItems": 10, "type": "array" } }, "type": "object", "x-zs-$id": "BulkDeletePartialSuccessResponse", "x-zs-llm-description": "Partial-success (207) some webhooks deleted, others failed. Check each item's status." }, "BulkDeleteReadOnlyNotAllowedError": { "additionalProperties": false, "description": "Represents the error entry in a bulk delete response when a webhook in the request is read-only and cannot be deleted.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The webhook is read-only and cannot be deleted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the ID of the read-only webhook that cannot be deleted.", "properties": { "id": { "description": "Represents the ID of the read-only webhook that cannot be deleted.", "maxLength": 20, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Insufficient privileges to delete Read only webhook** - The webhook is read-only and cannot be deleted by the requesting user.", "enum": [ "Insufficient privileges to delete Read only webhook" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "BulkDeleteReadOnlyNotAllowedError", "x-zs-llm-description": "Bulk delete entry failed the webhook is read-only and cannot be deleted." }, "BulkDeleteResultDetails": { "additionalProperties": false, "description": "Identifier details for a bulk-delete result item.", "properties": { "id": { "description": "Field update ID for which this result applies.", "maxLength": 20, "type": "string" } }, "required": [ "id" ], "title": "Bulk Delete Result Details", "type": "object", "x-zs-$id": "BulkDeleteResultDetails", "x-zs-llm-description": "Contains the id of the field update processed in a bulk delete item." }, "BulkDeleteSuccessItem": { "additionalProperties": false, "description": "Result item for a field update ID deleted successfully in bulk delete.", "properties": { "code": { "description": "Result code.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "$ref": "#/components/schemas/BulkDeleteResultDetails" }, "message": { "description": "Success message.", "example": "field update deleted successfully", "maxLength": 255, "type": "string" }, "status": { "description": "Operation status.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Bulk Delete Success Item", "type": "object", "x-zs-$id": "BulkDeleteSuccessItem", "x-zs-llm-description": "Single item confirming a field update was deleted successfully in bulk." }, "BulkDeleteSuccessResponse": { "additionalProperties": false, "description": "Bulk delete success response where all requested field update IDs are deleted.", "properties": { "field_updates": { "description": "Deletion result entries for each requested ID.", "items": { "$ref": "#/components/schemas/BulkDeleteSuccessItem" }, "maxItems": 10, "type": "array" } }, "required": [ "field_updates" ], "title": "Bulk Delete Success Response", "type": "object", "x-zs-$id": "BulkDeleteSuccessResponse", "x-zs-llm-description": "All requested field update IDs were deleted successfully." }, "BulkDeleteTasksAllFailedResponse": { "additionalProperties": false, "description": "Bulk delete response when all provided task IDs failed. Each item contains INVALID_DATA or NOT_ALLOWED details for that ID.", "properties": { "tasks": { "description": "Per-ID failure results for the bulk request.", "items": { "$ref": "#/components/schemas/BulkDeleteTasksFailureItem" }, "maxItems": 10, "type": "array" } }, "required": [ "tasks" ], "title": "Bulk Delete Tasks All Failed Response", "type": "object", "x-zs-$id": "BulkDeleteTasksAllFailedResponse", "x-zs-llm-description": "All bulk delete IDs failed. Check each item's code: INVALID_DATA means the ID doesn't exist, NOT_ALLOWED means it's associated with an automation." }, "BulkDeleteTasksFailureItem": { "additionalProperties": false, "description": "Result item for a task ID that failed during bulk delete. Code is INVALID_DATA when the ID does not exist, or NOT_ALLOWED when the task is associated with a rule/blueprint or is read-only.", "properties": { "code": { "description": "Failure code.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the failed task ID.", "properties": { "id": { "description": "ID of the task that could not be deleted.", "maxLength": 20, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Failure message.", "example": "the id given seems to be invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Operation status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Bulk Delete Tasks Failure Item", "type": "object", "x-zs-$id": "BulkDeleteTasksFailureItem", "x-zs-llm-description": "Single item showing a task ID failed to delete. Code is INVALID_DATA (ID not found) or NOT_ALLOWED (task is associated)." }, "BulkDeleteTasksMixedResponse": { "additionalProperties": false, "description": "Bulk delete partial-success response. Contains mixed success and failure items for the requested task IDs.", "properties": { "tasks": { "description": "Per-ID deletion results for the bulk request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/BulkDeleteTasksSuccessItem" }, { "$ref": "#/components/schemas/BulkDeleteTasksFailureItem" } ], "description": "Represents a single per-ID outcome entry returned in a bulk DELETE request, indicating either a successful delete or a per-ID failure reason." }, "maxItems": 10, "type": "array" } }, "required": [ "tasks" ], "title": "Bulk Delete Tasks Mixed Response", "type": "object", "x-zs-$id": "BulkDeleteTasksMixedResponse", "x-zs-llm-description": "Partial-success response some task IDs deleted, others failed. Iterate items and check each status/code to identify failures." }, "BulkDeleteTasksSuccessItem": { "additionalProperties": false, "description": "Result item for a task ID that was deleted successfully in a bulk delete operation.", "properties": { "code": { "description": "Result code.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the deleted task ID.", "properties": { "id": { "description": "Unique ID of the deleted task.", "maxLength": 20, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Success message.", "example": "task deleted successfully", "maxLength": 255, "type": "string" }, "status": { "description": "Operation status.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Bulk Delete Tasks Success Item", "type": "object", "x-zs-$id": "BulkDeleteTasksSuccessItem", "x-zs-llm-description": "Single item confirming a task ID was deleted successfully in bulk." }, "BulkDeleteTasksSuccessResponse": { "additionalProperties": false, "description": "Bulk delete success response. All requested task IDs were deleted successfully.", "properties": { "tasks": { "description": "Deletion result entries for each requested task ID.", "items": { "$ref": "#/components/schemas/BulkDeleteTasksSuccessItem" }, "maxItems": 10, "type": "array" } }, "required": [ "tasks" ], "title": "Bulk Delete Tasks Success Response", "type": "object", "x-zs-$id": "BulkDeleteTasksSuccessResponse", "x-zs-llm-description": "All requested task IDs were deleted successfully. Every item has status 'success'." }, "BulkDeleteWebhooksSuccessResponse": { "additionalProperties": false, "description": "Represents the success response for a bulk webhook deletion where all specified webhooks were deleted.", "properties": { "webhooks": { "description": "Represents the list of operation results confirming each webhook deletion.", "items": { "$ref": "#/components/schemas/WebhookStatusResponse" }, "maxItems": 10, "type": "array" } }, "type": "object", "x-zs-$id": "BulkDeleteWebhooksSuccessResponse", "x-zs-llm-description": "All requested webhooks were deleted successfully." }, "BulkOperationResponse": { "additionalProperties": false, "description": "Represents the response structure for bulk operations, containing per-record result codes and operation details.", "properties": { "data": { "description": "Array of operation results per record.", "items": { "additionalProperties": false, "description": "Individual operation result.", "properties": { "code": { "description": "Result code for the operation.", "enum": [ "SUCCESS", "INVALID_DATA", "DUPLICATE_DATA", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Operation details including affected record ID.", "properties": { "api_name": { "description": "API name of the field that caused the error (if applicable).", "maxLength": 100, "type": "string" }, "id": { "description": "ID of the affected record.", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string" }, "json_path": { "description": "JSONPath to the field in request payload (if applicable).", "maxLength": 500, "type": "string" }, "param_name": { "description": "Parameter name that caused the error (if applicable).", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the operation result message for the record.", "maxLength": 500, "type": "string" }, "status": { "description": "Operation status.", "enum": [ "success", "error" ], "type": "string" } }, "required": [ "code", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ResponseStructureForBulkOperations" }, "BusinessHoursErrorResponse": { "additionalProperties": false, "description": "Standard error response structure for business hours API operations.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED", "MINIMUM_DATA_NOT_FOUND", "MISSING_MANDATORY_FIELDID", "ALREADY_USED", "MANDATORY_NOT_FOUND", "DEPENDENT_FIELD_MISSING", "INVALID_DATA", "CANNOT_BE_UPDATED", "CANNOT_UPDATE", "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional contextual information about the error", "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponse" }, "BusinessHoursErrorResponses": { "anyOf": [ { "additionalProperties": false, "description": "Error response schema for business hours operations, including validation failures and business rule violations.", "properties": { "business_hours": { "$ref": "#/components/schemas/BusinessHoursErrorResponse" } }, "required": [ "business_hours" ], "type": "object", "x-zs-$id": "BusinessHoursErrorResponse" }, { "$ref": "#/components/schemas/BusinessHoursErrorResponse" } ], "x-zs-$id": "BusinessHoursErrorResponses" }, "CadenceDescription": { "description": "Represents the description text of a Cadence.", "maxLength": 500, "type": "string" }, "CadenceEnrollmentType": { "description": "Represents the enrollment type of a Cadence, indicating how records are enrolled.", "enum": [ "custom_view", "manual_enrollment" ], "maxLength": 255, "type": "string" }, "CadenceID": { "description": "Represents the unique identifier of a Cadence.", "maxLength": 255, "type": "string" }, "CadenceName": { "description": "Represents the name of a Cadence.", "maxLength": 100, "type": "string" }, "CadencesCloneRequestBody": { "additionalProperties": false, "description": "Represents the request body schema for cloning an existing Cadence.", "properties": { "cadences": { "description": "Represents the list of Cadences to clone.", "items": { "additionalProperties": false, "description": "Represents the configuration for the cloned Cadence.", "properties": { "custom_view": { "additionalProperties": false, "description": "Represents the Custom View associated with the Cadence enrollment.", "properties": { "id": { "description": "Represents the unique identifier of the Custom View.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "description": { "description": "Represents the description of the cloned Cadence.", "maxLength": 500, "type": "string" }, "execution_details": { "additionalProperties": false, "description": "Represents the execution frequency details for the Cadence.", "properties": { "execute_every": { "$ref": "#/components/schemas/ExecuteEvery" } }, "type": "object" }, "module": { "$ref": "#/components/schemas/ModuleInformation" }, "name": { "description": "Represents the name of the cloned Cadence.", "maxLength": 100, "type": "string" }, "type": { "description": "Represents the enrollment type of the Cadence.\nPossible values:\ncustom_view - Automatically enrolls records matching a Custom View.\nmanual_enrollment - Allows manual enrollment of records into the Cadence.", "enum": [ "custom_view", "manual_enrollment" ], "type": "string" } }, "required": [ "module", "name", "type" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "cadences" ], "type": "object" }, "CadencesCreateRequestBody": { "additionalProperties": false, "description": "Represents the request body schema for creating a new Cadence with follow-up steps and action configurations.", "properties": { "cadences": { "description": "Represents the list of Cadences to create.", "items": { "additionalProperties": false, "description": "Represents the configuration for the new Cadence, including its follow-up steps, execution details, and enrollment settings.", "properties": { "custom_view": { "additionalProperties": false, "description": "Represents the Custom View used for automatic record enrollment in the Cadence.", "properties": { "id": { "description": "Represents the unique identifier of the Custom View.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getCustomViews", "propertyId": "CustomViewId" }, { "operationId": "createCustomView", "propertyId": "CustomViewResultId" } ], "resource": "custom_views" } } }, "required": [ "id" ], "type": "object" }, "description": { "description": "Represents the description of the Cadence.", "maxLength": 500, "type": "string" }, "execution_details": { "additionalProperties": false, "description": "Represents the execution frequency and unenrollment configuration for the Cadence.", "properties": { "execute_every": { "$ref": "#/components/schemas/ExecuteEvery" }, "unenroll_properties": { "description": "Represents the conditions under which records are automatically unenrolled from the Cadence.", "items": { "$ref": "#/components/schemas/UnenrollPropertiesNested" }, "maxItems": 200, "type": "array" } }, "type": "object" }, "follow_ups": { "description": "Represents the list of follow-up steps configured for the Cadence.", "items": { "additionalProperties": false, "description": "Represents a single follow-up step in the Cadence, including its action and trigger configuration.", "properties": { "action": { "$ref": "#/components/schemas/ActionNested", "description": "Cadence followup action (Required)" }, "execute_after": { "$ref": "#/components/schemas/ExecuteAfterNested" }, "parent_follow_up": { "additionalProperties": false, "description": "Represents the parent follow-up step that this step branches from.", "properties": { "reference_id": { "description": "Represents the reference identifier of the parent follow-up step.", "maxLength": 255, "type": "string" } }, "type": "object" }, "reference_id": { "description": "Represents the unique reference identifier for the follow-up step within the Cadence.", "maxLength": 255, "type": "string" }, "triggers": { "description": "Represents the list of trigger conditions that determine when this follow-up step executes.", "items": { "description": "Represents a single trigger condition for the follow-up step.", "maxLength": 255, "type": "string" }, "maxItems": 500, "type": "array" } }, "required": [ "action" ], "type": "object" }, "maxItems": 100, "type": "array" }, "id": { "description": "Represents the unique identifier of the Cadence.", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/ModuleInformation" }, "name": { "description": "Represents the name of the Cadence.", "maxLength": 100, "type": "string" }, "type": { "description": "Represents the enrollment type of the Cadence.\nPossible values:\ncustom_view - Automatically enrolls records matching a Custom View.\nmanual_enrollment - Allows manual enrollment of records into the Cadence.", "enum": [ "custom_view", "manual_enrollment" ], "type": "string" } }, "required": [ "module", "name", "type" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "cadences" ], "type": "object" }, "CadencesCreatedTime": { "description": "Represents the creation date and time of the Cadence, in ISO 8601 format.", "format": "date-time", "type": "string" }, "CadencesCustomViewInfo": { "additionalProperties": false, "description": "Represents the identifier and name of a Custom View.", "properties": { "id": { "description": "Represents the unique identifier of the Custom View.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the Custom View.", "maxLength": 255, "type": "string" } }, "title": "Custom View Information", "type": [ "object", "null" ] }, "CadencesDetailsNested": { "additionalProperties": false, "description": "Represents the nested details of a Cadence operation result, including follow-up actions and resource identifiers.", "properties": { "draft_cadence": { "additionalProperties": false, "description": "Represents the draft version of the Cadence associated with the operation.", "properties": { "id": { "description": "Represents the unique identifier of the draft Cadence.", "maxLength": 255, "type": "string" } }, "type": "object" }, "follow_ups": { "description": "Represents the list of follow-up actions involved in the operation.", "items": { "additionalProperties": false, "description": "Represents a follow-up action, including its identifier and associated action details.", "properties": { "action": { "additionalProperties": false, "description": "Represents the action associated with the follow-up item.", "properties": { "id": { "description": "Represents the unique identifier of the follow-up action.", "maxLength": 255, "type": "string" }, "type": { "description": "Represents the type of the follow-up action.", "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "Represents the unique identifier of the follow-up item.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 100, "type": [ "null", "array" ] }, "id": { "description": "Represents the unique identifier of the resource associated with the operation.", "maxLength": 255, "type": "string", "x-zs-$id": "CadenceResultId" } }, "type": "object", "x-zs-$id": "DetailsNested" }, "CadencesExecutionDetailsNested": { "additionalProperties": false, "description": "Represents the details of a successful per-record operation result, including the record ID and the associated Cadences.", "properties": { "cadences": { "description": "Specify the list of Cadences associated with the operation result.", "items": { "$ref": "#/components/schemas/CadencesNested" }, "maxItems": 2, "type": "array" }, "id": { "description": "Represents the unique ID of the record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "CadencesExecutionErrorResponseMandatoryNotFound": { "additionalProperties": false, "description": "Represents the MANDATORY_NOT_FOUND error indicating that a required top-level array - record IDs or Cadence IDs - was missing from the request body.", "properties": { "code": { "description": "Represents the error code. The value is **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing required field.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "enum": [ "ids", "cadences_ids" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing required field.", "enum": [ "$.ids", "$.cadences_ids" ], "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing field.", "enum": [ "Record ids not found", "Cadences ids not found" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseMandatoryNotFound" }, "CadencesExecutionErrorResponseNotAllowed": { "additionalProperties": false, "description": "Represents the error response returned when a Cadence does not support manual enrollment - only manual_enrollment type Cadences are supported by this API.", "properties": { "code": { "description": "Represents the error code. The value is **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the Cadence that does not support manual enrollment.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the NOT_ALLOWED error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with the NOT_ALLOWED error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation is not allowed for this Cadence.", "enum": [ "id given is not manual enrollment cadence" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseNotAllowed" }, "CadencesInvalidDataWithId": { "additionalProperties": false, "description": "Represents error details when a field contains an invalid identifier.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the identifier of the invalid value provided.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with invalid data.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path", "id" ], "type": "object", "x-zs-$id": "InvalidDataWithId" }, "CadencesInvalidDataWithSupportedValues": { "additionalProperties": false, "description": "Represents error details when a field contains an invalid value, listing the supported values.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with invalid data.", "maxLength": 500, "type": "string" }, "param_name": { "description": "Represents the parameter name of the field with invalid data.", "maxLength": 255, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the field.", "items": { "description": "Represents a supported value for the field.", "maxLength": 500, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "supported_values", "api_name", "json_path" ], "type": "object", "x-zs-$id": "InvalidDataWithSupportedValues" }, "CadencesItemNested": { "additionalProperties": false, "description": "Represents a single Cadence operation result, including the result code, message, status, and details.", "properties": { "code": { "description": "Represents the result code for the individual Cadence record operation.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/CadencesDetailsNested" }, "message": { "description": "Represents the result message for the individual Cadence record operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the result status for the individual Cadence record operation.", "maxLength": 255, "type": "string" } }, "type": "object" }, "CadencesNested": { "additionalProperties": false, "description": "Represents a Cadence in the operation result, including its unique ID and name.", "properties": { "id": { "description": "Represents the unique ID of the Cadence.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the Cadence.", "maxLength": 255, "type": "string" } }, "type": "object" }, "CadencesRecordsCountSuccess": { "additionalProperties": false, "description": "Represents the record count data for a Cadence, including the Cadence identifier and the number of enrolled records.", "properties": { "cadences": { "additionalProperties": false, "description": "Represents the identifier and name details of the Cadence.", "properties": { "id": { "$ref": "#/components/schemas/CadenceID" }, "name": { "$ref": "#/components/schemas/CadenceName" } }, "type": "object" }, "count": { "description": "Represents the number of records currently enrolled in the Cadence.", "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "CadencesRecordsCountSuccess" }, "CadencesTaskTypeFollowupActionRequestObject": { "additionalProperties": false, "description": "Represents the follow-up step configuration for a task action in a Cadence.", "properties": { "id": { "description": "Represents the unique identifier of the task action.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getWorkflowTasks", "propertyId": "WorkflowTaskId" }, { "operationId": "createWorkflowTasks", "propertyId": "WorkflowTaskResultId" } ], "resource": "workflow_tasks" } }, "type": { "description": "Represents the action type for this follow-up step.", "enum": [ "tasks" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "TaskTypeFollowupActionRequestObject" }, "CadencesUpdateRequestBody": { "additionalProperties": false, "description": "Represents the request body schema for updating the configuration of one or more existing Cadences.", "properties": { "cadences": { "description": "Represents the list of Cadences to update.", "items": { "additionalProperties": false, "description": "Represents the updated configuration for a single Cadence.", "properties": { "description": { "description": "Represents the updated description of the Cadence.", "maxLength": 500, "type": "string" }, "execution_details": { "additionalProperties": false, "description": "Represents the updated execution frequency and unenrollment configuration for the Cadence.", "properties": { "unenroll_properties": { "description": "Represents the updated conditions under which records are automatically unenrolled from the Cadence.", "items": { "$ref": "#/components/schemas/UnenrollPropertiesNested" }, "maxItems": 200, "type": "array" } }, "type": "object" }, "follow_ups": { "description": "Represents the updated list of follow-up steps for the Cadence.", "items": { "$ref": "#/components/schemas/FollowUpsUpdateNested" }, "maxItems": 100, "type": "array" }, "id": { "description": "Represents the unique identifier of the Cadence to update.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the updated name of the Cadence.", "maxLength": 100, "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "cadences" ], "type": "object" }, "CannotRemoveSchema": { "additionalProperties": false, "description": "Represents the error response returned when a delete operation would leave required data empty or remove a resource that is still in use.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "CANNOT_REMOVE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the resource that cannot be removed from the workflow rule.", "properties": { "api_name": { "description": "Represents the API name of the resource that cannot be removed.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the resource that cannot be removed.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Actions cannot be empty", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleCannotRemoveErrorResponse", "x-zs-llm-description": "Error code: CANNOT_REMOVE. Returned when a delete operation would leave required data empty. Most common: attempting to remove the last remaining action from a condition via PUT with _delete=null. A rule must always have at least one action per condition. Fix: delete the entire condition or rule instead of removing its last action." }, "CcEmailNested": { "additionalProperties": false, "description": "Represents a CC recipient entry for a mail merge email, containing the address type and email value.", "properties": { "type": { "description": "Represents the type of the address.\nPossible values:\n**email** - Indicates that the value is an email address.\n", "enum": [ "email" ], "maxLength": 5, "type": "string" }, "value": { "description": "Represents the email address to include in the CC list for the mail merge email.", "format": "email", "maxLength": 255, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "ChatNotificationActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that sends a chat notification to an integrated chat service, such as Slack or Zoho Cliq, when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationChatNotificationDetails", "description": "Configuration for the chat notification action. Requires a message, which supports merge fields, and a target channel, user, or field to notify." }, "id": { "description": "Represents the unique ID of the ChatNotification action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the ChatNotification action. This field is required.", "maxLength": 100, "type": "string" }, "type": { "description": "Represents chat service type. Each service has a limit of 1 action per rule.", "enum": [ "slack_notifications", "cliq_notifications", "cisco_notifications", "google_chat_notifications", "microsoft_teams_notifications" ], "type": "string" } }, "required": [ "type", "name", "details" ], "type": "object", "x-zs-$id": "ChatNotificationActionSchema", "x-zs-llm-description": "Inline action for chat integrations: type=slack_notifications|cliq_notifications|cisco_notifications|google_chat_notifications|microsoft_teams_notifications. Limit 1 per type per rule. Requires name, details.message (supports ${Module.Field} merge tokens), and details.notify_to ({type: user|channel|fields} with appropriate sub-fields)." }, "ChildRelationshipReference": { "additionalProperties": false, "description": "Represents the reference to a child relationship module. The api_name property is required to identify the child relationship.", "properties": { "$disrupted": { "description": "Indicates whether the related module relationship referenced by this criterion is in a disrupted state, typically due to an unresolvable or deleted relationship definition.", "type": "boolean" }, "api_name": { "description": "Represents the API name of the child relationship module used to identify the relationship.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getChildRelationshipsForModule", "propertyId": "ChildRelationshipApiName" } ], "resource": "child_relationships" } }, "id": { "description": "Represents the unique ID of the child relationship module record.", "format": "int64", "maxLength": 25, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getChildRelationshipsForModule", "propertyId": "ChildRelationshipId" } ], "resource": "child_relationships" } } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "ChildRelationshipReference" }, "CircuitsActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that executes a Zoho Circuits workflow when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationCircuitsDetails", "description": "Configuration for the Zoho Circuits action. Requires the ID of the circuit to execute." }, "id": { "description": "Represents the unique ID of the Circuits action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the Circuits action. This field is required.", "maxLength": 100, "type": "string" }, "type": { "const": "circuits", "description": "Represents the action type discriminator that identifies this as a Circuits action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "name", "details" ], "type": "object", "x-zs-$id": "CircuitsActionSchema", "x-zs-llm-description": "Inline action type='circuits'. Executes a Zoho Circuits workflow. Limit 1/rule. Requires name, details.circuit_id (Zoho Circuits circuit identifier). Verify 'circuits' is enabled for the module via getWorkflowConfigurations before using." }, "CloneProfileActionResponse": { "additionalProperties": false, "description": "Response of a successful profile clone action.", "properties": { "code": { "description": "Operation result code. Possible values: `SUCCESS`.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details returned with the clone operation result.", "properties": { "id": { "$ref": "#/components/schemas/ProfilesId", "description": "ID of the newly created (cloned) profile.", "x-zs-$id": "ProfileResultId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Description of the clone operation result.", "examples": [ "profile created successfully" ], "maxLength": 1000, "type": "string" }, "status": { "description": "Status of the operation result. Possible values: `success`.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "CloneProfileCannotBeClonedErrorResponse": { "additionalProperties": false, "description": "Error body returned when the specified profile is not permitted to be cloned.", "properties": { "profiles": { "description": "Per-profile INVALID_DATA errors indicating the clone operation is not permitted.", "items": { "additionalProperties": false, "description": "INVALID_DATA error entry indicating this profile cannot be cloned.", "properties": { "code": { "description": "Error code indicating invalid data. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object returned for this error type.", "maxProperties": 0, "type": "object" }, "message": { "description": "Human-readable description of why the clone operation is not permitted.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "CloneProfileCannotBeClonedErrorResponse" }, "CloneProfileDuplicateProfileNameErrorResponse": { "additionalProperties": false, "description": "Error body returned when the name requested for the cloned profile already belongs to an existing profile.", "properties": { "profiles": { "description": "Per-profile duplicate name errors from the clone request.", "items": { "$ref": "#/components/schemas/DuplicateProfileNameError" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "CloneProfileDuplicateProfileNameErrorResponse" }, "CloneProfileInvalidCreateRequestErrorResponse": { "additionalProperties": false, "description": "Error body returned when the clone profile request payload has missing mandatory fields.", "properties": { "profiles": { "description": "Per-profile validation errors from the clone request.", "items": { "$ref": "#/components/schemas/MandatoryNotFoundProfileError" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "CloneProfileInvalidCreateRequestErrorResponse" }, "CloneProfileInvalidIdErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/ProfilesInvalidIdError" } ], "description": "Error body returned when the profile ID in the clone request path is invalid or refers to a deleted profile.", "x-zs-$id": "CloneProfileInvalidIdErrorResponse" }, "CloneProfileInvalidProfileNameSpecialCharsErrorResponse": { "additionalProperties": false, "description": "Error body returned when the cloned profile's name contains disallowed special characters.", "properties": { "profiles": { "description": "Per-profile INVALID_DATA errors pointing to the invalid `name` value in the clone request.", "items": { "additionalProperties": false, "description": "Per-profile INVALID_DATA error indicating the `name` field contains a disallowed special character.", "properties": { "code": { "description": "Error code indicating invalid profile name data. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the invalid `name` field in the clone request.", "properties": { "api_name": { "description": "API name of the field that failed validation.", "maxLength": 255, "minLength": 1, "type": "string" }, "json_path": { "description": "A JSONPath expression that indicates the location of the invalid field in the request payload.", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable description of the invalid profile name error.", "maxLength": 1000, "type": "string" }, "status": { "description": "Response status indicator. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "CloneProfileInvalidProfileNameSpecialCharsErrorResponse" }, "CloneProfileLicenseLimitExceededErrorResponse": { "additionalProperties": false, "description": "Error body returned when cloning a profile would exceed the organization's allowed profile count.", "properties": { "profiles": { "description": "Per-profile license limit exceeded errors from the clone request.", "items": { "$ref": "#/components/schemas/ProfilesLicenseLimitExceededError" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "CloneProfileLicenseLimitExceededErrorResponse" }, "CloneProfileResponse": { "additionalProperties": false, "description": "Response body returned after a profile is successfully cloned.", "properties": { "profiles": { "description": "Array containing the clone action result (contains at most one entry).", "items": { "$ref": "#/components/schemas/CloneProfileActionResponse" }, "maxItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "CloneProfileResponse" }, "CommonErrorResponse": { "additionalProperties": false, "description": "Represents the error response containing per-territory validation failure details.", "properties": { "territories": { "description": "Represents the list of per-territory validation errors.", "items": { "additionalProperties": false, "description": "Represents the validation error details for a single territory in the request.", "properties": { "code": { "description": "Represents the error code for the territory validation failure. Possible values: INVALID_DATA - The territory ID is invalid. DUPLICATE_DATA - The territory is already associated with the user. PERMISSION_DENIED - The user lacks the required permission for the territory.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the territory validation error.", "properties": { "api_name": { "description": "Represents the API field name associated with the validation error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that caused the validation error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the territory validation failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the territory operation. Possible values: error - The territory operation failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "status" ], "type": "object" }, "maxItems": 200, "minItems": 0, "type": "array", "uniqueItems": true } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "CommonErrorResponse" }, "CommonForbiddenErrorResponse": { "additionalProperties": false, "description": "Represents the forbidden error response returned when the user does not have permission to access the API.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "permission denied - access the api", "permission denied" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CommonForbiddenErrorResponse" }, "CommonUrlErrorResponse": { "additionalProperties": false, "description": "Represents a top-level error response for invalid path parameters, including a resource path index in the error details.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: INVALID_DATA - One or more path parameters in the request URL are invalid. NOT_ALLOWED - The operation is not permitted for the specified user.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the path parameter index.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the path parameter that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: error - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "status" ], "type": "object", "x-zs-$id": "CommonUrlErrorResponse" }, "ComparatorValueMismatch": { "additionalProperties": false, "description": "Error schema returned when the comparator value itself does not satisfy the dependency validation rules imposed by the dependee field. Carries error code DEPENDENT_MISMATCH and includes details identifying the criterion field with the invalid comparator value, its dependee field (api_name, json_path), and the criterion field own api_name and json_path.", "properties": { "code": { "description": "Error code identifying the comparator dependency mismatch condition. Possible values: DEPENDENT_MISMATCH.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing diagnostic detail about the dependency mismatch, including the criterion field with the invalid comparator value (api_name, json_path) and the dependee field that imposed the violated validation rule (dependee.api_name, dependee.json_path).", "properties": { "api_name": { "description": "API name of the criterion field whose comparator value does not satisfy the dependency rule imposed by the dependee field.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Identifies the dependee field whose value determines the validation rules applied to the comparator of the criterion field in error. Contains the API name and JSON path of the dependee field.", "properties": { "api_name": { "description": "API name of the dependee field whose value imposed the violated validation rule on the criterion field comparator.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path locating the dependee field within the request body.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path locating the criterion field with the invalid comparator value within the request body.", "maxLength": 512, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Descriptive message providing details about the comparator value mismatch error.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the response indicating the outcome of the request. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ComparatorValueMismatch" }, "CompositeFieldMapping": { "additionalProperties": false, "description": "Represents a composite-type field mapping used exclusively for the Participants field in the Events module via the add_meeting action. The value carries a structured object that encodes participant data and is not applicable to any other field or automation action type.", "properties": { "display_value": { "description": "The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests.", "maxLength": 500, "type": "string" }, "field": { "$ref": "#/components/schemas/AutomationFieldAttributes", "description": "Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING." }, "type": { "const": "composite", "description": "Serves as the polymorphic discriminator that identifies this field mapping as a composite mapping; the value must be set to \"composite\" to select this schema variant.", "type": "string" }, "value": { "additionalProperties": true, "description": "Holds the structured composite object that encodes participant data for the Events module Participants field; the shape of this object varies according to the participant type configuration defined for the automation rule.", "type": "object" } }, "required": [ "field", "type", "value" ], "title": "Composite Field Mapping", "type": "object", "x-zs-$id": "CompositeFieldMapping", "x-zs-llm-description": "type='composite' mapping. Used ONLY for the Participants field in Events module (add_meeting action). Value is a structured object representing multiple participant entries. Cannot be used on other field types returns NOT_ALLOWED." }, "ConditionsNestedSchema": { "additionalProperties": false, "description": "Represents a single condition within a workflow rule that defines which records are evaluated and what actions are executed when the criteria are met.", "properties": { "_delete": { "description": "Indicates that this condition should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "criteria_details": { "$ref": "#/components/schemas/CriteriaDetailsNestedSchema", "description": "Record matching criteria for this condition. When provided, criteria_details must be a JSON object and cannot be null. To match all records, pass an object with criteria set to null, but do not set criteria_details itself to null. This field is required for certain trigger types, such as related module triggers like Notes on Leads. The convert action type requires criteria_details.criteria to be a non-null filter object. Omit criteria_details entirely or pass criteria as null to match all records when the trigger does not require specific criteria and no convert action is present." }, "id": { "description": "Represents the unique ID of the condition. Auto-generated on creation. Required on PUT to identify which condition to update.", "format": "int64", "type": "string" }, "instant_actions": { "$ref": "#/components/schemas/InstantActionsNestedSchema", "description": "Actions to execute immediately when the condition is met. At least one of instant_actions or scheduled_actions must be present - returns MANDATORY_NOT_FOUND if both are absent." }, "scheduled_actions": { "$ref": "#/components/schemas/ScheduledActionsNestedSchema", "description": "Actions to execute after a configured delay. Scheduled actions require both the trigger and the action type to support scheduling." }, "sequence_number": { "description": "Represents the execution order of this condition within the workflow rule, starting from one. Must be unique across all conditions in the rule.", "format": "int32", "type": "integer" } }, "required": [ "sequence_number" ], "type": "object", "x-zs-llm-description": "A condition defines WHICH records to act on and WHAT actions to execute. Each rule has 1+ conditions evaluated in sequence_number order. Required: sequence_number (integer, starting from 1). At least one of instant_actions or scheduled_actions must be present. Optional: criteria_details (filter gate). Convert action requires criteria_details.criteria to be non-null." }, "ContactRoleSuccessSchema": { "additionalProperties": false, "description": "Represents the result of a successful contact role operation.", "properties": { "code": { "description": "Represents the status code of the operation.\n\n**Possible values:**\n- **SUCCESS** - The contact role operation completed successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the contact role for the create or update operation.", "properties": { "id": { "description": "Represents the unique ID of the contact role.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the result of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the operation.\n\n**Possible values:**\n- **success** - The contact role operation completed successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ContactRoleSuccessSchema" }, "ConversionRequest": { "additionalProperties": false, "description": "Configuration for converting a single lead", "properties": { "Deals": { "$ref": "#/components/schemas/DealConversion" }, "add_to_existing_record": { "description": "When true, associates the Lead with an existing Account or Contact instead of creating duplicates.", "type": "boolean" }, "assign_to": { "additionalProperties": false, "description": "Assigns a record owner for the new Contact and Account after lead conversion. It ensures that the converted lead is assigned to a specific user in Zoho CRM. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve valid User IDs.", "properties": { "id": { "description": "Zoho CRM user ID (int64 as string)", "maxLength": 20, "type": "string" } }, "required": [ "id" ], "type": "object" }, "carry_over_tags": { "additionalProperties": false, "description": "Configuration for carrying over tags from the Lead to converted records", "properties": { "Accounts": { "additionalProperties": true, "description": "Tag carryover settings for Account records", "type": "object" }, "Contacts": { "additionalProperties": true, "description": "Tag carryover settings for Contact records.", "type": "object" }, "Deals": { "additionalProperties": true, "description": "Tag carryover settings for Deal records", "type": "object" } }, "type": "object" }, "default": {}, "notify_lead_owner": { "default": false, "description": "If true, sends email notification to the Lead owner about the conversion. Default is false.", "type": "boolean" }, "notify_new_entity_owner": { "default": false, "description": "If true, notifies the owner(s) of newly created Contact, Account, or Deal records. Default is false.", "type": "boolean" }, "overwrite": { "description": "Determines whether to overwrite the Account Name in a Contact when converting a Lead.\nFor example, If a Contact is already linked to an Account but the Lead’s Company name is different, enabling this option will update the Contact’s Account to match the Lead’s Company.\n**Possible values:**\nfalse (default) : Keeps the existing Account Name in the Contact unchanged.\ntrue : Updates the Contact’s associated Account Name if it differs from the Company name in the Lead.", "type": "boolean" } }, "type": "object" }, "ConversionRequestWrapper": { "additionalProperties": false, "description": "Wrapper object containing array of conversion requests", "properties": { "data": { "description": "Array of lead conversion configurations", "items": { "$ref": "#/components/schemas/ConversionRequest" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object" }, "ConversionScheduled": { "additionalProperties": false, "description": "Lead conversion scheduled for background processing", "properties": { "code": { "description": "Status code indicating conversion was scheduled", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Job details", "properties": { "job_id": { "description": "Unique job identifier", "maxLength": 20, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Message that summarizes the scheduling result for the lead conversion request.", "maxLength": 500, "type": "string" }, "status": { "description": "Overall status", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "ConversionScheduledWrapper": { "additionalProperties": false, "description": "Wrapper for scheduled conversion response", "properties": { "data": { "description": "Array containing the scheduled job information", "items": { "$ref": "#/components/schemas/ConversionScheduled" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ConversionScheduledWrapper" }, "ConversionSuccess": { "additionalProperties": false, "description": "Successful lead conversion result", "properties": { "code": { "description": "Status code indicating successful conversion", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of created records including their IDs and names.", "properties": { "Accounts": { "anyOf": [ { "$ref": "#/components/schemas/EntityReference" }, { "description": "No Account was created during conversion", "type": "null", "x-zs-$id": "NoAccountCreatedConversion" } ], "description": "Account record information, or null if no Account was created" }, "Contacts": { "$ref": "#/components/schemas/EntityReference" }, "Deals": { "anyOf": [ { "$ref": "#/components/schemas/EntityReference" }, { "description": "No Deal was created during conversion", "type": "null", "x-zs-$id": "NoDealCreated" } ], "description": "Deal record information, or null if no Deal was created" } }, "required": [ "Contacts", "Deals", "Accounts" ], "type": "object" }, "message": { "description": "Message that summarizes the outcome of the lead conversion request.", "maxLength": 500, "type": "string" }, "status": { "description": "Overall status of the conversion operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "ConversionSuccessWrapper": { "additionalProperties": false, "description": "Wrapper for successful conversion response", "properties": { "data": { "description": "Array of conversion results", "items": { "$ref": "#/components/schemas/ConversionSuccess" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ConversionSuccessWrapper" }, "ConvertActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that converts a record to another module type, such as converting a lead to a contact, account, and deal.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationConvertDetails", "description": "Configuration for converting records. This action is only available when the trigger module is Leads, Quotes, or Sales_Orders. The convert action requires non-null criteria in the condition; null criteria will result in a dependent field missing error. For Leads conversion, the following fields are mandatory: add_to_existing_contact, add_to_existing_account, apply_restriction, and change_owner which is an object containing the apply_assignment_threshold flag. Key optional fields include create_deal for creating a deal, carry_tags which is an array of module references and not a boolean, field_mappings with a maximum of 25 entries, move_attachment_to for specifying a target module, contact_role which is applicable only when create_deal is true, and convert_to which is used for Quotes and SalesOrders conversions. Example configuration for a Leads conversion without creating a deal." }, "id": { "description": "Represents the unique ID of the Convert action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the Convert action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. For convert, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only)." }, "type": { "const": "convert", "description": "Represents the action type discriminator that identifies this as a Convert action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ConvertActionSchema", "x-zs-llm-description": "Inline action type='convert'. Converts records across modules: Leads->Contacts+Accounts+Deals, Quotes->SalesOrders/Invoices, SalesOrders->Invoices. Limit 1 per rule. Requires criteria_details.criteria to be non-null. For Leads: add_to_existing_contact, add_to_existing_account, change_owner are mandatory. For Quotes/SalesOrders: convert_to is mandatory. No scheduled actions allowed with convert." }, "ConvertErrorResponse": { "additionalProperties": false, "description": "Root-level error response without data wrapper", "properties": { "code": { "description": "Indicates the error code.", "enum": [ "INVALID_DATA", "ID_ALREADY_CONVERTED", "CANNOT_PERFORM_ACTION", "NOT_ALLOWED", "REQUIRED_PARAM_MISSING", "NOT_REVIEWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Error details", "properties": { "param_name": { "description": "Name of the missing or invalid parameter. ", "maxLength": 100, "type": "string" }, "resource_path_index": { "description": "Index of the resource path that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ErrorResponse" }, "ConvertMappingModule": { "anyOf": [ { "additionalProperties": false, "description": "Represents the lead conversion mapping configuration, specifying how fields from the Leads module are mapped to corresponding fields in the Contacts, Deals, and Accounts modules.", "properties": { "Accounts": { "$ref": "#/components/schemas/ConvertMappingTargetModule" }, "Contacts": { "$ref": "#/components/schemas/ConvertMappingTargetModule" }, "Deals": { "$ref": "#/components/schemas/ConvertMappingTargetModuleWithFields" } }, "required": [ "Contacts", "Deals", "Accounts" ], "title": "Leads Convert Mapping", "type": "object", "x-zs-$id": "LeadsConvertMapping" }, { "additionalProperties": false, "description": "Represents the Quotes module conversion mapping configuration, specifying how fields from a Quote are mapped to corresponding fields in the Invoices and Sales_Orders modules.", "properties": { "Invoices": { "$ref": "#/components/schemas/ConvertMappingTargetModule" }, "SalesOrders": { "$ref": "#/components/schemas/ConvertMappingTargetModule" } }, "required": [ "SalesOrders", "Invoices" ], "title": "Quotes Convert Mapping", "type": "object", "x-zs-$id": "QuotesConvertMapping" }, { "additionalProperties": false, "description": "Represents the Sales Order conversion mapping configuration, specifying how fields from a Sales Order are mapped to corresponding fields in the Invoices module.", "properties": { "Invoices": { "$ref": "#/components/schemas/ConvertMappingTargetModule" } }, "required": [ "Invoices" ], "title": "Sales Orders Convert Mapping", "type": "object", "x-zs-$id": "SalesOrdersConvertMapping" }, { "additionalProperties": false, "description": "Represents a null or empty convert mapping object indicating that no field conversion mapping is configured for this field.", "maxProperties": 0, "title": "No Convert Mapping", "type": "object", "x-zs-$id": "EmptyLayoutConvertMappingObject" } ], "description": "Represents the convert mapping configuration that defines how record field values are transferred across modules during a record conversion operation.", "x-zs-$id": "ConvertMappingModuleStructure" }, "ConvertMappingTargetModule": { "additionalProperties": false, "description": "Represents the target layout configuration for a module involved in a record conversion operation, identifying the layout by its API name and display label.", "properties": { "display_label": { "description": "Represents the label of the target module's layout as it appears in the CRM interface during record conversion.", "example": "Standard", "maxLength": 255, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the target layout." }, "name": { "description": "Represents the unique API name that programmatically identifies the target layout within the conversion mapping configuration.", "example": "Standard", "maxLength": 255, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object", "x-zs-$id": "ConvertMappingTargetModuleStructure" }, "ConvertMappingTargetModuleWithFields": { "additionalProperties": false, "description": "Represents the target layout configuration for a module involved in a record conversion, including field-level mapping details that define how source field values are transferred.", "properties": { "display_label": { "description": "Represents the label of the target module's layout as it appears in the CRM interface during record conversion. This variant is accompanied by field-level mapping details.", "example": "Standard", "maxLength": 255, "type": "string" }, "fields": { "description": "Contains the collection of field configurations belonging to the target module's layout that participate in the record conversion process, each describing how a specific field is handled during the transfer of data.", "items": { "additionalProperties": false, "description": "Represents a single field entry within the target module's layout, capturing the field's label and any constraints that apply when transferring record data during conversion.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the field in the target module." }, "field_label": { "description": "Represents the name of the field as it appears in the CRM interface within the target module's layout during record conversion.", "example": "Deal Name", "maxLength": 255, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the field." }, "required": { "description": "Indicates whether the field must be populated for the record conversion to proceed successfully. Possible values: `true` — the field is mandatory and a value must be provided before conversion can complete; `false` — the field is optional and may be left unpopulated during conversion.", "example": true, "type": "boolean" } }, "required": [ "api_name", "field_label", "id", "required" ], "type": "object" }, "maxItems": 100, "type": "array" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the target layout." }, "name": { "description": "Represents the unique API name that programmatically identifies the target layout within the conversion mapping configuration. This variant is accompanied by field-level mapping details.", "example": "Standard", "maxLength": 255, "type": "string" } }, "required": [ "display_label", "name", "id", "fields" ], "type": "object", "x-zs-$id": "ConvertMappingTargetModuleWithFieldsStructure" }, "CoqlApiName": { "description": "API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.", "example": "api_name30", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$id": "ApiName" }, "CoqlFieldSchema": { "additionalProperties": false, "description": "Represents a CRM field configuration in the Zoho CRM organization, including its metadata, display properties, and operational settings.", "properties": { "additional_column": { "anyOf": [ { "description": "Represents the additional column name configuration for the field.", "example": "Custom_Column_1", "maxLength": 100, "type": "string", "x-zs-$id": "AdditionalColumnName" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the name of the additional database column associated with the field, if applicable." }, "address": { "anyOf": [ { "additionalProperties": false, "description": "Represents the address type configuration for the field.", "properties": { "type": { "description": "Represents the address type for this field configuration.", "example": "shipping", "maxLength": 25, "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "AddressDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the address configuration associated with the field, applicable when the field is of an address type." }, "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "associated_module": { "anyOf": [ { "additionalProperties": false, "description": "Represents the associated module details for the field, such as a subform module.", "properties": { "id": { "$ref": "#/components/schemas/CoqlId" }, "module": { "$ref": "#/components/schemas/CoqlModuleName" } }, "required": [ "module", "id" ], "type": "object", "x-zs-$id": "AssociatedModule" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the module associated with this field, such as a subform module." }, "association_details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the association details for a lookup-type field, including the related and lookup field configurations.", "properties": { "lookup_field": { "additionalProperties": false, "description": "Represents the configuration of the lookup field in this association.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "related_field": { "additionalProperties": false, "description": "Represents the related field linked to this association.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "related_field", "lookup_field" ], "type": "object", "x-zs-$id": "AssociationDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the association configuration for lookup-type fields, including the related field and lookup field details." }, "auto_number": { "anyOf": [ { "additionalProperties": false, "description": "Represents the auto-number settings for the field, including prefix, suffix, and starting values.", "properties": { "prefix": { "description": "Represents the prefix added before each auto-number value.", "example": "ORD-", "maxLength": 25, "type": "string" }, "start_number": { "description": "Represents the initial numeric value from which the auto-number sequence begins.", "example": 100, "format": "int32", "type": "number" }, "starting_number_length": { "description": "Represents the digit length of the starting auto-number value.", "example": 5, "format": "int32", "type": "number" }, "suffix": { "description": "Represents the suffix appended after each auto-number value.", "example": "-2024", "maxLength": 25, "type": "string" } }, "required": [], "type": "object", "x-zs-$id": "AutoNumberDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the auto-number configuration for the field, if the field uses auto-numbering." }, "blueprint_supported": { "description": "Indicates whether the field is supported in Blueprint configurations.\nPossible values:\n**true** - The field is supported in Blueprint configurations.\n**false** - The field is not supported in Blueprint configurations.", "example": true, "type": "boolean" }, "child_fields": { "anyOf": [ { "description": "Represents the list of child field entries within an address field configuration.", "items": { "additionalProperties": false, "description": "Represents a child field entry within an address field configuration.", "properties": { "field": { "additionalProperties": false, "description": "Represents the configuration details of the child field.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "name": { "description": "Represents the name of the child field.", "example": "Address 1 - City", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "name", "id" ], "type": "object" }, "sequence_number": { "description": "Represents the display sequence of the child field within the address field.", "example": 1, "format": "int32", "type": "number" } }, "required": [ "sequence_number", "field" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "ChildFields" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the list of child fields associated with this field, applicable for address-type fields." }, "colour_code_enabled_by_system": { "description": "Indicates whether a color code is enabled by the system for this field.\nPossible values:\n**true** - A color code is enabled by the system.\n**false** - No color code is enabled by the system.", "example": false, "type": "boolean" }, "column_name": { "description": "Represents the database column name used to store the field value.", "example": "WEBSITE", "maxLength": 100, "type": "string" }, "convert_mapping": { "additionalProperties": false, "description": "Represents the field mapping configuration used when converting a lead to other CRM modules.", "properties": { "Accounts": { "anyOf": [ { "description": "Represents the Accounts field API name to which this field maps during lead conversion.", "example": "Contact_Name", "maxLength": 100, "type": "string", "x-zs-$id": "AccountFieldName" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the Accounts field API name to which this field is mapped during lead conversion." }, "Contacts": { "anyOf": [ { "description": "Represents the Contacts field API name to which this field maps during lead conversion.", "example": "Contact_Name", "maxLength": 100, "type": "string", "x-zs-$id": "ContactFieldName" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the Contacts field API name to which this field is mapped during lead conversion." }, "Deals": { "anyOf": [ { "description": "Represents the Deals field API name to which this field maps during lead conversion.", "example": "Contact_Name", "maxLength": 100, "type": "string", "x-zs-$id": "DealFieldName" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the Deals field API name to which this field is mapped during lead conversion." } }, "required": [], "type": "object" }, "created_source": { "description": "Represents the source through which this field was added to the organization.", "example": "api", "maxLength": 60, "type": "string" }, "created_time": { "anyOf": [ { "description": "Represents the creation timestamp of the field, in ISO 8601 date-time format.", "example": "2023-10-03T12:00:00+05:30", "format": "date-time", "type": "string", "x-zs-$id": "CreatedTime" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the creation timestamp of the field, in ISO 8601 format." }, "crypt": { "anyOf": [ { "additionalProperties": false, "description": "Represents the encryption settings for the field, including mode and status.", "properties": { "encrypt_case": { "anyOf": [ { "description": "Represents the encryption case configuration applied to this field.", "example": "lowercase", "maxLength": 25, "type": "string", "x-zs-$id": "EncryptCase" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the encryption case configuration applied to this field." }, "mode": { "description": "Represents the encryption mode applied to this field.", "example": "encryption", "maxLength": 25, "type": "string" }, "status": { "description": "Represents the current encryption status of the field.", "example": 1, "format": "int32", "type": "number" } }, "required": [ "mode", "status" ], "type": "object", "x-zs-$id": "CryptDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the encryption configuration for the field, if data encryption is enabled." }, "currency": { "anyOf": [ { "additionalProperties": false, "description": "Represents the currency settings for the field, including precision and rounding options.", "properties": { "precision": { "description": "Represents the number of decimal places used for the currency value.", "example": 2, "format": "int32", "type": "number" }, "rounding_option": { "description": "Represents the rounding option applied to the currency value.", "example": "Round Off", "maxLength": 25, "type": "string" } }, "required": [], "type": "object", "x-zs-$id": "CurrencyDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the currency configuration for the field, applicable when the field stores monetary values." }, "custom_field": { "description": "Indicates whether the field is a custom field created by the organization.\nPossible values:\n**true** - The field is a custom field.\n**false** - The field is a default system field.", "example": true, "type": "boolean" }, "customizable_properties": { "anyOf": [ { "description": "Represents the list of property names that can be customized for this field.", "items": { "description": "Represents a customizable property name for the field.", "example": "mandatory", "maxLength": 50, "type": "string" }, "maxItems": 100, "type": "array", "x-zs-$id": "CustomizableProperties" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the list of properties for this field that can be customized by the organization." }, "data_type": { "description": "Represents the data type of the field.", "example": "Text", "maxLength": 25, "type": "string" }, "decimal_place": { "anyOf": [ { "description": "Represents the decimal precision configuration for the field.", "example": 2, "format": "int32", "type": "number", "x-zs-$id": "DecimalPlaces" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the number of decimal places configured for the field, if the field stores decimal values." }, "default_value": {}, "display_field": { "description": "Indicates whether the field is configured as a display field.\nPossible values:\n**true** - The field is a display field.\n**false** - The field is not a display field.", "example": false, "type": "boolean" }, "display_format": { "anyOf": [ { "description": "Represents the display format pattern for the field.", "example": "dd-MM-yyyy HH:mm:ss", "maxLength": 50, "type": "string", "x-zs-$id": "DisplayFormat" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the display format string for the field, such as a date or number format pattern." }, "display_format_properties": { "anyOf": [ { "additionalProperties": false, "description": "Represents the additional display format properties for the field.", "properties": { "radio_display_type": { "description": "Represents the display type for a radio button field.", "example": "all", "maxLength": 25, "type": "string" }, "split": { "description": "Represents the split configuration value for a phone-type field.", "example": 3, "format": "int32", "type": "number" } }, "required": [], "type": "object", "x-zs-$id": "DisplayFormatProperties" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the additional display format properties for the field, applicable when the field has specific rendering requirements." }, "display_label": { "description": "Represents the display label shown to users for this field.", "example": "Last Name", "maxLength": 50, "type": "string" }, "display_type": { "description": "Represents the display type identifier for the field.", "example": 1, "format": "int32", "type": "number" }, "email_parser": { "additionalProperties": false, "description": "Represents the email parser configuration for the field, indicating which operations are supported through the email parser.", "properties": { "fields_update_supported": { "description": "Indicates whether the field can be updated through the email parser.\nPossible values:\n**true** - Field updates are supported by the email parser.\n**false** - Field updates are not supported by the email parser.", "example": true, "type": "boolean" }, "record_operations_supported": { "description": "Indicates whether record operations are supported for this field through the email parser.\nPossible values:\n**true** - Record operations are supported by the email parser.\n**false** - Record operations are not supported by the email parser.", "example": true, "type": "boolean" } }, "required": [ "fields_update_supported", "record_operations_supported" ], "type": "object" }, "enable_colour_code": { "description": "Indicates whether color coding is enabled for this field.\nPossible values:\n**true** - Color coding is enabled for the field.\n**false** - Color coding is not enabled for the field.", "example": false, "type": "boolean" }, "external": { "anyOf": [ { "additionalProperties": false, "description": "Represents the external field configuration, including visibility and type.", "properties": { "show": { "description": "Indicates whether the external field is visible.\nPossible values:\n**true** - The external field is visible.\n**false** - The external field is hidden.", "example": true, "type": "boolean" }, "type": { "description": "Represents the type of external field association, such as **org** for organization-level fields.", "example": "org", "maxLength": 50, "type": "string" } }, "required": [ "show", "type" ], "type": "object", "x-zs-$id": "External" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the external field configuration, applicable when the field is associated with an external system." }, "field_label": { "description": "Represents the display label of the field as shown in the Zoho CRM interface.", "example": "Last Name", "maxLength": 50, "type": "string" }, "field_read_only": { "description": "Indicates whether the field is configured as read-only.\nPossible values:\n**true** - The field is read-only and cannot be modified.\n**false** - The field can be modified.", "example": false, "type": "boolean" }, "filterable": { "description": "Indicates whether the field can be used as a filter criterion.\nPossible values:\n**true** - The field supports filtering.\n**false** - The field does not support filtering.", "example": true, "type": "boolean" }, "formula": { "anyOf": [ { "additionalProperties": false, "description": "Represents the formula configuration for the field, including return type and computation settings.", "properties": { "assume_default": { "description": "Indicates whether the formula assumes default values for empty inputs.\nPossible values:\n**true** - The formula assumes default values.\n**false** - The formula does not assume default values.", "example": true, "type": "boolean" }, "dynamic": { "description": "Indicates whether the formula is dynamic and recalculated on each access.\nPossible values:\n**true** - The formula is dynamic.\n**false** - The formula is static.", "example": false, "type": "boolean" }, "return_type": { "description": "Represents the data type returned by the formula.", "example": "number", "maxLength": 50, "type": "string" }, "stop_compute_conditionally": { "description": "Indicates whether formula computation stops based on a condition.\nPossible values:\n**true** - Formula computation stops conditionally.\n**false** - Formula computation runs to completion.", "example": false, "type": "boolean" }, "sub_return_type": { "description": "Represents the sub-return type of the formula, providing additional type information for string-type formulas.", "example": "small", "maxLength": 50, "type": "string" } }, "required": [], "type": "object", "x-zs-$id": "FormulaDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the formula configuration for the field, if the field value is computed using a formula." }, "generated_type": { "description": "Represents the integer identifier indicating the type or method used to generate this field.", "example": 1, "format": "int32", "type": "integer" }, "global_picklist": { "anyOf": [ { "additionalProperties": false, "description": "Represents the global picklist configuration linked to this field.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "GlobalPicklistDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the global picklist configuration associated with the field, if the field's picklist values are sourced from a global picklist." }, "hipaa_compliance": { "anyOf": [ { "additionalProperties": false, "description": "Represents the HIPAA compliance settings for the field.", "properties": { "restricted": { "description": "Indicates whether access to the field is restricted due to HIPAA compliance.\nPossible values:\n**true** - Access to the field is restricted.\n**false** - Access to the field is not restricted.", "example": false, "type": "boolean" }, "restricted_in_export": { "description": "Indicates whether the field value is restricted from being exported due to HIPAA compliance.\nPossible values:\n**true** - The field is restricted in exports.\n**false** - The field is not restricted in exports.", "example": false, "type": "boolean" } }, "required": [ "restricted_in_export", "restricted" ], "type": "object", "x-zs-$id": "HipaaCompliance" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the HIPAA compliance configuration for the field, if the field is marked as protected health information." }, "history_tracking": { "anyOf": [ { "additionalProperties": false, "description": "Represents the history tracking configuration for the field, including tracked fields and duration settings.", "properties": { "duration_configuration": { "description": "Represents the duration setting for retaining field change history.", "example": "7_DAYS", "maxLength": 120, "type": "string" }, "duration_configured_field": { "additionalProperties": false, "description": "Represents the field used to configure the history tracking duration.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "followed_fields": { "description": "Represents the list of fields whose changes are tracked in the history.", "items": { "additionalProperties": false, "description": "Represents a field entry whose changes are tracked in the history.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "module": { "additionalProperties": false, "description": "Represents the module associated with the field's history tracking configuration.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "related_list_name": { "description": "Represents the API name of the related list used to store history tracking data.", "example": "Module_Histories", "maxLength": 100, "type": "string" } }, "required": [ "related_list_name", "module", "duration_configured_field", "duration_configuration", "followed_fields" ], "type": "object", "x-zs-$id": "HistoryTrackingDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the history tracking configuration for the field, if field-level change history is enabled." }, "history_tracking_enabled": { "description": "Indicates whether history tracking is enabled for this field.\nPossible values:\n**true** - History tracking is enabled.\n**false** - History tracking is not enabled.", "example": false, "type": "boolean" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "json_type": { "description": "Represents the JSON data type used to represent the field value.", "example": "string", "maxLength": 25, "type": "string" }, "layout_associations": { "description": "Represents the list of layouts that include this field.", "items": { "additionalProperties": false, "description": "Represents a layout entry that includes this field.", "properties": { "api_name": { "description": "Represents the API name of the layout.", "example": "Standard_Layout", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "name": { "description": "Represents the display name of the layout.", "example": "Standard Layout", "maxLength": 25, "type": "string" } }, "required": [ "api_name", "name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "length": { "description": "Represents the maximum character or digit length allowed for the field value.", "example": 255, "format": "int32", "type": "number" }, "lookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the lookup field configuration, including the referenced module and filter settings.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "display_label": { "description": "Represents the display label of the related lookup field.", "example": "Related List Label 1", "maxLength": 50, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "module": { "additionalProperties": false, "description": "Represents the module from which the lookup field retrieves its records.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "crypt": { "description": "Indicates whether the data in the module is encrypted.\nPossible values:\n**true** - The module data is encrypted.\n**false** - The module data is not encrypted.", "example": false, "type": "boolean" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "crypt", "id" ], "type": "object" }, "query_details": { "additionalProperties": false, "description": "Represents the system query configuration applied to the lookup field.", "properties": { "query_id": { "description": "Represents the query ID associated with this lookup field.", "example": "4832675000000850800", "format": "int64", "maxLength": 30, "type": "string" }, "system_query_id": { "anyOf": [ { "description": "Represents the system-generated query ID for the lookup field.", "example": "4832675000000850800", "format": "int64", "maxLength": 30, "type": "string", "x-zs-$id": "SystemQueryId" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the system-generated query ID for this lookup field." } }, "required": [ "system_query_id" ], "type": "object" }, "revalidate_filter_during_edit": { "description": "Indicates whether the lookup filter criteria are revalidated when the record is edited.\nPossible values:\n**true** - The filter is revalidated during edits.\n**false** - The filter is not revalidated during edits.", "example": true, "type": "boolean" } }, "required": [], "type": "object", "x-zs-$id": "LookupDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the lookup configuration for the field, applicable when the field references records from another module." }, "lucene_colname": { "description": "Represents the Lucene index column name used for full-text search on this field.", "example": "LASTNAME", "maxLength": 1000, "type": "string" }, "modified_time": { "anyOf": [ { "description": "Represents the date and time when the field was last modified, in ISO 8601 date-time format.", "example": "2023-10-05T15:30:00+05:30", "format": "date-time", "type": "string", "x-zs-$id": "ModifiedTime" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the date and time when the field was last modified, in ISO 8601 format." }, "multi_module_lookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the multi-module lookup configuration, including display label, API name, and associated modules.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "display_label": { "description": "Represents the display label of the multi-module lookup field.", "example": "Appointments", "maxLength": 50, "type": "string" }, "modules": { "description": "Represents the list of modules that this multi-module lookup field can reference.", "items": { "additionalProperties": false, "description": "Represents a module entry available for selection in the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "module_name": { "description": "Represents the API name of the module available in the multi-module lookup.", "example": "Leads", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "module_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [], "type": "object", "x-zs-$id": "MultiModuleLookup" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the multi-module lookup configuration for the field, applicable when the field can reference records from multiple modules." }, "multiselectlookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the multi-select lookup configuration, including linking module and connected module details.", "properties": { "connected_details": { "additionalProperties": false, "description": "Represents the connected module details for the multi-select lookup field.", "properties": { "field": { "additionalProperties": false, "description": "Represents the field configuration in the connected module.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "field_label": { "description": "Represents the display label of the field in the connected module.", "example": "Account Name", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "layouts": { "description": "Represents the list of layouts associated with the connected module in the multi-select lookup.", "items": { "additionalProperties": false, "description": "Represents a layout entry for the connected module in the multi-select lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "module": { "additionalProperties": false, "description": "Represents the connected module in the multi-select lookup configuration.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "plural_label": { "description": "Represents the plural display label of the connected module.", "example": "Accounts", "maxLength": 25, "type": "string" } }, "required": [ "plural_label", "api_name", "id" ], "type": "object" } }, "required": [ "field", "module", "layouts" ], "type": "object" }, "linking_details": { "additionalProperties": false, "description": "Represents the linking module configuration that manages the many-to-many relationship.", "properties": { "connected_lookup_field": { "additionalProperties": false, "description": "Represents the connected lookup field in the linking module.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "field_label": { "description": "Represents the display label of the connected lookup field.", "example": "Account Name", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field in the linking module.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "field_label": { "description": "Represents the display label of the lookup field.", "example": "Contact Name", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Represents the linking module that manages the many-to-many relationship.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "plural_label": { "description": "Represents the plural display label of the linking module.", "example": "Contacts", "maxLength": 25, "type": "string" }, "visibility": { "description": "Represents the visibility setting of the linking module.", "example": 1, "format": "int32", "type": "number" } }, "required": [ "visibility", "plural_label", "api_name", "id" ], "type": "object" } }, "required": [ "module", "lookup_field", "connected_lookup_field" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Represents the related list configuration for the multi-select lookup field.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "display_label": { "description": "Represents the display label of the related list.", "example": "Related List Label 1", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "display_label", "api_name", "id" ], "type": "object" } }, "required": [], "type": "object", "x-zs-$id": "MultiModuleLookupDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the multi-select lookup configuration for the field, applicable when the field links to a many-to-many relationship module." }, "multiuserlookup": { "additionalProperties": false, "description": "Represents the multi-user lookup configuration for the field, applicable when the field can reference multiple users.", "properties": { "linking_details": { "additionalProperties": false, "description": "Represents the linking module configuration for the multi-user lookup field.", "properties": { "connected_lookup_field": { "additionalProperties": false, "description": "Represents the connected lookup field in the multi-user lookup linking module.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "field_label": { "description": "Represents the display label of the connected lookup field in the multi-user lookup.", "example": "Role Name", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field in the multi-user lookup linking module.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "field_label": { "description": "Represents the display label of the lookup field in the multi-user lookup.", "example": "User Name", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Represents the linking module for the multi-user lookup configuration.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "plural_label": { "description": "Represents the plural display label of the multi-user lookup module.", "example": "Users", "maxLength": 25, "type": "string" } }, "required": [ "plural_label", "api_name", "id" ], "type": "object" } }, "required": [ "module", "lookup_field", "connected_lookup_field" ], "type": "object" }, "record_access": { "description": "Indicates whether record access is enabled for the multi-user lookup field.\nPossible values:\n**true** - Record access is enabled.\n**false** - Record access is not enabled.", "example": true, "type": "boolean" } }, "required": [ "linking_details", "record_access" ], "type": "object" }, "operation_type": { "additionalProperties": false, "description": "Represents the set of operation types permitted for this field across different contexts.", "properties": { "api_create": { "description": "Indicates whether the field can be set during record creation via the API.\nPossible values:\n**true** - The field can be set when creating records via the API.\n**false** - The field cannot be set during API record creation.", "example": false, "type": "boolean" }, "api_update": { "description": "Indicates whether the field can be updated via the API.\nPossible values:\n**true** - The field can be updated via the API.\n**false** - The field cannot be updated via the API.", "example": false, "type": "boolean" }, "web_create": { "description": "Indicates whether the field can be set during record creation via the web interface.\nPossible values:\n**true** - The field can be set when creating records via the web interface.\n**false** - The field cannot be set during web record creation.", "example": false, "type": "boolean" }, "web_update": { "description": "Indicates whether the field can be updated via the web interface.\nPossible values:\n**true** - The field can be updated via the web interface.\n**false** - The field cannot be updated via the web interface.", "example": false, "type": "boolean" } }, "required": [ "web_update", "api_create", "web_create", "api_update" ], "type": "object" }, "parent_field": { "anyOf": [ { "additionalProperties": false, "description": "Represents the parent field configuration, including API name, display name, and ID.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "name": { "description": "Represents the display name of the parent field.", "example": "Address 1 - Coordinates", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "name", "id" ], "type": "object", "x-zs-$id": "ParentField" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the parent field configuration, applicable when this field is a sub-field within a parent field such as an address." }, "pick_list_values": { "anyOf": [ { "description": "Represents the list of picklist options configured for the field.", "items": { "additionalProperties": false, "description": "Represents a picklist option for the field.", "properties": { "actual_value": { "description": "Represents the actual stored value of the picklist option.", "example": "Option 1", "maxLength": 120, "type": "string" }, "colour_code": { "description": "Represents the color code associated with this picklist option.", "example": "#FF5733", "maxLength": 20, "type": "string" }, "display_value": { "description": "Represents the display label shown to users for this picklist option.", "example": "Option 1", "maxLength": 120, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" }, "reference_value": { "description": "Represents the reference value used internally for this picklist option.", "example": "option_1", "maxLength": 120, "type": "string" }, "sequence_number": { "description": "Represents the display order of the picklist option in the list.", "example": 1, "format": "int32", "type": "number" }, "type": { "description": "Represents the type classification of this picklist option.", "example": "standard", "maxLength": 50, "type": "string" } }, "required": [ "display_value", "sequence_number", "reference_value", "actual_value", "id", "type" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "PickListValues" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the list of available picklist option values for the field, if the field is of a picklist type." }, "pick_list_values_sorted_lexically": { "description": "Indicates whether the picklist options are sorted in lexicographic order.\nPossible values:\n**true** - The picklist options are sorted lexicographically.\n**false** - The picklist options follow a custom sequence order.", "example": false, "type": "boolean" }, "private": { "anyOf": [ { "additionalProperties": false, "description": "Represents the privacy settings for the field.", "properties": { "export": { "description": "Indicates whether the private field can be included in data exports.\nPossible values:\n**true** - The field can be exported.\n**false** - The field is restricted from exports.", "example": false, "type": "boolean" }, "restricted": { "description": "Indicates whether access to the private field is restricted.\nPossible values:\n**true** - Access to the field is restricted.\n**false** - Access to the field is not restricted.", "example": false, "type": "boolean" }, "type": { "description": "Represents the privacy level of the field, such as **High**.", "example": "High", "maxLength": 25, "type": "string" } }, "required": [ "restricted", "type", "export" ], "type": "object", "x-zs-$id": "PrivateField" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the privacy configuration for the field, if the field is marked as private." }, "public": { "description": "Indicates whether the field is publicly accessible.\nPossible values:\n**true** - The field is publicly accessible.\n**false** - The field is not publicly accessible.", "example": true, "type": "boolean" }, "quick_sequence_number": { "description": "Represents the sequence number of the field in the quick-create form.", "example": "1", "maxLength": 10, "type": "string" }, "range": { "anyOf": [ { "additionalProperties": false, "description": "Represents the allowed numeric range configuration for the field.", "properties": { "from": { "description": "Represents the minimum allowed value for the field.", "example": 1, "format": "double", "type": "number" }, "to": { "description": "Represents the maximum allowed value for the field.", "example": 100, "format": "double", "type": "number" } }, "required": [ "from", "to" ], "type": "object", "x-zs-$id": "RangeDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the allowed value range for the field, applicable when the field enforces a numeric range." }, "read_only": { "description": "Indicates whether the field is read-only in the current context.\nPossible values:\n**true** - The field is read-only.\n**false** - The field is editable.", "example": false, "type": "boolean" }, "refer_from_field": { "anyOf": [ { "description": "Represents the null state, indicating that no source field is referenced.", "type": "null", "x-zs-$id": "ReferFromFieldNull" }, { "additionalProperties": false, "description": "Represents the source field from which this field's value is referenced.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "ReferFromFieldDetails" } ], "description": "Represents the field from which this field's value is referenced, applicable when the field value is inherited from another field." }, "required": { "description": "Indicates whether the field is mandatory for creating or updating a record.\nPossible values:\n**true** - The field is mandatory.\n**false** - The field is optional.", "type": "boolean" }, "rollup_summary": { "anyOf": [ { "additionalProperties": false, "description": "Represents the rollup summary configuration, including the aggregate function, expression, and related module details.", "properties": { "based_on_module": { "additionalProperties": false, "description": "Represents the module whose records are aggregated in the rollup summary.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "expression": { "additionalProperties": false, "description": "Represents the expression configuration that defines the rollup calculation.", "properties": { "criteria": { "anyOf": [ { "additionalProperties": false, "description": "Represents the filter criteria configuration for the rollup summary.", "properties": { "comparator": { "description": "Represents the comparison operator used in the rollup filter criteria.", "example": "equals", "maxLength": 25, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field used as a criterion in the rollup filter.", "properties": { "api_name": { "description": "Represents the API name of the field used in the rollup filter criteria.", "example": "Status", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Represents the type of the rollup filter criteria.", "example": "custom", "maxLength": 25, "type": "string" }, "value": { "description": "Represents the value compared against the field in the rollup filter criteria.", "example": "Approved", "maxLength": 100, "type": "string" } }, "required": [ "comparator", "field", "type", "value" ], "type": "object", "x-zs-$id": "RollupCriteria" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the filter criteria applied to records before the rollup aggregation is computed." }, "function": { "description": "Represents the aggregate function used in the rollup summary calculation.", "example": "SUM", "maxLength": 25, "type": "string" }, "function_parameters": { "description": "Represents the list of parameters passed to the rollup aggregate function.", "items": { "additionalProperties": false, "description": "Represents a parameter for the rollup aggregate function.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "function_parameters", "function" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Represents the related list whose records are used for the rollup aggregation.", "properties": { "api_name": { "$ref": "#/components/schemas/CoqlApiName" }, "id": { "$ref": "#/components/schemas/CoqlId" } }, "required": [ "api_name", "id" ], "type": "object" }, "return_type": { "description": "Represents the data type of the value returned by the rollup summary.", "example": "number", "maxLength": 50, "type": "string" }, "rollup_based_on": { "description": "Represents the field on which the rollup aggregation is based.", "example": "Created_Time", "maxLength": 50, "type": "string" } }, "required": [], "type": "object", "x-zs-$id": "RollupSummaryDetails" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the rollup summary configuration for the field, applicable when the field aggregates data from related records." }, "searchable": { "description": "Indicates whether the field can be used in search queries.\nPossible values:\n**true** - The field is searchable.\n**false** - The field is not searchable.", "example": true, "type": "boolean" }, "separator": { "description": "Indicates whether the field acts as a visual separator in the layout.\nPossible values:\n**true** - The field is a separator.\n**false** - The field is a regular field.", "example": false, "type": "boolean" }, "sharing_properties": { "additionalProperties": false, "description": "Represents the data-sharing configuration for the field.", "properties": { "scheduler_status": { "description": "Represents the scheduler status for the field's sharing configuration.", "example": "enabled", "maxLength": 50, "type": "string" }, "share_permission": { "description": "Represents the sharing permission level configured for the field.", "example": "read_write", "maxLength": 50, "type": "string" }, "share_preference_enabled": { "description": "Indicates whether a share preference is configured for this field.\nPossible values:\n**true** - Share preference is enabled.\n**false** - Share preference is not enabled.", "example": true, "type": "boolean" } }, "required": [ "scheduler_status", "share_permission", "share_preference_enabled" ], "type": "object" }, "sortable": { "description": "Indicates whether records can be sorted by this field.\nPossible values:\n**true** - The field supports sorting.\n**false** - The field does not support sorting.", "example": true, "type": "boolean" }, "system_mandatory": { "description": "Indicates whether the field is marked as mandatory by the system.\nPossible values:\n**true** - The field is system-mandatory and cannot be set as optional.\n**false** - The field is not system-mandatory.", "example": false, "type": "boolean" }, "table_name": { "description": "Represents the name of the database table in which the field is stored.", "example": "CrmLeadDetails", "maxLength": 1000, "type": "string" }, "textarea": { "additionalProperties": false, "description": "Represents the textarea configuration for the field, applicable when the field is of a textarea type.", "properties": { "type": { "description": "Represents the textarea subtype, such as **Large** for large text areas.", "example": "Large", "maxLength": 50, "type": "string" } }, "required": [ "type" ], "type": "object" }, "tooltip": { "anyOf": [ { "additionalProperties": false, "description": "Represents the tooltip configuration for the field, including icon name and display text.", "properties": { "name": { "description": "Represents the icon name used for the tooltip.", "example": "info_icon", "maxLength": 25, "type": "string" }, "value": { "description": "Represents the tooltip text displayed to users when they hover over the field.", "example": "Last Name", "maxLength": 255, "type": "string" } }, "required": [ "name", "value" ], "type": "object", "x-zs-$id": "ToolTip" }, { "$ref": "#/components/schemas/CoqlTypeNull" } ], "description": "Represents the tooltip configuration for the field, if a tooltip is configured to provide additional guidance to users." }, "type": { "description": "Represents the field type classification.", "example": "user", "maxLength": 25, "type": "string" }, "ui_type": { "description": "Represents the UI type identifier that determines how the field is rendered in the user interface.", "example": 1, "format": "int32", "type": "number" }, "unique": { "additionalProperties": false, "description": "Represents the uniqueness constraint configuration for the field.", "properties": { "case_sensitive": { "description": "Indicates whether the uniqueness check for this field is case-sensitive.\nPossible values:\n**true** - The uniqueness check is case-sensitive.\n**false** - The uniqueness check is case-insensitive.", "example": false, "type": "boolean" } }, "required": [], "type": "object" }, "view_type": { "additionalProperties": false, "description": "Represents the view type configuration for the field, indicating which form views support this field.", "properties": { "create": { "description": "Indicates whether the field is available in the create form.\nPossible values:\n**true** - The field is available in the create form.\n**false** - The field is not available in the create form.", "example": true, "type": "boolean" }, "edit": { "description": "Indicates whether the field is available in the edit form.\nPossible values:\n**true** - The field is available in the edit form.\n**false** - The field is not available in the edit form.", "example": true, "type": "boolean" }, "quick_create": { "description": "Indicates whether the field is available in the quick-create form.\nPossible values:\n**true** - The field is available in the quick-create form.\n**false** - The field is not available in the quick-create form.", "example": true, "type": "boolean" }, "view": { "description": "Indicates whether the field is visible in the detail view.\nPossible values:\n**true** - The field is visible in the detail view.\n**false** - The field is not visible in the detail view.", "example": true, "type": "boolean" } }, "required": [ "view", "edit", "quick_create", "create" ], "type": "object" }, "virtual_field": { "description": "Indicates whether the field is a virtual field that is computed and not stored directly.\nPossible values:\n**true** - The field is virtual.\n**false** - The field is a stored field.", "example": false, "type": "boolean" }, "visible": { "description": "Indicates whether the field is visible to users in the Zoho CRM interface.\nPossible values:\n**true** - The field is visible.\n**false** - The field is hidden.", "example": true, "type": "boolean" }, "webhook": { "description": "Indicates whether webhook notifications are enabled for changes to this field.\nPossible values:\n**true** - Webhook notifications are enabled for this field.\n**false** - Webhook notifications are not enabled for this field.", "example": false, "type": "boolean" } }, "required": [ "webhook", "operation_type", "colour_code_enabled_by_system", "field_label", "type", "field_read_only", "display_label", "read_only", "association_details", "multi_module_lookup", "id", "filterable", "visible", "view_type", "separator", "searchable", "history_tracking_enabled", "external", "api_name", "unique", "enable_colour_code", "pick_list_values", "system_mandatory", "virtual_field", "range", "created_source", "display_type", "ui_type", "public", "email_parser", "currency", "custom_field", "lookup", "convert_mapping", "rollup_summary", "column_name", "display_field", "pick_list_values_sorted_lexically", "sortable", "data_type", "formula", "multiselectlookup", "auto_number", "table_name", "required", "refer_from_field", "default_value", "lucene_colname", "generated_type" ], "type": "object" }, "CoqlId": { "description": "Id of the resource.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$id": "Id" }, "CoqlModuleName": { "description": "Represents the name of the module.", "example": "Leads", "maxLength": 100, "type": "string" }, "CoqlTypeNull": { "description": "Represents the null if no information is available.", "type": "null", "x-zs-$id": "TypeNull" }, "CountParameters": { "additionalProperties": false, "description": "Represents optional filtering and selection parameters applied to related records before counting. Includes support for approval status, conversion status, category type, and field-level equality filters.", "properties": { "approval_state": { "description": "Represents the approval workflow state used to filter related records before counting.\nPossible values:\n**approved** - Count only records in the approved workflow state.", "enum": [ "approved" ], "type": "string" }, "approved": { "description": "Indicates whether to restrict the count to approved records only.\nPossible values:\n**true** - Count only approved records.\n**false** - Count only records that are not approved.", "type": "boolean" }, "category": { "description": "Represents the category type used to filter related records before counting.\nPossible values:\n**link** - Count only link-type related records.\n**files** - Count only file-attachment related records.", "enum": [ "link", "files" ], "type": "string" }, "converted": { "description": "Indicates whether to restrict the count to converted records only. Applicable to the Leads module.\nPossible values:\n**true** - Count only converted records.\n**false** - Count only records that have not been converted.", "type": "boolean" }, "filters": { "$ref": "#/components/schemas/FilterCriteria" } }, "required": [ "filters" ], "type": "object" }, "CountSuccessResponse": { "additionalProperties": false, "description": "Success response.", "properties": { "count": { "description": "Represents the count returned for the Assignment Rule operation.", "format": "int32", "type": "integer" } }, "title": "Count Sucess Response", "type": "object", "x-zs-$id": "CountSuccessResponse" }, "CreateAndUpdateBadResponseWithShareArray": { "additionalProperties": false, "description": "Represents the bad request response in which the errors are reported per share entry under the **share** array.", "properties": { "share": { "description": "Represents the list of error responses for the share record creation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/ShareRecordsMandatoryNotFound" }, { "$ref": "#/components/schemas/InvalidTypeErrorResponse" }, { "$ref": "#/components/schemas/InvalidShareWithValueErrorResponse" }, { "$ref": "#/components/schemas/InvalidShareWithIdErrorResponse" }, { "$ref": "#/components/schemas/ActivityModuleRelatedIssueErrorResponse" }, { "$ref": "#/components/schemas/ShareLimitExceedErrorResponse" } ], "description": "Each string represents the per-entry result for one share entry, which can be either a success or a specific error.", "x-zs-$id": "CreateAndUpdateMultipleStatusCaseErrorResponse" }, "maxItems": 20, "type": "array" } }, "required": [ "share" ], "type": "object", "x-zs-$id": "CreateUpdateBadResponseWithShareArray" }, "CreateAndUpdateBadResponseWithoutShareArray": { "anyOf": [ { "$ref": "#/components/schemas/InvalidRecordIdErrorResponse" }, { "$ref": "#/components/schemas/InvalidModuleNameErrorResponse" }, { "$ref": "#/components/schemas/ShareRecordsMaximumLengthErrorResponse" }, { "$ref": "#/components/schemas/UnsupportedModule" }, { "$ref": "#/components/schemas/AmbiguousShareErrorResponse" } ], "description": "Represents the bad request response in which the failure applies to the entire request rather than to individual share entries.", "x-zs-$id": "CreateAndUpdateBadResponseWithoutShareArray" }, "CreateAndUpdateShareRecordsBadRequest": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/CreateAndUpdateBadResponseWithShareArray" }, { "$ref": "#/components/schemas/CreateAndUpdateBadResponseWithoutShareArray" } ], "description": "Represents the bad request response returned by the share create and update operations. The payload is either a per-entry error list under the `share` array or a single error object for path-level or request-level failures.", "type": "object", "x-zs-$id": "CreateAndUpdateShareRecordsAllBadRequest" }, "CreateAndUpdateSuccessResponse": { "additionalProperties": false, "description": "Represents the per-entry success result of a share record create or update operation.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "record will be shared successfully" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateAndUpdateSuccessResponse" }, "CreateAuditLogExportDirectError": { "anyOf": [ { "$ref": "#/components/schemas/CreateAuditLogExportDirectErrorMandatoryNotFound" }, { "$ref": "#/components/schemas/CreateAuditLogExportDirectErrorInvalidData" }, { "$ref": "#/components/schemas/CreateAuditLogExportDirectErrorInvalidRequest" } ], "description": "Error raised before the criteria are validated, returned without the audit_log_export wrapper.", "x-zs-$id": "CreateAuditLogExportDirectError" }, "CreateAuditLogExportDirectErrorInvalidData": { "additionalProperties": false, "description": "The request body has the wrong data type at the top level.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the invalid value.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 64, "type": "string" }, "expected_data_type": { "description": "Data type expected for this field.", "maxLength": 32, "type": "string" }, "json_path": { "description": "JSON path of the field within the request body.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportDirectErrorInvalidData" }, "CreateAuditLogExportDirectErrorInvalidRequest": { "additionalProperties": false, "description": "The organization is in read-only mode, so no export can be scheduled.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Always an empty object for this error.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportDirectErrorInvalidRequest" }, "CreateAuditLogExportDirectErrorMandatoryNotFound": { "additionalProperties": false, "description": "The request body is missing the audit_log_export key.", "properties": { "code": { "description": "Error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportDirectErrorMandatoryNotFound" }, "CreateAuditLogExportErrorAlreadyScheduled": { "additionalProperties": false, "description": "An audit log export job is already scheduled for this organization.", "properties": { "code": { "description": "Error code.", "enum": [ "ALREADY_SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Identifier of the export job that is already scheduled.", "properties": { "id": { "description": "Unique identifier of the already scheduled export job.", "maxLength": 64, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorAlreadyScheduled" }, "CreateAuditLogExportErrorAmbiguityDuringProcessing": { "additionalProperties": false, "description": "Both id and api_name were supplied for a module value but they identify different modules.", "properties": { "code": { "description": "Error code.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Fields that conflict with one another.", "properties": { "ambiguity_due_to": { "description": "The conflicting fields.", "items": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "maxItems": 25, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorAmbiguityDuringProcessing" }, "CreateAuditLogExportErrorDependentFieldMissing": { "additionalProperties": false, "description": "A field was supplied without its dependent field.", "properties": { "code": { "description": "Error code.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "The missing field and the field it depends on.", "properties": { "api_name": { "description": "API name of the missing field.", "maxLength": 64, "type": "string" }, "dependee": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "expected_data_type": { "description": "Data type expected for the missing field.", "maxLength": 32, "type": "string" }, "json_path": { "description": "JSON path of the missing field within the request body.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorDependentFieldMissing" }, "CreateAuditLogExportErrorDependentMismatch": { "additionalProperties": false, "description": "The supplied value is incompatible with the comparator it depends on.", "properties": { "code": { "description": "Error code.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "The mismatched field and the field it depends on.", "properties": { "api_name": { "description": "API name of the mismatched field.", "maxLength": 64, "type": "string" }, "dependee": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "expected_data_type": { "description": "Data type expected for the mismatched field.", "maxLength": 32, "type": "string" }, "json_path": { "description": "JSON path of the mismatched field within the request body.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorDependentMismatch" }, "CreateAuditLogExportErrorExpectedFieldMissing": { "additionalProperties": false, "description": "Neither group nor field was supplied inside criteria.", "properties": { "code": { "description": "Error code.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Fields of which at least one must be supplied.", "properties": { "expected_fields": { "description": "Candidate fields, at least one of which is required.", "items": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "maxItems": 25, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorExpectedFieldMissing" }, "CreateAuditLogExportErrorInvalidData": { "additionalProperties": false, "description": "The supplied value is invalid for the given field or comparator.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the invalid value.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 64, "type": "string" }, "expected_data_type": { "description": "Data type expected for this field. Present when the value has the wrong type.", "maxLength": 32, "type": "string" }, "json_path": { "description": "JSON path of the field within the request body.", "maxLength": 256, "type": "string" }, "supported_values": { "description": "Values accepted for this field. Present when the value is outside the allowed set.", "items": { "description": "An accepted value.", "maxLength": 64, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorInvalidData" }, "CreateAuditLogExportErrorLimitExceeded": { "additionalProperties": false, "description": "An array in the request exceeds its permitted size.", "properties": { "code": { "description": "Error code.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the exceeded limit.", "properties": { "api_name": { "description": "API name of the array that exceeded its limit.", "maxLength": 64, "type": "string" }, "json_path": { "description": "JSON path of the array within the request body.", "maxLength": 256, "type": "string" }, "limit": { "description": "Maximum number of items permitted.", "maxLength": 32, "type": "string" } }, "required": [ "api_name", "json_path", "limit" ], "type": "object" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorLimitExceeded" }, "CreateAuditLogExportErrorMandatoryNotFound": { "additionalProperties": false, "description": "A mandatory key inside criteria is missing.", "properties": { "code": { "description": "Error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorMandatoryNotFound" }, "CreateAuditLogExportErrorNotAllowed": { "additionalProperties": false, "description": "The audited_time range spans more than 180 days.", "properties": { "code": { "description": "Error code.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorNotAllowed" }, "CreateAuditLogExportErrorNotSupported": { "additionalProperties": false, "description": "The supplied field or value is not supported by this API.", "properties": { "code": { "description": "Error code.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/AuditLogExportErrorFieldPointer" }, "message": { "description": "Error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateAuditLogExportErrorNotSupported" }, "CreateAuditLogExportWrappedError": { "additionalProperties": false, "description": "Error raised while validating the export criteria, wrapped in the audit_log_export array.", "properties": { "audit_log_export": { "description": "Array containing a single error object.", "items": { "anyOf": [ { "$ref": "#/components/schemas/CreateAuditLogExportErrorMandatoryNotFound" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorNotSupported" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorNotAllowed" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorInvalidData" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorLimitExceeded" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorExpectedFieldMissing" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorAmbiguityDuringProcessing" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorDependentFieldMissing" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorDependentMismatch" }, { "$ref": "#/components/schemas/CreateAuditLogExportErrorAlreadyScheduled" } ], "description": "The error raised while validating the export request.", "x-zs-$id": "CreateAuditLogExportWrappedErrorItem" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "audit_log_export" ], "type": "object", "x-zs-$id": "CreateAuditLogExportWrappedError" }, "CreateConnectedRecordActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that creates a connected record in a child module when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationCreateConnectedRecordDetails", "description": "Configuration for the create_connected_record action. Uses the same structure as create_record — module, layout, and field mappings — but the module must be a valid connected-record child module. Not supported for the Notes, Rebuy, or Competitor Mentions modules.\n" }, "id": { "description": "Represents the unique ID of the CreateConnectedRecord action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the CreateConnectedRecord action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. Not typically used for create_connected_record." }, "type": { "const": "create_connected_record", "description": "Represents the action type discriminator that identifies this as a CreateConnectedRecord action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "CreateConnectedRecordActionSchema", "x-zs-llm-description": "Inline action type='create_connected_record'. Same structure as create_record but targets a connected-record child module. Limit 1/rule. Not for Notes, Rebuy, or Competitor Mentions. Requires ManageAutomation or ManageConnectedWorkflow permission. Needs module, layout, and field_mappings." }, "CreateDuplicateCheckPreferenceRequest": { "additionalProperties": false, "description": "Represents the request payload used to create duplicate check preference.", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Duplicate check preference details.", "properties": { "type": { "description": "Type of duplicate check preference.", "enum": [ "converted_records", "mapped_module_records" ], "type": "string" }, "type_configurations": { "description": "Configurations for the duplicate check preference type. Mandatory when type is mapped_module_records and ignored when type is converted_records. Only the first entry is processed.", "items": { "additionalProperties": false, "description": "Type configuration details.", "properties": { "field_mappings": { "description": "Field mappings for duplicate check.", "items": { "additionalProperties": false, "description": "Field mapping details.", "properties": { "current_field": { "additionalProperties": false, "description": "Unique field in the Leads module to match on.", "properties": { "api_name": { "description": "Represents the API name of the unique field in the Leads module. Validated when supplied, but the mapping is stored against id.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the field. Use the [Get Fields Metadata API](fields.json#$.paths./settings/fields.get) to retrieve the unique ID fields. The mapping is stored against this id, so it is mandatory.", "maxLength": 50, "type": "string" }, "name": { "description": "Accepted for symmetry with the response and ignored by the API.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "mapped_field": { "additionalProperties": false, "description": "Unique field in the mapped module to match against.", "properties": { "api_name": { "description": "Represents the API name of the mapped field. Validated when supplied, but the mapping is stored against id.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the mapped field. The mapping is stored against this id, so it is mandatory.", "maxLength": 50, "type": "string" }, "name": { "description": "Accepted for symmetry with the response and ignored by the API.", "maxLength": 50, "type": "string" }, "selected": { "description": "Send None to skip this field mapping. Any other value, or omitting the property, creates the mapping.", "enum": [ "None" ], "maxLength": 4, "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "current_field", "mapped_field" ], "type": "object" }, "type": "array" }, "mapped_module": { "additionalProperties": false, "description": "Represents the mapped module details. Mandatory when type is mapped_module_records.", "properties": { "api_name": { "description": "Represents the API name of the module. Validated when supplied, but the module is resolved from id.", "enum": [ "Contacts" ], "type": "string" }, "id": { "description": "Represents the unique identifier of the module. The module must resolve to Contacts.", "maxLength": 50, "type": "string" }, "name": { "description": "Accepted for symmetry with the response and ignored by the API.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "field_mappings", "mapped_module" ], "type": "object" }, "maxItems": 1, "type": [ "array", "null" ] } }, "required": [ "type" ], "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "CreateDuplicateCheckPreferenceRequest" }, "CreateFieldUpdateRequest": { "additionalProperties": false, "description": "The request body wrapper for creating or updating a field update action. Must contain a field_updates array with exactly one entry.", "examples": [ { "field_updates": [ { "apply_assignment_threshold": false, "field": { "api_name": "Owner", "id": "738964000000091010" }, "module": { "api_name": "Accounts" }, "name": "Assign To Regional Owner", "notify": true, "related_records": [ { "api_name": "Contacts" }, { "api_name": "Deals" } ], "type": "static", "value": { "id": "738964000000030001" } } ] }, { "field_updates": [ { "dependent_fields": [ { "field": { "api_name": "Stage", "id": "3361265000000000525" }, "value": "Qualification" } ], "field": { "api_name": "Pipeline", "id": "3361265000000236001" }, "module": { "api_name": "Deals" }, "name": "Set Pipeline And Stage", "type": "static", "value": "Enterprise Sales" } ] } ], "properties": { "field_updates": { "description": "Array containing one field update configuration object. Exactly one item is allowed per request.", "items": { "$ref": "#/components/schemas/FieldUpdateConfigurationForCreate" }, "maxItems": 1, "type": "array" } }, "required": [ "field_updates" ], "title": "Create Field Update Request", "type": "object", "x-zs-llm-description": "Wraps the request body; must include a field_updates array containing exactly one entry. On PUT, include every required field (name, module, field, type, value) since partial updates are unreliable. type must be 'static'; field must carry both id and api_name at call time." }, "CreateFieldsResponse": { "additionalProperties": false, "description": "Represents the response body returned when one or more custom fields are created.", "properties": { "fields": { "description": "Represents the list of creation results, one per field submitted in the request.", "items": { "$ref": "#/components/schemas/FieldCreationResult" }, "maxItems": 5, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "CreateFieldsResponse" }, "CreateRecordActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that creates a new record in a specified CRM module when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationCreateRecordDetails", "description": "Configuration for the create_record action. Requires a module, a layout, and one to twenty-five field mappings that supply values for the new record fields, using a static value, a merge field, an execution-time offset, or a composite value. All fields marked mandatory by the layout must be included. Optionally restricts creation to prevent duplicate records.\n" }, "id": { "description": "Represents the unique ID of the CreateRecord action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the CreateRecord action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. For create_record, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only)." }, "type": { "const": "create_record", "description": "Represents the action type discriminator that identifies this as a CreateRecord action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "CreateRecordActionSchema", "x-zs-llm-description": "Inline action type='create_record'. Creates a record in a specified module (NOT Tasks/Events/Calls - use tasks/add_meeting/schedule_call). Requires module, layout, and field_mappings (1-25 entries, must include all mandatory fields). Each mapping: {field, type, value} with type discriminating: static (literal), merge_field (${!Module.Field} token), execution_time (date offset), composite (multi-value)." }, "CreateScoringRuleRequestBody": { "additionalProperties": false, "description": "Represents the request body for the create Scoring Rules operation, containing an array of Scoring Rule definitions.", "properties": { "scoring_rules": { "description": "Represents an array of Scoring Rule definitions to create. Required for POST operations.", "items": { "$ref": "#/components/schemas/ScoringRulePOST" }, "maxItems": 20, "minItems": 1, "type": "array" } }, "required": [ "scoring_rules" ], "title": "Create Scoring Rule Request Body", "type": "object" }, "CreateScoringRuleSuccessResponse": { "additionalProperties": false, "description": "Successful creation response for scoring rules, containing details of the created rules.", "properties": { "scoring_rules": { "description": "Represents the response body for a successful create Scoring Rules operation.", "items": { "$ref": "#/components/schemas/CreatedScoringRuleResponseItem" }, "maxItems": 20, "type": "array" } }, "title": "Create Scoring Rule Success Response", "type": "object", "x-zs-$id": "CreateScoringRuleSuccessResponse" }, "CreateTaskSuccessResponse": { "additionalProperties": false, "description": "Successful response after creating an automation task definition.", "properties": { "tasks": { "description": "Array containing the created task result.", "items": { "$ref": "#/components/schemas/TaskActionResult" }, "maxItems": 1, "type": "array" } }, "required": [ "tasks" ], "title": "Create Task Success Response", "type": "object", "x-zs-$id": "CreateTaskSuccessResponse", "x-zs-llm-description": "Success response after POST creation. Contains the created task ID in the result details." }, "CreateUnsubscribeLinksSuccessResponse": { "additionalProperties": false, "description": "Success response for a POST request that returns the action status of each newly created unsubscribe link.", "properties": { "unsubscribe_links": { "description": "Array containing the status of the creation operation for each link", "items": { "$ref": "#/components/schemas/UnsubscribeLinkActionStatus" }, "maxItems": 1, "type": "array" } }, "title": "Unsubscribe Link Creation Result List", "type": "object", "x-zs-$id": "PostunsubscribelinksResponse201" }, "CreateWebhooksRequestBody": { "additionalProperties": false, "description": "Represents the request body wrapper for creating a webhook. The webhooks array must contain exactly one webhook object.", "properties": { "webhooks": { "description": "Represents the list containing exactly one webhook object to create.", "items": { "$ref": "#/components/schemas/WebhookCreateInput" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "CreateWebhooksRequestBody", "x-zs-llm-description": "Top-level request envelope for creating a webhook action; must include a webhooks array holding exactly one webhook object." }, "CreateWebhooksSuccessResponse": { "additionalProperties": false, "description": "Represents the success response for a webhook creation request, including the operation result and the new webhook ID.", "properties": { "webhooks": { "description": "Represents the list containing the operation result for the created webhook, including the new webhook ID.", "items": { "$ref": "#/components/schemas/WebhookStatusResponse" }, "maxItems": 1, "type": "array" } }, "title": "Create Webhooks Success Response", "type": "object", "x-zs-$id": "CreateWebhooksSuccessResponse", "x-zs-llm-description": "Success response after POST creation. Contains the created webhook ID." }, "CreatedBySchema": { "additionalProperties": false, "description": "Nested schema for created_by", "properties": { "id": { "description": "Unique numeric ID of the user who created the scoring rule.", "maxLength": 25, "type": "string" }, "name": { "description": "Full name of the user who created the scoring rule.", "maxLength": 255, "type": "string" }, "zuid": { "description": "Zoho unique ID (ZUID) of the user who created the scoring rule.", "maxLength": 255, "type": "string" } }, "title": "User Information", "type": "object" }, "CreatedModifiedByObjectSchema": { "additionalProperties": false, "description": "Represents the identity details of the CRM user who created or last modified the workflow rule.", "properties": { "id": { "description": "Represents the unique ID of the CRM user.", "format": "string", "type": "string" }, "name": { "description": "Represents the name of the CRM user who created or last modified the workflow rule.", "format": "string", "type": "string" } }, "type": "object", "x-zs-llm-description": "User reference object containing name and id. Used in GET responses for created_by and modified_by fields showing who created or last modified the workflow rule." }, "CreatedScoringRuleResponseItem": { "additionalProperties": false, "description": "Response details for a scoring rule creation operation, including status, code, and associated messages.", "properties": { "code": { "description": "Represents the response code for the scoring rule creation operation", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details of an operation, including the identifier of affected fields.", "properties": { "id": { "description": "Represents the created scoring rule id", "maxLength": 25, "type": "string", "x-zs-$id": "CreatedScoringRuleId" } }, "type": "object" }, "message": { "description": "Represents the response message for the scoring rule creation operation", "maxLength": 255, "type": "string" }, "status": { "description": "Represents th response status for the scoring rule creation operation", "maxLength": 255, "type": "string" } }, "title": "Created Scoring Rule Response Item", "type": "object" }, "CreatorDetails": { "additionalProperties": false, "description": "Provides details about the creator of an entity, including their name and ID.", "properties": { "id": { "description": "Unique Zoho CRM user ID of the creator.", "maxLength": 255, "type": "string" }, "name": { "description": "Display name of the user who created this resource.", "maxLength": 255, "type": "string" } }, "title": "Creator Details", "type": "object", "x-zs-llm-description": "Read-only audit field showing who originally created this task. Contains name and id." }, "CreatorInfo": { "additionalProperties": false, "description": "Represents the identifier and name of the user who created the record.", "properties": { "id": { "description": "Represents the unique identifier of the user who created the record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the full name of the user who created the record.", "maxLength": 255, "type": "string" } }, "title": "Creator Information", "type": "object" }, "CriteriaDetailsNestedSchema": { "additionalProperties": false, "description": "Represents the filter criteria that determine which records satisfy the workflow rule condition.", "properties": { "criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "description": "Represents a null variant indicating no criteria or module filter is applied.", "type": "null", "x-zs-$id": "CriteriaNullDetailsNestedSchema1" } ], "description": "Represents the filter criteria applied to the trigger module records. When null, the rule applies to all records without additional field-level filtering." }, "relational_criteria": { "additionalProperties": false, "description": "Represents the filter criteria applied to a related module when the trigger involves cross-module data, such as emails, calls, or notes.", "properties": { "criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "description": "Represents a null variant indicating no criteria or module filter is applied.", "type": "null", "x-zs-$id": "CriteriaNullDetailsNestedSchema2" } ], "description": "Represents the filter criteria applied to the related module records. Follows the same structure as the top-level criteria field." }, "module": { "anyOf": [ { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema" }, { "description": "Represents a null variant indicating no criteria or module filter is applied.", "type": "null", "x-zs-$id": "ModuleOrFieldNullDetailsNestedSchema" } ], "description": "Represents the related module to filter on. Required when **module_selection** is set to **specific**." }, "module_selection": { "description": "Represents the scope selector for the related module filter. Required when **relational_criteria** is present.", "enum": [ "all", "specific", "unknown", null ], "type": [ "string", "null" ] } }, "type": "object" } }, "type": "object", "x-zs-llm-description": "Filter configuration determining which records pass through to action execution. Contains two independent blocks: criteria (filters on trigger module's own fields) and relational_criteria (filters on a related module). Both are optional - null or omitted criteria matches ALL records. Required for certain triggers (related-module triggers) and for convert action." }, "CriteriaTypeAssignToRequestObject": { "additionalProperties": false, "description": "Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.", "properties": { "criteria": { "additionalProperties": true, "description": "Defines the criteria of the users who is considered for owner assignment for records entering the current rule entry.", "type": [ "object", "null" ] }, "type": { "description": "Defines which set of users should be considered for assignment.\nPossible values:\n**criteria** - Represents criteria.", "enum": [ "criteria" ], "maxLength": 255, "type": "string" } }, "required": [ "type", "criteria" ], "type": "object", "x-zs-$id": "CriteriaTypeAssignToRequestObject" }, "CriteriaTypeAssignToResponseObject": { "additionalProperties": false, "description": "Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.", "properties": { "criteria": { "additionalProperties": true, "description": "Defines the criteria of the users who is considered for owner assignment for records entering the current rule entry. ", "type": [ "object", "null" ] }, "type": { "description": "Defines which set of users should be considered for assignment.\nPossible values:\n**criteria** - Represents criteria. ", "enum": [ "criteria" ], "maxLength": 255, "type": "string" } }, "required": [ "type", "criteria" ], "type": "object", "x-zs-$id": "CriteriaTypeAssignToResponseObject" }, "CrossFiltersRequest": { "description": "Represents a list of cross-filter objects that filter Custom View records based on related module records' criteria.", "items": { "additionalProperties": false, "description": "Represents a single cross-filter object that filters records based on the presence or absence of related module records matching the specified criteria.", "properties": { "criteria": { "$ref": "#/components/schemas/FilterCriterionRequest" }, "include_objects": { "description": "Indicates whether records with matching related records are included in the results.", "type": "boolean" }, "relation": { "$ref": "#/components/schemas/ChildRelationshipReference" } }, "required": [ "include_objects", "relation", "criteria" ], "type": "object" }, "maxItems": 3, "minItems": 0, "type": "array", "x-zs-$id": "CrossFiltersRequest" }, "CrossFiltersResponse": { "description": "Represents the list of cross-filter objects returned in the response, applied to the Custom View.", "items": { "additionalProperties": false, "description": "Represents a single cross-filter object returned in the response, containing the relationship reference, filter criteria, and inclusion flag.", "properties": { "criteria": { "$ref": "#/components/schemas/FilterCriterionResponse" }, "include_objects": { "description": "Indicates whether records with matching related records were included in the filtered results.", "type": "boolean" }, "relation": { "allOf": [ { "$ref": "#/components/schemas/ChildRelationshipReference" }, { "required": [ "api_name", "id", "$disrupted" ] } ] } }, "required": [ "criteria", "relation", "include_objects" ], "type": "object" }, "maxItems": 3, "minItems": 0, "type": "array", "x-zs-$id": "CrossFiltersResponse" }, "CustomFieldConfiguration": { "additionalProperties": false, "description": "Represents the configuration for a custom field associated with a Scoring Rule, including the referenced score field.", "properties": { "api_name": { "description": "Represents the API name of the custom field associated with the Scoring Rule.", "maxLength": 100, "type": "string" }, "field_label": { "description": "Represents the display name of the custom field. Required when creating a Scoring Rule.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique ID of the custom field associated with the Scoring Rule.", "maxLength": 25, "type": "string" }, "reference_field": { "$ref": "#/components/schemas/ReferencedScoreField", "description": "It will hold the referenced score field info. (Required for POST)" } }, "title": "Custom Field Configuration", "type": "object" }, "CustomFieldConfigurationPUT": { "additionalProperties": false, "description": "Configuration for custom fields in PUT request. Supports creating/updating a custom field or deleting one by providing its id with _delete: null.", "properties": { "_delete": { "description": "Set to null to delete the custom field", "type": "null" }, "api_name": { "description": "Api name of the custom field", "maxLength": 100, "type": "string" }, "field_label": { "description": "Name of the custom field", "maxLength": 100, "type": "string" }, "id": { "description": "Custom field id", "maxLength": 25, "type": "string" }, "reference_field": { "$ref": "#/components/schemas/ReferencedScoreField", "description": "It will hold the referenced score field info." } }, "title": "Custom Field Configuration PUT", "type": "object" }, "CustomFiscalYearPartialUpdate": { "additionalProperties": false, "anyOf": [ { "required": [ "surplus_week" ] }, { "required": [ "interval_display_option" ] }, { "required": [ "structure" ] }, { "required": [ "start_date" ] } ], "description": "Represents the request payload to update selected settings of an existing custom fiscal year. When `start_month` is provided alongside `start_date`, its value must match the month component of `start_date`.", "minProperties": 1, "properties": { "display_based_on": { "$ref": "#/components/schemas/FiscalYearDisplayBasedOnForCustom" }, "interval_display_option": { "$ref": "#/components/schemas/FiscalYearIntervalDisplayOption" }, "start_date": { "$ref": "#/components/schemas/FiscalYearStartDate" }, "start_month": { "$ref": "#/components/schemas/FiscalYearStartMonth", "description": "Specify the start month of the fiscal year. This field is optional. When provided, its value must match the month component of the configured start_date." }, "structure": { "$ref": "#/components/schemas/FiscalYearStructure" }, "surplus_week": { "$ref": "#/components/schemas/SurplusWeekNested", "description": "Specify the surplus week configuration for the custom fiscal year. Send `null` to clear the configured surplus week." } }, "type": "object", "x-zs-$id": "CustomFiscalYearPartialUpdate" }, "CustomViewCreateFailureItem": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataForUpdateCV" }, { "$ref": "#/components/schemas/MandatoryNotFoundForUpdateCVById" }, { "$ref": "#/components/schemas/DuplicateDataForUpdateCVById" }, { "$ref": "#/components/schemas/NotAllowedForUpdateCVById" }, { "$ref": "#/components/schemas/SpecialCharacterNotAllowed" }, { "$ref": "#/components/schemas/InvalidIndexFav" }, { "$ref": "#/components/schemas/InvalidIdFav" }, { "$ref": "#/components/schemas/NotAllowedDetailsUpdate" }, { "$ref": "#/components/schemas/LimitExceededForCreateCV" }, { "$ref": "#/components/schemas/FieldComparatorValueMissing" }, { "$ref": "#/components/schemas/FieldComparatorMismatch" }, { "$ref": "#/components/schemas/FieldValueMismatch" }, { "$ref": "#/components/schemas/ComparatorValueMismatch" }, { "$ref": "#/components/schemas/InvalidComparator" }, { "$ref": "#/components/schemas/LookupLimitExceeded" } ], "description": "Represents the creation failure details for a Custom View, containing the error code, status, message, and additional context.", "x-zs-$id": "CustomViewCreateFailureItem" }, "CustomViewCreateFailureResponse": { "additionalProperties": false, "description": "Represents the error response containing creation failure details for one or more Custom Views.", "properties": { "custom_views": { "description": "Represents the list of Custom View creation failure items, one entry per failed Custom View.", "items": { "$ref": "#/components/schemas/CustomViewCreateFailureItem" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewCreateFailureResponse" }, "CustomViewCriterionRequest": { "anyOf": [ { "$ref": "#/components/schemas/FilterCriterionRequest" }, { "description": "No criteria applied - the custom view returns all records", "type": "null", "x-zs-$id": "CustomViewRequestCriteriaNull" } ], "description": "Represents the filter criteria of the Custom View" }, "CustomViewCriterionResponse": { "anyOf": [ { "$ref": "#/components/schemas/FilterCriterionResponse" }, { "description": "No criteria is applied. The custom view returns all records.", "type": "null", "x-zs-$id": "CustomViewResponseCriteriaNull" } ], "description": "Represents the filter criteria of the Custom View" }, "CustomViewCrossFilterCriterionRequest": { "anyOf": [ { "$ref": "#/components/schemas/CrossFiltersRequest" }, { "description": "No cross-filter criteria applied", "type": "null", "x-zs-$id": "CustomViewRequestCrossCriteriaNull" } ], "description": "Represents the cross-filter criteria of the Custom View" }, "CustomViewCrossFilterCriterionResponse": { "anyOf": [ { "$ref": "#/components/schemas/CrossFiltersResponse" }, { "description": "No cross-filter criteria is applied.", "type": "null", "x-zs-$id": "CustomViewResponseCrossCriteriaNull" } ], "description": "Cross-filter criteria of the Custom View" }, "CustomViewDeleteFailure": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataDelete" }, { "$ref": "#/components/schemas/NotAllowedDetailsDelete" } ], "description": "Represents the deletion failure details for a Custom View, containing the error code, status, message, and additional context.", "x-zs-$id": "CustomViewDeleteFailure" }, "CustomViewDeleteItem": { "additionalProperties": false, "description": "Represents the response containing Custom View deletion results.", "properties": { "custom_views": { "description": "Represents the list of Custom View deletion result items, each containing success or failure details.", "items": { "$ref": "#/components/schemas/CustomViewDeleteFailure" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewDeleteItem" }, "CustomViewDeleteSuccess": { "additionalProperties": false, "description": "Represents the successful deletion response for a Custom View, including the status, code, and confirmation message.", "properties": { "code": { "description": "Represents the success code for the deletion operation.\nPossible values:\n**SUCCESS** - The Custom View deletion completed successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "$ref": "#/components/schemas/IdDetail" }, "message": { "description": "Represents the success message for the deletion operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the deletion response.\nPossible values:\n**success** - The operation was successful.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CustomViewDeleteSuccess" }, "CustomViewField": { "description": "Represents the list of fields included in the Custom View, each with display and pin configuration details.", "items": { "additionalProperties": false, "description": "Represents a field included in the Custom View, with configuration details such as pin status, pin order, and display width.", "properties": { "_pin": { "description": "Indicates whether the field is pinned in the Custom View.\nPossible values:\n**true** - The field is pinned.\n**false** - The field is not pinned.", "type": "boolean" }, "_pin_order": { "description": "Represents the order of the pinned field within the Custom View.", "format": "int32", "type": "integer" }, "_width": { "description": "Represents the display width of the field in pixels.", "format": "int32", "type": "integer" }, "api_name": { "description": "Represents the API name of the field included in the Custom View.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the field included in the Custom View.", "format": "int64", "maxLength": 25, "type": [ "string", "null" ] } }, "type": "object" }, "maxItems": 250, "type": "array", "x-zs-$id": "CustomViewField" }, "CustomViewGetItem": { "additionalProperties": false, "description": "Represents the details of a Custom View returned in the response, including its filter criteria, sort configuration, field list, and access control settings.", "properties": { "$modified_criteria": { "description": "Indicates whether the filter criteria of the Custom View has been modified since it was originally created.\nPossible values:\n**true** - The criteria has been modified.\n**false** - The criteria has not been modified.", "type": "boolean" }, "access_type": { "description": "Represents the access type of the Custom View.\nPossible values:\n**shared** - The view is shared with selected users, roles, groups, or territories.\n**public** - The view is accessible to all users in the organization.\n**only_to_me** - The view is private and accessible only to the creator.", "enum": [ "shared", "public", "only_to_me" ], "type": "string" }, "category": { "description": "Represents the category of the Custom View.\nPossible values:\n**public_views** - Views accessible to all users in the organization.\n**other_users_views** - Views created by other users in the organization.\n**shared_with_me** - Views shared with the current user.\n**created_by_me** - Views created by the current user.", "enum": [ "public_views", "other_users_views", "shared_with_me", "created_by_me" ], "type": "string" }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewsUserReference" }, { "description": "No user associated", "type": "null", "x-zs-$id": "ModifiedByUserReference" } ] }, "created_time": { "description": "Represents the date and time when the Custom View creation occurred.", "format": "date-time", "type": [ "string", "null" ] }, "criteria": { "$ref": "#/components/schemas/CustomViewCriterionResponse" }, "cross_filters": { "$ref": "#/components/schemas/CustomViewCrossFilterCriterionResponse" }, "default": { "description": "Indicates whether the Custom View is set as the default view for the module.\nPossible values:\n**true** - This is the default view.\n**false** - This is not the default view.", "type": "boolean" }, "display_value": { "description": "Represents the display label of the Custom View as shown to users.", "maxLength": 50, "type": "string" }, "favorite": { "description": "Represents the favorite order of the Custom View. A null value indicates the view is not marked as a favorite.", "format": "int32", "type": [ "null", "integer" ] }, "fields": { "$ref": "#/components/schemas/CustomViewField" }, "id": { "description": "Represents the unique ID of the Custom View.", "format": "int64", "maxLength": 25, "type": "string", "x-zs-$id": "CustomViewId" }, "last_accessed_time": { "description": "Represents the date and time when the Custom View was last accessed. A null value indicates the view has not been accessed.", "format": "date-time", "type": [ "string", "null" ] }, "locked": { "description": "Indicates whether the Custom View is locked and cannot be modified by users.\nPossible values:\n**true** - The view is locked.\n**false** - The view is not locked.", "type": "boolean" }, "modified_by": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewsUserReference" }, { "description": "No user associated", "type": "null", "x-zs-$id": "CreatedByUserReference" } ] }, "modified_time": { "description": "Modification Time of the Custom View", "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "Represents the name of the Custom View.", "maxLength": 50, "type": "string" }, "offline": { "description": "Indicates whether the Custom View is available in offline mode.\nPossible values:\n**true** - The view is available offline.\n**false** - The view is not available offline.", "type": "boolean" }, "shared_to": { "$ref": "#/components/schemas/SharedTo" }, "sort_by": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewsFieldReference" }, { "description": "No sort is applied", "type": "null", "x-zs-$id": "NoSortField" } ], "description": "Represents the field used to sort the records in the Custom View." }, "sort_order": { "anyOf": [ { "description": "Represents the sort order applied to the Custom View.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "enum": [ "asc", "desc" ], "type": "string", "x-zs-$id": "SortOrder" }, { "description": "Represents no sort order applied to the Custom View.", "type": "null", "x-zs-$id": "NoSortOrder" } ], "description": "Represents the sort order applied to the records in the Custom View." }, "system_defined": { "description": "Indicates whether the Custom View is a system-defined view created by Zoho CRM.\nPossible values:\n**true** - The view is system-defined.\n**false** - The view is user-defined.", "type": "boolean" }, "system_name": { "description": "Represents the system-defined name of the Custom View. A null value indicates the view does not have a system name.", "maxLength": 50, "type": [ "string", "null" ] } }, "type": "object", "x-zs-$id": "CustomViewGetItem" }, "CustomViewPostItem": { "additionalProperties": false, "description": "Represents the configuration for creating a Custom View, including its name, filter criteria, field list, sort configuration, and access control settings.", "properties": { "access_type": { "description": "Represents the access type for the Custom View.\nPossible values:\n**shared** - The view is shared with selected users, roles, groups, or territories.\n**public** - The view is accessible to all users in the organization.\n**only_to_me** - The view is private and accessible only to the creator.", "enum": [ "shared", "public", "only_to_me" ], "type": "string" }, "category": { "description": "Represents the category for the Custom View.\nPossible values:\n**public_views** - Views accessible to all users in the organization.\n**other_users_views** - Views created by other users in the organization.\n**shared_with_me** - Views shared with the current user.\n**created_by_me** - Views created by the current user.", "enum": [ "public_views", "other_users_views", "shared_with_me", "created_by_me" ], "type": "string" }, "criteria": { "$ref": "#/components/schemas/CustomViewCriterionRequest" }, "cross_filters": { "$ref": "#/components/schemas/CustomViewCrossFilterCriterionRequest" }, "favorite": { "description": "Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite.", "format": "int32", "type": [ "null", "integer" ] }, "fields": { "$ref": "#/components/schemas/CustomViewField" }, "locked": { "description": "Indicates whether the Custom View is locked.\nPossible values:\n**true** - The view is locked.\n**false** - The view is not locked.", "type": "boolean" }, "name": { "description": "Represents the name of the Custom View.", "maxLength": 50, "type": "string" }, "shared_to": { "$ref": "#/components/schemas/SharedTo" }, "sort_by": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewsFieldReference" }, { "description": "No sort is applied", "type": "null", "x-zs-$id": "SortFieldPost" } ], "description": "Represents the field used to sort the records in the Custom View." }, "sort_order": { "anyOf": [ { "description": "Represents the sort order for the Custom View.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "enum": [ "asc", "desc" ], "type": "string", "x-zs-$id": "SortOrderPost" }, { "description": "Represents no sort order applied to the Custom View.", "type": "null", "x-zs-$id": "NoSortOrderPost" } ], "description": "Represents the sort order applied to the records in the Custom View." }, "wrap_text": { "description": "Indicates whether text wrapping is enabled for the Custom View.\nPossible values:\n**true** - Text wrapping is enabled.\n**false** - Text wrapping is disabled.", "type": "boolean" } }, "required": [ "name", "access_type", "fields" ], "type": "object", "x-zs-$id": "CustomViewPostItem" }, "CustomViewPostSuccessResponse": { "additionalProperties": false, "description": "Represents the successful creation response for a Custom View, including the status, code, message, and ID details.", "properties": { "code": { "description": "Represents the success code for the create operation.\nPossible values:\n**SUCCESS** - The Custom View creation completed successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "$ref": "#/components/schemas/IdDetail" }, "message": { "description": "Represents the success message for the create operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the create response.\nPossible values:\n**success** - The operation was successful.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CustomViewPostSuccessResponse" }, "CustomViewPutBulkItem": { "additionalProperties": false, "description": "Represents the configuration for updating a Custom View in a bulk operation, including the view ID and the fields to update.", "properties": { "access_type": { "description": "Represents the access type for the Custom View.\nPossible values:\n**shared** - The view is shared with selected users, roles, groups, or territories.\n**public** - The view is accessible to all users in the organization.\n**only_to_me** - The view is private and accessible only to the creator.", "enum": [ "shared", "public", "only_to_me" ], "type": "string" }, "category": { "description": "Represents the category for the Custom View.\nPossible values:\n**public_views** - Views accessible to all users in the organization.\n**other_users_views** - Views created by other users in the organization.\n**shared_with_me** - Views shared with the current user.\n**created_by_me** - Views created by the current user.", "enum": [ "public_views", "other_users_views", "shared_with_me", "created_by_me" ], "type": "string" }, "criteria": { "$ref": "#/components/schemas/CustomViewCriterionRequest" }, "cross_filters": { "$ref": "#/components/schemas/CustomViewCrossFilterCriterionRequest" }, "favorite": { "description": "Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite.", "format": "int32", "type": [ "null", "integer" ] }, "fields": { "$ref": "#/components/schemas/CustomViewField" }, "id": { "description": "Represents the unique ID of the Custom View to update.", "format": "int64", "maxLength": 25, "type": "string" }, "locked": { "description": "Indicates whether the Custom View is locked.\nPossible values:\n**true** - The view is locked.\n**false** - The view is not locked.", "type": "boolean" }, "name": { "description": "Represents the name of the Custom View.", "maxLength": 50, "type": "string" }, "shared_to": { "$ref": "#/components/schemas/SharedTo" }, "sort_by": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewsFieldReference" }, { "description": "No sort is applied", "type": "null", "x-zs-$id": "SortFieldPutBulk" } ], "description": "Represents the field used to sort the records in the Custom View." }, "sort_order": { "anyOf": [ { "description": "Represents the sort order for the Custom View.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "enum": [ "asc", "desc" ], "type": "string", "x-zs-$id": "SortOrderPutBulk" }, { "description": "Represents no sort order applied to the Custom View.", "type": "null", "x-zs-$id": "NoSortOrderPutBulk" } ], "description": "Represents the sort order applied to the records in the Custom View." } }, "required": [ "id" ], "type": "object", "x-zs-$id": "CustomViewPutBulkItem" }, "CustomViewPutByIdItem": { "additionalProperties": false, "description": "Represents the configuration for updating a Custom View by its ID, including the fields to update.", "properties": { "access_type": { "description": "Represents the access type for the Custom View.\nPossible values:\n**shared** - The view is shared with selected users, roles, groups, or territories.\n**public** - The view is accessible to all users in the organization.\n**only_to_me** - The view is private and accessible only to the creator.", "enum": [ "shared", "public", "only_to_me" ], "type": "string" }, "category": { "description": "Represents the category for the Custom View.\nPossible values:\n**public_views** - Views accessible to all users in the organization.\n**other_users_views** - Views created by other users in the organization.\n**shared_with_me** - Views shared with the current user.\n**created_by_me** - Views created by the current user.", "enum": [ "public_views", "other_users_views", "shared_with_me", "created_by_me" ], "type": "string" }, "criteria": { "$ref": "#/components/schemas/CustomViewCriterionRequest" }, "cross_filters": { "$ref": "#/components/schemas/CustomViewCrossFilterCriterionRequest" }, "favorite": { "description": "Represents the favorite order for the Custom View. A null value indicates the view is not marked as a favorite.", "format": "int32", "type": [ "null", "integer" ] }, "fields": { "$ref": "#/components/schemas/CustomViewField" }, "locked": { "description": "Indicates whether the Custom View is locked.\nPossible values:\n**true** - The view is locked.\n**false** - The view is not locked.", "type": "boolean" }, "name": { "description": "Represents the name of the Custom View.", "maxLength": 50, "type": "string" }, "shared_to": { "$ref": "#/components/schemas/SharedTo" }, "sort_by": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewsFieldReference" }, { "description": "No sort is applied", "type": "null", "x-zs-$id": "SortFieldPutById" } ], "description": "Represents the field used to sort the records in the Custom View." }, "sort_order": { "anyOf": [ { "description": "Represents the sort order for the Custom View.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "enum": [ "asc", "desc" ], "type": "string", "x-zs-$id": "SortOrderPutById" }, { "description": "Represents no sort order applied to the Custom View.", "type": "null", "x-zs-$id": "NoSortOrderPutById" } ], "description": "Represents the sort order applied to the records in the Custom View." } }, "type": "object", "x-zs-$id": "CustomViewPutByIdItem" }, "CustomViewSortByIdFailureDetails": { "additionalProperties": false, "description": "Represents the error response containing sort failure details for the change sort by ID operation.", "properties": { "custom_views": { "description": "Represents the list of Custom View sort failure items for the sort by ID operation.", "items": { "$ref": "#/components/schemas/CustomViewSortByIdFailureItem" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewSortByIdFailureDetails" }, "CustomViewSortByIdFailureItem": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataSortById" }, { "$ref": "#/components/schemas/MandatoryNotFoundForSort" } ], "description": "Represents the sort failure details for a Custom View in the sort by ID operation, containing the error code, status, message, and additional context." }, "CustomViewSortFailureDetails": { "additionalProperties": false, "description": "Represents the error response containing sort failure details for the change sort operation.", "properties": { "custom_views": { "description": "Represents the list of Custom View sort failure items for the sort operation.", "items": { "$ref": "#/components/schemas/CustomViewSortFailureItem" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewSortFailureDetails" }, "CustomViewSortFailureItem": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataSort" }, { "$ref": "#/components/schemas/MandatoryNotFoundForSort" } ], "description": "Represents the sort failure details for a Custom View, containing the error code, status, message, and additional context.", "x-zs-$id": "CustomViewSortFailureItem" }, "CustomViewUpdateFailureDetails": { "additionalProperties": false, "description": "Represents the error response containing update failure details for one or more Custom Views.", "properties": { "custom_views": { "description": "Represents the list of Custom View update failure items.", "items": { "$ref": "#/components/schemas/CustomViewUpdateFailureItem" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewUpdateFailureDetails" }, "CustomViewUpdateFailureItem": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataForUpdateCV" }, { "$ref": "#/components/schemas/MandatoryNotFoundForUpdateCVById" }, { "$ref": "#/components/schemas/DuplicateDataForUpdateCVById" }, { "$ref": "#/components/schemas/NotAllowedForUpdateCVById" }, { "$ref": "#/components/schemas/SpecialCharacterNotAllowed" }, { "$ref": "#/components/schemas/InvalidIndexFav" }, { "$ref": "#/components/schemas/InvalidIdFav" }, { "$ref": "#/components/schemas/NotAllowedDetailsUpdate" }, { "$ref": "#/components/schemas/InvalidDataType" }, { "$ref": "#/components/schemas/FieldComparatorValueMissing" }, { "$ref": "#/components/schemas/FieldComparatorMismatch" }, { "$ref": "#/components/schemas/FieldValueMismatch" }, { "$ref": "#/components/schemas/ComparatorValueMismatch" }, { "$ref": "#/components/schemas/InvalidComparator" }, { "$ref": "#/components/schemas/LookupLimitExceeded" } ], "description": "Represents the update failure details for a Custom View, containing the error code, status, message, and additional context.", "x-zs-$id": "CustomViewUpdateFailureItem" }, "CustomViewUpdateSuccess": { "additionalProperties": false, "description": "Represents the successful update response for a Custom View operation, including the status, code, message, and updated view ID.", "properties": { "code": { "description": "Represents the success code for the update operation.\nPossible values:\n**SUCCESS** - The Custom View update completed successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details for the successful update operation.", "properties": { "id": { "description": "Represents the unique ID of the updated Custom View.", "format": "int64", "maxLength": 25, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message for the update operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the update response.\nPossible values:\n**success** - The operation was successful.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CustomViewUpdateSuccess" }, "CustomViewUpdateSuccessResponse": { "additionalProperties": false, "description": "Represents the bulk update success response containing a list of updated Custom View items.", "properties": { "custom_views": { "description": "Represents the list of Custom View update success items.", "items": { "$ref": "#/components/schemas/CustomViewUpdateSuccess" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewUpdateSuccessResponse" }, "CustomViewWrapFailure": { "additionalProperties": false, "description": "Represents the error response containing Custom View wrap failure details.", "properties": { "custom_views": { "description": "Represents the list of Custom View wrap failure items.", "items": { "$ref": "#/components/schemas/CustomViewWrapFailureItem" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewWrapFailure" }, "CustomViewWrapFailureItem": { "description": "Custom view failure item", "items": { "$ref": "#/components/schemas/InvalidWrapDataType" }, "x-zs-$id": "CustomViewWrapFailureItem" }, "CustomViewsCustomViewInfo": { "additionalProperties": false, "description": "Represents pagination metadata and category label translations for the Custom Views response.", "properties": { "count": { "description": "Represents the total number of Custom Views available for the specified module.", "format": "int32", "type": "integer" }, "default": { "description": "Represents the ID of the default Custom View for the module.", "format": "int64", "maxLength": 255, "type": "string" }, "more_records": { "description": "Indicates whether more records are available beyond the current page.\nPossible values:\n**true** - More records are available.\n**false** - No more records are available.", "type": "boolean" }, "page": { "description": "Represents the current page number of the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of Custom Views returned per page.", "format": "int32", "type": "integer" }, "translation": { "additionalProperties": false, "description": "Represents the localized display labels for the Custom View category names.", "properties": { "created_by_me": { "description": "Represents the display label for the created by me category of Custom Views.", "maxLength": 255, "type": "string" }, "other_users_views": { "description": "Represents the display label for the other users' views category of Custom Views.", "maxLength": 255, "type": "string" }, "public_views": { "description": "Represents the display label for the public views category of Custom Views.", "maxLength": 255, "type": "string" }, "shared_with_me": { "description": "Represents the display label for the shared with me category of Custom Views.", "maxLength": 255, "type": "string" } }, "required": [ "public_views", "other_users_views", "shared_with_me", "created_by_me" ], "type": "object" } }, "type": "object", "x-zs-$id": "CustomViewInfo" }, "CustomViewsFieldReference": { "additionalProperties": false, "description": "Represents a reference to a field in the Custom View, identified by its API name and unique ID.", "properties": { "api_name": { "description": "Represents the API name of the field. A null value indicates no field is selected.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the field. A null value indicates no field is selected.", "format": "int64", "maxLength": 25, "type": [ "string", "null" ] } }, "type": "object", "x-zs-$id": "FieldReference" }, "CustomViewsInvalidModuleError": { "additionalProperties": false, "description": "Represents the error response returned when the specified module in the request is invalid or does not exist.", "properties": { "code": { "description": "Represents the error code for the invalid module error.\nPossible values:\n**INVALID_MODULE** - The specified module does not exist or is invalid.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the invalid module error.", "properties": { "param_name": { "description": "Name of the invalid parameter", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid module.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, "CustomViewsInvalidUrlPatternError": { "additionalProperties": false, "description": "Represents the error response returned when the request URL does not match any recognized API pattern.", "properties": { "code": { "description": "Represents the error code for the invalid URL pattern.\nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any known pattern.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the URL pattern error.", "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern issue.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidUrlPatternError" }, "CustomViewsUnableToParseDataTypeError": { "additionalProperties": false, "description": "Represents the error response returned when a request parameter or body value cannot be parsed as the expected data type.", "properties": { "code": { "description": "Represents the error code for the data type parse failure.\nPossible values:\n**UNABLE_TO_PARSE_DATA_TYPE** - The server could not parse the data type from the request.", "enum": [ "UNABLE_TO_PARSE_DATA_TYPE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the data type parse failure.", "type": "object" }, "message": { "description": "Represents the error message describing the data type parse failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UnableToParseDataTypeError" }, "CustomViewsUserReference": { "additionalProperties": false, "description": "Represents a user reference containing the user ID and display name.", "properties": { "id": { "description": "Represents the unique ID of the user.", "format": "int64", "maxLength": 25, "type": "string" }, "name": { "description": "Represents the display name of the user.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-zs-$id": "UserReference" }, "CvProfilePermissionError": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have the required profile permission to perform the operation.", "properties": { "code": { "description": "Represents the error code for the permission denial.\nPossible values:\n**NO_PERMISSION** - The user does not have the required profile permission to perform the operation.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the permission error.", "properties": { "permissions": { "description": "List of CRM permission keys that are missing for the operation", "items": { "description": "A CRM permission key name", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the permission denial.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered a permission error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CvProfilePermissionError" }, "DashboardCriteriaProcessingSummary": { "additionalProperties": false, "description": "Represents the summary of dashboard criteria impact for the job, including counts of total evaluated, processed, and failed criteria.", "properties": { "failed": { "description": "Indicates the total number of records that failed to process during the dashboard criteria evaluation.", "format": "int32", "type": "integer" }, "processed": { "description": "Represents the processed records.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the total number of records submitted for processing in the dashboard criteria evaluation, encompassing both successful and failed records.", "format": "int32", "type": "integer" } }, "required": [ "failed", "processed", "total" ], "title": "Dashboard Criteria Processing Summary", "type": "object" }, "DataError": { "additionalProperties": true, "description": "Standard error response object returned when a request fails. Contains the error code, the message, the status, and a details block identifying the offending field.", "properties": { "code": { "description": "Represents the error code returned when a data validation error occurs.", "example": "INVALID_DATA", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "example": "Duration", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "example": "$.data[1].Duration", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message returned when the request fails.", "example": "Duration value should not be greater than 24hrs or less than 5mins", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response, indicating that an error occurred.", "example": "error", "maxLength": 1000, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DataError" }, "DataNestedBase": { "additionalProperties": true, "description": "Base schema for a service object payload. Defines the fields common to create and update requests, including identity, status, availability, members, pricing, and tax.", "properties": { "Availability_Type": { "description": "Specify how the service availability is defined. \n\n\n**Possible values**: Specific Day(s), Specific Date Range, Every\nBusiness Days, Specific Date(s).\n", "enum": [ "Specific Day(s)", "Specific Date Range", "Every Business Days", "Specific Date(s)" ], "maxLength": 19, "type": [ "string", "null" ] }, "Available_Dates": { "description": "Specify the list of dates on which the service is available. The key is mandatory when Availability_Type is Specific Date(s).", "items": { "description": "Each string specifies a date on which the service is available, in YYYY-MM-DD format.", "maxLength": 255, "type": "string" }, "maxItems": 20, "type": [ "array", "null" ] }, "Available_Days": { "description": "Specify the list of business days on which the service is available. The key is mandatory when Availability_Type is Specific Day(s).", "items": { "description": "Each string specifies a business day on which the service is available.", "maxLength": 255, "type": "string" }, "maxItems": 7, "type": [ "array", "null" ] }, "Available_From": { "description": "Specify the date from which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range.", "maxLength": 100, "type": [ "string", "null" ] }, "Available_Till": { "description": "Specify the date until which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range.", "enum": [ "2026-01-13", "2026-01-29" ], "maxLength": 100, "type": [ "string", "null" ] }, "Available_Timings": { "description": "Specify the available time windows for the service. The total available time must be at least equal to the service Duration.", "maxLength": 4, "type": [ "string", "null" ] }, "Description": { "description": "Specify a description of the service.", "maxLength": 32000, "type": [ "string", "null" ] }, "Duration": { "description": "Specify the duration of the service, in minutes. Must be greater than 5 minutes and less than 24 hours.", "format": "int32", "type": [ "integer", "null" ] }, "Job_Sheet_Required": { "description": "Specify whether a job sheet is required for the service. \n\n**Possible values**: Yes, No.\n", "enum": [ "Yes", "No" ], "maxLength": 3, "type": [ "string", "null" ] }, "Job_Sheet_Section__s": { "description": "Specify the job sheet section associated with the service. It can be set only when Job_Sheet_Required is Yes.", "maxLength": 255, "type": [ "string", "null" ] }, "Location": { "description": "Specify where the service is delivered. \n\n**Possible values**: Client Address, Business Address, Business\nAddress and Client Address.\n", "enum": [ "Business Address", "Business Address and Client Address", "Client Address" ], "maxLength": 1000, "type": [ "string", "null" ] }, "Members": { "description": "Specify the users who deliver the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "items": { "$ref": "#/components/schemas/MembersitemBase" }, "maxItems": 100, "type": [ "array", "null" ] }, "Owner": { "$ref": "#/components/schemas/OwnerBase" }, "Price": { "description": "Specify the price charged for the service in the organization currency.", "format": "int32", "type": [ "integer", "null" ] }, "Record_Image": { "description": "Specify the record image to associate with the service.", "maxLength": 255, "type": [ "string", "null" ] }, "Service_Name": { "description": "Specify the name of the service.", "maxLength": 120, "type": [ "string", "null" ] }, "Status": { "description": "Specify the operational status of the service. \n\n\n**Possible values**: \n\n- Available - service is active and accepting bookings.\n\n- Not in Use - service is currently inactive.\n\n- Scheduled - service is queued to become Available on\nAvailable_From.\n\n- Temporarily Unavailable - service is paused for the\nUnavailable_From-to-Unavailable_Till window.\n", "enum": [ "Available", "Temporarily Unavailable", "Not in Use", "Scheduled" ], "maxLength": 100, "type": [ "string", "null" ] }, "Tag": { "description": "Specify the tag names to associate with the service record. Refer to the [Get tags](tags.yaml#$.paths./settings/tags.get) resource for valid values.", "items": { "description": "Each string specifies one tag name to associate with the service record.", "maxLength": 2000, "type": "string" }, "maxItems": 100, "type": [ "array", "null" ] }, "Tax": { "description": "Specify the taxes applied to the service cost.", "items": { "description": "Each string represents one tax entry applied to the service cost.", "maxLength": 255, "type": "string" }, "maxItems": 2, "type": [ "array", "null" ] }, "Unavailable_From": { "description": "Specify the date and time from which the service becomes unavailable. Must fall within the service availability window.", "maxLength": 25, "type": [ "string", "null" ] }, "Unavailable_Till": { "description": "Specify the date and time until which the service remains unavailable. Must fall within the service availability window.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Specify the unique ID of the service record being updated.", "maxLength": 100, "type": [ "string", "null" ] } }, "type": "object" }, "DataNestedV2": { "allOf": [ { "$ref": "#/components/schemas/DataNestedBase" }, { "additionalProperties": true, "description": "Update specific overrides applied to the base service object schema.", "properties": { "Owner": { "$ref": "#/components/schemas/OwnerNestedV2" } }, "type": "object" } ], "description": "Service object schema used in update requests. Extends the base service object with update-specific overrides on the Owner field." }, "DataTypeMismatchError": { "additionalProperties": false, "description": "Represents the error details returned when a field value in the request does not match the expected data type.", "properties": { "api_name": { "description": "Represents the API name of the field with the data type mismatch.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with the data type mismatch.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "DataTypeMismatchError" }, "DateTimeFormatConfig": { "additionalProperties": false, "description": "Represents the date and time formatting configuration applied to date or datetime merge-field values in webhook request payloads. Applicable only when a date or datetime merge-field is used in headers, url_parameters, or body. Returns null when no date or datetime merge-fields are present.", "properties": { "date_format": { "description": "Represents the format pattern for date-only merge-field values in the webhook payload.", "maxLength": 255, "type": "string" }, "datetime_format": { "description": "Represents the format pattern for datetime merge-field values in the webhook payload.", "maxLength": 255, "type": "string" }, "time_zone": { "description": "Represents the timezone identifier applied to datetime merge-field values in the webhook payload.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ], "x-zs-llm-description": "Nullable date/time formatting for webhook payloads. Only applies to date/datetime merge fields. Null means default formatting." }, "DealContactRolesInvalidDataError": { "additionalProperties": false, "description": "Error response of an invalid related ID provided in the request.", "properties": { "code": { "const": "INVALID_DATA", "description": "Error code indicating invalid deal ID", "type": "string" }, "details": { "additionalProperties": false, "description": "Error details containing the path index", "properties": { "resource_path_index": { "const": 1, "description": "Index of the path parameter that is invalid (1 for deal ID)", "format": "int64", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "const": "the related id given seems to be invalid", "description": "Error message indicating the deal ID is invalid", "type": "string" }, "status": { "const": "error", "description": "Response status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataError" }, "DealContactRolesInvalidModuleError": { "additionalProperties": false, "description": "Error response of an invalid module name provided in the request.", "properties": { "code": { "const": "INVALID_MODULE", "description": "Error code indicating invalid module name", "type": "string" }, "details": { "additionalProperties": false, "description": "Error details containing the path index", "properties": { "resource_path_index": { "const": 0, "description": "Index of the path parameter that is invalid (0 for module)", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "const": "the module name given seems to be invalid", "description": "Error message indicating the module name is invalid", "type": "string" }, "status": { "const": "error", "description": "Response status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, "DealContactRolesRequiredParamMissingError": { "additionalProperties": false, "description": "Error response of a missing required parameter.", "properties": { "code": { "const": "REQUIRED_PARAM_MISSING", "description": "Error code indicating a required parameter is missing", "type": "string" }, "details": { "additionalProperties": false, "description": "Error details containing the missing parameter name", "properties": { "param_name": { "const": "fields", "description": "Name of the missing required parameter", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "const": "One of the expected parameter is missing", "description": "Error message indicating a parameter is missing", "type": "string" }, "status": { "const": "error", "description": "Response status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "DealConversion": { "additionalProperties": false, "description": "Deal record configuration for lead conversion", "properties": { "$move_attachments": { "description": "If true, moves attachments from the Lead to the Deal", "type": "boolean" }, "Amount": { "description": "Expected revenue amount for the Deal", "format": "double", "type": "number" }, "Campaign_Source": { "description": "Campaign source associated with this Deal", "maxLength": 100, "type": "string" }, "Closing_Date": { "description": "Expected closing date for the Deal (ISO 8601 date format: YYYY-MM-DD)", "format": "date", "type": "string" }, "Contact_Role": { "description": "Represents the **role** of the Contact in this Deal", "maxLength": 50, "type": "string" }, "Deal_Name": { "description": "Specify the name of the Deal", "maxLength": 120, "type": "string" }, "Description": { "description": "Detailed description of the Deal", "maxLength": 32000, "type": "string" }, "Lead_Source": { "description": "Source from which the Lead originated", "maxLength": 100, "type": "string" }, "Next_Step": { "description": "Next action or milestone for the Deal", "maxLength": 200, "type": "string" }, "Pipeline": { "description": "Indicates the **sales pipeline** for the Deal. Must match an existing pipeline in the CRM.", "maxLength": 100, "type": "string" }, "Probability": { "description": "Win probability percentage (0-100)", "format": "int32", "maximum": 100, "minimum": 0, "type": "integer" }, "Stage": { "description": "Current stage of the Deal within the specified Pipeline. Must be valid for the chosen Pipeline.", "maxLength": 100, "type": "string" }, "Type": { "description": "Type of Deal (e.g., New Business, Existing Business)", "maxLength": 50, "type": "string" } }, "required": [ "Deal_Name", "Pipeline", "Stage", "Closing_Date" ], "type": "object" }, "DefaultAssigneeRequestObject": { "anyOf": [ { "$ref": "#/components/schemas/UserTypeDefaultAssigneeRequestObject" } ], "description": "Fallback assignee when no rule entry matches. Currently supports user type. Additional types (for example, queue) may be added in future versions.", "title": "Default Assignee Request Object" }, "DefaultAssigneeResponseObject": { "additionalProperties": false, "description": "Details of the fallback user for record assignment in cases where the owner cannot be assigned through rule entries.", "properties": { "id": { "anyOf": [ { "$ref": "#/components/schemas/IdSchema" }, { "description": "To define \"logged in user\" as fallback user for the given Assignment Rule, set ${CURRENTUSER} as value for this field.", "enum": [ "${CURRENTUSER}" ], "type": "string", "x-zs-$id": "DefaultAssigneeCurrentUserRefResponseFormatTemp" } ], "description": "Represents the iD of the default assignee. is deprecated." }, "name": { "description": "Represents the display name of the default assignee. ", "maxLength": 255, "type": "string" }, "resource": { "anyOf": [ { "$ref": "#/components/schemas/ResourceResponseObject", "description": "Defines the details of the default assignee", "x-zs-$id": "DefaultAssigneeResourceDetails" }, { "additionalProperties": false, "description": "Defines the details of the default assignee.", "properties": { "api_name": { "description": "To define \"logged in user\" as fallback user for the given Assignment Rule, set ${CURRENTUSER} as value for this field.\nPossible values:\n**${CURRENTUSER}** - Represents ${currentuser}.", "enum": [ "${CURRENTUSER}" ], "type": "string" }, "name": { "description": "Logged in user reference display name.", "maxLength": 255, "type": "string" } }, "x-zs-$id": "LoggedInUserReferenceDetails" } ], "description": "Represents the resource returned for the Assignment Rule operation." }, "type": { "description": "Defines the type of the default assignee.\nPossible values:\n**user** - Represents user.", "enum": [ "user" ], "type": "string" } }, "title": "Default Assignee Details", "type": "object", "x-zs-$id": "DefaultAssigneeResponseObject" }, "DefaultViewLayoutNested": { "additionalProperties": false, "description": "Nested schema for _default_view when type is layout", "properties": { "display_label": { "description": "Represents the display label of the default layout view.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique numeric identifier of the default view.", "maxLength": 25, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaLayoutsId" } ], "resource": "portals_meta" } }, "name": { "description": "Represents the internal name of the default view.", "maxLength": 255, "type": "string" }, "type": { "description": "The type of the default view.", "enum": [ "layout" ], "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "DefaultViewLayoutNested" }, "DefaultViewNested": { "anyOf": [ { "$ref": "#/components/schemas/DefaultViewLayoutNested" }, { "$ref": "#/components/schemas/DefaultViewWizardNested" } ], "description": "Nested schema for _default_view representing the default view configuration associated with the portal user type, including the view's unique identifier, name, display label, and type.", "x-zs-$id": "DefaultViewNested" }, "DefaultViewWizardNested": { "additionalProperties": false, "description": "Nested schema for _default_view when type is wizard", "properties": { "display_label": { "description": "The display label of the resource", "maxLength": 255, "type": "string" }, "id": { "description": "The unique identifier of the resource", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getAllWizards", "propertyId": "WizardId" } ], "resource": "wizards" } }, "name": { "description": "The name of the resource", "maxLength": 255, "type": "string" }, "type": { "description": "The type of the resource", "enum": [ "wizard" ], "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "DefaultViewWizardNested" }, "Delete207SuccessResponse": { "additionalProperties": false, "description": "Represents a successful deletion result in the multi-Status response, containing the deleted record ID.", "properties": { "code": { "description": "Represents the response code for the delete operation.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the deleted appointment record, including the record ID.", "properties": { "id": { "description": "Represents the unique identifier of the deleted appointment record.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message for the record deletion.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the record deletion.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "Delete207SuccessResponse" }, "DeleteFieldUpdateReadOnlyActionError": { "additionalProperties": false, "description": "Returned when attempting to delete a read-only field update action.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Index of the resource path segment related to the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "example": "field update can not be deleted", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Delete Field Update Read Only Action Error", "type": "object", "x-zs-$id": "DeleteFieldUpdateReadOnlyActionError", "x-zs-llm-description": "Cannot delete a read-only field update action. These are system-managed and cannot be removed." }, "DeleteFieldUpdateSuccessResponse": { "additionalProperties": false, "description": "Indicates that the field update was deleted successfully.", "properties": { "field_updates": { "description": "Array containing the deleted field update action. Contains exactly one item.", "items": { "$ref": "#/components/schemas/FieldUpdateActionResult" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteFieldUpdateSuccessResponse", "x-zs-llm-description": "Confirms the field update action was deleted successfully." }, "DeleteLayoutDetails": { "additionalProperties": false, "description": "Represents the identifying details of a layout that has been successfully deleted, returned in the deletion response to confirm which layout was removed.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the deleted layout." } }, "required": [ "id" ], "type": "object" }, "DeleteLayoutResult": { "additionalProperties": false, "description": "Represents the outcome of a single layout deletion attempt within a batch operation, including a status code and descriptive message for that layout.", "properties": { "code": { "description": "Indicates the outcome code returned for the layout deletion attempt. Possible values: `SUCCESS` — the layout deletion completes successfully.", "enum": [ "SUCCESS" ], "example": "SUCCESS", "type": "string" }, "details": { "$ref": "#/components/schemas/DeleteLayoutDetails" }, "message": { "description": "Contains a descriptive message summarising the outcome of the layout deletion operation, providing context for both successful completions and failure conditions.", "example": "layout deleted", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the overall processing state of the layout deletion request. Possible values: `success` — the layout was removed as requested.", "enum": [ "success" ], "example": "success", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "DeleteLayoutSuccessResponseBody": { "additionalProperties": false, "description": "Represents the response body returned when one or more layouts are successfully deleted, containing per-layout deletion results.", "properties": { "layouts": { "description": "Contains one entry per layout included in the deletion request, each reporting the individual outcome — such as success or failure — for that specific layout.", "items": { "$ref": "#/components/schemas/DeleteLayoutResult" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "DeleteLayoutSuccessResponseBody" }, "DeleteObject": { "additionalProperties": false, "description": "Represents the configuration object used to specify the deletion mode when removing a layout or resource, indicating whether the deletion is permanent or a soft delete to the recycle bin.", "properties": { "permanent": { "description": "Indicates whether the resource is removed irrecoverably or placed in the recycle bin for potential recovery. Possible values: `true` — the resource is permanently destroyed and cannot be restored; `false` — the resource is moved to trash and may be recovered before final purge.", "examples": [ true, false ], "type": "boolean" } }, "required": [ "permanent" ], "type": "object" }, "DeleteOldValueNotAllowedErrorResponse": { "additionalProperties": false, "description": "Returned when delete_old_value is set to true for a regular picklist field where deletion of old value is not allowed.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "api_name": { "description": "The field API name", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path of the field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Cannot delete old_value for a picklist field" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Delete Old Value Not Allowed Error Response", "type": "object", "x-zs-$id": "DeleteOldValueNotAllowedErrorResponse" }, "DeleteProfileInvalidActionErrorResponse": { "additionalProperties": false, "description": "Error body returned when the action given in the delete profile request is invalid.", "properties": { "code": { "description": "Error code indicating an invalid action. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object returned for this error type.", "maxProperties": 0, "type": "object" }, "message": { "description": "Human-readable description of the invalid action error.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteProfileInvalidActionErrorResponse" }, "DeleteProfileInvalidIdErrorResponse": { "allOf": [ { "$ref": "#/components/schemas/ProfilesInvalidIdError" } ], "description": "Error body returned when the profile ID in the delete request path is invalid or refers to a deleted profile.", "x-zs-$id": "DeleteProfileInvalidIdErrorResponse" }, "DeleteProfileSystemProfileNotAllowedErrorResponse": { "additionalProperties": false, "description": "Error body returned when attempting to delete a built-in system profile, which is not permitted.", "properties": { "code": { "description": "Error code indicating the operation is not allowed. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the path segment containing the system profile ID.", "properties": { "resource_path_index": { "description": "Zero-based index of the URL path segment that contains the system profile ID.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable description of why the system profile cannot be deleted.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteProfileSystemProfileNotAllowedErrorResponse" }, "DeleteRelationsSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned after deleting contact role relations.", "properties": { "data": { "description": "Status entries for each deleted relation", "items": { "additionalProperties": false, "description": "Result for a single relation delete operation", "properties": { "code": { "const": "SUCCESS", "description": "Operation status code", "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the deleted relation", "properties": { "id": { "description": "Identifier of the deleted relation", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "const": "relation removed", "description": "Result message", "type": "string" }, "status": { "const": "success", "description": "Operation status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteRelationsSuccessResponse" }, "DeleteTaskByIdSuccessResponse": { "additionalProperties": false, "description": "Single-task delete success response.", "properties": { "tasks": { "description": "Contains one success result object for the deleted task.", "items": { "$ref": "#/components/schemas/TaskActionResult" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "tasks" ], "title": "Delete Task By Id Success Response", "type": "object", "x-zs-$id": "DeleteTaskByIdSuccessResponse", "x-zs-llm-description": "Confirms a single task was successfully deleted by ID." }, "DeleteUserTypeUsersPresentError": { "additionalProperties": false, "description": "Returned when the portal user type cannot be deleted because it still has active portal users assigned to it. Remove or reassign users before deleting the user type.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "param_name": { "description": "Represents the parameter name.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Deletion of portal user type is not allowed, as user type contains users, which need to be transferred to other user type" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "DeleteUserTypeUsersPresentError" }, "DeleteWebhookByIdSuccessResponse": { "additionalProperties": false, "description": "Represents the success response for deleting a single webhook by its ID.", "properties": { "webhooks": { "description": "Represents the list containing the operation result for the deleted webhook.", "items": { "$ref": "#/components/schemas/WebhookStatusResponse" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteWebhookByIdSuccessResponse", "x-zs-llm-description": "Confirms a single webhook was deleted by ID." }, "DeleteappointmentssResponse200": { "additionalProperties": false, "description": "Represents the success response for the bulk appointment deletion request.", "properties": { "data": { "description": "Represents the list of deletion result objects for each appointment record in the request.", "items": { "$ref": "#/components/schemas/AppointmentsDataNested1" }, "maxItems": 3, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteappointmentssResponse200" }, "DeletedRecordsErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a deleted records response error.", "properties": { "data": { "description": "Represents the data value.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidModuleGetDeletedError" }, { "$ref": "#/components/schemas/PatternNotMatchedGetDeletedError" } ], "description": "Represents a single item in the DeletedRecordsErrorResponse array." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeletedRecordsErrorResponse" }, "DeletedRecordsSuccessResponse": { "additionalProperties": false, "description": "Represents the response schema for the deleted records success operation.", "examples": [ { "data": [ { "created_by": { "id": "5332848000000734001", "name": "rbtd11 rbtd11" }, "deleted_by": { "id": "5332848000000734001", "name": "rbtd11 rbtd11" }, "deleted_time": "2026-06-10T11:20:23+05:30", "display_name": "wqadsx", "id": "5332848000000890001", "type": "recycle" }, { "created_by": { "id": "5332848000000734001", "name": "rbtd11 rbtd11" }, "deleted_by": { "id": "5332848000000734001", "name": "rbtd11 rbtd11" }, "deleted_time": "2026-06-09T16:30:11+05:30", "display_name": "qwrqwrfqwr", "id": "5332848000000780028", "type": "recycle" } ], "info": { "count": 2, "more_records": true, "page": 1, "per_page": 2 } } ], "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the DeletedRecordsSuccessResponse array.", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" }, "name": { "description": "Represents the data value.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "deleted_by": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" }, "name": { "description": "Represents the data value.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "deleted_time": { "description": "Represents the data value.", "format": "date-time", "type": "string" }, "display_name": { "description": "Represents the data value.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Represents the data value.", "format": "int64", "type": "string", "x-zs-$id": "DeletedRecordId" }, "type": { "description": "Represents the data value.", "enum": [ "recycle", "permanent" ], "type": "string" } }, "required": [ "id", "type", "deleted_time", "created_by", "deleted_by", "display_name" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents the info value.", "properties": { "count": { "description": "Represents the info value.", "format": "int32", "type": "integer" }, "more_records": { "description": "Represents the info value.", "type": "boolean" }, "page": { "description": "Represents the info value.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the info value.", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "DeletedRecordsSuccessResponse" }, "DeleteidResponse200": { "additionalProperties": false, "description": "Represents the success response for the single appointment deletion request.", "properties": { "data": { "description": "Represents the list of deletion result objects for the deleted appointment record.", "items": { "$ref": "#/components/schemas/AppointmentsDataNested1" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteidResponse200" }, "DeleteservicessResponse200": { "additionalProperties": false, "description": "Wrapped response for a service DELETE request. Contains a data array with one status object carrying the success code and the deleted service ID.", "properties": { "data": { "description": "Represents the per-record status array containing the result for each deleted service record.", "items": { "$ref": "#/components/schemas/ServicesDataNested1" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteservicessResponse200" }, "DeletetagsResponse200": { "additionalProperties": false, "description": "Represents the response body for a successful tag deletion.", "properties": { "tags": { "description": "Represents an array containing the result of the tag deletion operation.", "items": { "$ref": "#/components/schemas/TagsTagsNested1" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeletetagsResponse200" }, "DeleteusertypeResponse200": { "additionalProperties": false, "description": "Returned on successful deletion of a portal user type. Contains the name of the deleted user type.", "properties": { "user_type": { "description": "An array containing the result of the delete operation, including the identifier of the deleted user type.", "items": { "$ref": "#/components/schemas/UserTypeNested2" }, "maxItems": 1, "type": "array" } }, "required": [ "user_type" ], "type": "object", "x-zs-$id": "DeleteusertypeResponse200" }, "DependencyFieldMissingDetails": { "additionalProperties": false, "description": "Represents error details when a required dependency field is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the field with the missing dependency.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee field that is required but missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the dependee field.", "maxLength": 500, "type": "string" }, "param_name": { "description": "Represents the parameter name of the dependee field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path of the field with the missing dependency.", "maxLength": 500, "type": "string" }, "param_name": { "description": "Represents the parameter name associated with the field.", "maxLength": 255, "type": "string" } }, "required": [ "dependee" ], "type": "object", "x-zs-$id": "DependencyFieldMissingDetails" }, "DependentFieldMissingErrorInURL": { "additionalProperties": false, "description": "Represents the error response when a required dependent field is missing from a URL-parameterized territory request.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory operation. Possible values: **DEPENDENT_FIELD_MISSING**.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name, JSON path, and dependent field information.", "properties": { "api_name": { "description": "Represents the API name of the field whose dependent field is missing.", "maxLength": 100, "minLength": 1, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that is required but absent from the request.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the URL path segment that identifies the resource associated with the dependent field error.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field in the request body that triggered the dependent field error.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when a required dependent field is missing.", "enum": [ "This territory has its child. Please Give the transfer_to_id field value" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "DependentFieldMissingErrorInURL" }, "DependentFieldMissingSchema": { "additionalProperties": false, "description": "Error code DEPENDENT_FIELD_MISSING occurs when: action details are missing or empty, assign_owner resource is omitted, scheduled_actions execute_after lacks period or unit, or field_update lookup_field is not provided. To fix, check the action type's required companion fields and include all of them.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the **dependee** value from the error detail object.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Dependent Field missing", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleDependentFieldMissingErrorResponses", "x-zs-llm-description": "Error code: DEPENDENT_FIELD_MISSING. Returned when: (1) action details object is missing or empty, (2) assign_owner type is set but resource is omitted, (3) scheduled_actions execute_after missing period/unit, (4) field_update lookup_field needed but not provided. Fix: check the action type's required companion fields and provide all of them." }, "DependentFieldsNested": { "additionalProperties": false, "description": "A dependent field that must be included alongside the target field's value, used when the target field's valid options depend on another field (for example, Pipeline requires Stage). Supports nesting up to 3 levels.\n", "properties": { "dependent_fields": { "description": "Nested dependent fields that must be set when the current dependent field itself has further dependencies.", "items": { "$ref": "#/components/schemas/DependentFieldsNestedLevel2" }, "maxItems": 10, "type": "array" }, "field": { "$ref": "#/components/schemas/FieldDetails", "description": "Specify the API name and ID of the dependent field to be updated." }, "value": { "description": "Contains value of the dependent field.", "maxLength": 255, "type": "string" } }, "required": [ "field", "value" ], "type": "object", "x-zs-llm-description": "A field that must be included alongside the target field's value, with nesting supported up to 3 levels. Requires field ({id, api_name}) and value (string). Dependency chains: Pipeline needs Stage (1 level), Layout needs Pipeline which needs Stage (2 levels using nested dependent_fields)." }, "DependentFieldsNestedLevel2": { "additionalProperties": false, "description": "Second-level dependent field in a chained dependency. Example: Stage in a Pipeline -> Stage chain.", "properties": { "dependent_fields": { "description": "Third-level dependent fields for deeper dependency chains.", "items": { "$ref": "#/components/schemas/DependentFieldsNestedLevel3" }, "maxItems": 10, "type": "array" }, "field": { "$ref": "#/components/schemas/FieldDetails", "description": "Specify the API name and ID of the dependent field to be updated." }, "value": { "description": "Contains value of the dependent field.", "maxLength": 255, "type": "string" } }, "required": [ "field", "value" ], "type": "object", "x-zs-llm-description": "Second-level dependent field in a chained dependency (e.g., Stage depends on Pipeline). Must match its parent field's value." }, "DependentFieldsNestedLevel3": { "additionalProperties": false, "description": "Third-level (deepest) dependent field in a chained dependency. No further nesting is supported beyond this level.", "properties": { "field": { "$ref": "#/components/schemas/FieldDetails", "description": "Specify the API name and ID of the dependent field to be updated." }, "value": { "description": "Contains value of the dependent field.", "maxLength": 255, "type": "string" } }, "required": [ "field", "value" ], "type": "object", "x-zs-llm-description": "Third-level (deepest) dependent field. No further nesting is supported. Must be consistent with level-2 parent." }, "DependentMisMatchSchema": { "additionalProperties": false, "description": "Represents the error response returned when **module_selection** is set to a value that requires a specific module but no module is provided.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the **dependee** value from the error detail object.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleDependentMisMatchErrorResponses", "x-zs-llm-description": "Error code: DEPENDENT_MISMATCH. Returned when a field's value conflicts with its controlling field. Common cases: (1) module_selection is 'all' but relational_criteria is provided (should be 'specific'), (2) trigger type doesn't support scheduled_actions but they're included, (3) repeat=true with scheduled actions. Fix: align dependent values with their parent field's constraints." }, "DependentMismatchDetails": { "additionalProperties": false, "anyOf": [ { "description": "Represents the variant of DependentMismatchDetails in which the allowed values for the dependent field are conveyed through the supported_values list.", "properties": { "supported_values": { "description": "Represents the list of allowed values for the dependent field given the parent field's current value.", "items": { "description": "Represents an allowed value for the dependent field.", "maxLength": 500, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "supported_values" ], "x-zs-$id": "DependencyFieldDetailsSupportedValues" }, { "description": "Represents the variant of DependentMismatchDetails in which the expected data type for the dependent field is conveyed through expected_data_type.", "properties": { "expected_data_type": { "description": "Represents the data type expected for the dependent field given the parent field's current value.", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type" ], "x-zs-$id": "DependencyFieldDetailsExpectedDataType" } ], "description": "Represents error details when a dependent field value does not match the expected values based on the parent field.", "properties": { "api_name": { "description": "Represents the API name of the field with the dependency mismatch.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee field associated with the mismatch.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the dependee field.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "expected_data_type": { "description": "Represents the data type the server expected for the dependent field based on the parent field's value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with the dependency mismatch.", "maxLength": 500, "type": "string" }, "param_name": { "description": "Represents the parameter name associated with the field.", "maxLength": 255, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the dependee field.", "items": { "description": "Represents a supported value for the dependee field.", "maxLength": 500, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "dependee" ], "type": "object", "x-zs-$id": "DependentMismatchDetails" }, "DependentServiceError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a dependent service error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "DEPENDENT_SERVICE_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "dependency_error": { "description": "Contains additional context about the error.", "enum": [ "NO_PERMISSION", "LIMIT_EXCEEDED", "PROCESSING_ERROR", "CANNOT_PROCESS" ], "type": "string" } }, "required": [ "dependency_error" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DependentServiceError" }, "DetailsNested1": { "additionalProperties": false, "description": "Represents the response details returned upon successful initiation of the sign mail merge operation.", "properties": { "report_link": { "description": "Represents the URL of the sign mail merge job report.", "format": "uri", "maxLength": 255, "type": "string" }, "sign_resource_id": { "description": "Represents the unique ID of the sign request resource created for the sign mail merge operation.", "maxLength": 255, "type": "string" } }, "type": "object" }, "DetailsNested2": { "additionalProperties": false, "description": "Nested schema for details in merge response.", "properties": { "color_code": { "description": "Color code of the tag", "maxLength": 255, "type": [ "string", "null" ] }, "created_by": { "$ref": "#/components/schemas/TagsActionsCreatedByNested" }, "created_time": { "description": "Creation timestamp of the tag", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the tag", "maxLength": 255, "type": "string" }, "modified_by": { "$ref": "#/components/schemas/TagsActionsModifiedByNested" }, "modified_time": { "description": "Last modification timestamp of the tag", "maxLength": 255, "type": "string" }, "rid": { "description": "Resource ID", "format": "uuid", "type": "string" } }, "type": "object" }, "DetailsPermission": { "additionalProperties": false, "description": "Represents error details when the request fails due to missing permissions.", "properties": { "permissions": { "description": "Represents the list of required permissions that are missing.", "items": { "description": "Represents the name of a required permission.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "DetailsPermission" }, "DetailsSchema": { "additionalProperties": true, "description": "_Details Schema.", "title": "_Details Schema", "type": [ "null", "object" ], "x-zs-$id": "DetailsSchema" }, "DetailsWithExpectedDataTypeInfo": { "additionalProperties": false, "description": "Error details.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation. ", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type returned for the Assignment Rule operation. ", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation. ", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "DetailsWithExpectedDataTypeInfo" }, "DetailsWithInvalidFieldInfo": { "additionalProperties": false, "description": "Error details.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation. ", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation. ", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "DetailsWithInvalidFieldInfo" }, "DetailsWithMaximumLengthInfo": { "additionalProperties": false, "description": "Error details.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation. ", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation. ", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum length returned for the Assignment Rule operation. ", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "DetailsWithMaximumLengthInfo" }, "DetailsWithMinimumLengthInfo": { "additionalProperties": false, "description": "Error details.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation. ", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation. ", "maxLength": 1000, "type": "string" }, "minimum_length": { "description": "Represents the minimum length returned for the Assignment Rule operation. ", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "minimum_length" ], "type": "object", "x-zs-$id": "DetailsWithMinimumLengthInfo" }, "DetailsWithResourcePathIndexInfo": { "additionalProperties": false, "description": "Error details.", "properties": { "resource_path_index": { "description": "Index of the invalid request path parameter.\nPossible values:\n**3** - Represents 3. ", "enum": [ 3 ], "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "DetailsWithResourcePathIndexInfo" }, "DetailsWithSupportedValuesInfo": { "additionalProperties": false, "description": "Error details.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation. ", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation. ", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the supported values returned for the Assignment Rule operation. ", "items": { "description": "Represents each supported values entry returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "DetailsWithSupportedValuesInfo" }, "DirectPicklistOptionDeletionResponse": { "additionalProperties": false, "description": "Success response indicating picklist option has been deleted directly. Returns an array of deletion results.", "properties": { "pick_list_values": { "description": "pick list values", "items": { "$ref": "#/components/schemas/DirectPicklistOptionDeletionResult" }, "maxItems": 1, "minItems": 0, "type": "array" } }, "required": [ "pick_list_values" ], "title": "Direct Picklist Option Deletion Response", "type": "object", "x-zs-$id": "DirectPicklistOptionDeletionResponse" }, "DirectPicklistOptionDeletionResult": { "additionalProperties": false, "description": "Represents a direct (non-scheduled) deletion result for a picklist option, including status, code, message, and deleted option ID.", "properties": { "code": { "description": "Picklist option deletion result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the deleted picklist option", "properties": { "id": { "description": "The unique ID of the deleted picklist option", "format": "int64", "maxLength": 100, "minLength": 13, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Picklist option deletion message", "enum": [ "PickList Option deleted successfully" ], "type": "string" }, "status": { "description": "Picklist option deletion status", "enum": [ "success" ], "maxLength": 7, "minLength": 5, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Direct Picklist Option Deletion Result", "type": "object", "x-zs-$id": "DirectPicklistOptionDeletionResult" }, "DiscretePaginationLimitExceededGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a discrete pagination limit exceeded GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "DISCRETE_PAGINATION_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "limit": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DiscretePaginationLimitExceededGETError" }, "DisplayBasedOnFiscalYearUpdate": { "additionalProperties": false, "description": "Represents a request to update only the fiscal year display option for an existing standard or custom fiscal year.", "properties": { "display_based_on": { "description": "Specify whether the fiscal year label is based on the start month or the end month of the fiscal period. Possible values: `start_month`, `end_month`.", "enum": [ "start_month", "end_month" ], "maxLength": 20, "type": "string" } }, "required": [ "display_based_on" ], "type": "object", "x-zs-$id": "DisplayBasedOnFiscalYearUpdate" }, "DownloadAttachmentsErrorResponse": { "additionalProperties": false, "description": "Represents the standard error response returned by Zoho CRM APIs, containing the failure status, code, message, and contextual details.", "properties": { "code": { "description": "Represents the error code that identifies the specific failure condition. ", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional contextual information about the failure, such as the parameter name or field that triggered the error.", "type": "object" }, "message": { "description": "Represents the message describing the cause of the failure. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the outcome of the request.\nPossible values:\n**error** - Indicates that the request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "StandardErrorResponse" }, "DownloadMailMergeNested": { "additionalProperties": false, "description": "Represents the request payload for a download mail merge operation, including the template reference, output format, and optional file settings.", "properties": { "file_name": { "description": "Represents the file name for the downloaded mail merge document.", "maxLength": 255, "type": "string" }, "mail_merge_template": { "$ref": "#/components/schemas/MailMergeTemplateNested", "description": "To pass template name (Required)" }, "output_format": { "description": "Represents the output format for the downloaded document.\nPossible values:\n**pdf** - Downloads the document in PDF format.\n**html** - Downloads the document in HTML format.\n**docx** - Downloads the document in DOCX format.\n", "enum": [ "pdf", "html", "docx" ], "maxLength": 4, "type": "string" } }, "required": [ "mail_merge_template" ], "type": "object" }, "DuplicateDataErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when duplicate names are found in the module_parameters or custom_parameters collections.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**DUPLICATE_DATA** - A duplicate parameter name was detected in the request.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field that caused the duplicate data error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Represents the name of the parameter that contains the duplicate value.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**duplicate parameter name found** - A parameter name appears more than once in the request.", "enum": [ "duplicate parameter name found" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Duplicate Data Error Response", "type": "object", "x-zs-$id": "DuplicateDataErrorResponse", "x-zs-llm-description": "Duplicate names found in module or custom parameters. Ensure all parameter names are unique." }, "DuplicateDataErrorSchemaPOST": { "additionalProperties": false, "description": "Represents an error when a contact role with the same name already exists in the CRM organization.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **DUPLICATE_DATA** - A contact role with the same name already exists.\n", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the duplicate data.", "properties": { "api_name": { "description": "Represents the API name of the field that contains a duplicate value.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains a duplicate value.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DuplicateDataErrorSchemaPOST" }, "DuplicateDataErrorSchemaPUT": { "additionalProperties": false, "description": "Represents an error when a contact role with the same name already exists in the CRM organization.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **DUPLICATE_DATA** - A contact role with the same name already exists.\n", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the duplicate data.", "properties": { "api_name": { "description": "Represents the API name of the field that contains a duplicate value.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the ID of the contact role that has the duplicate name.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains a duplicate value.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DuplicateDataErrorSchemaPUT" }, "DuplicateDataForUpdateCVById": { "additionalProperties": false, "description": "Represents the error details returned when the request contains duplicate values for a field that requires unique values.", "properties": { "code": { "description": "Represents the error code for the duplicate data error.\nPossible values:\n**DUPLICATE_DATA** - The request contains duplicate values for a field that requires unique values.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the duplicate field.", "properties": { "api_name": { "description": "Represents the API name of the field with the duplicate value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the duplicate field in the request body.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the duplicate data issue.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateDataForUpdateCVById" }, "DuplicateLinkingDataError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a duplicate linking data error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "DUPLICATE_LINKING_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "maxLength": 19, "type": "string" }, "linking_fields": { "description": "Contains additional context about the error.", "items": { "description": "Represents a single item in the DuplicateLinkingDataError array.", "maxLength": 50, "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "linking_fields", "id" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateLinkingDataError" }, "DuplicateProfileNameError": { "additionalProperties": false, "description": "A DUPLICATE_DATA error returned when a profile with the same name already exists.", "properties": { "code": { "description": "Error code indicating duplicate profile name data. \n**Possible values:**\n **DUPLICATE_DATA**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the duplicated field and the ID of the conflicting profile.", "properties": { "api_name": { "description": "Indicates the API name of the field that contains duplicate data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "A JSONPath expression that indicates the location of the duplicate field in the request payload.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "A descriptive error message explaining why the data was identified as a duplicate.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateProfileNameError" }, "DuplicateTagError": { "additionalProperties": false, "description": "Represents an error response returned when a tag with the same name already exists in the module.", "properties": { "code": { "description": "Represents the error code **DUPLICATE_DATA**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing validation information.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the duplicate data error.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the ID of the duplicate tag record.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains the duplicate value.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the duplicate data condition.", "enum": [ "duplicate data" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "DuplicateTagError" }, "DuplicateVariableGroupError": { "additionalProperties": false, "description": "Represents an error response returned when duplicate data is detected for one or more variable groups in the request.", "properties": { "code": { "description": "Represents the error code **DUPLICATE_DATA**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the duplicate field that caused the error.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the duplicate value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains the duplicate value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that duplicate data was detected.", "enum": [ "duplicate data" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Duplicate Variable Group Error", "type": "object", "x-zs-$id": "DuplicateVariableGroupError" }, "DurationNotSatisfyServiceTimingError": { "additionalProperties": false, "description": "Error response returned when the service Duration does not fit within the configured availability timing.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the service duration does not satisfy the configured service timing requirements.", "enum": [ "Duration does not satisfy the service timing" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "DurationNotSatisfyServiceTimingError" }, "EmailAddress": { "additionalProperties": false, "description": "Object representing an email address and display name.", "properties": { "email": { "description": "The actual email address.", "format": "email", "maxLength": 255, "type": "string" }, "user_name": { "description": "The display name of the email recipient or sender.", "maxLength": 255, "type": "string" } }, "required": [ "email" ], "type": "object" }, "EmailCreateRecordActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that creates a record via an email-based trigger, applicable to modules such as Leads or Contacts.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationEmailCreateRecordDetails", "description": "Configuration for the create-record-from-email action. Requires the target module, either Leads or Contacts, and exactly one field mapping that assigns the record owner.\n" }, "id": { "description": "Represents the unique ID of the EmailCreateRecord action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the EmailCreateRecord action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "type": { "const": "create_record_email", "description": "Represents the action type discriminator that identifies this as a EmailCreateRecord action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "EmailCreateRecordActionSchema", "x-zs-llm-description": "Inline action type='create_record_email'. Creates a Leads or Contacts record via email. Limit 1/rule. Requires details.module (api_name: 'Leads' or 'Contacts') and details.field_mappings (exactly 1 entry specifying owner assignment: field with value.type user|role|group|country and value.resource.id)." }, "EmailEngagementMetricsSchema": { "additionalProperties": false, "description": "Represents email engagement metrics for an email notification action, including sent, delivered, opened, clicked, bounced, and unsent counts.", "properties": { "bounced": { "description": "Represents number of emails that bounced back.", "format": "int32", "type": "integer" }, "bulk_mail": { "description": "Represents number of bulk email messages sent.", "type": "boolean" }, "clicked": { "description": "Represents number of emails where recipients clicked a link.", "format": "int32", "type": "integer" }, "delivered": { "description": "Represents number of emails successfully delivered.", "format": "int32", "type": "integer" }, "opened": { "description": "Represents number of emails opened by recipients.", "format": "int32", "type": "integer" }, "sent": { "description": "Represents total number of emails sent.", "format": "int32", "type": "integer" }, "sent_percentage": { "description": "Represents percentage of emails successfully sent out of total attempted.", "format": "int32", "type": "integer" }, "unopened": { "description": "Represents number of emails not opened by recipients.", "format": "int32", "type": "integer" }, "unsent": { "description": "Represents number of emails that failed to send.", "format": "int32", "type": "integer" } }, "required": [ "bounced", "bulk_mail", "clicked", "delivered", "opened", "sent", "sent_percentage", "unopened", "unsent" ], "title": "Email Engagement Metrics", "type": "object", "x-zs-llm-description": "Email-specific engagement stats within action usage. Contains sent, delivered, opened, clicked, bounced, unsent, unopened counts, sent_percentage, and bulk_mail flag. Only populated for email_notifications actions." }, "EmailNotificationAssociateActionSchema": { "additionalProperties": false, "description": "Represents an associate action that sends a pre-configured email notification when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "additionalProperties": false, "description": "Represents the read-only details of the associated email notification. Returned in GET responses and not required in POST or PUT requests.", "properties": { "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module this action applies to." } }, "type": "object" }, "id": { "description": "Represents the unique ID of the email notification. Required when associating an existing email notification with the rule.", "example": "6660682000001435009", "maxLength": 20, "title": "Email Notification Action Id", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getEmailNotifications", "propertyId": "EmailNotificationsId" } ], "resource": "email_notifications" } }, "name": { "description": "Represents the display name of the EmailNotificationAssociate action. Returned in GET responses and derived from the associated action configuration.", "maxLength": 500, "type": "string" }, "related_details": { "$ref": "#/components/schemas/EmailNotificationRelatedDetailsSchema", "description": "Controls whether the email is sent at the best time for the recipient (powered by Data Intelligence). Null when best_time is not enabled." }, "type": { "const": "email_notifications", "description": "Represents the action type discriminator that identifies this as a EmailNotificationAssociate action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "EmailNotificationAssociateActionSchema", "x-zs-llm-description": "References a pre-configured email notification entity by ID. Create the entity first via postEmailNotifications, then use its ID here. Supports related_details.best_time for optimal send timing. Entity must be created for the correct module (main module, or relational_criteria.module if module_selection='specific' with Emails/Facebook/Twitter)." }, "EmailNotificationRelatedDetailsSchema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the best-time delivery configuration for the email notification action, controlling when the email sends to reach the recipient at the optimal delivery time.", "properties": { "best_time": { "description": "Indicates whether to send the email notification at the best time for the recipient. When set to true, the platform determines the optimal send time.", "type": "boolean" } }, "type": "object", "x-zs-$id": "EmailNotificationRelatedDetailsBestTimeSchema" }, { "description": "Represents a null value indicating best-time delivery is not configured for this email notification action.", "type": "null", "x-zs-$id": "EmailNotificationRelatedDetailsNullSchema" } ], "description": "Represents the optional related configuration details for email notification actions, including best-time delivery settings.", "x-zs-llm-description": "Supplementary config for email_notifications associate action. Controls best-time delivery scheduling - when best_time=true, the email is sent at the recipient's optimal engagement time rather than immediately." }, "EmailNotificationTypeFollowupActionRequestObject": { "additionalProperties": false, "description": "Represents the follow-up step configuration for an email notification action in a Cadence.", "properties": { "id": { "description": "Represents the unique identifier of the email notification action.", "example": "6660682000001435009", "maxLength": 255, "title": "Email Notification Action Id", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getEmailNotifications", "propertyId": "EmailNotificationsId" }, { "operationId": "postEmailNotifications", "propertyId": "EmailNotificationResultId" } ], "resource": "email_notifications" } }, "type": { "description": "Represents the action type for this follow-up step.", "enum": [ "email_notifications" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "EmailNotificationTypeFollowupActionRequestObject" }, "EmailObject": { "additionalProperties": false, "description": "Detailed email metadata object for association.", "properties": { "attachments": { "description": "List of attachments associated with the email. Use the [Files API](files.yaml#$.paths./files.get) to retrieve attachment IDs.", "items": { "$ref": "#/components/schemas/AttachmentRef" }, "maxItems": 20, "type": "array" }, "bcc": { "description": "Blind carbon copy recipients of the email.", "items": { "$ref": "#/components/schemas/EmailAddress" }, "maxItems": 50, "type": "array" }, "cc": { "description": "Carbon copy recipients of the email.", "items": { "$ref": "#/components/schemas/EmailAddress" }, "maxItems": 50, "type": "array" }, "content": { "description": "The email body content.", "maxLength": 32000, "type": "string" }, "date_time": { "description": "The timestamp of the email (ISO 8601 format).", "format": "date-time", "maxLength": 50, "type": "string" }, "from": { "$ref": "#/components/schemas/EmailAddress" }, "mail_format": { "default": "text", "description": "The format of the email content.", "enum": [ "text", "html" ], "type": "string" }, "original_message_id": { "description": "The unique identifier of the email from the mail server. This is used to prevent duplicate email associations.", "maxLength": 255, "type": "string" }, "sent": { "description": "Indicates whether the email was sent (true) or received (false) by the CRM user.", "type": "boolean" }, "subject": { "description": "The subject line of the email.", "maxLength": 500, "type": "string" }, "to": { "description": "Primary recipients of the email.", "items": { "$ref": "#/components/schemas/EmailAddress" }, "maxItems": 50, "type": "array" } }, "required": [ "from", "to", "subject", "content", "original_message_id", "sent", "date_time" ], "type": "object" }, "EmailTemplateListItem": { "additionalProperties": false, "description": "Represents an Email Template in list view with summary information, including metadata, statistics, and association details.", "properties": { "active": { "description": "Indicates whether the Email Template is active. \nPossible values:\n**true** - The template is active.\n**false** - The template is inactive/deleted.", "type": "boolean" }, "associated": { "description": "Indicates whether the Email Template is currently associated with one or more CRM components. \nPossible values:\n**true** - The template is associated with one or more CRM components.\n**false** - The template is not associated with any CRM component.", "type": "boolean" }, "attachments": { "description": "Represents the list of attachments associated with the Email Template. ", "items": { "additionalProperties": false, "description": "Represents an attachment entry associated with the Email Template.", "properties": { "file_id": { "description": "Represents the unique ID of the attachment file in the Zoho CRM file store. ", "maxLength": 255, "type": "string" }, "file_name": { "description": "Represents the name of the attachment file. ", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the attachment entry. ", "maxLength": 255, "type": "string" }, "size": { "description": "Represents the size of the attachment file. ", "maxLength": 255, "type": "string" } }, "required": [ "size", "file_name", "file_id", "id" ], "type": "object" }, "maxItems": 10, "type": [ "array", "null" ] }, "category": { "description": "Template category - normal, draft, marketplace, plugin, or default", "enum": [ "normal", "draft", "marketplace", "plugin", "system_templates" ], "type": "string" }, "consent_linked": { "description": "Indicates whether this Email Template is linked to a consent form. \nPossible values:\n**true** - The template is linked to a consent form.\n**false** - The template is not linked to a consent form.", "type": "boolean" }, "created_by": { "$ref": "#/components/schemas/EmailTemplatesUserRef" }, "created_time": { "description": "Represents the timestamp indicating when Zoho CRM created the Email Template. ", "format": "date-time", "type": "string" }, "editor_mode": { "description": "Represents the editor mode used to create the Email Template. \nPossible values:\n**plain_text** - The template uses plain text format.\n**rich_text** - The template uses rich text format.\n**gallery** - The template uses the gallery drag-and-drop editor.", "enum": [ "plain_text", "rich_text", "gallery" ], "type": "string" }, "favorite": { "description": "Indicates whether the Email Template is marked as a favorite by the authenticated user. \nPossible values:\n**true** - The template is marked as a favorite.\n**false** - The template is not marked as a favorite.", "type": "boolean" }, "folder": { "$ref": "#/components/schemas/EmailTemplatesFolderRef" }, "id": { "description": "Represents the unique ID of the Email Template. ", "maxLength": 255, "type": "string", "x-zs-$id": "EmailTemplatesId" }, "last_usage_time": { "description": "Represents the timestamp indicating when the Email Template was last used. ", "format": "date-time", "type": [ "string", "null" ] }, "last_version_statistics": { "additionalProperties": false, "description": "Represents the email delivery and engagement statistics from the most recent version of the template. ", "properties": { "bounced": { "description": "Represents the number of emails that bounced when sent using this template. ", "format": "int32", "type": "integer" }, "clicked": { "description": "Represents the number of link clicks recorded in emails sent using this template. ", "format": "int32", "type": "integer" }, "delivered": { "description": "Represents the number of emails delivered successfully when sent using this template. ", "format": "int32", "type": "integer" }, "opened": { "description": "Represents the number of emails opened by recipients when sent using this template. ", "format": "int32", "type": "integer" }, "sent": { "description": "Represents the total number of emails sent using this template. ", "format": "int32", "type": "integer" }, "tracked": { "description": "Represents the number of emails sent using this template for which tracking is enabled. ", "format": "int32", "type": "integer" } }, "required": [ "tracked", "delivered", "opened", "bounced", "sent", "clicked" ], "type": "object" }, "modified_by": { "$ref": "#/components/schemas/EmailTemplatesUserRef" }, "modified_time": { "description": "Represents the timestamp indicating when the Email Template was last modified. ", "format": "date-time", "type": "string" }, "module": { "$ref": "#/components/schemas/EmailTemplatesModuleRef" }, "name": { "description": "Represents the display name of the Email Template. ", "maxLength": 75, "type": "string" }, "subject": { "description": "Represents the email subject line of the template. ", "maxLength": 250, "type": "string" } }, "required": [ "created_time", "modified_time", "last_usage_time", "category", "folder", "module", "created_by", "modified_by", "name", "id", "editor_mode", "favorite", "attachments", "subject", "associated", "active", "consent_linked", "last_version_statistics" ], "type": "object" }, "EmailTemplateListResponse": { "additionalProperties": false, "description": "Successful response for email templates retrieval", "properties": { "email_templates": { "description": "Represents the list of email templates matching the request criteria. ", "items": { "$ref": "#/components/schemas/EmailTemplateListItem" }, "maxItems": 2000, "type": "array" }, "info": { "$ref": "#/components/schemas/EmailTemplatesInfoBlock" } }, "required": [ "email_templates", "info" ], "type": "object", "x-zs-$id": "EmailTemplateListResponse" }, "EmailTemplatesErrorItemBase": { "additionalProperties": false, "description": "Represents the base structure for error response items, containing the code, message, status, and details fields.", "properties": { "code": { "description": "Represents the error code identifier. ", "maxLength": 128, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error. ", "type": "object" }, "message": { "description": "Represents the descriptive message explaining the error. ", "maxLength": 1024, "type": "string" }, "status": { "description": "Represents the severity level of the error. \n\nPossible values:\n\n**error** - The request resulted in an error.\n\n**warning** - The request completed with a warning.\n\n**info** - The response carries informational status.\n", "enum": [ "error", "warning", "info" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ErrorItemBase" }, "EmailTemplatesErrorItemInvalidData": { "allOf": [ { "$ref": "#/components/schemas/EmailTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Represents the specialized properties for the INVALID_DATA and INVALID_MODULE error types.", "properties": { "code": { "description": "Represents the error code for the invalid data or module condition. \n\nPossible values:\n\n**INVALID_DATA** - The provided data is invalid.\n\n**INVALID_MODULE** - The specified module does not exist or is not accessible.\n", "enum": [ "INVALID_DATA", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the invalid data error. ", "type": "object" } }, "type": "object" } ], "description": "Represents an error item indicating that the provided data or module reference is invalid.", "x-zs-$id": "ErrorItemInvalidData" }, "EmailTemplatesErrorItemInvalidRequest": { "additionalProperties": false, "description": "Represents an error item indicating that the request payload is invalid or cannot be parsed.", "properties": { "code": { "description": "Represents the error code for the invalid request condition. \n\nPossible values:\n\n**INVALID_REQUEST** - The request payload is invalid.\n\n**JSON_PARSE_ERROR** - The request body could not be parsed as valid JSON.\n\n**INVALID_MODULE** - The specified module does not exist or is not accessible.\n", "enum": [ "INVALID_REQUEST", "JSON_PARSE_ERROR", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the invalid request error. ", "type": "object" }, "message": { "description": "Represents the descriptive error message for the invalid request. ", "maxLength": 1024, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request resulted in an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ErrorItemInvalidRequest" }, "EmailTemplatesErrorItemMandatoryNotFound": { "allOf": [ { "$ref": "#/components/schemas/EmailTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Represents the specialized properties for the MANDATORY_NOT_FOUND error type.", "properties": { "code": { "description": "Represents the error code indicating that a mandatory field is missing. \nPossible values:\n**MANDATORY_NOT_FOUND** - A required field is absent from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the missing mandatory field. ", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field. ", "maxLength": 128, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory field in the request body. ", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ErrorItemMandatoryNotFoundDetails" } }, "type": "object" } ], "description": "Represents an error item indicating that a required field is absent from the request.", "x-zs-$id": "ErrorItemMandatoryNotFound" }, "EmailTemplatesErrorItemPatternNotMatched": { "allOf": [ { "$ref": "#/components/schemas/EmailTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Represents the specialized properties for the PATTERN_NOT_MATCHED error type.", "properties": { "code": { "description": "Represents the error code indicating that a value does not match the required pattern. \n\nPossible values:\n\n**PATTERN_NOT_MATCHED** - The provided value does not conform to the expected format.\n", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents details with the API name of the field that failed pattern validation.", "properties": { "api_name": { "description": "Represents the API name of the field whose value did not match the required pattern. ", "maxLength": 128, "type": "string" } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "ErrorItemPatternNotMatchedDetails1" }, { "additionalProperties": true, "description": "Represents additional details for the pattern mismatch error in a generic format.", "type": "object", "x-zs-$id": "ErrorItemPatternNotMatchedDetails2" } ], "description": "Represents additional details identifying the field that failed pattern validation. " } }, "type": "object" } ], "description": "Represents an error item indicating that a field value does not match the required pattern.", "x-zs-$id": "ErrorItemPatternNotMatched" }, "EmailTemplatesFolderRef": { "additionalProperties": false, "description": "Represents a reference to the folder in which the Email Template is stored.", "properties": { "id": { "description": "Represents the unique ID of the folder. ", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the folder. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "EmailTemplatesInfoBlock": { "additionalProperties": false, "description": "Represents the pagination metadata for the email templates list response.", "properties": { "count": { "description": "Represents the number of Email Template records returned in the current page. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional pages of results are available. \nPossible values:\n**true** - More records are available on subsequent pages.\n**false** - The current page contains the last available records.", "type": "boolean" }, "page": { "description": "Represents the current page number of the paginated response. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of Email Template records returned per page. ", "format": "int32", "type": "integer" } }, "required": [ "per_page", "page", "count", "more_records" ], "type": "object" }, "EmailTemplatesModuleRef": { "additionalProperties": false, "description": "Represents a reference to the CRM module associated with the Email Template. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "properties": { "api_name": { "description": "Represents the API name of the module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the module. ", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "EmailTemplatesUserRef": { "additionalProperties": false, "description": "Represents a reference to the Zoho CRM user associated with the Email Template.", "properties": { "id": { "description": "Represents the unique ID of the user. ", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "EmailUser": { "additionalProperties": false, "description": "Represents an email user with an email address and an optional display name.", "properties": { "email": { "description": "Represents the email address of the user.", "maxLength": 255, "type": "string" }, "user_name": { "description": "Represents the display name of the user.", "maxLength": 255, "type": "string" } }, "required": [ "email" ], "type": "object", "x-zs-$id": "EmailUser" }, "EmptyDetails": { "additionalProperties": false, "description": "Represents an empty error details object with no additional information.", "properties": {}, "type": "object", "x-zs-$id": "EmptyDetails" }, "EmptyRequestBody": { "additionalProperties": false, "description": "Empty request body", "title": "Empty Request Body", "type": "object" }, "EmptyUrlError": { "additionalProperties": false, "description": "Represents the error returned when the url field is present in the request but contains an empty string.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook URL field is empty or not provided.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the empty value.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the empty value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains the empty value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Empty value is not allowed** - The webhook URL field cannot be empty.", "enum": [ "Empty value is not allowed" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "EmptyUrlError", "x-zs-llm-description": "The url field was provided but is empty. Supply a valid URL." }, "EntityReference": { "additionalProperties": false, "description": "Reference to a CRM entity with ID and name", "properties": { "id": { "description": "Unique identifier of the entity record (int64 as string)", "maxLength": 20, "type": "string", "x-zs-$id": "ConvertId" }, "name": { "description": "Represents the name of the entity.", "maxLength": 200, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "EntityReference" }, "EqualFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a filter criterion for the equal comparator. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime fields; SimpleFilterCriterionValueNumber for integer, currency, or double fields; SimpleFilterCriterionValueBoolean for Boolean fields; SimpleFilterCriterionValueObjectRequest for lookup, ownerlookup, or userlookup fields; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders. Accepts scalar or array values. Resolve the data_type from the field's FieldSchema.", "properties": { "comparator": { "description": "Represents the equal comparison operator applied to the criterion.\nPossible values:\nequal - Matches records where the field value equals the specified filter value.", "enum": [ "equal" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the equal filter criterion.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the equal filter criterion is applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Contains an array of filter values for the equal comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectRequest" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" } ], "x-zs-$id": "EqualFilterCriterionRequestValueArrayItemsObject" } ], "x-zs-$id": "EqualFilterCriterionRequestValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "EqualFilterCriterionRequestValueArray" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueBoolean" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectRequest" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueGeneralPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueDateTimePredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNDaysPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueAgeDuePredefined" } ], "description": "Represents the filter value used in the equal comparator. Accepts a scalar or an array of values, depending on the field's data_type." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "EqualFilterCriterionRequest" }, "EqualFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the response for a filter criterion using the equal comparator. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime; SimpleFilterCriterionValueNumber for integer, currency, or double; SimpleFilterCriterionValueBoolean for Boolean; SimpleFilterCriterionValueObjectResponse for lookup, ownerlookup, or userlookup; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders.", "properties": { "$disrupted": { "description": "Indicates whether the equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.", "type": "boolean" }, "comparator": { "description": "Represents the equal comparison operator returned for the criterion.\nPossible values:\nequal - Matches records where the field value equals the specified filter value.", "enum": [ "equal" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the equal filter criterion response.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the equal filter criterion was applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "value", "pre_defined", "field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Contains an array of filter values returned for the equal comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectResponse" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" } ], "x-zs-$id": "EqualFilterCriterionResponseValueArrayItemsObject" } ], "x-zs-$id": "EqualFilterCriterionResponseValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "EqualFilterCriterionResponseValueArray" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueBoolean" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectResponse" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueGeneralPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueDateTimePredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNDaysPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueAgeDuePredefined" } ], "description": "Represents the filter value returned for the equal comparator. Contains a scalar or an array of values, depending on the field's data_type." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "EqualFilterCriterionResponse" }, "EqualityFilterCriterionRequest": { "anyOf": [ { "$ref": "#/components/schemas/EqualFilterCriterionRequest" }, { "$ref": "#/components/schemas/NotEqualFilterCriterionRequest" } ], "description": "Represents an equality filter criterion that dispatches to either the EqualFilterCriterionRequest or NotEqualFilterCriterionRequest schema based on the comparator value.", "x-zs-$id": "EqualityFilterCriterionRequest" }, "EqualityFilterCriterionResponse": { "anyOf": [ { "$ref": "#/components/schemas/EqualFilterCriterionResponse" }, { "$ref": "#/components/schemas/NotEqualFilterCriterionResponse" } ], "description": "Represents the response for an equality filter criterion that dispatches to either the EqualFilterCriterionResponse or NotEqualFilterCriterionResponse schema based on the comparator value.", "x-zs-$id": "EqualityFilterCriterionResponse" }, "ErrorApiNameGenerationMandatoryMissingResponse": { "additionalProperties": false, "description": "400 error returned when required fields for API name generation are not provided.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "API Name Generation Mandatory Missing Error Response", "type": "object", "x-zs-$id": "ErrorResponseCore1084285366" }, "ErrorDataNested": { "additionalProperties": false, "description": "Represents a failed per-record operation result in a multi-status response.", "properties": { "code": { "description": "Indicates the error code for the per-record failure. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": true, "description": "JSON object specifying the details of the per-record error, including the affected field name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the request field that caused the per-record error. Possible values: **ids**.", "enum": [ "ids" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "Indicates the JSON path to the specific value in the request that triggered the per-record error.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the reason for the per-record failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the per-record result. Possible values: **error**.", "enum": [ "error" ], "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "ErrorDataNested" }, "ErrorDetail": { "additionalProperties": false, "description": "Represents the details of a single error returned in a standard error response.", "properties": { "code": { "description": "Represents the error code for the specific issue encountered.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response.", "maxLength": 100, "type": "string" } }, "type": "object", "x-zs-$id": "ErrorDetail" }, "ErrorDetailsAmbiguity": { "additionalProperties": false, "description": "Error details containing information about ambiguous fields that caused processing conflict", "properties": { "ambiguity_due_to": { "description": "List of conflicting fields that caused the ambiguity (id and api_name)", "items": { "additionalProperties": false, "description": "Details of a field that contributed to the ambiguity", "properties": { "api_name": { "description": "The API name of the ambiguous field", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path indicating the location of the ambiguous field in the request", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "minItems": 2, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object", "x-zs-$id": "ErrorDetailsAmbiguity" }, "ErrorDetailsEmpty": { "additionalProperties": false, "description": "Empty error details object for errors that don't require additional context", "type": "object", "x-zs-$id": "ErrorDetailsEmpty" }, "ErrorDetailsExpectedFields": { "additionalProperties": false, "description": "Error details containing list of expected fields that are missing", "properties": { "expected_fields": { "description": "List of field names that were expected but not provided", "items": { "additionalProperties": false, "description": "Details of an expected field", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path indicating where the field was expected in the request", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 20, "minItems": 1, "type": "array" } }, "required": [ "expected_fields" ], "type": "object", "x-zs-$id": "ErrorDetailsExpectedFields" }, "ErrorDetailsFieldInfo": { "additionalProperties": false, "description": "Error details with field information, used for field-level validation errors", "properties": { "api_name": { "description": "The API name of the field that caused the error", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path indicating the location of the field in the request", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ErrorDetailsFieldInfo" }, "ErrorDetailsNotSupportedFilters": { "additionalProperties": false, "description": "Error details for unsupported filters, containing the expected data type and field information", "properties": { "api_name": { "description": "The API name of the field that is not supported", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "The expected data type for the field", "enum": [ "json_type" ], "type": "string" }, "json_path": { "description": "JSON path indicating the location of the unsupported field in the request", "maxLength": 500, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object", "x-zs-$id": "ErrorDetailsNotSupportedFilters" }, "ErrorDetailsResourcePathIndex": { "additionalProperties": false, "description": "Error details containing resource path index information", "properties": { "resource_path_index": { "description": "The index of the resource path segment that is invalid", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "ErrorDetailsResourcePathIndex" }, "ErrorInvalidDataResponse": { "additionalProperties": false, "description": "400 error for general invalid data submitted in the request.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "The maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Error Response", "type": "object", "x-zs-$id": "ErrorInvalidDataResponse" }, "ErrorInvalidDataTypeResponse": { "additionalProperties": false, "description": "400 error indicating a field has an incorrect data type.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "The expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Type Error Response", "type": "object", "x-zs-$id": "ErrorInvalidDataTypeResponse" }, "ErrorInvalidPersonalityModule": { "additionalProperties": false, "description": "Returned when the personality module specified in the request body is invalid. The `details` object identifies the field by API name and JSON path.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Invalid personality module." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorInvalidPersonalityModule" }, "ErrorItemInvalidDataForGet": { "allOf": [ { "$ref": "#/components/schemas/EmailTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Represents the specialized properties for the INVALID_DATA and INVALID_MODULE error types in retrieval operations.", "properties": { "code": { "description": "Represents the error code for the invalid data or module condition. \n\nPossible values:\n\n**INVALID_DATA** - The provided data is invalid.\n\n**INVALID_MODULE** - The specified module does not exist or is not accessible.\n", "enum": [ "INVALID_DATA", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the invalid data error. ", "type": "object" }, "message": { "description": "Represents the error message describing the invalid data.", "maxLength": 1024, "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object" } ], "description": "Represents an error item indicating that the provided data or module reference is invalid for a retrieval request.", "x-zs-$id": "ErrorItemInvalidDataForGet" }, "ErrorItemMandatoryNotFoundForGet": { "allOf": [ { "$ref": "#/components/schemas/EmailTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Represents the MANDATORY_NOT_FOUND error details for the Email Template retrieval request.", "properties": { "code": { "description": "Represents the error code for the missing mandatory field. The value is **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": true, "description": "Represents the error details containing the field name and path of the missing mandatory field.", "type": "object", "x-zs-$id": "ErrorItemMandatoryNotFoundForGetDetails1" }, { "additionalProperties": false, "description": "Represents the error details containing the parent API name for the missing mandatory field.", "properties": { "parent_api_name": { "description": "Represents the API name of the parent module for the missing mandatory field.", "maxLength": 255, "type": "string" } }, "required": [ "parent_api_name" ], "type": "object", "x-zs-$id": "ErrorItemMandatoryNotFoundForGetDetails2" } ], "description": "None" }, "message": { "description": "Represents the error message describing the missing mandatory field.", "maxLength": 1024, "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object" } ], "description": "Represents an error item indicating that a required field is absent from a retrieval request.", "x-zs-$id": "ErrorItemMandatoryNotFoundForGet" }, "ErrorItemPatternNotMatchedForGet": { "allOf": [ { "$ref": "#/components/schemas/EmailTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Represents the specialized properties for the PATTERN_NOT_MATCHED error type in retrieval operations.", "properties": { "code": { "description": "Represents the error code indicating that a value does not match the required pattern. \nPossible values:\n**PATTERN_NOT_MATCHED** - The provided value does not conform to the expected format.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents details with the API name of the field that failed pattern validation.", "properties": { "api_name": { "description": "Represents the API name of the field whose value did not match the required pattern. ", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "ErrorItemPatternNotMatchedForGetDetails1" }, { "additionalProperties": true, "description": "Represents additional details for the pattern mismatch error in a generic format.", "type": "object", "x-zs-$id": "ErrorItemPatternNotMatchedForGetDetails2" } ], "description": "Represents additional details identifying the field that failed pattern validation. " }, "message": { "description": "Represents the error message describing the pattern mismatch.", "maxLength": 1024, "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object" } ], "description": "Represents an error item indicating that a field value does not match the required pattern in a retrieval request.", "x-zs-$id": "ErrorItemPatternNotMatchedForGet" }, "ErrorMandatoryFieldMissingResponse": { "additionalProperties": false, "description": "400 error indicating a required field was not provided in the request.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Mandatory Field Missing Error Response", "type": "object", "x-zs-$id": "ErrorMandatoryFieldMissingResponse" }, "ErrorResponse403": { "additionalProperties": false, "description": "Represents the error response returned when the requesting user does not have permission to perform Cadence enrollment or un-enrollment.", "properties": { "code": { "description": "Represents the error code for the permission failure. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Indicates the error details containing the CRM permissions required to perform this operation. ", "properties": { "permissions": { "description": "Represents the list of CRM permissions required to perform this operation.", "items": { "description": "Indicates a CRM permission name required to perform this operation.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message for the permission failure. Possible values: **No permission**. ", "enum": [ "No permission" ], "type": "string" }, "status": { "description": "Indicates the error status. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response 403", "type": "object", "x-zs-$id": "ErrorResponse403" }, "ErrorResponseApiNotSupportedClientPortal": { "additionalProperties": false, "description": "Represents the error response returned when the authenticated user is a Client Portal user, which is an unsupported user type for this API.", "properties": { "code": { "description": "Represents the error code. The value is **API_NOT_SUPPORTED**.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the unsupported login user type.", "properties": { "unsupported_login_user_type": { "description": "Represents the login user type that is not supported by this API.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_login_user_type" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported user type.", "enum": [ "api not supported for client portal user" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseApiNotSupportedClientPortal" }, "ErrorResponseApiNotSupportedDomain": { "additionalProperties": false, "description": "Represents the error response returned when the caller's Zoho data-center domain does not support the Cadence execution API.", "properties": { "code": { "description": "Represents the error code. The value is **API_NOT_SUPPORTED**.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details including the list of supported domains for this API.", "properties": { "supported_domains": { "description": "Represents the list of Zoho data-center domains that support the Cadence execution API.", "items": { "description": "Represents a supported Zoho data-center domain.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "supported_domains" ], "type": "object" }, "message": { "description": "Represents the error message describing the domain restriction.", "enum": [ "api not supported" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseApiNotSupportedDomain" }, "ErrorResponseCannotRemove": { "additionalProperties": false, "description": "Assignment rule must contain atleast one rule entry.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**CANNOT_REMOVE** - Represents cannot remove.", "enum": [ "CANNOT_REMOVE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation. Possible values: **rule_entries** - Represents rule entries.", "enum": [ "rule_entries" ], "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation. Possible values: **$.assignment_rules[0].rule_entries** - Represents $.Assignment Rules[0].rule entries.", "enum": [ "$.assignment_rules[0].rule_entries" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Cannot remove", "type": "object", "x-zs-$id": "ErrorResponseCannotRemove" }, "ErrorResponseCore1009543207": { "additionalProperties": false, "description": "Represents the error when the request data array exceeds the maximum allowed length.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the request data that caused the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that contains invalid data.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed number of items in the data array.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1009543207" }, "ErrorResponseCore1090893661": { "additionalProperties": false, "description": "Represents the error when an appointment is marked as completed without a job sheet.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Appointment cannot be marked as completed without creating the jobsheet" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1090893661" }, "ErrorResponseCore1117753881": { "additionalProperties": false, "description": "Represents an error response returned when duplicate data is detected for a variable group item in a multi-status response.", "properties": { "code": { "description": "Represents the error code **DUPLICATE_DATA**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the duplicate field.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the duplicate value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains the duplicate value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that duplicate data was detected.", "enum": [ "duplicate data" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1117753881" }, "ErrorResponseCore1168955151": { "additionalProperties": false, "description": "Represents the error when a required field is missing from the request.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1168955151" }, "ErrorResponseCore1207168962": { "additionalProperties": false, "description": "Represents the error when the selected service is unavailable at the specified appointment time.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Service is not available on the given time" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1207168962" }, "ErrorResponseCore1277582131": { "additionalProperties": false, "description": "Represents the error when the appointment owner is not a member of the service specified in Service_Name.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Appointment Owner is not a part of Service Members" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1277582131" }, "ErrorResponseCore1332683101": { "additionalProperties": false, "description": "Represents the error when cancellation information fields are updated without setting the Status to Cancelled.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "To Update the fields of Cancellation Information Section, value of Status should be Cancelled" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1332683101" }, "ErrorResponseCore1544688711": { "additionalProperties": false, "description": "Represents the error when the appointment ID provided in the request is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1544688711" }, "ErrorResponseCore1593946428": { "additionalProperties": false, "description": "Represents the error when the Appointment_For field value is not a valid JSON object.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that has an incorrect value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "invalid data", "INVALID_DATA" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1593946428" }, "ErrorResponseCore1604218709": { "additionalProperties": false, "description": "Represents the error when the module API name in the request URL is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the path parameter that caused the error.", "properties": { "resource_path_index": { "description": "Represents the index of the path parameter in the request URL that is invalid.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid module name.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1604218709" }, "ErrorResponseCore1720623915": { "additionalProperties": false, "description": "Represents the error when a required appointment field is missing from the request.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1720623915" }, "ErrorResponseCore1818284114": { "additionalProperties": false, "description": "Represents the error when the appointment time does not fall within the configured business hours.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Appointment time does not falls under business hours" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1818284114" }, "ErrorResponseCore1875045219": { "additionalProperties": false, "description": "Represents the error when the HTTP request method is not supported.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the invalid request method.", "enum": [ "The http request method type is not a valid one" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1875045219" }, "ErrorResponseCore1944579470": { "additionalProperties": false, "description": "Represents the error when the appointment ID specified in the request URL is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the invalid path parameter.", "properties": { "resource_path_index": { "description": "Represents the index of the path parameter in the request URL that contains an invalid ID.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message indicating that the appointment ID is invalid.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore1944579470" }, "ErrorResponseCore201487910": { "additionalProperties": false, "description": "Represents the error when the appointment start time is set to a past date.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Appointment cannot be scheduled for past dates" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore201487910" }, "ErrorResponseCore2114620743": { "additionalProperties": false, "description": "Represents the error when the module API name provided in Appointment_For does not exist in the multi-module lookup.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "the given module name is not exist in multimodulelookup", "invalid data", "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore2114620743" }, "ErrorResponseCore2137699283": { "additionalProperties": false, "description": "Represents the error when one or more appointment records cannot be deleted.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "id": { "description": "Represents the ID of the appointment record that could not be processed.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "record not deleted" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore2137699283" }, "ErrorResponseCore2271053024": { "additionalProperties": false, "description": "Represents the error response returned when the appointment ID in the request URL is invalid.", "properties": { "code": { "description": "Represents the error code returned for the invalid URL pattern failure.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object for the invalid URL pattern failure.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the invalid URL pattern failure.", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": "Indicates the response status for the invalid URL pattern failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore2271053024" }, "ErrorResponseCore261228299": { "additionalProperties": false, "description": "Represents the error when the Rescheduled_From field is empty while Reschedule_Reason is provided.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_FIELD_MISSING", "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Rescheduled_From cannot be empty", "Reschedule the appointment atleast once to Update the fields of Reschedule Information Section" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore261228299" }, "ErrorResponseCore496791912": { "additionalProperties": false, "description": "Represents the error when the appointment Status is set to Overdue before the appointment end time.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Appointment cannot be marked as overdue before the appointment ends" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore496791912" }, "ErrorResponseCore55175210": { "additionalProperties": false, "description": "Represents the error when the required unit key is missing from a Remind_At object.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "mandatory key missing" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore55175210" }, "ErrorResponseCore622374562": { "additionalProperties": false, "description": "Represents the error when Rescheduled_From and Appointment_Start_Time have the same value.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_FIELD_UNCHANGED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Reschedule_From and Appointment_Start_Time cannot be same", "Reschedule the appointment atleast once to Update the fields of Reschedule Information Section" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore622374562" }, "ErrorResponseCore653152835": { "additionalProperties": false, "description": "Represents the error when the appointment Status is set to Completed before the appointment end time.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Appointment cannot be marked as completed before the appointment ends" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore653152835" }, "ErrorResponseCore899638570": { "additionalProperties": false, "description": "Represents the error when a job sheet is created for an appointment that has not been completed.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that triggers this constraint.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency constraint.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency constraint.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "enum": [ "Job Sheet can be created only for completed appointment", "Field of this jobsheet cannot be updated. Choose appropriate Jobsheet in services" ], "type": "string" }, "status": { "description": "Indicates the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseCore899638570" }, "ErrorResponseCoreInvalidDataFlat": { "additionalProperties": false, "description": "Represents the error response returned when the appointment record could not be deleted due to invalid data.", "properties": { "code": { "description": "Represents the error code returned for the flat invalid data failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid data failure, including the resource path index.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path in the request that triggered the invalid data error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data failure.", "enum": [ "record not deleted" ], "type": "string" }, "status": { "description": "Indicates the response status for the invalid data failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core - Invalid Data Flat", "type": "object", "x-zs-$id": "ErrorResponseCoreInvalidDataFlat" }, "ErrorResponseCoreNoPermission": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have the required permission to perform the appointment action.", "properties": { "code": { "description": "Represents the error code returned for the permission-denied failure.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the permission-denied failure, including the list of required permissions.", "properties": { "permissions": { "description": "Represents the list of permissions required to perform the appointment action.", "items": { "description": "Represents the name of a required permission.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission-denied failure.", "enum": [ "permission denied", "record not accessible" ], "type": "string" }, "status": { "description": "Indicates the response status for the permission-denied failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core - No Permission", "type": "object", "x-zs-$id": "ErrorResponseCoreNoPermission" }, "ErrorResponseCoreNoPermissionFlat": { "additionalProperties": false, "description": "Represents the flat error response returned when the appointment record is not accessible due to insufficient permissions.", "properties": { "code": { "description": "Represents the error code returned for the flat permission-denied failure.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the flat permission-denied failure, including the resource path index.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path in the request that triggered the permission-denied error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the flat permission-denied failure.", "enum": [ "record not accessible" ], "type": "string" }, "status": { "description": "Indicates the response status for the flat permission-denied failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core - No Permission Flat", "type": "object", "x-zs-$id": "ErrorResponseCoreNoPermissionFlat" }, "ErrorResponseCoreRecordLocked": { "additionalProperties": false, "description": "Represents the error response returned when the appointment record is locked and cannot be modified.", "properties": { "code": { "description": "Represents the error code returned for the record-locked failure.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details associated with the locked record, including the field name, action, and JSON path that triggered the failure.", "properties": { "action": { "description": "Represents the action that was attempted on the locked record.", "enum": [ "record_locking" ], "type": "string" }, "api_name": { "description": "Represents the API name of the field associated with the record-locking error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that triggered the record-locked error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "action", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the record-locked failure.", "enum": [ "Sorry, you cannot perform this operation as the record is locked." ], "type": "string" }, "status": { "description": "Indicates the response status for the record-locked failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core - Record Locked", "type": "object", "x-zs-$id": "ErrorResponseCoreRecordLocked" }, "ErrorResponseDataInvalidDataType": { "additionalProperties": false, "description": "Represents the INVALID_DATA error returned when the **ids** or Cadence IDs field has the wrong data type - for example, a string was supplied where an array is expected.", "properties": { "code": { "description": "Represents the error code. The value is **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the expected data type information.", "properties": { "api_name": { "description": "Represents the API name of the field with the wrong data type.", "enum": [ "ids", "cadences_ids" ], "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the field.", "enum": [ "jsonarray" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with the wrong data type.", "enum": [ "$.ids", "$.cadences_ids" ], "maxLength": 1000, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the data type mismatch.", "enum": [ "Record ids not found", "Cadences ids not found" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseDataInvalidDataType" }, "ErrorResponseDataInvalidId": { "additionalProperties": false, "description": "Represents the INVALID_DATA error returned when an individual record ID or Cadence ID in the request arrays is invalid.", "properties": { "code": { "description": "Represents the error code. The value is **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the invalid ID.", "properties": { "api_name": { "description": "Represents the API name of the field containing the invalid ID.", "enum": [ "ids", "cadences_ids" ], "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field. Present when the error is caused by a data type mismatch.", "enum": [ "bigint", "jsonarray" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field containing the invalid ID.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid ID.", "enum": [ "the given id seems to be invalid", "given id seems to be invalid", "invalid cadence id is given" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseDataInvalidId" }, "ErrorResponseDataInvalidIdArray": { "additionalProperties": false, "description": "Represents the array-form error response returned when one or more record IDs in the **ids** array are invalid.", "properties": { "data": { "description": "Represents the list of per-record error entries for each invalid record ID.", "items": { "additionalProperties": false, "description": "Represents the error entry for a single invalid record ID.", "properties": { "code": { "description": "Represents the error code for the invalid record ID. The value is **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the invalid record ID.", "properties": { "api_name": { "description": "Represents the API name of the field containing the invalid record ID.", "enum": [ "ids", "cadences_ids" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field containing the invalid record ID.", "maxLength": 1000, "pattern": "^\\$\\.(ids|cadences_ids)\\[[0-9]+\\]$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the invalid record ID.", "enum": [ "given id seems to be invalid", "invalid cadence id is given", "the given id seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseDataInvalidIdArray" }, "ErrorResponseDependentFieldMissing": { "additionalProperties": false, "description": "Dependent field missing.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**DEPENDENT_FIELD_MISSING** - Represents dependent field missing.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee returned for the Assignment Rule operation.", "properties": { "api_name": { "description": "Nested detail field: API_name.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Dependent field missing", "type": "object", "x-zs-$id": "ErrorResponseDependentFieldMissing" }, "ErrorResponseDependentMismatch": { "additionalProperties": false, "description": "Dependent mimatch.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**DEPENDENT_MISMATCH** - Represents dependent mismatch.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee returned for the Assignment Rule operation.", "properties": { "param_name": { "description": "Nested detail field: param_name.\nPossible values:\n**module** - Represents module.", "enum": [ "module" ], "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.\nPossible values:\n**dependent mismatch** - Represents dependent mismatch.", "enum": [ "dependent mismatch" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Dependent mismatch", "type": "object", "x-zs-$id": "ErrorResponseDependentMismatch" }, "ErrorResponseDuplicateData": { "additionalProperties": false, "description": "Duplicate data.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**DUPLICATE_DATA** - Represents duplicate data.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation. Possible values: **api_name** - Represents API name. **name** - Represents name.", "enum": [ "api_name", "name" ], "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation. Possible values: **$.assignment_rules[0].api_name** - Represents $.Assignment Rules[0].API name. **$.assignment_rules[0].name** - Represents $.Assignment Rules[0].name.", "enum": [ "$.assignment_rules[0].api_name", "$.assignment_rules[0].name" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Duplicate data", "type": "object", "x-zs-$id": "ErrorResponseDuplicateData" }, "ErrorResponseExpectedFieldsMissing": { "additionalProperties": false, "description": "Expected fields missing.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**EXPECTED_FIELD_MISSING** - Represents expected field missing.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "expected_fields": { "description": "Represents the expected fields returned for the Assignment Rule operation.", "items": { "additionalProperties": false, "description": "Represents each expected fields entry returned for the Assignment Rule operation.", "properties": { "api_name": { "description": "Nested detail field: API_name.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Expected fields missing", "type": "object", "x-zs-$id": "ErrorResponseExpectedFieldsMissing" }, "ErrorResponseFeatureNotSupported": { "additionalProperties": false, "description": "Feature not supported.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**FEATURE_NOT_SUPPORTED** - Represents feature not supported.", "enum": [ "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": {}, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.\nPossible values:\n**Assignment rules not supported for current edition** - Represents Assignment Rules not supported for current edition.", "enum": [ "Assignment rules not supported for current edition" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Feature not supported", "type": "object", "x-zs-$id": "ErrorResponseFeatureNotSupported" }, "ErrorResponseInvalidData": { "additionalProperties": false, "description": "Invalid data.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**INVALID_DATA** - Represents invalid data.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/DetailsWithResourcePathIndexInfo" }, { "$ref": "#/components/schemas/DetailsWithExpectedDataTypeInfo" }, { "$ref": "#/components/schemas/DetailsWithMinimumLengthInfo" }, { "$ref": "#/components/schemas/DetailsWithMaximumLengthInfo" }, { "$ref": "#/components/schemas/DetailsWithSupportedValuesInfo" }, { "$ref": "#/components/schemas/DetailsWithInvalidFieldInfo" } ], "description": "Represents additional details about the Assignment Rule operation result.", "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Invalid Data", "type": "object", "x-zs-$id": "ErrorResponseInvalidData" }, "ErrorResponseInvalidDataCadenceIds": { "additionalProperties": false, "description": "Represents the INVALID_DATA error returned when the Cadence IDs array contains an invalid ID or has the wrong data type.", "properties": { "code": { "description": "Represents the error code. The value is **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with validation information for the invalid Cadence ID.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the invalid Cadence ID.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains the invalid Cadence ID.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the Cadence ID value.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid Cadence ID.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseInvalidDataCadenceIds" }, "ErrorResponseInvalidModule": { "additionalProperties": false, "description": "Error response when module given is invalid.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**INVALID_MODULE** - Represents invalid module.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "param_name": { "description": "Represents the param name returned for the Assignment Rule operation.\nPossible values:\n**module** - Represents module. ", "enum": [ "module" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.\nPossible values:\n**the module name given seems to be invalid** - Represents the module name given seems to be invalid.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Error Response", "type": "object", "x-zs-$id": "ErrorResponseInvalidModule" }, "ErrorResponseLimitExceeded": { "additionalProperties": false, "description": "Limit exceeded.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**LIMIT_EXCEEDED** - Represents limit exceeded.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "api_name": { "description": "Represents the API name returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path returned for the Assignment Rule operation.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the limit returned for the Assignment Rule operation. ", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.\nPossible values:\n**limit exceeded** - Represents limit exceeded.", "enum": [ "limit exceeded" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Limit exceeded", "type": "object", "x-zs-$id": "ErrorResponseLimitExceeded" }, "ErrorResponseLimitExceededCadenceIds": { "additionalProperties": false, "description": "Represents the LIMIT_EXCEEDED error returned when the Cadence IDs array exceeds the allowed maximum of 5 per request.", "properties": { "code": { "description": "Represents the error code identifying the type of limit violation. The value is **LIMIT_EXCEEDED**.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the limit value and the fields that caused the limit violation.", "properties": { "limit": { "description": "Represents the maximum allowed count for the Cadence IDs array per request.", "format": "int32", "type": "integer" }, "limit_due_to": { "description": "Represents the list of fields responsible for the limit violation.", "items": { "additionalProperties": false, "description": "Represents a field that contributed to the limit violation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the limit violation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the limit violation.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "limit", "limit_due_to" ], "type": "object" }, "message": { "description": "Represents the error message describing the limit violation.", "enum": [ "Limit Exceeded, You cannot give more than 5 cadences ids" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseLimitExceededCadenceIds" }, "ErrorResponseLimitExceededRecordIds": { "additionalProperties": false, "description": "Represents the error response returned when the **ids** array exceeds the allowed maximum of 100 record IDs per request.", "properties": { "code": { "description": "Represents the error code. The value is **LIMIT_EXCEEDED**.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the limit value and the fields that caused the limit violation.", "properties": { "limit": { "description": "Represents the maximum allowed count for the **ids** array.", "format": "int32", "type": "integer" }, "limit_due_to": { "description": "Represents the list of fields responsible for the limit violation.", "items": { "additionalProperties": false, "description": "Represents a field that contributed to the limit violation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the limit violation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the limit violation.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "limit", "limit_due_to" ], "type": "object" }, "message": { "description": "Represents the error message describing the limit violation.", "enum": [ "Limit Exceeded, You cannot give more than 100 record ids" ], "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseLimitExceededRecordIds" }, "ErrorResponseModuleNotSupported": { "additionalProperties": false, "description": "Error response for a module that is valid but unsupported in Assignment Rule processes.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**NOT_SUPPORTED** - Represents not supported.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "param_name": { "description": "Represents the param name returned for the Assignment Rule operation.\nPossible values:\n**module** - Represents module. ", "enum": [ "module" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message returned when the specified module does not support Assignment Rules.\nPossible values:\n**Module not supported in assignment rules** - Indicates that Assignment Rules are not supported for the specified module.", "enum": [ "Module not supported in assignment rules" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Module Not Supported Error Response", "type": "object", "x-zs-$id": "ErrorResponseModuleNotSupported" }, "ErrorResponseNoPermissionToAccessAPI": { "additionalProperties": false, "description": "If current user does not have permission to access API.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**NO_PERMISSION** - Represents no permission.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "permissions": { "description": "Represents the list of required permissions. ", "items": { "description": "Represents each permissions entry returned for the Assignment Rule operation. Possible values: **Crm_Implied_Api_Access** - Represents crm implied API access.", "enum": [ "Crm_Implied_Api_Access" ], "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.\nPossible values:\n**permission denied** - Represents permission denied.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "No Permission To Access API Error Response", "type": "object", "x-zs-$id": "ErrorResponseNoPermissionToAccessAPI" }, "ErrorResponseNoPermissionToManageAR": { "additionalProperties": false, "description": "If current user does not have permission to manage Assignment Rules of given module.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**NO_PERMISSION** - Represents no permission.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "permissions": { "description": "Represents the list of required permissions. ", "items": { "description": "Represents each permissions entry returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message for insufficient permission to manage Assignment Rules for the specified module.\nPossible values:\n**User does not have sufficient permission to manage assignment rules of given module** - Indicates that the user lacks the required Assignment Rule management permission for the module.", "enum": [ "User does not have sufficient permission to manage assignment rules of given module" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "No Permission To Manage AR Error Response", "type": "object", "x-zs-$id": "ErrorResponseNoPermissionToManageAR" }, "ErrorResponseNoPermissionToManageAROfPrivateModule": { "additionalProperties": false, "description": "If current user is neither the org admin nor the admin of the given private module.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**NO_PERMISSION** - Represents no permission.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": {}, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.\nPossible values:\n**User is neither the org admin nor the admin of the given private module** - Represents user is neither the org admin nor the admin of the given private module.", "enum": [ "User is neither the org admin nor the admin of the given private module" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "No Permission To Manage AR Of Private Module Error Response", "type": "object", "x-zs-$id": "ErrorResponseNoPermissionToManageAROfPrivateModule" }, "ErrorResponseRequiredParamMissing": { "additionalProperties": false, "description": "Required param missing.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**REQUIRED_PARAM_MISSING** - Represents required param missing.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "param_name": { "description": "Represents the param name returned for the Assignment Rule operation.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.\nPossible values:\n**One of the expected param is missing** - Represents one of the expected param is missing.", "enum": [ "One of the expected param is missing" ], "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**error** - Represents error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error response - Required param missing", "type": "object", "x-zs-$id": "ErrorResponseRequiredParamMissing" }, "ErrorResponseTagIdNotFound": { "additionalProperties": false, "description": "Error indicating that the specified tag ID was not found.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The field name that caused the error", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Error message", "enum": [ "tags not found" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ErrorResponseTagIdNotFound" }, "ErrorResponseWithCadenceAsHead": { "additionalProperties": false, "description": "Represents an error response where the Cadence object serves as the top-level container for field-level errors.", "properties": { "cadences": { "description": "Represents the list of Cadences, each containing field-level error details for the corresponding request entry.", "items": { "$ref": "#/components/schemas/AllErrorResponse" }, "maxItems": 300, "type": "array" } }, "type": "object", "x-zs-$id": "ErrorResponseWithCadenceAsHead" }, "ExecuteAfterNested": { "additionalProperties": false, "description": "Represents the execution delay configuration for a follow-up action, specifying the period unit and numeric value.", "properties": { "period": { "description": "Represents the time unit for the follow-up execution delay.\nPossible values:\nminutes - Execution delay in minutes.\nhours - Execution delay in hours.\nbusiness_hours - Execution delay in business hours.\ndays - Execution delay in days.\nbusiness_days - Execution delay in business days.\nmonths - Execution delay in months.", "enum": [ "minutes", "hours", "business_hours", "days", "business_days", "months" ], "type": "string" }, "unit": { "description": "Represents the numeric value of the execution delay, expressed in the specified period unit.", "format": "int32", "maximum": 99, "minimum": 1, "type": "integer" } }, "required": [ "period", "unit" ], "type": "object" }, "ExecuteEvery": { "additionalProperties": false, "description": "Represents the recurring execution interval for a Cadence, specifying the frequency period and numeric value.", "properties": { "period": { "description": "Represents the frequency interval for recurring Cadence execution.\nPossible values:\nimmediately - Execute immediately after each enrollment trigger.\nhours - Execute at the specified number of hours interval.\ndays - Execute at the specified number of days interval.\nweeks - Execute at the specified number of weeks interval.", "enum": [ "immediately", "hours", "days", "weeks" ], "type": "string" }, "unit": { "description": "Represents the numeric value of the execution interval, expressed in the specified period unit.", "format": "int32", "maximum": 99, "minimum": 1, "type": "integer" } }, "required": [ "period" ], "type": [ "object", "null" ] }, "ExecuteWhenNestedSchema": { "anyOf": [ { "$ref": "#/components/schemas/ExecuteWhenT1Simple" }, { "$ref": "#/components/schemas/ExecuteWhenT2FieldUpdate" }, { "$ref": "#/components/schemas/ExecuteWhenT3SectionUpdate" }, { "$ref": "#/components/schemas/ExecuteWhenT4DateBased" }, { "$ref": "#/components/schemas/ExecuteWhenT5TimeOffset" }, { "$ref": "#/components/schemas/ExecuteWhenT6ScoreUpdate" }, { "$ref": "#/components/schemas/ExecuteWhenT7EmailRepliedWithin" } ], "description": "Represents the trigger configuration that defines when the workflow rule fires, including the trigger type and its associated details.", "discriminator": { "mapping": { "activate": "#/components/schemas/ExecuteWhenT1Simple", "anyaction": "#/components/schemas/ExecuteWhenT1Simple", "cancel": "#/components/schemas/ExecuteWhenT1Simple", "create": "#/components/schemas/ExecuteWhenT1Simple", "create_or_edit": "#/components/schemas/ExecuteWhenT1Simple", "date_or_datetime": "#/components/schemas/ExecuteWhenT4DateBased", "deactivate": "#/components/schemas/ExecuteWhenT1Simple", "delete": "#/components/schemas/ExecuteWhenT1Simple", "edit": "#/components/schemas/ExecuteWhenT1Simple", "email_received": "#/components/schemas/ExecuteWhenT1Simple", "email_received_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "email_received_opened_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "fb_comment_on_page": "#/components/schemas/ExecuteWhenT1Simple", "fb_like_on_post": "#/components/schemas/ExecuteWhenT1Simple", "fb_post_on_page": "#/components/schemas/ExecuteWhenT1Simple", "fb_send_message": "#/components/schemas/ExecuteWhenT1Simple", "field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "incoming_call_createedit": "#/components/schemas/ExecuteWhenT1Simple", "incoming_call_edit": "#/components/schemas/ExecuteWhenT1Simple", "incoming_call_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "incoming_call_ring": "#/components/schemas/ExecuteWhenT1Simple", "incoming_call_section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "incoming_call_start": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_bounced": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_clicked": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_notopened": "#/components/schemas/ExecuteWhenT5TimeOffset", "mail_sent_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "mail_sent_opened": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_opened_notreplied": "#/components/schemas/ExecuteWhenT5TimeOffset", "mail_sent_replied": "#/components/schemas/ExecuteWhenT1Simple", "mail_sent_replied_within": "#/components/schemas/ExecuteWhenT7EmailRepliedWithin", "marked_as_complete": "#/components/schemas/ExecuteWhenT1Simple", "missed_call": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_createedit": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_edit": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "outgoing_call_ring": "#/components/schemas/ExecuteWhenT1Simple", "outgoing_call_section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "outgoing_call_start": "#/components/schemas/ExecuteWhenT1Simple", "overdue": "#/components/schemas/ExecuteWhenT5TimeOffset", "reassign": "#/components/schemas/ExecuteWhenT1Simple", "recommendation_rebuy": "#/components/schemas/ExecuteWhenT5TimeOffset", "reschedule": "#/components/schemas/ExecuteWhenT1Simple", "rollup_summary_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "scheduled_call_createedit": "#/components/schemas/ExecuteWhenT1Simple", "scheduled_call_edit": "#/components/schemas/ExecuteWhenT1Simple", "scheduled_call_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "scheduled_call_section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "score_decrease": "#/components/schemas/ExecuteWhenT6ScoreUpdate", "score_increase": "#/components/schemas/ExecuteWhenT6ScoreUpdate", "score_update": "#/components/schemas/ExecuteWhenT6ScoreUpdate", "section_update": "#/components/schemas/ExecuteWhenT3SectionUpdate", "stage_automation_field_update": "#/components/schemas/ExecuteWhenT2FieldUpdate", "tw_comment_on_tweet": "#/components/schemas/ExecuteWhenT1Simple", "tw_mention_on": "#/components/schemas/ExecuteWhenT1Simple", "tw_retweet_on_tweet": "#/components/schemas/ExecuteWhenT1Simple", "tw_send_message": "#/components/schemas/ExecuteWhenT1Simple", "voc_incoming_signal": "#/components/schemas/ExecuteWhenT1Simple", "zia_scoring_rule": "#/components/schemas/ExecuteWhenT6ScoreUpdate" }, "propertyName": "type" }, "x-zs-llm-description": "Trigger configuration discriminator (oneOf). The type field selects the trigger template - route to the matching schema: T1 (simple lifecycle/event types), T2 (field_update), T3 (section_update), T4 (date_or_datetime), T5 (time offset), T6 (score_update), T7 (mail_sent_replied_within). Not all triggers work on all modules - validate with getWorkflowConfigurations first." }, "ExecuteWhenT1Simple": { "additionalProperties": false, "description": "Represents a simple trigger type (T1) that fires on record creation, editing, deletion, or when specific CRM events occur, with optional repeat and cross-module support.", "properties": { "details": { "additionalProperties": false, "description": "Represents the optional trigger configuration details, including **repeat** (Boolean) and **trigger_module** (object) for cross-module triggers.", "properties": { "repeat": { "description": "Indicates whether the rule fires every time the trigger condition is met. When false, the rule fires only on the first occurrence.", "type": "boolean" }, "trigger_module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module, such as a rule on Leads triggered by a note creation event, which requires the trigger module to reference the Notes module. To discover module API names and identifiers, retrieve the available modules from the system." } }, "type": "object" }, "type": { "description": "Represents the trigger API name that activates the workflow rule. Supported values vary by module; use the getWorkflowConfigurations endpoint to retrieve supported triggers for the target module.", "enum": [ "create", "edit", "create_or_edit", "delete", "cancel", "reschedule", "reassign", "anyaction", "deactivate", "activate", "marked_as_complete", "incoming_call_ring", "incoming_call_start", "incoming_call_createedit", "incoming_call_edit", "outgoing_call_ring", "outgoing_call_start", "outgoing_call_edit", "outgoing_call_createedit", "missed_call", "scheduled_call_createedit", "scheduled_call_edit", "email_received", "mail_sent", "mail_sent_clicked", "mail_sent_replied", "mail_sent_opened", "mail_sent_bounced", "fb_post_on_page", "fb_comment_on_page", "fb_like_on_post", "fb_send_message", "tw_mention_on", "tw_retweet_on_tweet", "tw_comment_on_tweet", "tw_send_message", "voc_incoming_signal" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "ExecuteWhenT1Simple", "x-zs-llm-description": "Simple trigger template for record lifecycle and event types: create, edit, create_or_edit, delete, cancel, and module-specific variants (email_received, missed_call, mail_sent_*, fb_*, tw_*). Only requires details.repeat (bool). Email/call/social triggers require their dedicated module with relational_criteria linking to target module. Validate availability via getWorkflowConfigurations." }, "ExecuteWhenT2FieldUpdate": { "additionalProperties": false, "description": "Represents a field update trigger type that fires when a specified field value on a record changes according to defined criteria.", "properties": { "details": { "additionalProperties": false, "description": "Represents the field update trigger details, including the criteria that define which field value change activates the rule.", "properties": { "criteria": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowSimpleFilterCriterion" }, { "$ref": "#/components/schemas/WorkflowGroupedFilterCriterion" } ], "description": "Represents the field value change criteria that activate the trigger. Defines which field is monitored and what change condition fires the rule." }, "match_all": { "description": "Controls the logic applied across criteria groups.\nPossible values:\ntrue - All criteria groups must match (AND logic).\nfalse - Any one criteria group is sufficient (OR logic).", "type": "boolean" }, "repeat": { "description": "Indicates whether the rule fires every time the field update condition is met. When false, the rule fires only on the first occurrence.", "type": "boolean" }, "trigger_module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values." } }, "required": [ "criteria" ], "type": "object" }, "type": { "description": "Represents the trigger type for field update rules. Availability varies by the target module.", "enum": [ "field_update", "incoming_call_field_update", "outgoing_call_field_update", "scheduled_call_field_update", "stage_automation_field_update", "rollup_summary_update" ], "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ExecuteWhenT2FieldUpdate", "x-zs-llm-description": "Field update trigger. Fires when a specific field value\nchanges. The monitored field is defined inside\ndetails.criteria.field - not at top level. Set details.criteria.value\nto '${ANYVALUE}' to fire on any change regardless of new value.\nCall-prefixed variants require the Calls module. details.repeat controls\nre-execution on subsequent edits. details.match_all controls\nmulti-criteria evaluation.\n" }, "ExecuteWhenT3SectionUpdate": { "additionalProperties": false, "description": "Represents the trigger type for section update rules. Availability varies by the target module\n", "properties": { "details": { "additionalProperties": false, "description": "Represents the section update trigger details, including the layout section IDs to monitor.", "properties": { "repeat": { "description": "Indicates whether the rule fires every time a section update\ncondition is met. When false, the rule fires only on the first\noccurrence.\n", "type": "boolean" }, "section_ids": { "description": "Represents the array of layout section IDs to monitor for updates. Each ID must correspond to a valid section ID for the target module.", "items": { "description": "Represents the unique ID of a layout section to monitor.", "format": "int64", "type": "string" }, "maxItems": 10, "minItems": 1, "type": "array" }, "trigger_module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "Optional. The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values." } }, "required": [ "section_ids" ], "type": "object" }, "type": { "description": "Represents the trigger type for section update rules. Use getWorkflowConfigurations to verify the trigger is available for the target module.", "enum": [ "section_update", "incoming_call_section_update", "outgoing_call_section_update", "scheduled_call_section_update" ], "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ExecuteWhenT3SectionUpdate", "x-zs-llm-description": "Section update trigger. Fires when any field within specific layout sections is modified. Required: details.sections (array of section objects). Call-prefixed variants require the Calls module. Validate available sections via getLayouts for the module." }, "ExecuteWhenT4DateBased": { "additionalProperties": false, "description": "Represents the date or datetime field to monitor for triggering the rule. Must reference an existing date or datetime field on the module.\n", "properties": { "details": { "additionalProperties": false, "description": "Represents the date-based trigger details, including the target date field, time offset, and recurrence configuration.", "properties": { "execute_at": { "description": "Represents the exact time of day at which to fire the trigger, in 24-hour HH:mm format. Applicable only to datetime fields.", "format": "time", "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the date or datetime field to monitor for triggering the rule. Use the getFields endpoint to discover available date and datetime fields.", "properties": { "api_name": { "description": "Represents the API name of the date or datetime field, such as **Created_Time**, **Modified_Time**, or a custom field API name.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the date or datetime field.", "maxLength": 20, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "period": { "description": "Represents the time unit for the offset relative to the monitored date field. For example, **days**, **weeks**, or **months**.", "enum": [ "minutes", "hours", "days", "weeks", "months", "years", "b_hours", "b_days" ], "type": "string" }, "recur_cycle": { "description": "Represents the recurrence frequency for the date-based trigger.\nPossible values:\nonce - Fires once.\nmonthly - Fires monthly on the same date.\nyearly - Fires yearly on the same date.", "enum": [ "once", "monthly", "yearly" ], "type": "string" }, "repeat": { "description": "Indicates whether the trigger fires repeatedly. When true, the trigger fires on each recurrence as configured.", "type": "boolean" }, "trigger_module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "Specifies the module that triggers the workflow rule. If omitted,\nit defaults to the rule's top-level module. Specify this when the trigger\ntargets a different module. For example, a workflow rule on Leads triggered\nwhen a note is created requires 'trigger_module': {\"api_name\": \"Notes\",\n'id': '...'}. Use 'getModules' to retrieve the module API name and ID.\n" }, "unit": { "description": "Represents the offset magnitude relative to the monitored date field value. Negative values indicate before the date; positive values indicate after.", "format": "int32", "type": "integer" } }, "required": [ "field", "period", "unit" ], "type": "object" }, "type": { "description": "Represents the trigger type for date or datetime-based rules, which fire relative to a date field value on the record.", "enum": [ "date_or_datetime" ], "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ExecuteWhenT4DateBased", "x-zs-llm-description": "Date-based trigger. Fires relative to a date/datetime field value (before or after). Required: details.field ({api_name, id} - must be date/datetime type), details.period ('days'|'hours'), details.sign ('negative' for before, 'positive' for after), details.unit (integer - number of days/hours). Broadly available across modules." }, "ExecuteWhenT5TimeOffset": { "additionalProperties": false, "description": "Represents the trigger type for time-offset rules. Availability varies by the target module.\n", "properties": { "details": { "additionalProperties": false, "description": "Represents the time offset trigger details, including the time unit and magnitude for the offset.", "properties": { "field": { "additionalProperties": false, "description": "Represents the field reference returned in GET responses for time-offset triggers, including the trigger field details.", "properties": { "id": { "description": "Represents the field identifier for the time-offset trigger. Returns **-1** when the field is system-determined.", "maxLength": 20, "type": "string" } }, "type": "object" }, "period": { "description": "Represents the time unit for the offset.\nPossible values:\ndays - Offset in days.\nhours - Offset in hours.", "enum": [ "days", "hours" ], "type": "string" }, "trigger_module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module that actually triggers the rule. Defaults to\nthe rule's top-level module if omitted. Must be explicitly set\nwhen the trigger targets a different module - e.g., a rule on\nLeads triggered by 'note created' requires trigger_module =\n{api_name: 'Notes', id: '...'}. Use `getModules` to discover\nmodule api_name and id values.\n" }, "unit": { "description": "Represents the time offset magnitude. Always a positive integer for time-offset triggers, such as 1 for one day or 3 for three hours.", "format": "int32", "type": "integer" } }, "required": [ "period", "unit" ], "type": "object" }, "type": { "description": "Represents the trigger type for time-offset rules. Use getWorkflowConfigurations to verify the trigger is available for the target module.", "enum": [ "overdue", "email_received_notreplied", "email_received_opened_notreplied", "mail_sent_opened_notreplied", "mail_sent_notreplied", "mail_sent_notopened", "recommendation_rebuy" ], "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ExecuteWhenT5TimeOffset", "x-zs-llm-description": "Time offset trigger. Fires after a specified delay from an event. Required: details.period ('days'|'hours'), details.unit (integer). Module-specific triggers: email time-offset types (email_received_notreplied, mail_sent_notopened) require a dedicated email module with relational_criteria. 'overdue' requires an activity module. Does not support repeat.\n" }, "ExecuteWhenT6ScoreUpdate": { "additionalProperties": false, "description": "Represents a score update trigger type (T6) that fires when a record score changes due to configured scoring rules.", "properties": { "details": { "additionalProperties": false, "description": "Represents the score update trigger details, including the Scoring Rule scope and the applicable scoring rules.", "properties": { "repeat": { "description": "Indicates whether the rule fires every time the score condition is met. When false, the rule fires only on the first occurrence.", "type": "boolean" }, "rules": { "description": "Represents the array of Scoring Rule references to monitor. Required when **type** is set to **Selective_Rules**.", "items": { "additionalProperties": false, "description": "Represents a single Scoring Rule reference. Must include the Scoring Rule ID for POST and PUT requests. The name field is read-only and returned in GET responses.", "properties": { "id": { "description": "Represents the unique ID of the Scoring Rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the Scoring Rule. This field is read-only and returned in GET responses.", "maxLength": 255, "readOnly": true, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 50, "minItems": 1, "type": "array" }, "trigger_module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module, such as a rule on Leads triggered by a note creation event, which requires the trigger module to reference the Notes module. To discover module API names and identifiers, retrieve the available modules from the system." }, "type": { "description": "Represents the trigger type for scoring rules. Supports score increase and score decrease trigger events.", "enum": [ "All_Rules", "Selective_Rules" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": { "description": "Represents the trigger type for scoring rules. Supports score increase and score decrease trigger events.", "enum": [ "score_increase", "score_decrease", "score_update", "zia_scoring_rule" ], "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ExecuteWhenT6ScoreUpdate", "x-zs-llm-description": "Score update trigger. Fires when a record's score changes based on scoring rules. Required: details.type ('All_Rules' for any scoring rule, 'Selective_Rules' for specific ones). For Selective_Rules also requires details.scoring_rules array with rule IDs. Trigger types: score_increase, score_decrease, score_update, zia_scoring_rule." }, "ExecuteWhenT7EmailRepliedWithin": { "additionalProperties": false, "description": "Represents an email-reply-window trigger type (T7) that fires when a sent email receives a reply within a configured time window.", "properties": { "details": { "additionalProperties": false, "description": "Represents the email-reply-window trigger details, including the time unit and magnitude for the reply window.", "properties": { "period": { "description": "Represents the time unit for the reply window.\nPossible values:\ndays - Window measured in days.\nhours - Window measured in hours.", "enum": [ "days", "hours" ], "type": "string" }, "trigger_module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module that actually triggers the rule. Defaults to the rule's top-level module if omitted. Must be explicitly set when the trigger targets a different module - e.g., a rule on Leads triggered by 'note created' requires trigger_module = {api_name: 'Notes', id: '...'}. Use `getModules` to discover module api_name and id values." }, "unit": { "description": "Represents the reply window magnitude, such as 3 for a window of three days or three hours.", "format": "int32", "type": "integer" } }, "required": [ "period", "unit" ], "type": "object" }, "type": { "description": "Represents the trigger type for email-reply-window rules. Requires a dedicated email module workflow rule.", "enum": [ "mail_sent_replied_within" ], "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ExecuteWhenT7EmailRepliedWithin", "x-zs-llm-description": "Email replied-within trigger. Fires when a sent email\nreceives a reply within a time window.Required-details.period ('days'|'hours'), details.unit (integer). Only type: mail_sent_replied_within. Typically requires a dedicated email module with relational_criteria. Does not support repeat.\n" }, "ExecutionTimeFieldMapping": { "additionalProperties": false, "description": "Represents an execution_time-type field mapping that computes a date, datetime, or ALARM value at runtime by applying a signed offset to a trigger field or the current time. The value carries an ExecutionTimeValue object specifying the period, unit, trigger_field, and optional time or notify_type properties. A plus sign places the result after the trigger; a minus sign places it before. ALARM fields always require minus. Workflow task actions support only days and business_days as period values.", "properties": { "display_value": { "description": "The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests.", "maxLength": 500, "type": "string" }, "field": { "$ref": "#/components/schemas/AutomationFieldAttributes", "description": "Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING." }, "type": { "const": "execution_time", "description": "Identifies the mapping variant as an execution-time offset. The value is always \"execution_time\" for this schema and acts as the polymorphic discriminator across the AutomationFieldMappings union.", "type": "string" }, "value": { "$ref": "#/components/schemas/ExecutionTimeValue", "description": "Execution-time object specifying how to compute the date/datetime offset from a reference field." } }, "required": [ "field", "type", "value" ], "title": "Execution Time Field Mapping", "type": "object", "x-zs-$id": "ExecutionTimeFieldMapping", "x-zs-llm-description": "type='execution_time' mapping. REQUIRED for Date, DateTime, and ALARM field types (static/merge_field on these returns DEPENDENT_MISMATCH). Computes value as offset from trigger_field. Value object needs: period ('days'|'hours'|'minutes'), unit (integer as string), trigger_field (merge token or ${CURRENTTIME}), sign (for before/after offset)." }, "ExecutionTimeValue": { "additionalProperties": false, "description": "Represents the offset configuration used by an execution_time mapping to compute a final date, datetime, or ALARM value at runtime. Contains period (the time unit granularity), unit (the numeric magnitude expressed as a string integer), and trigger_field (a merge token or ${CURRENTTIME}). Date fields use period, unit, and trigger_field with an implied positive direction. Datetime fields additionally accept sign to control direction. ALARM fields additionally accept time and notify_type, and always require a minus sign. Workflow task actions restrict period to days or business_days.", "properties": { "notify_type": { "description": "The notification channel used to deliver the reminder. Applies exclusively when the target field carries data type ALARM (i.e., Remind_At); date and datetime fields do not use this property. Possible values:\n**popup** — triggers an in-app notification.\n**email** — sends a message to the task owner.\n**emailandpopup** — delivers both simultaneously.", "enum": [ "popup", "email", "emailandpopup" ], "type": "string" }, "period": { "description": "The calendar or time unit applied to the offset. Possible values:\n**days** — counts all calendar days including weekends and holidays; supported by every action type.\n**business_days** — excludes weekends and requires the organisation's business-day setting to be enabled; supported by all action types.\n**hours** — available only for create_record, add_meeting, and schedule_call.\n**minutes** — available only for create_record, add_meeting, and schedule_call.\nworkflow_tasks accept only **days** or **business_days**.", "enum": [ "days", "business_days", "hours", "minutes" ], "type": "string" }, "sign": { "default": "plus", "description": "The direction of the offset relative to the trigger date. Possible values:\n**plus** — places the computed value after the trigger (for example, a due date two days after record creation).\n**minus** — places the computed value before the trigger (for example, a reminder one day before the due date).\nFor datetime fields (data_type=datetime) a value is expected; omitting it returns a DEPENDENT_FIELD_MISSING error. For date-only fields (data_type=date) the value defaults to **plus** when absent. When targeting Remind_At (data_type=ALARM), **minus** is the only applicable direction.", "enum": [ "plus", "minus" ], "type": "string" }, "time": { "description": "The time-of-day component of the computed value, expressed in 24-hour HH:mm format (for example, \"13:00\", \"01:30\"). Applies when the target field carries data type datetime or ALARM (as reported by GET /settings/fields). Supplying this property for a date-only field (data_type=date) produces a validation error.", "example": "13:00", "maxLength": 20, "type": "string" }, "trigger_field": { "description": "The reference date or datetime field from which the offset is measured. Accepts a merge-field token that resolves to a Date or DateTime field on the parent module (for example, \"${!Leads.Modified_Time}\", \"${!Tasks.Due_Date}\"), or the reserved constant \"${CURRENTTIME}\" to use the automation execution timestamp. When computing a Remind_At (ALARM) value, \"${!Tasks.Due_Date}\" is the typical anchor.", "example": "${CURRENTTIME}", "maxLength": 255, "type": "string" }, "unit": { "description": "The number of period units to offset from the trigger date, supplied as a non-negative integer string (for example, \"1\", \"30\"). Passing \"0\" produces a same-day result, such as scheduling a Remind_At on the same day as the due date.", "example": "1", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "period", "unit", "trigger_field" ], "title": "Execution Time Value", "type": "object", "x-zs-$id": "ExecutionTimeValue", "x-zs-llm-description": "Offset computation object for date/datetime/ALARM fields. Required fields: period ('days'|'hours'|'minutes'), unit (string integer quantity), trigger_field (merge-field token like ${!Leads.Created_Time} or ${CURRENTTIME}). Optional: sign ('positive' for after, 'negative' for before default varies by context). Missing required fields return DEPENDENT_FIELD_MISSING." }, "ExpectedDependentFieldMissingDetails": { "additionalProperties": false, "description": "Represents error details when expected dependent fields are missing from the request.", "properties": { "dependee": { "additionalProperties": false, "description": "Represents the expected dependent field that is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the expected dependent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the expected dependent field.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "expected_fields": { "description": "Represents the list of expected fields that are missing from the request.", "items": { "additionalProperties": false, "description": "Represents a missing expected field, identified by its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the missing expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing expected field.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "dependee", "expected_fields" ], "type": "object", "x-zs-$id": "ExpectedDependentFieldMissingDetails" }, "ExpectedFieldMissingDetails": { "additionalProperties": false, "description": "Represents error details when expected fields are missing from the request.", "properties": { "expected_fields": { "description": "Represents the list of expected fields that are missing from the request.", "items": { "additionalProperties": false, "description": "Represents a missing expected field, identified by its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the missing expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing expected field.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "expected_fields" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingDetails" }, "ExpectedFieldMissingErrorSingle": { "additionalProperties": false, "description": "Error response for missing expected fields in single record operations", "properties": { "data": { "description": "Array of error results for single record", "items": { "additionalProperties": false, "description": "Error details for missing expected fields", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "expected_fields": { "description": "List of expected fields that are missing", "items": { "additionalProperties": false, "description": "Expected field details", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the expected field", "maxLength": 500, "type": "string" } }, "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingErrorSingle" }, "ExpectedFieldMissingSchema": { "additionalProperties": false, "description": "Represents the error response returned when required fields such as the module API name and ID are missing from the request.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "expected_fields": { "description": "Represents the **expected_fields** value from the error detail object.", "items": { "additionalProperties": false, "description": "Represents the **items** value from the error detail object.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Specify atleast one field", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleExpectedFieldMissingErrorResponses", "x-zs-llm-description": "Error code: EXPECTED_FIELD_MISSING. Returned when a required identifier object (module, field) is provided but missing its expected keys. Typically: module object present but both api_name and id are absent. Fix: provide at least one identifier (api_name or id) in the reference object." }, "ExpectedParamMissingError": { "additionalProperties": false, "description": "Represents an error response when at least one of the expected request parameters is absent.", "properties": { "code": { "description": "Represents the error code for the failed operation. ", "enum": [ "EXPECTED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details listing the expected parameters, at least one of which must be provided.", "properties": { "param_names": { "description": "Represents the list of expected parameter names, at least one of which must be included in the request.", "items": { "description": "Represents the name of an expected request parameter.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "param_names" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the error response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Expected Param Missing Error", "type": "object", "x-zs-$id": "ExpectedParamMissingError" }, "ExpiredValueError": { "additionalProperties": false, "description": "Error response when a token or value has expired", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "EXPIRED_VALUE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the expired value", "properties": { "param_name": { "description": "Name of the parameter with expired value", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ExpiredValueError" }, "ExpiredValueGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a expired value GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "EXPIRED_VALUE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ExpiredValueGETError" }, "FailureEntityDetails": { "additionalProperties": false, "description": "Represents the details of the CRM record whose automation event triggered a failed webhook execution.", "properties": { "id": { "description": "Represents the unique identifier of the CRM record that triggered the webhook execution failure.", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/AutomationModuleDetailsResponse", "description": "API name of the CRM module the triggering record belongs to." }, "name": { "description": "Represents the display name of the CRM record that triggered the webhook execution failure.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-llm-description": "Details of the CRM record whose event triggered a failed webhook execution, including module and record identification." }, "FailureSchema": { "additionalProperties": false, "description": "Represents a generic failure response returned when an unexpected error occurs during workflow rule creation or update.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "FAILURE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details providing additional context about the failure.", "properties": { "message": { "description": "Represents the internal error message describing the failure.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "workflow creation Failed", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleFailureErrorResponse", "x-zs-llm-description": "Error code: FAILURE. Generic backend failure during rule creation or update. Not caused by invalid input - indicates an unexpected server-side error. Resolution: retry the request. If persistent, the rule configuration may be triggering an edge case - simplify and retry incrementally." }, "FeatureDisabledSchema": { "additionalProperties": false, "description": "Represents the error response returned when a feature required by the workflow rule configuration is currently disabled in the organization.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "FEATURE_DISABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the reason the feature is disabled.", "properties": { "message": { "description": "Represents the reason the feature is disabled.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "CANNOT_UPDATE", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleFeatureDisabledErrorResponse", "x-zs-llm-description": "Error code: FEATURE_DISABLED. Returned when the feature required by the workflow rule is turned off at the org level (e.g., VoC disabled, social integrations disabled). Resolution: enable the feature in CRM settings or remove the action that requires it." }, "FeatureNoPermissionError": { "additionalProperties": false, "description": "Indicates that the user does not have the necessary permissions to create a field update action.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field associated with the permission error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field in the request body", "maxLength": 1000, "type": "string" }, "permissions": { "description": "Permission that the current user is missing", "items": { "description": "One permission the current user is missing.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "feature not available in this edition", "User not allowed to create action of this feature type", "permission denied to access the api" ], "type": "string" }, "status": { "description": "Represents the error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Feature No Permission Error", "type": "object", "x-zs-$id": "FeatureNoPermissionError", "x-zs-llm-description": "The user lacks permission to create/manage field update actions. Check profile settings." }, "FeatureNotEnableOrNotSupported": { "additionalProperties": false, "description": "Error envelope returned when the data enrichment feature is either disabled for the organization or not available under the current CRM edition.", "properties": { "code": { "description": "Identifies the feature-availability failure that was raised.\n\nPossible values:\n**FEATURE_NOT_ENABLED** - The data enrichment feature has not been enabled for the organization.\n**FEATURE_NOT_SUPPORTED** - The current CRM edition does not support the data enrichment feature.", "enum": [ "FEATURE_NOT_ENABLED", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the feature-availability failure. This object remains empty for this error.", "properties": {}, "type": "object" }, "message": { "description": "Data enrichment is not available for your edition of CRM.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because the data enrichment feature is unavailable.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FeatureNotEnableOrNotSupported" }, "FeatureNotSupportedErrorResponse": { "additionalProperties": false, "description": "Returned when the requested feature is not supported by the current license. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": {}, "type": "object" }, "message": { "description": "Error message", "enum": [ "Your License does not support this feature" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Feature Not Supported Error Response", "type": "object", "x-zs-$id": "FeatureNotSupportedErrorResponse" }, "FetchAssociatedPlacesResponse": { "additionalProperties": false, "description": "Response containing the list of places where unsubscribe links are currently associated in the Zoho CRM organization.", "properties": { "associations": { "description": "Array of association records showing where unsubscribe links are being used", "items": { "$ref": "#/components/schemas/UnsubscribeLinkAssociationRecord" }, "maxItems": 1, "type": "array" } }, "required": [ "associations" ], "title": "Fetch Associated Places Response", "type": "object", "x-zs-$id": "FetchAssociatedPlacesResponse" }, "FieldApiAmbiguityError": { "additionalProperties": false, "description": "Returned when the provided field ID and field API name do not refer to the same CRM field.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "ambiguity_due_to": { "description": "Field references whose id and api_name values do not match, causing the ambiguity.", "items": { "additionalProperties": false, "description": "One field reference whose id and api_name values conflict.", "properties": { "api_name": { "description": "API name of the conflicting field reference.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the conflicting field reference.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "The field api name seems to be invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Field Api Ambiguity Error", "type": "object", "x-zs-$id": "FieldApiAmbiguityError", "x-zs-llm-description": "The field ID and field api_name point to different CRM fields. Supply only one identifier or ensure both refer to the same field." }, "FieldComparatorMismatch": { "additionalProperties": false, "description": "Error schema returned when the comparator value supplied for a criterion field does not match the valid comparator values determined by its dependee field. Contains the error code DEPENDENT_MISMATCH and a details object identifying the criterion field, its dependee field, and the list of supported comparator values.", "properties": { "code": { "description": "Error code identifying the type of field comparator mismatch condition. Possible values: DEPENDENT_MISMATCH.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Detailed information about the field comparator mismatch, including the API name and JSON path of the criterion field in error, the dependee field that governs valid comparator values, and the array of supported comparator values.", "properties": { "api_name": { "description": "Represents the API name of the criterion field whose comparator value does not match any of the supported values determined by the dependee field.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The dependee field whose value determines which comparator values are valid for the criterion field that raised the DEPENDENT_MISMATCH error. Contains the API name and JSON path of the dependee field.", "properties": { "api_name": { "description": "API name of the dependee field that determines the valid comparator values for the criterion field in error.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path locating the dependee field within the request body.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path locating the criterion field whose comparator value does not match any of the supported values determined by the dependee field.", "maxLength": 512, "type": "string" }, "supported_values": { "description": "Contains the comparator values that are valid for the criterion field, as determined by the dependee field.", "items": { "description": "Represents one supported comparator value valid for the criterion field, as determined by the dependee field.", "maxLength": 256, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "dependee", "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message describing the comparator mismatch condition for the criterion field.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status of the error response. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FieldComparatorMismatch" }, "FieldComparatorValueMissing": { "additionalProperties": false, "description": "Represents the error response returned when a criterion comparator cannot be applied because the comparator value supplied by the dependee field is absent. Carries error code DEPENDENT_FIELD_MISSING along with details identifying both the field in error and the dependee field whose value is missing.", "properties": { "code": { "description": "Represents the error code that identifies the category of failure for this error response.\nPossible values:\nDEPENDENT_FIELD_MISSING - Indicates that the comparator value required from the dependee criterion field is absent, preventing the comparator from being evaluated.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains detailed information about the criterion field that caused the error and the dependee field whose comparator value is missing, including the API name and JSON path for each.", "properties": { "api_name": { "description": "API name of the criterion field that triggered the DEPENDENT_FIELD_MISSING error.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee criterion field — that is, the field whose value determines what the current comparator accepts — and whose missing comparator value triggered this error. Contains the API name and JSON path of that dependee field.", "properties": { "api_name": { "description": "Represents the API name of the dependee criterion field whose comparator value is absent and caused the evaluation failure.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path that locates the dependee criterion field within the request body, identifying where the missing comparator value was expected.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path locating the criterion field in error within the request body.", "maxLength": 512, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message describing the DEPENDENT_FIELD_MISSING condition returned in the response envelope.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the response. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FieldComparatorValueMissing" }, "FieldCreationResult": { "additionalProperties": false, "description": "Represents the result of a single field creation.", "properties": { "code": { "description": "Represents the result code.", "enum": [ "SUCCESS" ], "example": "SUCCESS", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the created field.", "properties": { "id": { "description": "Represents the ID of the created field.", "example": "111112000000067259", "maxLength": 25, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message.", "example": "field created", "maxLength": 225, "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "success" ], "example": "success", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FieldCreationResult" }, "FieldDependencyProcessingSummary": { "additionalProperties": false, "description": "Represents the summary of field dependency impact for the job, including counts of total evaluated, processed, and failed dependencies.", "properties": { "failed": { "description": "Represents the failed field dependencies.", "format": "int32", "type": "integer" }, "processed": { "description": "Represents the processed field dependencies.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the total field dependencies.", "format": "int32", "type": "integer" } }, "required": [ "failed", "processed", "total" ], "title": "Field Dependency Processing Summary", "type": "object" }, "FieldDetails": { "additionalProperties": false, "description": "Identifies the target field to update. Requires both id and api_name; if they refer to different fields, the request fails with AMBIGUITY_DURING_PROCESSING.\n", "properties": { "api_name": { "description": "API name of the CRM field (e.g., Deal_Name, Pipeline, Owner, Layout, Multi_Select_1).", "example": "Pipeline", "maxLength": 255, "type": "string" }, "data_type": { "description": "Data type of the CRM field, for example text, picklist, or lookup.", "example": "text", "maxLength": 255, "type": "string" }, "field_label": { "description": "Display label of the CRM field, as shown in the CRM UI.", "example": "Last_Name", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the CRM field. Mandatory in create/update payloads.", "example": "3361265000000236001", "maxLength": 255, "type": "string" }, "ui_type": { "description": "Internal UI type code for the field. Present only in response; not required in requests.", "format": "int32", "type": "integer" } }, "required": [ "id", "api_name" ], "title": "Field Details", "type": "object", "x-zs-llm-description": "Identifies the field to be updated; both id and api_name are required at call time look them up via GET /settings/fields?module={api_name}. Dependency rules: Pipeline fields need Stage in dependent_fields; Layout fields need Pipeline (with nested Stage); Owner fields need notify and related_records. Supplying a mismatched id and api_name triggers AMBIGUITY_DURING_PROCESSING." }, "FieldLabel": { "description": "Name of the field label.", "example": "custom_field_1", "maxLength": 100, "type": "string" }, "FieldLengthExceededError": { "additionalProperties": false, "description": "Returned when a field value exceeds its maximum allowed length or size constraint.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field that exceeded the limit", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field in the request body", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "The maximum allowed length or size for the field", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data", "The lenght of name has exceeded the limit", "The length of the value exceeded the max limit" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Field Length Exceeded Error", "type": "object", "x-zs-$id": "FieldLengthExceededError", "x-zs-llm-description": "A field value exceeds its maximum allowed length. Shorten the value and retry." }, "FieldMappingForRead": { "description": "Array of field mappings for read operations.", "items": { "additionalProperties": false, "description": "Field mapping item for read operations.", "properties": { "crm_field": { "anyOf": [ { "additionalProperties": false, "description": "CRM field object with ID, API name, and display name.", "properties": { "api_name": { "description": "API name of the CRM field.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the CRM field.", "maxLength": 19, "type": "string" }, "name": { "description": "Display name of the CRM field.", "maxLength": 255, "type": "string" } }, "required": [ "id", "api_name" ], "type": "object", "x-zs-$id": "CrmFieldObjWithName" }, { "description": "Null value for CRM field (no mapping).", "type": "null", "x-zs-$id": "CrmFieldObjWithNameNull" } ], "description": "CRM field object with additional display name." }, "enrich_field": { "additionalProperties": false, "description": "Zia enrichment field metadata with display label.", "properties": { "display_label": { "description": "Display label of the Zia enrichment field.", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the Zia enrichment field.", "maxLength": 255, "type": "string" } }, "required": [ "name", "display_label" ], "type": "object" } }, "required": [ "enrich_field", "crm_field" ], "type": "object" }, "maxItems": 50, "type": "array" }, "FieldMappingForWrite": { "description": "Array of field mappings for write operations.", "items": { "additionalProperties": false, "description": "Field mapping item for write operations.", "properties": { "crm_field": { "anyOf": [ { "additionalProperties": false, "description": "CRM field object with ID and API name.", "properties": { "api_name": { "description": "API name of the CRM field.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the CRM field.", "maxLength": 19, "type": "string" } }, "required": [ "id", "api_name" ], "type": "object", "x-zs-$id": "CrmField" }, { "description": "Null value for CRM field (no mapping).", "type": "null", "x-zs-$id": "CrmFieldNull" } ], "description": "CRM field object. Provide both ID and API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names." }, "enrich_field": { "additionalProperties": false, "description": "Zia enrichment field metadata.", "properties": { "name": { "description": "Name of the Zia enrichment field.", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "enrich_field", "crm_field" ], "type": "object" }, "maxItems": 50, "type": "array" }, "FieldNotAllowedInPortalsError": { "additionalProperties": false, "description": "Returned when the request includes a field that is not supported in client portals. The `details` object specifies the field that caused the error.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Field is not allowed in portals." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FieldNotAllowedInPortalsError" }, "FieldNotSupportedInCriteria": { "additionalProperties": false, "description": "Represents the error response returned when a criterion field type is not supported in filter criteria. Field types such as file upload and image upload cannot be used as filter criteria fields. The error code is INVALID_DATA. The details object identifies the unsupported field via its api_name and json_path.", "properties": { "code": { "description": "Indicates the classification of the error returned by the API.\n\nPossible values:\nINVALID_DATA - The request contains a criterion field whose type is not supported in filter criteria.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains detailed information identifying the unsupported criterion field. The api_name property specifies the API name of the offending field, and the json_path property locates it within the request body.", "properties": { "api_name": { "description": "Specifies the API name of the criterion field whose type is not supported in filter criteria.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Specifies the JSON path that locates the unsupported criterion field within the request body.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Provides a fixed descriptive message identifying the unsupported criterion field.\n\nPossible values:\n\"The given field api_name is not supported in criteria\" - Indicates that the field identified by api_name cannot be used in filter criteria.", "enum": [ "The given field api_name is not supported in criteria" ], "type": "string" }, "status": { "description": "Indicates the outcome status of the API response.\n\nPossible values:\nerror - The request failed because the specified criterion field type is not supported in filter criteria.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FieldNotSupportedInCriteria" }, "FieldPicklistActionJob": { "additionalProperties": false, "allOf": [ { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." }, { "description": "Represents the description for allOf nested." } ], "description": "Represents a scheduled job for a picklist field action (delete, replace, or delete-and-replace), including the job ID, target module, impact details, status, and message.", "properties": { "action": { "description": "Represents the scheduler detail action.", "enum": [ "DELETE_PICKLIST_OPTION", "REPLACE_PICKLIST_OPTION", "DELETE_AND_REPLACE_PICKLIST_OPTION" ], "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/ScheduledJobImpactDetails" }, "job_id": { "description": "Represents the job id of the scheduler.", "format": "int64", "type": "string" }, "message": { "description": "Represents the message of the scheduler response.", "enum": [ "Job completed", "Job scheduled", "Job failed", "Job inprogress" ], "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/FieldsModuleReference" }, "status": { "description": "Represents the status of the scheduler.", "enum": [ "SCHEDULED", "FAILED", "COMPLETED", "INPROGRESS" ], "maxLength": 255, "type": "string" } }, "required": [ "action", "details", "job_id", "message", "module", "status" ], "title": "Field Picklist Action Job", "type": "object", "x-zs-$id": "FieldPicklistActionJob" }, "FieldPicklistJobsResponse": { "additionalProperties": false, "description": "Represents the response body for the scheduled jobs request, containing the list of scheduled picklist field action jobs and pagination details.", "properties": { "info": { "$ref": "#/components/schemas/ListPageInfo" }, "scheduled_jobs": { "description": "Represents the list of scheduled picklist field action jobs retrieved for the specified field.", "items": { "$ref": "#/components/schemas/FieldPicklistActionJob" }, "maxItems": 200, "type": "array" } }, "required": [ "info", "scheduled_jobs" ], "title": "Field Picklist Jobs Response", "type": "object", "x-zs-$id": "FieldPicklistJobsResponse" }, "FieldRequestBodySchema": { "additionalProperties": false, "description": "Specify the request body for creating custom fields. Maximum of 25 fields can be created in a single call.", "properties": { "fields": { "description": "Specify the list of fields to create.", "items": { "additionalProperties": false, "allOf": [ {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {}, {} ], "description": "Specify the field configuration to create.", "properties": { "_update_existing_records": { "description": "Specify whether to update existing auto-number records with the new format.", "example": true, "type": "boolean" }, "association_details": { "additionalProperties": false, "description": "Specify the association details configuration.", "properties": { "lookup_field": { "additionalProperties": false, "description": "Specify the details of the lookup field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "reference_id": { "$ref": "#/components/schemas/FieldsReferenceId" } }, "type": "object" }, "related_field": { "additionalProperties": false, "description": "Specify the details of the related field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "type": "object" } }, "required": [ "related_field", "lookup_field" ], "type": "object", "x-zs-$id": "PostAssociationDetails" }, "auto_number": { "additionalProperties": false, "description": "Specify the configuration for auto number fields.", "properties": { "prefix": { "description": "Specify the prefix of the starting number.", "example": "3", "maxLength": 16, "type": "string" }, "start_number": { "description": "Specify the starting number for the auto number field.", "example": "3", "maxLength": 16, "type": "string" }, "suffix": { "description": "Specify the suffix of the starting number.", "example": "3", "maxLength": 16, "type": "string" } }, "required": [ "start_number", "prefix", "suffix" ], "type": "object" }, "crypt": { "anyOf": [ { "additionalProperties": false, "description": "Specify the field encryption configuration.", "properties": { "mode": { "description": "Specify the encryption: Store value encrypted. decryption: Store value unencrypted (default).", "enum": [ "encryption", "decryption" ], "example": "decryption", "type": "string" } }, "required": [ "mode" ], "type": "object", "x-zs-$id": "FieldEncryptionDetails" }, { "description": "Specify whether field encryption is enabled.", "example": true, "type": "boolean", "x-zs-$id": "IsFieldEncrypted" } ] }, "currency": { "additionalProperties": false, "description": "Specify the currency field configuration.", "properties": { "precision": { "description": "Specify the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place.", "example": "123.466", "maxLength": 25, "type": "string" }, "rounding_option": { "description": "Specify how to round currency values.", "enum": [ "normal", "round_off", "round_up", "round_down" ], "example": "normal", "maxLength": 25, "type": "string" } }, "required": [ "rounding_option", "precision" ], "type": "object" }, "data_type": { "description": "Specify the data type of the field.", "enum": [ "text", "textarea", "email", "phone", "picklist", "multiselectpicklist", "date", "datetime", "integer", "autonumber", "currency", "percent", "bigint", "double", "website", "boolean", "fileupload", "imageupload", "lookup", "userlookup", "multiselectlookup", "multiuserlookup", "formula", "rollup_summary", "address" ], "example": "text", "maxLength": 50, "type": "string" }, "decimal_place": { "description": "Specify the number of decimal places for the formula field. This is valid for double and currency return types. Possible values are from 0 to 9, both inclusive.", "example": 2, "format": "int32", "type": "number" }, "default_value": { "description": "Specify the default value for the picklist field.", "example": "New", "maxLength": 25, "type": "string" }, "enable_colour_code": { "description": "Specify whether colour coding is enabled for the picklist field.", "example": false, "type": "boolean" }, "enable_record_state": { "description": "Specify whether record state is enabled for the picklist field.", "example": false, "type": "boolean" }, "encrypt_case": { "description": "Specify the permission case for encrypted field.", "enum": [ "uppercase", "lowercase" ], "example": "lowercase", "type": "string" }, "external": { "additionalProperties": false, "description": "Specify the external field configuration for third-party app integration.", "properties": { "show": { "description": "Specify whether to display the field in the UI.", "example": true, "type": "boolean" }, "type": { "description": "Specify the external field type. 'user' assigns a different ID per user; 'org' assigns a common ID for the organization.", "enum": [ "user", "org", "external_lookup" ], "example": "user", "maxLength": 25, "type": "string" } }, "required": [ "type", "show" ], "type": "object" }, "field_label": { "description": "Specify the unique display label of the field.", "example": "Your Name", "maxLength": 25, "type": "string" }, "filterable": { "description": "Specify whether the field can be used in filters.", "example": true, "type": "boolean" }, "formula": { "additionalProperties": false, "description": "Specify the details of the formula field, including the return type and the expression.", "properties": { "dynamic": { "description": "Specify whether the formula is Auto Refresh.", "example": true, "type": "boolean" }, "expression": { "description": "Specify the formula expression.", "example": "Sqrt(Len(${Email}))", "maxLength": 255, "type": "string" }, "return_type": { "description": "Specify the return type of the formula.", "enum": [ "double", "currency", "text", "date", "datetime", "boolean" ], "example": "double", "type": "string" }, "stop_compute_conditionally": { "description": "Specify whether to stop computation conditionally.", "example": true, "type": "boolean" }, "stop_compute_expression": { "description": "Specify the expression that determines when to stop computation.", "example": "3>1", "maxLength": 255, "type": "string" }, "sub_return_type": { "description": "Specify the string subtype of the formula return value when the return type is text.", "enum": [ "small", "medium", "large" ], "example": "small", "maxLength": 25, "type": "string" } }, "required": [ "expression", "return_type" ], "type": "object" }, "global_picklist": { "additionalProperties": false, "description": "Specify the global picklist configuration.", "properties": { "api_name": { "description": "Specify the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "id": { "description": "Specify the ID of the global picklist to associate with this field.", "example": "2423488000000123456", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "hipaa_compliance_enabled": { "description": "Specify the enable HIPAA compliance for this field.", "example": false, "type": "boolean" }, "history_tracking": { "additionalProperties": false, "description": "Specify the history tracking configuration.", "properties": { "duration_configuration": { "description": "Specify the duration for which history is tracked.", "enum": [ "days", "time" ], "example": "time", "maxLength": 25, "type": "string" }, "followed_fields": { "description": "Specify the list of fields to create.", "items": { "additionalProperties": false, "description": "Specify the field to be tracked.", "properties": { "api_name": { "description": "Specify the API name of the field to be tracked.", "example": "Status", "maxLength": 25, "type": "string" }, "id": { "description": "Specify the ID of the field to be tracked.", "example": "2423488000000123457", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 10, "type": "array" }, "related_list_name": { "description": "Specify the name of the related list for history tracking.", "example": "Field History", "maxLength": 50, "type": "string" } }, "required": [ "related_list_name", "duration_configuration", "followed_fields" ], "type": "object" }, "history_tracking_enabled": { "description": "Specify whether history tracking is enabled for the field.", "example": false, "type": "boolean" }, "length": { "description": "Specify the maximum number of characters allowed. Varies by data type.", "example": 150, "format": "int32", "maximum": 50000, "minimum": 1, "type": "integer" }, "lookup": { "additionalProperties": false, "description": "Specify the lookup field configuration.", "properties": { "display_label": { "description": "Specify the display label in related list.", "example": "demo1", "maxLength": 25, "type": "string" }, "module": { "additionalProperties": false, "description": "Specify the module to associate via lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name" ], "type": "object" }, "query_details": { "additionalProperties": false, "description": "Specify the filter criteria for lookup records.", "properties": { "criteria": { "additionalProperties": false, "description": "Specify the filter criteria for lookup fields.", "properties": { "group": { "description": "Specify the array of filter conditions.", "items": { "additionalProperties": false, "description": "Specify the group criteria values.", "properties": { "comparator": { "description": "Specify the comparison operator.", "enum": [ "equal", "not_equal", "like", "not_like", "greater_equal", "greater_than", "less_equal", "less_than", "in", "not_in", "starts_with", "ends_with", "contains", "not_contains", "between", "not_between", "include_all", "include_any", "exclude_all", "exclude_any" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the field details.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name" ], "type": "object" }, "value": { "anyOf": [ { "description": "Specify the value to be matched.", "example": "max", "maxLength": 125, "type": "string", "x-zs-$id": "CriteriaValue" }, { "description": "Specify the array list of value to be matched.", "items": { "description": "Specify the value to be matched.", "example": "max", "maxLength": 125, "type": "string" }, "maxItems": 10, "type": "array", "x-zs-$id": "CriteriaArray" } ], "description": "Specify the value to compare against." } }, "required": [ "field", "comparator", "value" ], "type": "object" }, "maxItems": 10, "type": "array" }, "group_operator": { "description": "Specify the logical operator for multiple conditions.", "enum": [ "AND", "OR" ], "type": "string" } }, "required": [ "group" ], "type": "object" } }, "type": "object" }, "revalidate_filter_during_edit": { "default": false, "description": "Specify the revalidate filters during record edit.", "type": "boolean" }, "sharing_properties": { "additionalProperties": false, "description": "Specify the sharing configuration (for userlookup).", "properties": { "share_permission": { "description": "Specify the sharing permission level.", "enum": [ "full-access", "read-write", "read-only" ], "type": "string" }, "share_preference_enabled": { "description": "Specify the enable share preferences.", "type": "boolean" }, "share_with_superiors": { "description": "Specify the enable share preferences.", "type": "boolean" } }, "required": [ "share_preference_enabled", "share_permission" ], "type": "object" } }, "required": [ "module" ], "type": "object" }, "multiselectlookup": { "additionalProperties": false, "description": "Specify the multi-select lookup field configuration.", "properties": { "connected_details": { "additionalProperties": false, "description": "Specify the details of the module to connect.", "properties": { "field": { "additionalProperties": false, "description": "Specify the field details.", "properties": { "field_label": { "description": "Specify the field label in connected module.", "example": "Last Name", "maxLength": 25, "type": "string" } }, "required": [ "field_label" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Specify the API name of module to connect.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name" ], "type": "object" } }, "required": [ "module", "field" ], "type": "object" }, "linking_details": { "additionalProperties": false, "description": "Specify the linking module details.", "properties": { "module": { "additionalProperties": false, "description": "Specify the module name passed as parameter is case insensitive. For example, the module name 'Leads'.", "properties": { "plural_label": { "description": "Specify the plural label for linking module.", "example": "Leads", "maxLength": 25, "type": "string" } }, "required": [ "plural_label" ], "type": "object" } }, "required": [ "module" ], "type": "object" } }, "required": [ "connected_details", "linking_details" ], "type": "object" }, "number_separator": { "description": "Specify whether to display the field value in formatted view. The default value is true.", "example": true, "type": "boolean" }, "pick_list_values": { "description": "Specify the picklist configuration.", "items": { "additionalProperties": false, "description": "Specify the picklistValue to be shown.", "properties": { "actual_value": { "description": "Specify the actual value of the picklist option. Once set, this value cannot be changed.", "example": "EXT_VAL_1", "maxLength": 25, "type": "string" }, "colour_code": { "description": "Specify the hex code for the picklist value color.", "example": "#FF5733", "maxLength": 25, "type": "string" }, "display_value": { "description": "Specify the display Value to be shown.", "example": "EXT_VAL_1", "maxLength": 25, "type": "string" }, "reference_value": { "description": "Specify the reference value to be Userd Internal.", "example": "EXT_VAL_1", "maxLength": 25, "type": "string" } }, "required": [ "display_value", "actual_value" ], "type": "object" }, "maxItems": 10, "type": "array" }, "pick_list_values_sorted_lexically": { "description": "Specify whether picklist values are sorted lexically.", "example": true, "type": "boolean" }, "private": { "additionalProperties": false, "description": "Specify the gDPR compliance configuration.", "properties": { "type": { "description": "Specify the privacy level for GDPR compliance.", "enum": [ "Low", "High" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "profiles": { "description": "Each object in the array represents the name and ID of the profile that has access to the field. By default, all organization users will have access to the field. **Possible permission types:** read_write, read_only, and hidden. **read_write:** The user has read and write permissions for the field. **read_only:** The user has only read permission for the field. **hidden:** The field is not visible to the user. Note that it is mandatory to specify a permission type to the profiles in order to access the field.", "items": { "additionalProperties": false, "description": "Specify the profile access and permission configuration.", "properties": { "id": { "$ref": "#/components/schemas/FieldsId" }, "permission_type": { "description": "Specify the permission level for this profile.", "enum": [ "read_write", "read_only", "hidden" ], "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "reference_id": { "$ref": "#/components/schemas/FieldsReferenceId" }, "rollup_summary": { "additionalProperties": false, "description": "Specify the rollup summary field configuration.", "properties": { "based_on_module": { "additionalProperties": false, "description": "Specify the source module for rollup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" } }, "required": [ "api_name" ], "type": "object" }, "expression": { "additionalProperties": false, "description": "Specify the calculation expression.", "properties": { "criteria": { "additionalProperties": false, "description": "Specify the filter criteria for lookup fields.", "properties": { "group": { "description": "Specify the array of filter conditions.", "items": { "additionalProperties": false, "description": "Specify the filter details need to be added for validation action.", "properties": { "comparator": { "description": "Specify the comparison operator.", "enum": [ "equal", "not_equal", "like", "not_like", "greater_equal", "greater_than", "less_equal", "less_than", "in", "not_in", "starts_with", "ends_with", "contains", "not_contains", "between", "not_between", "include_all", "include_any", "exclude_all", "exclude_any" ], "example": "exclude_all", "maxLength": 25, "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the field to be added in validation.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name" ], "type": "object" }, "value": { "anyOf": [ { "description": "Specify the value to be matched.", "example": "max", "maxLength": 125, "type": "string", "x-zs-$id": "CriteriaValueString" }, { "description": "Specify the array list of value to be matched.", "items": { "description": "Specify the value to be matched.", "example": "max", "maxLength": 125, "type": "string" }, "maxItems": 10, "type": "array", "x-zs-$id": "CriteriaValueArray" } ], "description": "Specify the value to compare against." } }, "required": [ "field", "comparator", "value" ], "type": "object" }, "maxItems": 10, "type": "array" }, "group_operator": { "description": "Specify the logical operator for multiple conditions.", "enum": [ "AND", "OR" ], "type": "string" } }, "required": [ "group" ], "type": "object" }, "function": { "description": "Specify the aggregation function.", "enum": [ "SUM", "COUNT", "AVG", "MIN", "MAX" ], "type": "string" }, "function_parameters": { "description": "Specify the fields to aggregate.", "items": { "additionalProperties": false, "description": "Specify the expression for the calculation need to be done.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "function_parameters", "function" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Specify the related list for rollup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" } }, "required": [ "api_name" ], "type": "object" }, "return_type": { "description": "Specify the return type of the rollup summary.", "enum": [ "currency", "double", "integer" ], "type": "string" } }, "required": [ "return_type", "expression", "based_on_module", "related_list" ], "type": "object" }, "separator": { "description": "Specify whether to use a thousands separator for number fields.", "example": true, "type": "boolean" }, "textarea": { "additionalProperties": false, "description": "Specify the text area field configuration.", "properties": { "type": { "description": "Specify the small: 2000 chars, large: 32000 chars, rich_text: 50000 chars.", "enum": [ "small", "large", "rich_text" ], "example": "small", "type": "string" } }, "required": [ "type" ], "type": "object" }, "tooltip": { "additionalProperties": false, "description": "Represents the tooltip content for the field. **Possible names**: **static_text** : Specifies that the field should have a static text tooltip. The tooltip content will be displayed in the field when the user clicks on the field box. **info_icon** : Specifies that the field should have an info icon tooltip. Clicking on the \"info icon\" will display the tooltip contents. Note that it is mandatory to specify both the name and value when you specify tooltip key.", "properties": { "name": { "description": "Specify the type of tooltip: static_text (shown in field box) or info_icon (shown on icon click).", "enum": [ "static_text", "info_icon" ], "type": "string" }, "value": { "description": "Specify the tooltip content. Max 35 chars for static_text, 255 chars for info_icon.", "maxLength": 255, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "unique": { "anyOf": [ { "additionalProperties": false, "description": "Specify the field uniqueness configuration.", "properties": { "case_sensitive": { "description": "Specify whether uniqueness is case sensitive.", "example": true, "type": "boolean" } }, "required": [ "case_sensitive" ], "type": "object", "x-zs-$id": "FieldUniquenessDetails" }, { "description": "Specify whether the field value must be unique across records.", "example": true, "type": "boolean", "x-zs-$id": "IsFieldUnique" } ] } }, "required": [ "field_label", "data_type" ], "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "type": "object" }, "FieldScoreConfigurationRequest": { "additionalProperties": false, "description": "Represents a field-based score configuration entry that links a field criteria condition to a score.", "properties": { "criteria": { "$ref": "#/components/schemas/FilterCriterionRequest" }, "id": { "description": "Field rule ID", "maxLength": 255, "type": "string" }, "score": { "description": "Specifies the score points to add when the criteria condition is met.", "format": "int32", "type": "integer" } }, "title": "Field-Based Score Configuration (Request)", "type": "object" }, "FieldScoreConfigurationResponse": { "additionalProperties": false, "description": "Represents the score configuration for module fields based on specific criteria.", "properties": { "criteria": { "$ref": "#/components/schemas/FilterCriterionResponse" }, "id": { "description": "Represents the primary key of the field rule (Required in UPDATE).", "maxLength": 255, "type": "string" }, "score": { "description": "Represents the points that should be added for the criteria and this is mandatory", "format": "int32", "type": "integer" } }, "title": "Field-Based Score Configuration (Response)", "type": "object" }, "FieldUpdateActionCreatedTime": { "description": "Date-time when this field update action was created.", "example": "2025-11-20T22:34:38-08:00", "maxLength": 255, "title": "Field Update Action Created Time", "type": "string", "x-zs-llm-description": "Read-only ISO date-time string set by the server on creation." }, "FieldUpdateActionId": { "description": "Unique identifier of the field update action.", "example": "3361265000006176255", "maxLength": 20, "title": "Field Update Action Id", "type": "string", "x-zs-$id": "FieldUpdatesId", "x-zs-llm-description": "Read-only unique ID of this field update action. Use this value to reference the action in workflow rules." }, "FieldUpdateActionModifiedTime": { "description": "Date-time when this field update action was last modified.", "example": "2025-11-20T22:34:38-08:00", "maxLength": 255, "title": "Field Update Action Modified Time", "type": "string", "x-zs-llm-description": "Read-only ISO date-time string updated by the server on every modification." }, "FieldUpdateActionResult": { "additionalProperties": false, "description": "Result object for a field update create, update, or delete operation. Contains the operation outcome code, a human-readable message, the status, and details including the server-generated ID.", "properties": { "code": { "description": "Operation result code. 'SUCCESS' for successful operations. In bulk operations (DELETE 207), individual items may return error codes like 'NOT_ALLOWED' or 'INVALID_DATA'.", "enum": [ "SUCCESS", "NOT_ALLOWED", "INVALID_DATA" ], "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/ActionResultDetails" }, "message": { "description": "Human-readable message describing the operation outcome.", "maxLength": 255, "type": "string" }, "status": { "description": "Overall status of the operation. 'success' for successful operations, 'error' for failed individual items in bulk operations.", "enum": [ "success", "error" ], "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Field Update Action Result", "type": "object", "x-zs-llm-description": "Generic action result for field update create/update/delete operations. Check status and code fields for outcome." }, "FieldUpdateArrayValue": { "description": "An array of string values used for multi-select picklist fields, where each element represents one selected option.", "example": [ "Option 1", "Option 2" ], "items": { "description": "Individual option value for the multi-select field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "title": "Field Update Array Value", "type": "array", "x-zs-$id": "FieldUpdateArrayValue", "x-zs-llm-description": "A list of string options for multi-select picklist fields where every element is one chosen option. Pair with update_type='overwrite' to replace all selections or 'append' to add to the current set." }, "FieldUpdateAssociateActionSchema": { "additionalProperties": false, "description": "Represents an associate action that updates field values using a pre-configured field update action when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "additionalProperties": false, "description": "Represents the read-only details of the associated field update action. Returned in GET responses and not required in POST or PUT requests.", "properties": { "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module this action applies to." } }, "type": "object" }, "id": { "description": "Represents the unique ID of the field update action. Use the Get Field Updates API to retrieve available IDs.", "example": "3361265000006176255", "maxLength": 20, "title": "Field Update Action Id", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFieldUpdates", "propertyId": "FieldUpdatesId" } ], "resource": "field_updates" } }, "name": { "description": "Represents the display name of the FieldUpdateAssociate action. Returned in GET responses and derived from the referenced action configuration.", "maxLength": 500, "type": "string" }, "related_details": { "$ref": "#/components/schemas/FieldUpdateRelatedDetailsSchema", "description": "Specifies the lookup field when the field update targets a related module. Null when the update targets the workflow rule's own module." }, "type": { "const": "field_updates", "description": "Represents the action type discriminator that identifies this as a FieldUpdateAssociate action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "FieldUpdateAssociateActionSchema", "x-zs-llm-description": "References a pre-configured field update entity by ID. Create the entity first via createFieldUpdates, then use its ID here. Supports related_details.lookup_field for targeting a related module's field - set null for same-module updates. Entity must be created for the correct module context." }, "FieldUpdateBooleanValue": { "description": "A boolean value used for checkbox fields, where true marks the field as checked and false marks it as unchecked.", "title": "Field Update Boolean Value", "type": "boolean", "x-zs-$id": "FieldUpdateBooleanValue", "x-zs-llm-description": "A true/false value for checkbox-type fields where true marks the field as checked/enabled and false marks it as unchecked/disabled." }, "FieldUpdateByIdResponse": { "additionalProperties": false, "description": "Response payload for retrieving a single field update action by ID.", "properties": { "field_updates": { "description": "Array containing the matched field update action. Contains one item for a valid ID.", "items": { "$ref": "#/components/schemas/FieldUpdateConfigurationForList" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "FieldUpdateByIdResponse", "x-zs-llm-description": "Single field update detail response from GET-by-ID. Contains the full configuration." }, "FieldUpdateConfigurationForCreate": { "additionalProperties": false, "description": "Defines a single field update action, including the target module, target field, mapping type, and the value to apply. Some properties are conditionally required depending on the target field's type — for example, Owner fields require notify and related_records.", "properties": { "apply_assignment_threshold": { "default": false, "description": "Whether to enforce assignment-threshold rules when updating the Owner field. This key is applicable only for Owner updates, and is required only when active owner-assignment thresholds exist for the module. If thresholds are not configured, sending this key can be rejected as not allowed.", "type": "boolean" }, "dependent_fields": { "description": "Dependent fields that must be set alongside the target field. Required for dependent picklist relationships. Common chains: Pipeline -> Stage, Layout -> Pipeline, and Layout -> Pipeline -> Stage (nested via dependent_fields inside the Pipeline node).", "items": { "$ref": "#/components/schemas/DependentFieldsNested" }, "maxItems": 1, "type": [ "array", "null" ] }, "feature_type": { "$ref": "#/components/schemas/FieldUpdateFeatureType", "description": "The automation feature this field update is associated with. Defaults to 'workflow' if omitted. All enum values are supported for creation via API." }, "field": { "$ref": "#/components/schemas/FieldDetails", "description": "Target field to be updated. Provide both field.id and field.api_name. If both are present but inconsistent, ambiguity or invalid-data errors can be returned." }, "module": { "$ref": "#/components/schemas/FieldUpdatesModuleDetails", "description": "The CRM module where this field update should be applied. Specify using the module's unique ID and/or API name (e.g., Deals, Leads, Contacts)." }, "name": { "description": "Name of the field update action. Must be unique within the org. This label is displayed in the automation rule configuration UI.", "example": "FieldUpdatePOST", "maxLength": 255, "type": "string" }, "notify": { "default": false, "description": "Whether to send an email notification to the new owner when the Owner field is updated. Required when the target field is Owner (omitting returns DEPENDENT_FIELD_MISSING). Must not be sent when the target field is not Owner (returns NOT_ALLOWED).", "type": "boolean" }, "related_module": { "$ref": "#/components/schemas/RelatedModuleDetails", "description": "Related module context when the field update is configured on a related module's records (e.g., updating a field on Contacts related to Accounts). Pass null or omit when not applicable." }, "related_records": { "description": "Related modules whose open record ownership should also be transferred when the Owner field is updated. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional modules depend on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Required when the target field is Owner (omitting returns DEPENDENT_FIELD_MISSING). Must not be sent when the target field is not Owner (returns NOT_ALLOWED). Pass null to skip ownership transfer on related records.", "items": { "$ref": "#/components/schemas/RelatedRecordModule" }, "maxItems": 5, "type": [ "array", "null" ] }, "type": { "$ref": "#/components/schemas/FieldUpdateType", "description": "Create/update mapping type. Only static is accepted for create/update payloads." }, "update_type": { "$ref": "#/components/schemas/FieldUpdateUpdateType", "description": "Strategy for applying the value. Required for multi-select fields: 'overwrite' replaces all existing values, 'append' adds to them. Omit or pass null for single-value fields." }, "value": { "anyOf": [ { "$ref": "#/components/schemas/FieldUpdateStringValue", "x-zs-$id": "FieldUpdateStringValue" }, { "$ref": "#/components/schemas/FieldUpdateArrayValue", "x-zs-$id": "FieldUpdateArrayValue" }, { "$ref": "#/components/schemas/FieldUpdateOwnerValue", "x-zs-$id": "FieldUpdateOwnerValue" }, { "$ref": "#/components/schemas/FieldUpdateBooleanValue", "x-zs-$id": "FieldUpdateBooleanValue" }, { "$ref": "#/components/schemas/FieldUpdateNumberValue", "x-zs-$id": "FieldUpdateNumberValue" }, { "$ref": "#/components/schemas/FieldUpdateNullValue", "x-zs-$id": "FieldUpdateNullValue" } ], "description": "The value to assign to the target field when this action is triggered. The type must match the target field's data type - a mismatch returns DEPENDENT_MISMATCH. Pipeline expects a string value from Pipelines metadata; Layout expects a layout object from Layouts metadata; Owner expects a user object from Users API." } }, "required": [ "name", "module", "field", "value", "type" ], "title": "Field Update Configuration For Create", "type": "object", "x-zs-llm-description": "Describes a single field update action. Required: name, module ({api_name}), field ({id, api_name}), type ('static'), and a value whose shape matches the field's data_type. Conditional: Pipeline field needs a string value (pipeline name) and Stage in dependent_fields; Layout field needs an object value and Pipeline in dependent_fields; Owner field needs value={id}, notify (boolean, required), and related_records (array, required pass null to skip). Optional: update_type ('overwrite' or 'append' for multi-select fields), apply_assignment_threshold (Owner only)." }, "FieldUpdateConfigurationForList": { "additionalProperties": false, "description": "Represents one field update action returned by the list API, including field configuration, update behavior, module context, and audit metadata.", "properties": { "apply_assignment_threshold": { "description": "Whether assignment-threshold rules (record count limits per user) should be enforced when updating the field. Only applicable when the target field is an Owner field and the org has assignment thresholds configured. When true, the system checks whether the new owner has reached their record limit before applying the update. Ignored for non-Owner fields.", "type": "boolean" }, "associated": { "description": "Whether this action is currently linked to any automation rule, approval process, or blueprint.", "type": "boolean" }, "created_by": { "$ref": "#/components/schemas/FieldUpdatesCreatedBy", "description": "User who created this field update action." }, "created_time": { "$ref": "#/components/schemas/FieldUpdateActionCreatedTime" }, "deletable": { "description": "Represents whether the current user can delete this field update action.", "type": "boolean" }, "dependent_fields": { "description": "Dependent fields that must be set alongside the target field when dependency rules apply. Includes patterns such as Pipeline -> Stage and Layout -> Pipeline -> Stage (nested). Nested dependencies can be represented through dependent_fields within each item. Null when the target field has no dependency rules configured.", "items": { "$ref": "#/components/schemas/DependentFieldsNested" }, "maxItems": 10, "type": [ "array", "null" ] }, "editable": { "description": "Whether the current user can edit this field update action.", "type": "boolean" }, "feature_type": { "$ref": "#/components/schemas/FieldUpdateFeatureType", "description": "Automation feature where this field update action is used." }, "field": { "$ref": "#/components/schemas/FieldDetails", "description": "The target CRM field that this action updates." }, "id": { "$ref": "#/components/schemas/FieldUpdateActionId", "x-zs-$id": "FieldUpdatesId" }, "lock_status": { "$ref": "#/components/schemas/FieldUpdatesLockStatus", "description": "Indicates whether this field update action is locked for edit/delete." }, "modified_by": { "$ref": "#/components/schemas/FieldUpdatesModifiedBy", "description": "User who last modified this field update action." }, "modified_time": { "$ref": "#/components/schemas/FieldUpdateActionModifiedTime" }, "module": { "$ref": "#/components/schemas/FieldUpdatesModuleDetails", "description": "Primary CRM module on which this field update action is configured." }, "name": { "description": "Display name of the field update action.", "maxLength": 255, "type": "string" }, "notify": { "description": "Whether to send an email notification to the new record owner when the Owner field is updated via this action. Only applicable when the target field is an Owner field. When true, the newly assigned owner receives an email informing them of the ownership change. Ignored for non-Owner fields.", "type": "boolean" }, "parent_module": { "additionalProperties": false, "description": "Parent module context when the field update is configured on a child module. Null when the field update is on a top-level module.", "properties": { "api_name": { "description": "API name of the parent CRM module.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the parent CRM module.", "maxLength": 20, "type": "string" } }, "type": [ "object", "null" ] }, "related_module": { "$ref": "#/components/schemas/RelatedModuleDetails", "description": "Related module context when the automation is configured on related records; null when not applicable." }, "related_records": { "description": "List of related modules whose record ownership should also be transferred along with the parent record when the Owner field is updated. Only applicable when the target field is an Owner field. Common activity modules (Tasks, Calls, Events) are available for all modules. Additional related modules are available depending on the parent module: Accounts can also include Contacts and Deals; Contacts can also include Deals. Null when the target field is not an Owner field or when no related modules are selected for ownership transfer.", "items": { "$ref": "#/components/schemas/RelatedRecordModule" }, "maxItems": 5, "type": [ "array", "null" ] }, "source": { "description": "Source application that created or manages this action (e.g., crm).", "maxLength": 255, "type": "string" }, "type": { "$ref": "#/components/schemas/FieldUpdateTypeResponse", "description": "Type returned by the API for this field update. Create/update accepts only static; GET responses can include merge_field for pre-existing actions." }, "update_type": { "$ref": "#/components/schemas/FieldUpdateUpdateType", "description": "Specifies how the field value should be applied when the target field supports multiple update strategies (e.g., multi-select picklist, Owner). Null when the field type does not support multiple update strategies (e.g., text, single picklist)." }, "value": { "anyOf": [ { "description": "A plain text value. Used when the target field is a single-value field such as a text field (e.g., Deal_Name), picklist (e.g., Pipeline, Stage), number, date, or similar scalar field types. Example: \"PostTest\", \"Qualification\".", "maxLength": 255, "type": "string", "x-zs-$id": "ListStringValue" }, { "description": "An array of selected option values. Used when the target field is a multi-select picklist. Each element represents one selected option. Example: [\"Option 1\", \"Option 2\"].", "items": { "description": "One selected option value for the multi-select field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array", "x-zs-$id": "ListArrayValue" }, { "additionalProperties": true, "description": "A structured object value. Used when the target field requires composite data - for example, a Layout field (with id, name, display_label), an Owner/user-lookup field (with id, name), or other lookup-type fields that resolve to a resource with an identifier.", "type": "object", "x-zs-$id": "ListObjectValue" }, { "description": "A boolean value. Used when the target field is a checkbox or boolean-type field. true enables/checks the field, false disables/unchecks it.", "type": "boolean", "x-zs-$id": "ListBooleanValue" }, { "description": "A numeric value. Used when the target field is a number, currency, decimal, or percentage field type. Example: 100, 25.5.", "type": "number", "x-zs-$id": "ListNumberValue" }, { "description": "A null value. Used to clear/empty the target field - equivalent to choosing 'empty value' in the field update configuration.", "type": "null", "x-zs-$id": "ListNullValue" } ], "description": "The value configured for the field update. The shape depends on the target field type." } }, "required": [ "module", "name", "field", "type", "value" ], "title": "Field Update Configuration For List", "type": "object", "x-zs-llm-description": "Full field update action object from GET list. Contains field configuration, update behavior, module context, and audit metadata." }, "FieldUpdateFeatureType": { "description": "Automation feature where this field update action is used. Supports baseline features plus connected_workflows. No cadence support.", "enum": [ "workflow", "approval_process", "blueprint_transition", "blueprint_state", "assignment_rules", "kiosk", "commandcenter_service", "connected_workflows" ], "maxLength": 255, "title": "Field Update Feature Type", "type": "string", "x-zs-llm-description": "Enum identifying which automation feature owns this field update. Supports workflow, approval_process, blueprint, orchestration, etc. No cadence support." }, "FieldUpdateNullValue": { "description": "Null value - clears/empties the target field, removing any previously set value.", "title": "Field Update Null Value", "type": "null", "x-zs-$id": "FieldUpdateNullValue", "x-zs-llm-description": "Null literal clears/empties the target field, removing any previously set value." }, "FieldUpdateNumberValue": { "description": "A numeric value used for number, currency, decimal, or percentage fields.", "example": 1000.5, "title": "Field Update Number Value", "type": "number", "x-zs-$id": "FieldUpdateNumberValue", "x-zs-llm-description": "A numeric value applied to fields typed as number, currency, decimal, or percentage." }, "FieldUpdateObject": { "additionalProperties": false, "description": "Represents a field operation object used in layout update requests to add, modify, create, or remove a field within a section.", "minProperties": 1, "properties": { "_delete": { "$ref": "#/components/schemas/DeleteObject", "description": "Delete configuration for removing the field. Set permanent to false to move to unused section (can be re-added later), true to permanently delete the field and its data." }, "association_details": { "$ref": "#/components/schemas/PatchAssociationDetails", "description": "Association details for Field-Of-Lookup (FOL) mapping. Links this field to a related field in another module through a lookup field." }, "data_type": { "description": "Represents the data type of the field. Required when adding a new custom field to the layout. Possible values: `text`, `textarea`, `email`, `phone`, `website`, `integer`, `bigint`, `currency`, `double`, `percent`, `date`, `datetime`, `boolean`, `picklist`, `multiselectpicklist`, `lookup`, `multiselectlookup`, `autonumber`, `fileupload`, `imageupload`, `formula`, `rollup_summary`, `consent_lookup`, `profileimage`, `richtextarea`, `userlookup`, `multiuserlookup`, `event_reminder`.", "enum": [ "text", "textarea", "email", "phone", "website", "integer", "bigint", "currency", "double", "percent", "date", "datetime", "boolean", "picklist", "multiselectpicklist", "lookup", "multiselectlookup", "autonumber", "fileupload", "imageupload", "formula", "rollup_summary", "consent_lookup", "profileimage", "richtextarea", "userlookup", "multiuserlookup", "event_reminder" ], "examples": [ "text", "picklist", "lookup" ], "type": "string" }, "element_type": { "description": "Represents the element type for special field components in the layout, distinguishing standard data fields from mirror fields. Possible values: `field` — a standard data field. `mirror_field` — a field that mirrors a value from a lookup source.", "enum": [ "field", "mirror_field" ], "examples": [ "mirror_field" ], "type": "string" }, "field_label": { "description": "Represents the display label shown for the field in the CRM interface. Required when creating a new custom field through a layout update.", "examples": [ "CF1", "Custom Text Field" ], "maxLength": 255, "minLength": 1, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of an existing field. Required when adding, updating position, or removing an existing field. Omit when creating a new custom field." }, "length": { "description": "Represents the maximum number of characters permitted for this field's value. Applicable to text and textarea field types.", "examples": [ 16, 255, 2000 ], "format": "int32", "maximum": 32000, "minimum": 1, "type": "integer" }, "lookup_field": { "additionalProperties": false, "description": "Represents the source lookup field from which a mirror field derives its value, establishing the cross-module field reference for mirror field creation.", "properties": { "api_name": { "description": "Represents the API name of the source lookup field on which this mirror field is based.", "examples": [ "Account_Name" ], "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the source lookup field." } }, "type": "object" }, "sequence_number": { "description": "Represents the one-based ordinal position of the field within its containing section, controlling the rendering order of fields on record forms.", "examples": [ 1, 2, 10 ], "format": "int32", "minimum": 1, "type": "integer" } }, "type": "object" }, "FieldUpdateOwnerValue": { "additionalProperties": false, "description": "An object value used for Owner or Layout fields, identified by id (a user ID for Owner fields or a layout ID for Layout fields), with an optional name for display.", "properties": { "id": { "description": "Unique identifier of the user to assign as the new owner.", "example": "3361265000000535001", "maxLength": 255, "type": "string" }, "name": { "description": "Optional display name for readability.", "example": "John Doe", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "title": "Field Update Object Reference Value", "type": "object", "x-zs-$id": "FieldUpdateOwnerValue", "x-zs-llm-description": "An object used as the value for Owner or Layout fields. id is required supply a user ID sourced from GET /users or a layout ID from GET /settings/layouts; name is an optional display label. For Owner fields, also configure notify and related_records on the parent object." }, "FieldUpdateRelatedDetailsSchema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the lookup field configuration that identifies the related module record for cross-module field update actions.", "properties": { "lookup_field": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The lookup field linking the rule module to the target module (e.g., Account_Name on Contacts). Provide the field's id and api_name." } }, "type": "object", "x-zs-$id": "FieldUpdateRelatedDetailsLookupSchema" }, { "description": "Represents a null value indicating the field update targets the workflow rule own module with no lookup field required.", "type": "null", "x-zs-$id": "FieldUpdateRelatedDetailsNullSchema" } ], "description": "Represents the optional related configuration details for field update actions, specifying the lookup field used for cross-module field updates.", "x-zs-llm-description": "Supplementary config for field_updates associate action. Specifies lookup_field ({api_name, id}) to target a related module's field via a lookup relationship. Set to null for same-module field updates." }, "FieldUpdateRequestBodySchema": { "additionalProperties": false, "description": "Request body for updating custom fields. Maximum of 25 fields can be updated in a single call.", "properties": { "fields": { "description": "Specify the list of fields to update.", "items": { "additionalProperties": false, "description": "Specify the field update configuration.", "properties": { "association_details": { "anyOf": [ { "additionalProperties": false, "description": "Specify the association details for the field, including the related field and lookup field configuration.", "properties": { "lookup_field": { "additionalProperties": false, "description": "Details of the lookup field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "type": "object" }, "related_field": { "additionalProperties": false, "description": "Details of the related field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "type": "object" } }, "required": [ "related_field", "lookup_field" ], "type": "object", "x-zs-$id": "PatchAssociationDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "currency": { "additionalProperties": false, "description": "Currency Field Data.", "properties": { "precision": { "description": "Specify the number of decimal places displayed for the currency value in the user interface. This value should be less than decimal_place.", "example": "123.466", "maxLength": 25, "type": "string" }, "rounding_option": { "description": "Specify how to round currency values.", "enum": [ "normal", "round_off", "round_up", "round_down" ], "example": "normal", "maxLength": 25, "type": "string" } }, "required": [ "rounding_option", "precision" ], "type": "object" }, "decimal_place": { "description": "The number of decimal places for the formula field. This is valid for double and currency return types. Possible values are from 0 to 9, both inclusive.", "example": 2, "format": "int32", "type": "number" }, "field_label": { "description": "Specify the unique display label of the field.", "example": "Your Name", "maxLength": 255, "type": "string" }, "formula": { "additionalProperties": false, "description": "Specify the details of the formula field, including the return type and the expression.", "properties": { "dynamic": { "description": "Specify whether the formula is Auto Refresh.", "example": true, "type": "boolean" }, "expression": { "description": "Specify the formula expression.", "example": "Sqrt(Len(${Email}))", "maxLength": 255, "type": "string" }, "return_type": { "description": "Specify the return type of the formula.", "enum": [ "double", "currency", "text", "date", "datetime", "boolean" ], "example": "double", "type": "string" }, "stop_compute_conditionally": { "description": "Specify whether to stop computation conditionally.", "example": true, "type": "boolean" }, "stop_compute_expression": { "description": "Specify the expression that determines when to stop computation.", "example": "3>1", "maxLength": 255, "type": "string" }, "sub_return_type": { "description": "Specify the string subtype of the formula return value when the return type is text.", "enum": [ "small", "medium", "large" ], "example": "small", "maxLength": 50, "type": "string" } }, "required": [ "expression", "return_type" ], "type": "object" }, "global_picklist": { "anyOf": [ { "additionalProperties": false, "description": "Global picklist configuration.", "properties": { "api_name": { "description": "API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "id": { "description": "ID of the global picklist to associate with this field.", "example": "2423488000000123456", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "GlobalPicklistConfig" }, { "description": "Null if no information is available.", "type": "null", "x-zs-$id": "GlobalPicklistConfigNull" } ] }, "history_tracking": { "additionalProperties": false, "description": "Specify the history tracking configuration.", "properties": { "duration_configuration": { "description": "Specify the duration for which history is tracked.", "enum": [ "days", "time" ], "example": "time", "maxLength": 25, "type": "string" }, "followed_fields": { "description": "Specify the list of fields to update.", "items": { "additionalProperties": false, "description": "Specify the field to be tracked.", "properties": { "_delete": { "description": "Set to null to remove field from tracking.", "type": "null" }, "api_name": { "description": "Specify the API name of the field to be tracked.", "example": "Status", "maxLength": 25, "type": "string" }, "id": { "description": "Specify the ID of the field to be tracked.", "example": "2423488000000123457", "format": "int64", "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" }, "related_list_name": { "description": "Specify the name of the related list for history tracking.", "example": "Field History", "maxLength": 50, "type": "string" } }, "required": [], "type": "object" }, "history_tracking_enabled": { "description": "Specify whether history tracking is enabled for the field.", "example": false, "type": "boolean" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "length": { "description": "Maximum number of characters allowed. Varies by data type.", "example": 150, "format": "int32", "maximum": 50000, "minimum": 1, "type": "integer" }, "lookup": { "additionalProperties": false, "description": "Specify the lookup field configuration.", "properties": { "query_details": { "additionalProperties": false, "description": "Specify the filter criteria for lookup records.", "properties": { "criteria": { "additionalProperties": false, "description": "Specify the filter criteria for lookup fields.", "properties": { "group": { "description": "Specify the array of filter conditions.", "items": { "additionalProperties": false, "description": "Specify the group criteria values.", "properties": { "comparator": { "description": "Specify the comparison operator.", "enum": [ "equal", "not_equal", "like", "not_like", "greater_equal", "greater_than", "less_equal", "less_than", "in", "not_in", "starts_with", "ends_with", "contains", "not_contains", "between", "not_between", "include_all", "include_any", "exclude_all", "exclude_any" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the field details.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name" ], "type": "object" }, "value": { "anyOf": [ { "description": "the value to be matched.", "example": "max", "maxLength": 125, "type": "string", "x-zs-$id": "FilterValue" }, { "description": "array list of value to be matched.", "items": { "description": "the value to be matched.", "example": "max", "maxLength": 125, "type": "string" }, "maxItems": 10, "type": "array", "x-zs-$id": "FilterValueArray" } ], "description": "Specify the value to compare against." } }, "required": [ "field", "comparator", "value" ], "type": "object" }, "maxItems": 10, "type": "array" }, "group_operator": { "description": "Specify the logical operator for multiple conditions.", "enum": [ "AND", "OR" ], "type": "string" } }, "required": [ "group" ], "type": "object" } }, "type": "object" } }, "required": [], "type": "object" }, "pick_list_values": { "description": "Specify the picklist configuration.", "items": { "additionalProperties": false, "description": "PicklistValue to be shown.", "properties": { "_global_picklist_value": { "additionalProperties": false, "description": "Specify the global picklist value.", "properties": { "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "id" ], "type": "object" }, "actual_value": { "description": "Specify the actual value of the picklist option. Once set, this value cannot be changed.", "example": "EXT_VAL_1", "maxLength": 25, "type": "string" }, "colour_code": { "description": "Specify the hex code for the picklist value color.", "example": "#FF5733", "maxLength": 25, "type": "string" }, "display_value": { "description": "Specify the display Value to be shown.", "example": "EXT_VAL_1", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "reference_value": { "description": "Specify the reference value to be Userd Internal.", "example": "EXT_VAL_1", "maxLength": 25, "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" }, "profiles": { "description": "Specify the profiles to which the field is to be assigned.", "items": { "additionalProperties": false, "description": "Specify the profile access and permission configuration.", "properties": { "id": { "$ref": "#/components/schemas/FieldsId" }, "permission_type": { "description": "Specify the permission level for this profile.", "enum": [ "read_write", "read_only", "hidden" ], "type": "string" } }, "required": [ "id", "permission_type" ], "type": "object" }, "maxItems": 10, "type": "array" }, "rollup_summary": { "additionalProperties": false, "description": "Specify the rollup summary field configuration.", "properties": { "based_on_module": { "additionalProperties": false, "description": "Specify the source module for rollup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" } }, "required": [ "api_name" ], "type": "object" }, "expression": { "additionalProperties": false, "description": "Specify the calculation expression.", "properties": { "criteria": { "additionalProperties": false, "description": "Specify the filter criteria for lookup fields.", "properties": { "group": { "description": "Specify the array of filter conditions.", "items": { "additionalProperties": false, "description": "Specify the filter details need to be added for validation action.", "properties": { "comparator": { "description": "Specify the comparison operator.", "enum": [ "equal", "not_equal", "like", "not_like", "greater_equal", "greater_than", "less_equal", "less_than", "in", "not_in", "starts_with", "ends_with", "contains", "not_contains", "between", "not_between", "include_all", "include_any", "exclude_all", "exclude_any" ], "example": "exclude_all", "maxLength": 25, "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the field to be added in validation.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name" ], "type": "object" }, "value": { "anyOf": [ { "description": "the value to be matched.", "example": "max", "maxLength": 125, "type": "string", "x-zs-$id": "FilterString" }, { "description": "array list of value to be matched.", "items": { "description": "the value to be matched.", "example": "max", "maxLength": 125, "type": "string" }, "maxItems": 10, "type": "array", "x-zs-$id": "FilterArray" } ], "description": "Specify the value to compare against." } }, "required": [ "field", "comparator", "value" ], "type": "object" }, "maxItems": 10, "type": "array" }, "group_operator": { "description": "Specify the logical operator for multiple conditions.", "enum": [ "AND", "OR" ], "type": "string" } }, "required": [ "group" ], "type": "object" }, "function": { "description": "Specify the aggregation function.", "enum": [ "SUM", "COUNT", "AVG", "MIN", "MAX" ], "type": "string" }, "function_parameters": { "description": "Specify the fields to aggregate.", "items": { "additionalProperties": false, "description": "Expression for the calculation need to be done.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "function_parameters", "function" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Specify the related list for rollup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" } }, "required": [ "api_name" ], "type": "object" }, "return_type": { "description": "Specify the return type of the rollup summary.", "enum": [ "currency", "double", "integer" ], "type": "string" } }, "required": [ "return_type", "expression", "based_on_module", "related_list" ], "type": "object" }, "sharing_properties": { "additionalProperties": false, "description": "Specify the update sharing properties for user lookup fields.", "properties": { "share_permission": { "description": "Specify the share permission.", "enum": [ "full-access", "read-write", "read-only" ], "example": "read-only", "maxLength": 25, "type": "string" }, "share_preference_enabled": { "description": "Specify the share permission needed.", "example": false, "type": "boolean" } }, "type": "object" }, "unique": { "anyOf": [ { "additionalProperties": false, "description": "Field uniqueness configuration.", "properties": { "_disable": { "anyOf": [ { "description": "marking the field is not a unique key.", "example": true, "type": "boolean", "x-zs-$id": "IsFieldUniquenessDisabled" }, { "description": "Null if no information is available.", "type": "null", "x-zs-$id": "IsFieldUniquenessDisabledNull" } ] }, "case_sensitive": { "description": "Indicates whether uniqueness is case sensitive.", "example": true, "type": "boolean" } }, "required": [ "case_sensitive" ], "type": "object", "x-zs-$id": "FieldUniquenessConfig" }, { "description": "Indicates whether the field value must be unique across records.", "example": true, "type": "boolean", "x-zs-$id": "FieldUnique" } ] } }, "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "type": "object" }, "FieldUpdateStringValue": { "description": "A string value used for text, single-picklist, date, or Pipeline fields. Picklist and Pipeline values are validated against the field's configured options.", "example": "Test", "maxLength": 255, "title": "Field Update String Value", "type": "string", "x-zs-$id": "FieldUpdateStringValue", "x-zs-llm-description": "A plain string assigned to text, single picklist, date, or Pipeline fields. Picklist values are checked against allowed options at creation time; retrieve valid choices from GET /settings/fields?module={api_name}. For Pipeline: look up the valid value via GET /settings/pipeline?module={api_name}." }, "FieldUpdateType": { "description": "The mapping type used when creating or updating the field update action. Only static is accepted; merge_field appears only in GET responses for existing actions.", "enum": [ "static" ], "maxLength": 255, "title": "Field Update Type", "type": "string", "x-zs-llm-description": "Declares the mapping strategy for the field value during create or update; only 'static' (a fixed literal) is accepted. merge_field is not valid in POST/PUT it only shows up in GET responses for actions that were created before this restriction." }, "FieldUpdateTypeResponse": { "description": "Response-only field update type. Create/update supports only static, while GET responses may include merge_field for pre-existing actions.", "enum": [ "static", "merge_field" ], "maxLength": 255, "title": "Field Update Type Response", "type": "string", "x-zs-$id": "FieldUpdateTypeResponse", "x-zs-llm-description": "The field update execution type. 'static' is the only creatable type; 'merge_field' may appear in GET responses for legacy actions." }, "FieldUpdateUpdateType": { "description": "Specifies how the new value is applied to a multi-select picklist or Owner field: overwrite replaces the existing value, append adds to the existing entries. Omit or set to null for single-value fields.", "enum": [ "overwrite", "append", null ], "maxLength": 255, "title": "Field Update Update Type", "type": [ "string", "null" ], "x-zs-llm-description": "Defines how the new value is applied to the field. Needed for multi-select picklist and Owner fields: 'overwrite' replaces everything, 'append' adds to existing entries (valid for multi-select and Owner with related_records). For single-value fields (text, single picklist, date) pass null or omit this property entirely." }, "FieldUpdatesCreatedBy": { "additionalProperties": false, "description": "User who created the field update action, including display name and unique identifier.", "properties": { "id": { "description": "Unique identifier of the user who created the resource.", "maxLength": 255, "type": "string" }, "name": { "description": "Display name of the user who created the resource.", "maxLength": 255, "type": "string" } }, "title": "Created By", "type": "object", "x-zs-llm-description": "Read-only audit field showing who created this field update action." }, "FieldUpdatesDependentFieldMissingError": { "additionalProperties": false, "description": "Returned when one or more required dependent fields are missing from the request.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the missing dependent field.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Identifies the field that requires the missing dependent field.", "properties": { "api_name": { "description": "API name of the field that requires the dependent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field that requires the dependent field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path to the missing dependent field.", "maxLength": 1000, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Dependent Field missing", "Field update action related module missing for kiosk feature" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Dependent Field Missing Error", "type": "object", "x-zs-$id": "DependentFieldMissingError", "x-zs-llm-description": "Required dependent fields are missing. When updating a field with dependencies, all dependent fields in the chain must be included." }, "FieldUpdatesDependentMismatchError": { "additionalProperties": false, "description": "Returned when a field's value is invalid in the context of its dependent field. For example, passing an unsupported type value for the given target field.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the mismatched dependency", "properties": { "api_name": { "description": "API name of the field with the invalid value", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The field that the invalid value depends on", "properties": { "api_name": { "description": "API name of the dependee field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the dependee field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path to the field with the invalid value", "maxLength": 1000, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Dependent Field is not matching" ], "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Dependent Mismatch Error", "type": "object", "x-zs-$id": "DependentMismatchError", "x-zs-llm-description": "The field's value is invalid in context of its dependent field. Verify that dependent field values are compatible with their parent." }, "FieldUpdatesExpectedFieldMissingError": { "additionalProperties": false, "description": "Returned when a required nested object (e.g., field) is provided but empty - at least one identifying property (api_name or id) must be specified.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details listing the expected fields that were missing", "properties": { "expected_fields": { "description": "List of fields where at least one must be provided", "items": { "additionalProperties": false, "description": "An expected field that was not provided in the request", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the expected field in the request body", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Expected Field Missing Error", "type": "object", "x-zs-$id": "ExpectedFieldMissingError", "x-zs-llm-description": "A required nested object (e.g., field) was provided empty. Supply at least api_name or id inside the object." }, "FieldUpdatesInvalidDataGenericError": { "additionalProperties": false, "description": "Returned when the field_updates value has an invalid data type.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field in the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "invalid data", "the fieldId given seems to be invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Generic Error", "type": "object", "x-zs-$id": "InvalidDataGenericError", "x-zs-llm-description": "Invalid data type for the field_updates key. Verify the request body structure matches the expected schema." }, "FieldUpdatesInvalidDataParamError": { "additionalProperties": false, "description": "Returned when a query parameter contains an invalid value. Applies to feature_type, sort_by, sort_order, and similar parameters.", "properties": { "code": { "description": "Error code indicating the data provided is invalid", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying which parameter caused the error", "properties": { "param_name": { "description": "The query parameter that has an invalid value", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "example": "The value provided to the param is Invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Param Error", "type": "object", "x-zs-$id": "InvalidDataParamError", "x-zs-llm-description": "A query parameter value is invalid. Check feature_type, sort_by, sort_order parameter values." }, "FieldUpdatesInvalidDataTypeError": { "additionalProperties": false, "description": "Returned when a field value type does not match the expected data type for the target field configuration.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field in the request body.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "List of values supported for the field.", "items": { "description": "One supported value for the field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Type Error", "type": "object", "x-zs-$id": "InvalidDataTypeError", "x-zs-llm-description": "A field value type does not match what the target field expects. Check the field's metadata for valid data types." }, "FieldUpdatesInvalidModuleError": { "additionalProperties": false, "description": "Returned when the module query parameter contains a module name that does not exist in the CRM organization.", "properties": { "code": { "description": "Error code indicating the module is invalid", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying which parameter caused the error", "properties": { "param_name": { "description": "The query parameter that has an invalid value", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "example": "The value provided to the param is Invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Error", "type": "object", "x-zs-$id": "InvalidModuleError", "x-zs-llm-description": "The module query parameter value does not match any valid CRM module. Verify via GET /settings/modules." }, "FieldUpdatesListResponse": { "additionalProperties": false, "description": "Successful response for listing field update actions. Contains an array of field update definitions configured in the org along with pagination metadata.", "properties": { "field_updates": { "description": "List of field update actions configured in the org.", "items": { "$ref": "#/components/schemas/FieldUpdateConfigurationForList" }, "maxItems": 200, "type": "array" }, "info": { "$ref": "#/components/schemas/FieldUpdatesPaginationInfo" } }, "title": "Field Updates List Response", "type": "object", "x-zs-$id": "FieldUpdatesListResponse", "x-zs-llm-description": "Paginated list response containing field update definitions and pagination info. Check info.more_records for additional pages." }, "FieldUpdatesLockStatus": { "additionalProperties": false, "description": "Indicates whether a particular component is locked, affecting its editability and deletability.", "properties": { "locked": { "description": "True when the action is locked and cannot be edited or deleted.", "type": "boolean" } }, "title": "Lock Status", "type": "object", "x-zs-llm-description": "Indicates whether the field update is locked (non-editable). Locked actions are managed by their parent automation." }, "FieldUpdatesMandatoryFieldMissingError": { "additionalProperties": false, "description": "Returned when a required field is missing in the request payload.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the missing required field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing required field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Required field is missing", "please specify value", "please specify dependency fieldId", "required field not found", "Please specify update_type", "please specify tabId and module api name", "Please specify name", "please specify fieldId and fieldName", "The required data missing" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Mandatory Field Missing Error", "type": "object", "x-zs-$id": "MandatoryFieldMissingError", "x-zs-llm-description": "A required field is missing from the request body. Check details for the missing field name." }, "FieldUpdatesModifiedBy": { "additionalProperties": false, "description": "User who last modified the field update action, including display name and unique identifier.", "properties": { "id": { "description": "Unique identifier of the user who last modified the resource.", "maxLength": 255, "type": "string" }, "name": { "description": "Display name of the user who last modified the resource.", "maxLength": 255, "type": "string" } }, "title": "Modified By", "type": "object", "x-zs-llm-description": "Read-only audit field showing who last modified this field update action." }, "FieldUpdatesModuleDetails": { "additionalProperties": false, "description": "Module metadata for the primary CRM module associated with the field update action.", "properties": { "api_name": { "description": "CRM module API name used in automation configuration (e.g., Leads, Contacts, Deals).", "example": "Deals", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the CRM module corresponding to api_name.", "example": "3361265000000000131", "maxLength": 255, "type": "string" }, "moduleName": { "description": "Internal module name. Present only in responses.", "maxLength": 255, "type": "string" }, "plural_label": { "description": "Plural display label of the module (e.g., Deals, Leads). Present only in responses.", "example": "Deals", "maxLength": 255, "type": "string" }, "singular_label": { "description": "Singular display label of the module (e.g., Deal, Lead). Present only in responses.", "example": "Deal", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "title": "Module Details", "type": "object", "x-zs-$id": "ModuleNestedObject", "x-zs-llm-description": "Module metadata for the primary CRM module associated with this field update action." }, "FieldUpdatesPaginationInfo": { "additionalProperties": false, "description": "Pagination metadata for list responses. Use more_records to determine if additional pages are available.", "properties": { "count": { "description": "Number of records returned in the current page.", "format": "int32", "type": "integer" }, "more_records": { "description": "True when additional records are available on subsequent pages.", "type": "boolean" }, "page": { "description": "Current page number (starts at 1).", "format": "int32", "type": "integer" }, "per_page": { "description": "Maximum number of records returned per page (default 200).", "format": "int32", "type": "integer" } }, "title": "Pagination Info", "type": "object", "x-zs-llm-description": "Pagination metadata. Use 'more_records' to decide whether to fetch the next page." }, "FieldValueMismatch": { "additionalProperties": false, "description": "Represents the error response returned when the data type of the value supplied for a criterion field does not match the expected data type determined by the dependee field. Returned with error code DEPENDENT_MISMATCH. Contains details identifying the mismatched criterion field, its dependee field, and the expected data type.", "properties": { "code": { "description": "Represents the error code identifying the type of error condition encountered. Possible values: DEPENDENT_MISMATCH.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains detailed information about the data type mismatch, including the criterion field that raised the error, the dependee field whose value determines the expected data type, and the expected data type itself.", "properties": { "api_name": { "description": "API name of the criterion field whose value does not match the expected data type.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee field whose value determines the expected data type for the criterion field that raised the mismatch error. Contains the API name and JSON path of the dependee field.", "properties": { "api_name": { "description": "API name of the dependee field that determines the expected data type for the criterion field in error.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path locating the dependee field within the request body.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "expected_data_type": { "description": "Data type expected for the criterion field value, as determined by the dependee field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path locating the criterion field whose value contains the data type mismatch.", "maxLength": 512, "type": "string" } }, "required": [ "dependee", "api_name", "json_path", "expected_data_type" ], "type": "object" }, "message": { "description": "Descriptive message providing details about the field value mismatch error.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the response. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FieldValueMismatch" }, "FieldsApiName": { "description": "API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.", "example": "api_name30", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$id": "ApiName" }, "FieldsErrorResponse": { "additionalProperties": true, "anyOf": [ { "additionalProperties": false, "description": "Represents the error Response for invalid data.", "properties": { "code": { "description": "Represents the error code identifying the specific type or category of the error returned in the response.", "enum": [ "INVALID_DATA" ], "example": "INVALID_DATA", "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error Response for invalid data.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error, used to identify the specific field within the Zoho CRM module.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "CommonInvalidData" }, { "additionalProperties": false, "description": "Represents the request has invalid datatype", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 30, "type": "string" }, "expected_data_type": { "description": "Represents the name of the expected_data_type.", "example": "integer", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "DataTypeInvalidData" }, { "additionalProperties": false, "description": "Represents the request has invalid datatype", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 30, "type": "string" }, "json_path": { "description": "Represents the JSON path identifying the exact location of the offending field within the request payload.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "range": { "additionalProperties": false, "description": "Represents the name of the expected_data_type.", "properties": { "from": { "description": "Represents the start of the expected data type range.", "example": 0, "format": "int32", "type": "integer" }, "to": { "description": "Represents the end of the expected data type range.", "example": 100, "format": "int32", "type": "integer" } }, "type": "object" } }, "required": [ "api_name", "json_path", "range" ], "type": "object", "x-zs-$id": "RangeValidationResponse" }, { "additionalProperties": false, "description": "Represents the in uri the data passed is wrong.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path.", "example": 2, "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "ResourcePathInvalidData" }, { "additionalProperties": false, "description": "Indicates whether the given data is invalid for a list of values.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "supported_values": { "description": "Represents the list of supported values accepted for the JSON key identified by **api_name** and **json_path**.", "items": { "anyOf": [ { "description": "Represents the string values that can be present.", "example": "static_text", "maxLength": 255, "type": "string", "x-zs-$id": "SupportedValuesInvalidDataString" }, { "description": "Represents a Boolean value that can be present in the supported values list.", "type": "boolean", "x-zs-$id": "SupportedValuesInvalidDataBoolean" } ] }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "ValuesInvalidData" }, { "additionalProperties": false, "description": "Indicates whether the given data is invalid for a list of values.", "properties": { "allowed_values": { "description": "Represents the list of allowed values accepted for the JSON key identified by **api_name** and **json_path**.", "items": { "description": "Represents the values can be present.", "example": "static_text", "maxLength": 255, "type": "string" }, "maxItems": 25, "minItems": 1, "type": "array" }, "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path", "allowed_values" ], "type": "object", "x-zs-$id": "AllowedValuesInvalidData" }, { "additionalProperties": false, "description": "Represents the request has invalid datatype", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "maximum_length": { "description": "Represents the maximum lenght allowed.", "example": 5, "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "MaxLengthInvalidData" }, { "additionalProperties": false, "description": "Represents the request has invalid datatype", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "minimum_length": { "description": "Represents the minimum length allowed.", "example": 5, "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "minimum_length" ], "type": "object", "x-zs-$id": "MinLengthInvalidData" }, { "additionalProperties": false, "description": "Indicates whether the given data is invalid for a list of values.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "expected_data_type": { "description": "Represents the name of the expected_data_type.", "example": "integer", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "supported_values": { "description": "Represents the list of supported values accepted for the JSON key identified by **api_name** and **json_path**.", "items": { "description": "Represents the values can be present.", "example": "static_text", "maxLength": 255, "type": "string" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values", "expected_data_type" ], "type": "object", "x-zs-$id": "SupportedExpectedType" } ] }, "message": { "description": "Represents the error message describing the issue.", "example": "Given data seems to be invalid", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidDataResponse" }, { "additionalProperties": false, "description": "Represents the error response when the given module is invalid.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "INVALID_MODULE" ], "example": "INVALID_MODULE", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the invalid module details.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "The module name given seems to be invalid", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidModuleResponse" }, { "additionalProperties": false, "description": "Represents the error response when the given Expression is more length.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "DYNAMIC_EXPRESSION_LENGTH_EXCEEDED" ], "example": "DYNAMIC_EXPRESSION_LENGTH_EXCEEDED", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the length Exceeded details.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "dynamic", "maxLength": 25, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the maximum length allowed.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "expression", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].formula.expression", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object", "x-zs-$id": "DependeeDetails" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].formula.dynamic", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path", "dependee" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "dynamic expression length is too long", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DynamicExpressionLengthExceededResponse" }, { "additionalProperties": false, "description": "Represents the error response when a syntax error is error.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "SYNTAX_ERROR" ], "example": "SYNTAX_ERROR", "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the syntax error details.", "properties": { "api_name": { "description": "Represents the API name of the field with syntax error.", "example": "api_name", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with duplicate data.", "example": "$.fields[0].api_name", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "SyntaxErrorResponseDetails" }, { "additionalProperties": false, "description": "Represents the syntax error details.", "properties": { "api_name": { "description": "Represents the API name of the field with syntax error.", "example": "api_name", "maxLength": 25, "type": "string" }, "id": { "description": "Represents the id of the field with duplicate data.", "example": "$.fields[0].id", "format": "int64", "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with duplicate data.", "example": "$.fields[0].api_name", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path", "id" ], "type": "object", "x-zs-$id": "SyntaxErrorResponseDetails2" } ] }, "message": { "description": "Represents the error message describing the issue.", "enum": [ "Formula expression has syntax error" ], "example": "Formula expression has syntax error", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "SyntaxErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response when a field is already used.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "ALREADY_USED" ], "example": "ALREADY_USED", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the field that is already used.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "api_name", "maxLength": 25, "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Represents the field due to which dependent fields are expected.", "properties": { "api_name": { "description": "Represents the API name of the followed field.", "example": "api_name", "maxLength": 30, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].history_tracking.followed_fields[0].api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].history_tracking.followed_fields[1].api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Field is already used", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "AlreadyUsedResponse" }, { "additionalProperties": false, "description": "Represents the error response when a feature is not enabled.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "FEATURE_NOT_ENABLED" ], "example": "FEATURE_NOT_ENABLED", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the feature that is not enabled.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "api_name", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].history_tracking.followed_fields[1].api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "enum": [ "Duration Configuration enhancement not enabled." ], "example": "Duration Configuration enhancement not enabled.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "FeatureNotEnabledResponse" }, { "additionalProperties": false, "description": "Represents the error response when a feature is not supported.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "NOT_SUPPORTED" ], "example": "NOT_SUPPORTED", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the feature that is not supported.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "api_name", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].history_tracking.followed_fields[0].api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Field is already used", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "NotSupportedResponse" }, { "additionalProperties": false, "description": "Represents the error response when a feature is not supported.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "FEATURE_NOT_SUPPORTED" ], "example": "FEATURE_NOT_SUPPORTED", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the feature that is not supported.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "api_name", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].history_tracking.followed_fields[0].api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Field is already used", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "FeatureNotSupportedResponse" }, { "additionalProperties": false, "description": "Represents the error response when a missing braces error occurs.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "MISSING_BRACES" ], "example": "MISSING_BRACES", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing braces error.", "properties": { "api_name": { "description": "Represents the API name of the field with missing braces.", "enum": [ "expression" ], "example": "expression", "maxLength": 26, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with missing braces.", "example": "$.fields[0].expression", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "MissingBracesErrorResponseDetails" }, "message": { "description": "Represents the error message describing the issue.", "enum": [ "Some of brace is missing in given expression" ], "example": "Some of brace is missing in given expression", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "MissingBracesErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response when an incorrect number of parameters error occurs.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "INCORRECT_NUMBER_OF_PARAM" ], "example": "INCORRECT_NUMBER_OF_PARAM", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the incorrect number of parameters error.", "properties": { "api_name": { "description": "Represents the API name of the field with incorrect number of parameters.", "example": "expression", "maxLength": 26, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with incorrect number of parameters.", "example": "$.fields[0].formula.expression", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "IncorrectNumberOfParamResponseDetails" }, "message": { "description": "Represents the error message describing the issue.", "enum": [ "The number of param is incorrect for one of the method" ], "example": "The number of param is incorrect for one of the method", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "IncorrectNumberOfParamResponse" }, { "additionalProperties": false, "description": "Represents the error response when dependent field values do not match.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "DEPENDENT_MISMATCH" ], "example": "DEPENDENT_MISMATCH", "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the dependent mismatch details.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependice Details .", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object", "x-zs-$id": "DependenDetailtMismatchResponse" }, { "additionalProperties": false, "description": "Represents the dependent mismatch details.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependice Details .", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "range": { "additionalProperties": false, "description": "Represents the allowed numeric range.", "properties": { "from": { "description": "Represents the minimum allowed value.", "example": 1, "format": "int32", "type": "integer" }, "to": { "description": "Represents the maximum allowed value.", "example": 255, "format": "int32", "type": "integer" } }, "required": [ "from", "to" ], "type": "object" } }, "required": [ "dependee", "api_name", "json_path", "range" ], "type": "object", "x-zs-$id": "DependenWihtrangeDetailtMismatchResponse" }, { "additionalProperties": false, "description": "Indicates whether the given data is invalid for a list of values.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "supported_values": { "description": "Represents the list of supported values accepted for the JSON key identified by **api_name** and **json_path**.", "items": { "anyOf": [ { "description": "Represents the values can be present.", "example": "static_text", "maxLength": 255, "type": "string", "x-zs-$id": "StringSupportedValue" }, { "description": "Represents the values can be present.", "example": 1, "format": "int32", "type": "integer", "x-zs-$id": "IntegerSupportedValue" } ] }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "ValueDetailtMismatchResponse" }, { "additionalProperties": false, "description": "Represents the dependent mismatch details.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependice Details .", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "supported_values": { "description": "Represents the list of supported values that can be provided for the field.", "items": { "description": "Represents the supported value.", "maxLength": 255, "type": "string" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "dependee", "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "ValueAndDepDetailtMismatchResponse" }, { "additionalProperties": false, "description": "Represents the maximum length allowed.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependice Details .", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "maximum_length": { "description": "Represents the maximum length allowed.", "example": 5, "format": "int32", "type": "integer" } }, "required": [ "dependee", "maximum_length", "api_name", "json_path" ], "type": "object", "x-zs-$id": "DependentMaxLengthInvalidData" } ] }, "message": { "description": "Represents the error message describing the issue.", "example": "Dependent field value does not match", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DependentMismatchResponse" }, { "additionalProperties": false, "description": "Represents the error response when a configured limit is exceeded.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "LIMIT_EXCEEDED", "FIELD_LIMIT_EXCEEDED" ], "example": "LIMIT_EXCEEDED", "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the limit exceeded details.", "properties": { "limit": { "description": "Represents the maximum allowed limit.", "example": 5, "format": "int32", "type": "integer" }, "limit_due_to": { "description": "Represents the fields due to which the limit is exceeded.", "items": { "additionalProperties": false, "description": "Represents the field responsible for limit exceed.", "properties": { "api_name": { "description": "Represents the API name of the field.", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field.", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "LimitDueLimitExceededResponseDetail" }, { "additionalProperties": false, "description": "Represents the limit exceeded details.", "properties": { "limit": { "description": "Represents the maximum allowed limit.", "example": 5, "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "LimitExceededResponseDetailForLimitOnly" } ] }, "message": { "description": "Represents the error message describing the issue.", "example": "Configured limit exceeded", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "LimitExceededResponse" }, { "additionalProperties": false, "description": "Represents the error response when a dependent field is missing.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "example": "DEPENDENT_FIELD_MISSING", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the missing dependent field details.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the field due to which dependent fields are expected.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 30, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Dependent field is missing", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DependentFieldMissingResponse" }, { "additionalProperties": false, "description": "Represents the error response when expected fields are missing in the request.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "EXPECTED_FIELD_MISSING" ], "example": "EXPECTED_FIELD_MISSING", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the expected fields that are missing.", "properties": { "api_name": { "description": "Represents the API name of the expected field.", "example": "id", "maxLength": 25, "type": "string" }, "expected_fields": { "description": "Represents the list of expected fields that are missing.", "items": { "additionalProperties": false, "description": "Represents the field due to which dependent fields are expected.", "properties": { "api_name": { "description": "Represents the API name of the expected field.", "example": "id", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the expected field.", "example": "$.fields[0].lookup.id", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" }, "json_path": { "description": "Represents the JSON path of the expected field.", "example": "$.fields[0].lookup.id", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object", "x-zs-$id": "ExpectedFieldMissingResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "example": "Expected field is missing", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingResponse" }, { "additionalProperties": false, "description": "Represents the error response when ambiguity occurs during request processing.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "example": "AMBIGUITY_DURING_PROCESSING", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the fields causing ambiguity.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields causing ambiguity.", "items": { "additionalProperties": false, "description": "Represents the field due to which dependent fields are expected.", "properties": { "api_name": { "description": "Represents the API name of the ambiguous field.", "example": "api_name", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the ambiguous field.", "example": "$.fields[0].lookup.api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "AmbiguityDuringProcessingResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "example": "Ambiguity while processing the request", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "AmbiguityDuringProcessingResponse" }, { "additionalProperties": false, "description": "Represents the error response when expected dependent fields are missing.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "EXPECTED_DEPENDENT_FIELD_MISSING" ], "example": "EXPECTED_DEPENDENT_FIELD_MISSING", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of missing dependent fields.", "properties": { "dependee": { "additionalProperties": false, "description": "Represents the field due to which the dependent fields are expected.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "example": "restore_all_records", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the dependee field.", "example": "$.restore_all_records", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "expected_fields": { "description": "Represents the list of expected dependent fields that are missing.", "items": { "additionalProperties": false, "description": "Represents the field due to which dependent fields are expected.", "properties": { "api_name": { "description": "Represents the API name of the expected dependent field.", "example": "ids", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the expected dependent field.", "example": "$.ids", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "ExpectedDependentFieldMissingResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "example": "Expected dependent field is missing", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ExpectedDependentFieldMissingResponse" }, { "additionalProperties": false, "description": "Represents the error response when duplicate data is found.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "DUPLICATE_DATA" ], "example": "DUPLICATE_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the duplicate data details.", "properties": { "api_name": { "description": "Represents the API name of the field with duplicate data.", "example": "api_name", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with duplicate data.", "example": "$.fields[0].api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "type": "object", "x-zs-$id": "DuplicateDataResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "enum": [ "Duplicate option display_value", "Linking Module label is already Exist.", "duplicate data", "API NAME DUPLICATE", "Field label duplicate", "Duplicate related list name" ], "example": "duplicate data", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DuplicateDataResponse" }, { "additionalProperties": false, "description": "Represents the error response when a mandatory field is not found in the request.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "MANDATORY_NOT_FOUND" ], "example": "MANDATORY_NOT_FOUND", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the mandatory field that is missing.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field.", "example": "field_label", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the mandatory field.", "example": "$.fields[0].field_label", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "MandatoryNotFoundResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "example": "Mandatory field not found", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundResponse" }, { "additionalProperties": false, "description": "Represents the error response when a reserved system keyword is used.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "RESERVED_KEYWORD_NOT_ALLOWED" ], "example": "RESERVED_KEYWORD_NOT_ALLOWED", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the field containing a reserved keyword.", "properties": { "api_name": { "description": "Represents the API name of the field with reserved keyword.", "example": "api_name", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with reserved keyword.", "example": "$.fields[0].api_name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ReservedKeywordNotAllowedResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "example": "System keyword not allowed in api name", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ReservedKeywordNotAllowedResponse" }, { "additionalProperties": false, "description": "Represents the error response when the requested operation or field is not allowed.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "NOT_ALLOWED" ], "example": "NOT_ALLOWED", "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the details of why the operation is not allowed.", "properties": { "api_name": { "description": "Represents the API name of the field or operation.", "example": "unique", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field or operation.", "example": "$.fields[0].unique", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "NotAllowedResponseDetail" }, { "additionalProperties": false, "description": "Represents the details of why the operation is not allowed.", "properties": { "api_name": { "description": "Represents the API name of the field or operation.", "example": "unique", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field or operation.", "example": "$.fields[0].unique", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "limit": { "description": "Represents the limit of the field or operation.", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "limit" ], "type": "object", "x-zs-$id": "NotAllowedLimitResponse" }, { "additionalProperties": false, "description": "Represents the details of why the operation is not allowed.", "properties": { "api_name": { "description": "Represents the API name of the field or operation.", "example": "unique", "maxLength": 25, "type": "string" }, "id": { "description": "Represents the ID of the field or operation.", "example": "3708696000004384825", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field or operation.", "example": "$.fields[0].unique", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "limit": { "description": "Represents the limit of the field or operation.", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "limit", "id" ], "type": "object", "x-zs-$id": "NotAllowedIdResponse" }, { "additionalProperties": false, "description": "Represents the details of why the operation is not allowed.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path.", "example": 2, "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "NotAllowedResponseDetailForResourcePath" } ] }, "message": { "description": "Represents the error message describing the issue.", "example": "Operation is not allowed", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "NotAllowedResponse" }, { "additionalProperties": false, "description": "Represents the error response when one of the required parameters is missing.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "REQUIRED_PARAM_MISSING" ], "example": "REQUIRED_PARAM_MISSING", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required parameter.", "properties": { "param_name": { "description": "Represents the name of the missing request parameter.", "example": "ids", "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "RequiredParamMissingResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "example": "One of the expected parameter is missing", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingResponse" }, { "additionalProperties": false, "description": "Represents an error response indicating that the crypt property cannot be changed while the encryption/decryption scheduler is running.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "PROPERTY_LOCKED" ], "example": "PROPERTY_LOCKED", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error Response for invalid data.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "The module name given seems to be invalid", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "PropertyLockedResponse" }, { "additionalProperties": false, "description": "Represents an error response indicating that the crypt property cannot be changed because unsupported criteria were used.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "INVALID_DATA" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error Response for invalid data.", "properties": { "api_name": { "description": "Represents the API name of the global picklist.", "example": "Global_Status_Picklist", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the error.", "example": "$.fields[0].tooltip.name", "maxLength": 500, "pattern": "^\\$(\\.[a-zA-Z_][a-zA-Z0-9_]*|\\[[0-9]+\\])+$", "type": "string" }, "other_details": { "additionalProperties": false, "description": "Represents the response object containing an array of errors.", "properties": { "savedCVFilters": { "description": "Represents an array of field metadata objects.", "items": { "additionalProperties": false, "description": "Represents the customView unsupported criteria usage.", "properties": { "cvid": { "description": "Represents the id of the CustomView.", "example": "1385208000000973001", "format": "int64", "type": "string" }, "cvmodule": { "description": "Represents the module Name.", "example": "Leads", "maxLength": 50, "type": "string" }, "cvname": { "description": "Represents the customView Name.", "example": "All Open Leads", "maxLength": 100, "type": "string" } }, "required": [ "cvid", "cvmodule", "cvname" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "CustomViewUsage" } }, "required": [ "api_name", "json_path", "other_details" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "The module name given seems to be invalid", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "UnSupportedCriteriaResponse" }, { "additionalProperties": false, "description": "Represents the error response when the user does not have permission to perform the requested operation.", "properties": { "code": { "const": "NO_PERMISSION", "description": "Represents the error code for this error type.", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the permissions required to perform the operation.", "properties": { "permissions": { "description": "Represents the list of permissions required to perform the operation.", "items": { "description": "Represents the permission required to perform the operation.", "maxLength": 100, "type": "string" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "NoPermissionResponseDetail" }, "message": { "description": "Represents the error message describing the issue.", "example": "permission denied", "maxLength": 1000, "type": "string" }, "status": { "const": "error", "description": "Represents the response status.", "type": "string" } }, "type": "object", "x-zs-$id": "NoPermissionResponse" }, { "additionalProperties": false, "description": "Represents the error response when one of the required parameters is missing.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "INVALID_REQUEST_METHOD", "OAUTH_SCOPE_MISMATCH", "AUTHENTICATION_FAILURE", "INVALID_URL_PATTERN", "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents the additional error details.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "One of the expected parameter is missing", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error", "success" ], "example": "error", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "GeneralErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response when validation of the request body fails.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "INCORRECT_DATA_TYPE_PARAM" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the validation errors.", "properties": { "api_name": { "description": "Represents the API name of the field with incorrect data type.", "example": "length", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with incorrect data type.", "example": "$.fields[0].length", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Validation error in the request body", "maxLength": 255, "type": "string" }, "status": { "const": "error", "description": "Represents the response status.", "type": "string" } }, "type": "object", "x-zs-$id": "IncorrectDataTypeParamResponse" }, { "additionalProperties": false, "description": "Represents the error response when validation of the request body fails.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "PARTICIPATING_FIELD_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the validation errors.", "properties": { "api_name": { "description": "Represents the API name of the field with incorrect data type.", "example": "length", "maxLength": 25, "type": "string" }, "id": { "description": "Represents the ID of the field with incorrect data type.", "example": "1234567890", "maxLength": 25, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with incorrect data type.", "example": "$.fields[0].length", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path", "id" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Validation error in the request body", "maxLength": 255, "type": "string" }, "status": { "const": "error", "description": "Represents the response status.", "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ParticipatingFieldNotFoundResponse" } ], "description": "Represents the error response structure.", "type": "object", "x-zs-$id": "BadRequestErrorResponse" }, "FieldsFeatureNotSupportedError": { "additionalProperties": false, "description": "Represents the error response returned when the requested feature is not supported by the current license.", "properties": { "code": { "description": "Represents the error code for the unsupported feature error.", "enum": [ "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported feature error.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message indicating the feature is not supported.", "enum": [ "Your License does not support this feature" ], "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Feature Not Supported Error", "type": "object", "x-zs-$id": "FeatureNotSupportedError" }, "FieldsFieldSchema": { "additionalProperties": false, "description": "Represents the schema representing a field in the module.", "properties": { "additional_column": { "anyOf": [ { "description": "Represents the additional column of the field.", "example": "Custom_Column_1", "maxLength": 100, "type": "string", "x-zs-$id": "AdditionalColumnName" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "address": { "anyOf": [ { "additionalProperties": false, "description": "Represents the address details, if available.", "properties": { "type": { "description": "Represents the type of address.", "example": "shipping", "maxLength": 25, "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "AddressDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "api_name": { "$ref": "#/components/schemas/FieldsApiName", "x-zs-$id": "FieldsApiName" }, "associated_module": { "anyOf": [ { "additionalProperties": false, "description": "Represents the details of the associated module, such as a subform.", "properties": { "id": { "$ref": "#/components/schemas/FieldsId" }, "module": { "$ref": "#/components/schemas/FieldsModuleName" } }, "required": [ "id", "module" ], "type": "object", "x-zs-$id": "AssociatedModule" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "association_details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the association details of the lookup field, including the related field and the lookup field configuration in the connected module.", "properties": { "lookup_field": { "additionalProperties": false, "description": "Represents the details of the lookup field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "related_field": { "additionalProperties": false, "description": "Represents the details of the related field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "lookup_field", "related_field" ], "type": "object", "x-zs-$id": "AssociationDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "auto_number": { "anyOf": [ { "additionalProperties": false, "description": "Represents the auto number details of the field.", "properties": { "prefix": { "anyOf": [ { "description": "Represents the prefix for the auto number.", "example": "ORD-", "maxLength": 25, "type": "string", "x-zs-$id": "Prefix" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "start_number": { "description": "Represents the starting number for the auto number.", "example": 100, "format": "int32", "type": "number" }, "starting_number_length": { "description": "Represents the length of the starting number.", "example": 5, "format": "int32", "type": "number" }, "suffix": { "anyOf": [ { "description": "Represents the suffix for the auto number.", "example": "-2024", "maxLength": 25, "type": "string", "x-zs-$id": "Suffix" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] } }, "type": "object", "x-zs-$id": "AutoNumberDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "blueprint_supported": { "description": "Indicates whether the field is supported in Blueprint configurations.", "example": true, "type": "boolean" }, "businesscard_supported": { "description": "Indicates whether the field can be added to the business card section.", "example": false, "type": "boolean" }, "child_fields": { "anyOf": [ { "description": "Represents the list of child fields associated with the Address field.", "items": { "additionalProperties": false, "description": "Represents the details of a child Address fields.", "properties": { "field": { "additionalProperties": false, "description": "Represents the details of the child Address field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "name": { "description": "Represents the name of the child Address field.", "example": "Address 1 - City", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id", "name" ], "type": "object" }, "sequence_number": { "description": "Represents the sequence number of the child field present in the Address field.", "example": 1, "format": "int32", "type": "number" } }, "required": [ "field", "sequence_number" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "ChildFields" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "colour_code_enabled_by_system": { "description": "Indicates whether colour coding is enabled for this field by the system.", "example": false, "type": "boolean" }, "column_name": { "description": "Represents the column name of the field.", "example": "WEBSITE", "maxLength": 100, "type": "string" }, "convert_mapping": { "additionalProperties": false, "description": "Represents the convert mapping details of the field.", "properties": { "Accounts": { "anyOf": [ { "description": "Represents the mapping details for Contacts field name.", "example": "Contact_Name", "maxLength": 100, "type": "string", "x-zs-$id": "AccountFieldName" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "Contacts": { "anyOf": [ { "description": "Represents the mapping details for Contacts field name.", "example": "Contact_Name", "maxLength": 100, "type": "string", "x-zs-$id": "ContactFieldName" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "Deals": { "anyOf": [ { "description": "Represents the mapping details for Contacts field name.", "example": "Contact_Name", "maxLength": 100, "type": "string", "x-zs-$id": "DealFieldName" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "Invoices": { "anyOf": [ { "description": "Represents the mapping details for Invoices field name.", "example": "Invoice_Name", "maxLength": 100, "type": "string", "x-zs-$id": "InvoiceFieldName" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "Sales_Orders": { "anyOf": [ { "description": "Represents the mapping details for Sales Orders field name.", "example": "Sales_Order_Name", "maxLength": 100, "type": "string", "x-zs-$id": "SalesOrderFieldName" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] } }, "type": "object" }, "created_source": { "description": "Represents the source from which the field was created.", "example": "api", "maxLength": 60, "type": "string" }, "created_time": { "anyOf": [ { "description": "Represents the time when the record was created.", "example": "2023-10-03T12:00:00+05:30", "format": "date-time", "type": "string", "x-zs-$id": "CreatedTime" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "crypt": { "anyOf": [ { "additionalProperties": false, "description": "Represents the encryption configuration of the field when encryption is enabled.", "properties": { "encrypt_case": { "anyOf": [ { "description": "Represents the details of the encryption case.", "example": "lowercase", "maxLength": 25, "type": "string", "x-zs-$id": "EncryptCase" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "mode": { "description": "Represents the encryption mode used.", "example": "encryption", "maxLength": 25, "type": "string" }, "status": { "description": "Represents the status of the encryption.", "example": 1, "format": "int32", "type": "number" } }, "required": [ "mode", "status" ], "type": "object", "x-zs-$id": "CryptDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "currency": { "anyOf": [ { "additionalProperties": false, "description": "Represents the currency configuration of the field, including precision, rounding option, and currency code.", "properties": { "precision": { "description": "Represents the precision of the currency.", "example": 2, "format": "int32", "type": "number" }, "rounding_option": { "description": "Represents the rounding option for the currency.", "example": "Round Off", "maxLength": 25, "type": "string" } }, "type": "object", "x-zs-$id": "CurrencyDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "custom_field": { "description": "Indicates if the field is a custom field.", "example": true, "type": "boolean" }, "customizable_properties": { "anyOf": [ { "description": "Represents the customizable properties of the field.", "items": { "description": "Represents a customizable property of the field.", "example": "mandatory", "maxLength": 50, "type": "string" }, "maxItems": 100, "type": "array", "x-zs-$id": "CustomizableProperties" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "data_type": { "description": "Represents the data type of the field.", "example": "Text", "maxLength": 25, "type": "string" }, "decimal_place": { "anyOf": [ { "description": "Represents the number of decimal places for the field.", "example": 2, "format": "int32", "type": "number", "x-zs-$id": "DecimalPlaces" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "display_field": { "description": "Indicates if the field is a display field.", "example": false, "type": "boolean" }, "display_format": { "anyOf": [ { "description": "Represents the display format applied to the field value, such as the date or date-time pattern shown in the user interface.", "example": "dd-MM-yyyy HH:mm:ss", "maxLength": 50, "type": "string", "x-zs-$id": "DisplayFormat" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "display_format_properties": { "anyOf": [ { "additionalProperties": false, "description": "Represents the display format configuration for the field, including the phone-number split value and radio-button display type.", "properties": { "radio_display_type": { "description": "Represents the display type applied to radio button fields, such as **all** or **vertical**.", "example": "all", "maxLength": 25, "type": "string" }, "split": { "description": "Represents the split value applied to phone number fields, which divides the number into the specified number of segments.", "example": 3, "format": "int32", "type": "number" } }, "type": "object", "x-zs-$id": "DisplayFormatProperties" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "display_label": { "description": "Represents the display label of the field.", "example": "Last Name", "maxLength": 50, "type": "string" }, "display_type": { "description": "Represents the display type of the field.", "example": 1, "format": "int32", "type": "number" }, "email_parser": { "additionalProperties": false, "description": "Represents the email parser details of the field.", "properties": { "fields_update_supported": { "description": "Indicates if field updates are supported by email parser.", "example": true, "type": "boolean" }, "record_operations_supported": { "description": "Indicates if record operations are supported by email parser.", "example": true, "type": "boolean" } }, "required": [ "fields_update_supported", "record_operations_supported" ], "type": "object" }, "enable_colour_code": { "description": "Indicates if colour code is enabled for the field.", "example": false, "type": "boolean" }, "enable_record_category": { "description": "Indicates if the record category feature is enabled for this picklist field. Only returned when the record category feature is available.", "example": false, "type": "boolean" }, "enable_transition_for_record_category": { "description": "Indicates if transitions between record categories are enabled. Only returned when enable_record_category is true.", "example": false, "type": "boolean" }, "external": { "anyOf": [ { "additionalProperties": false, "description": "Represents the external field configuration of the field, including its visibility and type when integrated with an external system.", "properties": { "show": { "description": "Indicates if the external field is shown.", "example": true, "type": "boolean" }, "type": { "description": "Indicates the type of the external field.", "example": "org", "maxLength": 50, "type": "string" } }, "required": [ "show", "type" ], "type": "object", "x-zs-$id": "External" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "field_label": { "description": "Represents the display name of the field in the user's preferred language.", "example": "Last Name", "maxLength": 100, "type": "string" }, "field_read_only": { "description": "Indicates whether the field is always read-only and cannot be edited under any circumstances.", "example": false, "type": "boolean" }, "filterable": { "description": "Indicates if the field is filterable.", "example": true, "type": "boolean" }, "formula": { "anyOf": [ { "additionalProperties": false, "description": "Represents the formula details of the field.", "properties": { "assume_default": { "description": "Indicates if the formula should assume default values.", "example": true, "type": "boolean" }, "dynamic": { "description": "Indicates if the formula is dynamic.", "example": false, "type": "boolean" }, "return_type": { "description": "Represents the return type of the formula.", "example": "number", "maxLength": 50, "type": "string" }, "stop_compute_conditionally": { "description": "Indicates if the formula computation should stop conditionally.", "example": false, "type": "boolean" }, "sub_return_type": { "description": "Represents the sub-type of the formula return value, such as the specific string subtype when the return type is a string.", "example": "small", "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "FormulaDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "global_picklist": { "anyOf": [ { "additionalProperties": false, "description": "Represents the global picklist details linked to the field, identified by its API name and unique ID.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "GlobalPicklistDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "hipaa_compliance": { "anyOf": [ { "additionalProperties": false, "description": "Represents the HIPAA compliance configuration of the field, including restrictions applied during access and export.", "properties": { "restricted": { "description": "Indicates if the field is restricted.", "example": false, "type": "boolean" }, "restricted_in_export": { "description": "Indicates if the field is restricted in export.", "example": false, "type": "boolean" } }, "required": [ "restricted", "restricted_in_export" ], "type": "object", "x-zs-$id": "HipaaCompliance" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "hipaa_compliance_enabled": { "description": "Indicates if HIPAA compliance is enabled for the field.", "example": false, "type": "boolean" }, "history_tracking": { "anyOf": [ { "additionalProperties": false, "description": "Represents the history tracking details of the field.", "properties": { "duration_configuration": { "description": "Represents the duration configuration for history tracking.", "example": "7_DAYS", "maxLength": 120, "type": "string" }, "duration_configured_field": { "additionalProperties": false, "description": "Represents the duration configured field details for history tracking.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "followed_fields": { "description": "Represents the list of fields being followed for history tracking.", "items": { "additionalProperties": false, "description": "Represents the details of a followed field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "module": { "additionalProperties": false, "description": "Represents the module details for history tracking.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "related_list_name": { "description": "Represents the name of the related list for history tracking.", "example": "Module_Histories", "maxLength": 100, "type": "string" } }, "required": [ "duration_configuration", "duration_configured_field", "followed_fields", "module", "related_list_name" ], "type": "object", "x-zs-$id": "HistoryTrackingDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "history_tracking_enabled": { "description": "Indicates if history tracking is enabled for the field.", "example": false, "type": "boolean" }, "id": { "$ref": "#/components/schemas/FieldsId", "x-zs-$id": "FieldsId" }, "json_type": { "description": "Represents the jSON type of the field.", "example": "string", "maxLength": 25, "type": "string" }, "layout_associations": { "description": "Represents the list of layout associations for the field.", "items": { "additionalProperties": false, "description": "Represents the layout association details.", "properties": { "api_name": { "description": "Represents the API name of the layout.", "example": "Standard_Layout", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "name": { "description": "Represents the name of the layout.", "example": "Standard Layout", "maxLength": 25, "type": "string" } }, "required": [ "api_name", "id", "name" ], "type": "object" }, "maxItems": 100, "type": "array" }, "length": { "description": "Represents the length of the field.", "example": 255, "format": "int32", "type": "number" }, "lookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the lookup field details.", "properties": { "api_name": { "anyOf": [ { "$ref": "#/components/schemas/FieldsApiName" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "display_label": { "anyOf": [ { "description": "Display label of the lookup field", "example": "Related List Label 1", "maxLength": 50, "type": "string", "x-zs-$id": "LookupDisplayLabel" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "id": { "anyOf": [ { "$ref": "#/components/schemas/FieldsId" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "module": { "additionalProperties": false, "description": "Represents the module details for the lookup field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "crypt": { "description": "Indicates if the module is encrypted.", "example": false, "type": "boolean" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "crypt", "id" ], "type": "object" }, "query_details": { "additionalProperties": false, "description": "Represents the query details for the lookup field.", "properties": { "query_id": { "description": "Represents the query ID for the lookup field.", "example": "4832675000000850800", "format": "int64", "maxLength": 30, "type": "string" }, "system_query_id": { "anyOf": [ { "description": "Represents the system query ID for the lookup field.", "example": "4832675000000850800", "format": "int64", "maxLength": 30, "type": "string", "x-zs-$id": "SystemQueryId" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] } }, "required": [ "system_query_id" ], "type": "object" }, "revalidate_filter_during_edit": { "description": "Indicates if the filter should be revalidated during edit.", "example": true, "type": "boolean" } }, "type": "object", "x-zs-$id": "LookupDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "mask_details": { "anyOf": [ { "additionalProperties": true, "description": "If field masking is enabled for the field, it will return the masking information; otherwise null.", "type": "object", "x-zs-$id": "MaskDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "mass_update": { "description": "Indicates if mass update is enabled for the field.", "example": true, "type": "boolean" }, "modified_time": { "anyOf": [ { "description": "Represents the time when the record was last modified.", "example": "2023-10-05T15:30:00+05:30", "format": "date-time", "type": "string", "x-zs-$id": "ModifiedTime" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "multi_module_lookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the multi-module lookup configuration of the field, including the display label, API name, and the list of modules the lookup references.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "display_label": { "description": "Represents the display label of the multi module lookup.", "example": "Appointments", "maxLength": 50, "type": "string" }, "modules": { "description": "Represents the list of modules associated with the multi module lookup.", "items": { "additionalProperties": false, "description": "Represents the details of the module.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "module_name": { "description": "Represents the name of the module.", "example": "Leads", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "id", "module_name" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "MultiModuleLookup" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "multiselectlookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the multi-module lookup details of the field.", "properties": { "connected_details": { "additionalProperties": false, "description": "Represents the connected details for the multi-module lookup.", "properties": { "field": { "additionalProperties": false, "description": "Represents the field details for the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "field_label": { "description": "Represents the field label of the field.", "example": "Account Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "layouts": { "description": "Represents the list of layouts associated with the multi-module lookup.", "items": { "additionalProperties": false, "description": "Represents the layout details for the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "module": { "additionalProperties": false, "description": "Represents the module details for the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "plural_label": { "description": "Represents the plural label of the module.", "example": "Accounts", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "id", "plural_label" ], "type": "object" } }, "required": [ "field", "layouts", "module" ], "type": "object" }, "linking_details": { "additionalProperties": false, "description": "Represents the linking details for the multi-module lookup.", "properties": { "connected_lookup_field": { "additionalProperties": false, "description": "Represents the connected lookup field details for the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "field_label": { "description": "Represents the field label of the connected lookup field.", "example": "Account Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field details for the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "field_label": { "description": "Represents the field label of the lookup field.", "example": "Contact Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Represents the module details for the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "plural_label": { "description": "Represents the plural label of the module.", "example": "Contacts", "maxLength": 50, "type": "string" }, "visibility": { "description": "Represents the visibility of the module.", "example": 1, "format": "int32", "type": "number" } }, "required": [ "api_name", "id", "plural_label", "visibility" ], "type": "object" } }, "required": [ "connected_lookup_field", "lookup_field", "module" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Represents the related list details for the multi-module lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "display_label": { "description": "Represents the display label of the related list.", "example": "Related List Label 1", "maxLength": 25, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "display_label", "id" ], "type": "object" } }, "type": "object", "x-zs-$id": "MultiModuleLookupDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "multiuserlookup": { "additionalProperties": false, "description": "Represents the multi-user lookup details of the field.", "properties": { "linking_details": { "additionalProperties": false, "description": "Represents the linking details for the multi-user lookup.", "properties": { "connected_lookup_field": { "additionalProperties": false, "description": "Represents the connected lookup field details for the multi-user lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "field_label": { "description": "Represents the label of the connected lookup field.", "example": "Role Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field details for the multi-user lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "field_label": { "description": "Represents the label of the lookup field.", "example": "User Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Represents the module details for the multi-user lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "plural_label": { "description": "Represents the plural label of the module.", "example": "Users", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "id", "plural_label" ], "type": "object" } }, "required": [ "connected_lookup_field", "lookup_field", "module" ], "type": "object" }, "record_access": { "description": "Indicates if record access is enabled for the multi-user lookup.", "example": true, "type": "boolean" } }, "required": [ "linking_details", "record_access" ], "type": "object" }, "operation_type": { "additionalProperties": false, "description": "Represents the operation types allowed for the field.", "properties": { "api_create": { "description": "Indicates whether the field can be created through the API.", "example": false, "type": "boolean" }, "api_update": { "description": "Indicates whether the field can be updated through the API.", "example": false, "type": "boolean" }, "web_create": { "description": "Indicates whether the field can be created through the web.", "example": false, "type": "boolean" }, "web_update": { "description": "Indicates whether the field can be updated through the web.", "example": false, "type": "boolean" } }, "required": [ "api_create", "api_update", "web_create", "web_update" ], "type": "object" }, "parent_field": { "anyOf": [ { "additionalProperties": false, "description": "Represents the parent field of the current field, applicable to subfields such as address coordinates that belong to a composite parent field.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" }, "name": { "description": "Represents the name of the parent field.", "example": "Address 1 - Coordinates", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "id", "name" ], "type": "object", "x-zs-$id": "ParentField" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "pick_list_values": { "anyOf": [ { "description": "Represents the list of picklist values configured for the field, applicable to picklist and multi-select picklist fields.", "items": { "additionalProperties": false, "description": "Represents the details of a picklist value, including its display value, actual value, sequence number, and color code.", "properties": { "actual_value": { "description": "Represents the actual stored value of the picklist option.", "example": "Option 1", "maxLength": 120, "type": "string" }, "colour_code": { "description": "Represents the colour code associated with the picklist option.", "example": "#FF5733", "maxLength": 20, "type": "string" }, "display_value": { "description": "Represents the display value of the picklist option shown in the user interface.", "example": "Option 1", "maxLength": 120, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId", "x-zs-$id": "FieldsPickListValuesId" }, "record_category_value": { "additionalProperties": false, "description": "Reference to an existing record category value mapped to this picklist option. **At least one identifier must be provided**: `id`, `rid`, or `api_name`. Multiple identifiers can be provided for validation purposes. Server-side validation enforces this requirement.", "properties": { "api_name": { "description": "API name of the record category value", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the record category value", "format": "int64", "type": "string" } }, "type": "object" }, "reference_value": { "description": "Represents the reference value of the picklist option used by integrations and reports.", "example": "option_1", "maxLength": 120, "type": "string" }, "sequence_number": { "description": "Represents the order position of the picklist option in the dropdown list.", "example": 1, "format": "int32", "type": "number" }, "type": { "description": "Represents whether the picklist option is used or unused in the module.", "example": "standard", "maxLength": 50, "type": "string" } }, "required": [ "actual_value", "display_value", "id", "reference_value", "sequence_number", "type" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "PickListValues" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "pick_list_values_sorted_lexically": { "description": "Indicates whether the picklist values are sorted alphabetically.", "example": false, "type": "boolean" }, "private": { "anyOf": [ { "additionalProperties": false, "description": "Represents the privacy configuration of the field, including the restriction type, access restrictions, and export restrictions applied to sensitive data.", "properties": { "export": { "description": "Indicates if the field is exportable.", "example": false, "type": "boolean" }, "restricted": { "description": "Indicates if the field is restricted.", "example": false, "type": "boolean" }, "type": { "description": "Represents the type of privacy.", "example": "High", "maxLength": 25, "type": "string" } }, "required": [ "export", "restricted", "type" ], "type": "object", "x-zs-$id": "PrivateField" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "profiles": { "description": "Represents the list of profiles associated with the field.", "items": { "additionalProperties": false, "description": "Represents the profile details.", "properties": { "id": { "$ref": "#/components/schemas/FieldsId" }, "name": { "description": "Represents the name of the profile.", "example": "Administrator", "maxLength": 60, "type": "string" }, "permission_type": { "description": "Represents the type of permission granted.", "example": "read_write", "maxLength": 25, "type": "string" } }, "required": [ "id", "name", "permission_type" ], "type": "object" }, "maxItems": 50, "type": "array" }, "public": { "description": "Indicates if the field is public.", "example": true, "type": "boolean" }, "quick_sequence_number": { "description": "Represents the quick sequence number of the field.", "example": "1", "maxLength": 10, "type": "string" }, "range": { "anyOf": [ { "additionalProperties": false, "description": "Represents the numeric range allowed for the field, defined by the **from** and **to** values.", "properties": { "from": { "description": "Represents the starting value of the range.", "example": 1, "format": "double", "type": "number" }, "to": { "description": "Represents the ending value of the range.", "example": 100, "format": "double", "type": "number" } }, "required": [ "from", "to" ], "type": "object", "x-zs-$id": "RangeDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "read_only": { "description": "Indicates whether the field is read-only for the current user.", "example": false, "type": "boolean" }, "record_category_tracking_field": { "anyOf": [ { "additionalProperties": false, "description": "Field reference for tracking record category changes.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName", "description": "API name of the tracking field." }, "id": { "$ref": "#/components/schemas/FieldsId", "description": "Unique identifier of the tracking field." } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "RecordCategoryTrackingFieldStructure" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ], "description": "Reference to the field used to track record category changes over time in the timeline view. Only present when enable_record_category is true and a tracking field is configured." }, "record_category_values": { "description": "List of record category values defined for this picklist field. Only returned when enable_record_category is true.", "items": { "additionalProperties": false, "description": "Individual record category configuration.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName", "description": "API name of the record category." }, "id": { "$ref": "#/components/schemas/FieldsId", "description": "Unique identifier of the record category." }, "nature_of_category": { "description": "Nature of the record category indicating sentiment or outcome.", "enum": [ "none", "thumbs_up", "thumbs_down" ], "example": "thumbs_up", "type": "string" }, "value": { "description": "Display value of the record category.", "example": "Closed Won", "maxLength": 120, "type": "string" } }, "required": [ "id", "api_name", "value", "nature_of_category" ], "type": "object" }, "maxItems": 50, "type": "array" }, "reference_id": { "$ref": "#/components/schemas/FieldsReferenceId" }, "rollup_summary": { "anyOf": [ { "additionalProperties": false, "description": "Represents the rollup summary details, if available.", "properties": { "based_on_module": { "additionalProperties": false, "description": "Represents the module on which the rollup summary is based.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "expression": { "additionalProperties": false, "description": "Represents the expression details of the rollup summary.", "properties": { "criteria": { "anyOf": [ { "additionalProperties": false, "description": "Represents the criteria details for the rollup summary.", "properties": { "comparator": { "description": "Represents the comparator used in the criteria.", "example": "equals", "maxLength": 25, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the details of the field used in the criteria.", "properties": { "api_name": { "description": "Represents the API name of the field.", "example": "Status", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Represents the type of the criteria.", "example": "custom", "maxLength": 25, "type": "string" }, "value": { "description": "Represents the value used in the criteria.", "example": "Approved", "maxLength": 100, "type": "string" } }, "required": [ "comparator", "field", "type", "value" ], "type": "object", "x-zs-$id": "RollupCriteria" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "function": { "description": "Represents the function used in the rollup summary.", "example": "SUM", "maxLength": 25, "type": "string" }, "function_parameters": { "description": "Represents the list of function parameters for the rollup summary.", "items": { "additionalProperties": false, "description": "Represents the details of a function parameter.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "function", "function_parameters" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Represents the related list details for the rollup summary.", "properties": { "api_name": { "$ref": "#/components/schemas/FieldsApiName" }, "id": { "$ref": "#/components/schemas/FieldsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "return_type": { "description": "Represents the return type of the rollup summary.", "example": "number", "maxLength": 50, "type": "string" }, "rollup_based_on": { "description": "Indicates what the rollup is based on.", "example": "Created_Time", "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "RollupSummaryDetails" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "searchable": { "description": "Indicates if the field is searchable.", "example": true, "type": "boolean" }, "separator": { "description": "Indicates if the field is a separator.", "example": false, "type": "boolean" }, "sharing_properties": { "additionalProperties": false, "description": "Represents the sharing properties of the field.", "properties": { "scheduler_status": { "description": "Represents the scheduler status for sharing.", "example": "enabled", "maxLength": 50, "type": "string" }, "share_permission": { "description": "Represents the share permission for the field.", "example": "read_write", "maxLength": 50, "type": "string" }, "share_preference_enabled": { "description": "Indicates if share preference is enabled.", "example": true, "type": "boolean" } }, "required": [ "scheduler_status", "share_permission", "share_preference_enabled" ], "type": "object" }, "sortable": { "description": "Indicates if the field is sortable.", "example": true, "type": "boolean" }, "static_field": { "description": "Indicates if the field is a static field", "example": false, "type": "boolean" }, "system_mandatory": { "description": "Indicates if the field is system mandatory.", "example": false, "type": "boolean" }, "textarea": { "additionalProperties": false, "description": "Represents the textarea field details.", "properties": { "type": { "description": "Represents the type of the textarea.", "example": "Large", "maxLength": 50, "type": "string" } }, "required": [ "type" ], "type": "object" }, "tooltip": { "anyOf": [ { "additionalProperties": false, "description": "Represents the tooltip configuration for the field, including the tooltip type and displayed message.", "properties": { "name": { "description": "Represents the it gives the name of the tool tip.", "example": "info_icon", "maxLength": 25, "type": "string" }, "value": { "description": "Represents the text for the tool tip.", "example": "Last Name", "maxLength": 255, "type": "string" } }, "required": [ "name", "value" ], "type": "object", "x-zs-$id": "ToolTip" }, { "$ref": "#/components/schemas/FieldsTypeNull" } ] }, "type": { "description": "Represents the type of the field used or unused.", "example": "user", "maxLength": 25, "type": "string" }, "ui_type": { "description": "Represents the UI type of the field.", "example": 1, "format": "int32", "type": "number" }, "unique": { "additionalProperties": false, "description": "Represents the uniqueness details of the field.", "properties": { "case_sensitive": { "description": "Indicates if the uniqueness is case sensitive.", "example": false, "type": "boolean" } }, "type": "object" }, "view_type": { "additionalProperties": false, "description": "Represents the view type details of the field.", "properties": { "create": { "description": "Indicates if the field supports create.", "example": true, "type": "boolean" }, "edit": { "description": "Indicates if the field is editable.", "example": true, "type": "boolean" }, "quick_create": { "description": "Indicates if the field supports quick create.", "example": true, "type": "boolean" }, "view": { "description": "Indicates if the field is viewable.", "example": true, "type": "boolean" } }, "required": [ "create", "edit", "quick_create", "view" ], "type": "object" }, "virtual_field": { "description": "Indicates if the field is a virtual field.", "example": false, "type": "boolean" }, "visible": { "description": "Indicates if the field is visible.", "example": true, "type": "boolean" }, "webhook": { "description": "Indicates whether webhook is enabled for the field.", "example": false, "type": "boolean" } }, "required": [ "api_name", "association_details", "auto_number", "businesscard_supported", "colour_code_enabled_by_system", "created_source", "currency", "custom_field", "data_type", "display_field", "display_label", "display_type", "email_parser", "enable_colour_code", "external", "field_label", "field_read_only", "filterable", "formula", "history_tracking_enabled", "id", "lookup", "mass_update", "multi_module_lookup", "operation_type", "pick_list_values", "pick_list_values_sorted_lexically", "profiles", "public", "range", "read_only", "rollup_summary", "searchable", "separator", "sortable", "system_mandatory", "type", "ui_type", "unique", "view_type", "virtual_field", "visible", "webhook" ], "type": "object" }, "FieldsId": { "description": "Id of the resource.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$id": "Id" }, "FieldsInternalServerError": { "additionalProperties": false, "description": "Represents the internal server error response, including the error code, message, and additional details.", "properties": { "code": { "const": "INTERNAL_ERROR", "description": "Represents the error code indicating the type of server-side failure.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the internal server error.", "type": "object" }, "message": { "description": "Represents the error message describing the server failure.", "maxLength": 255, "type": "string" }, "status": { "const": "error", "description": "Represents the status of the response.", "maxLength": 50, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InternalServerError" }, "FieldsInvalidModuleError": { "additionalProperties": false, "description": "Represents the error response returned when the provided module name is invalid or not recognized.", "properties": { "code": { "description": "Represents the error code for the invalid module error.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the invalid module error.", "properties": { "param_name": { "description": "Represents the name of the query parameter that contains the invalid module name.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message indicating the module name is invalid.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Error", "type": "object", "x-zs-$id": "InvalidModuleError" }, "FieldsModuleName": { "description": "Represents the name of the module.", "example": "Leads", "maxLength": 100, "type": "string" }, "FieldsModuleReference": { "additionalProperties": false, "description": "Represents the lightweight reference to the CRM module targeted by the scheduled job, including the module API name and unique identifier.", "properties": { "api_name": { "description": "Represents the API name of the module.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the module Id.", "maxLength": 20, "minLength": 13, "type": "string" } }, "required": [ "api_name", "id" ], "title": "Module Reference", "type": "object" }, "FieldsNested": { "additionalProperties": false, "description": "Represents a field that is accessible to portal users for the configured module. Includes the field's unique identifier, API name, read-only flag, and the list of per-field CRUD permissions.", "properties": { "api_name": { "description": "The API name of the CRM field accessible to portal users within this module.", "example": "api_name30", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsApiName" } ], "resource": "fields" } }, "id": { "description": "The unique numeric identifier of the CRM field.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" } ], "resource": "fields" } }, "permissions": { "description": "Represents the list of CRUD permission entries that control what portal users can do with this field.", "items": { "additionalProperties": false, "description": "A permission entry that specifies what portal users can do with a specific CRUD action (create, edit, delete, or view) for this field.", "properties": { "create": { "description": "Whether portal users can set a value for this field when creating a record.", "type": "boolean" }, "delete": { "description": "Whether portal users can delete records that have this field.", "type": "boolean" }, "edit": { "description": "Whether portal users can edit the value of this field on existing records.", "type": "boolean" }, "iscustomizable": { "description": "Whether the field permission for this action can be customized per portal user type.", "type": "boolean" }, "view": { "description": "Whether portal users can view the value of this field.", "type": "boolean" } }, "required": [ "iscustomizable" ], "type": "object" }, "maxItems": 25, "type": "array" }, "read_only": { "description": "Denotes whether the field is read-only for portal users. When `true`, portal users can view the field value but cannot modify it.", "type": [ "boolean", "null" ] } }, "type": "object" }, "FieldsPermissionDeniedError": { "additionalProperties": false, "description": "Represents the error response returned when the caller does not have the required permission to perform the requested operation.", "properties": { "code": { "description": "Represents the error code for the permission denied error.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the permission denied error, including the required CRM permissions.", "properties": { "permissions": { "description": "Represents the list of CRM permissions required to perform the requested operation.", "items": { "description": "Represents a single CRM permission required to perform the requested operation.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message indicating permission was denied.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Permission Denied Error", "type": "object", "x-zs-$id": "PermissionDeniedError" }, "FieldsReferenceId": { "description": "Represents the temporary identifier used to reference a screen within the same wizard request payload.", "example": "{{12345}}", "maxLength": 255, "pattern": "\\{\\{[a-zA-Z0-9]+\\}\\}", "type": "string" }, "FieldsTypeNull": { "description": "Represents the null if no information is available.", "type": "null", "x-zs-$id": "TypeNull" }, "FilterComparatorValueMismatch": { "additionalProperties": false, "description": "Represents an error returned when a value associated with a filter comparator fails validation due to constraints imposed by a dependee field. This error targets the value driven by the comparator rather than the comparator operator selection itself.", "properties": { "code": { "description": "Indicates the classification of the error.\nPossible values:\n**DEPENDENT_MISMATCH** - The comparator-driven value failed validation due to constraints imposed by the dependee field.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured diagnostic details identifying the filter field whose comparator-driven value failed dependency validation, including the controlling dependee field reference.", "properties": { "api_name": { "description": "Represents the API name of the filter field whose supplied value does not match the requirements of the comparator operator in use.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee field whose state or constraints govern the validation rules applied to the comparator value of the current filter field.", "properties": { "api_name": { "description": "Indicates the API name of the dependee field whose constraints triggered the comparator value validation failure.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path locating the dependee field within the request structure whose constraints govern the comparator value validation.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path locating the specific filter field whose value is incompatible with the comparator operator applied to it.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Represents the filter-specific parameter name identifying the request parameter associated with the comparator value mismatch.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Contains a descriptive error message summarizing the comparator-value mismatch encountered in the filter request.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome status of the response.\nPossible values:\n**error** - The request failed because the comparator-driven value did not satisfy dependency validation rules.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterComparatorValueMismatch" }, "FilterCondition": { "additionalProperties": false, "description": "A single filter condition specifying the field, comparator, and value to evaluate.", "properties": { "comparator": { "description": "Comparison operator used to evaluate the condition against the field value.", "example": "equal", "maxLength": 25, "type": "string" }, "field": { "additionalProperties": false, "description": "Field to apply the filter condition on.", "properties": { "api_name": { "description": "Represents the API name of the field to filter by.", "example": "name", "maxLength": 100, "type": "string" }, "data_type": { "description": "Indicates the data type of the field being filtered.", "example": "text", "maxLength": 50, "type": "string" }, "field_label": { "description": "Indicates the display label of the field being filtered.", "example": "Profile Name", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "type": { "description": "Specifies the type of the value used in the comparison, such as string or integer.", "example": "value", "maxLength": 25, "type": "string" }, "value": { "description": "The value to compare against the specified field using the comparator.", "example": "Administrator", "maxLength": 255, "type": "string" } }, "required": [ "field", "comparator", "value", "type" ], "type": "object", "x-zs-$id": "FilterCondition" }, "FilterCriteria": { "additionalProperties": false, "description": "Represents the field-based filter criteria applied to related records before counting. Contains the field to evaluate, the comparison operator, and the value to compare against.", "properties": { "comparator": { "description": "Represents the comparison operator used to filter related records before counting.\nPossible values:\n**equal** - Matches records where the specified field value equals the given value.", "enum": [ "equal" ], "type": "string" }, "field": { "$ref": "#/components/schemas/FilterField" }, "value": { "description": "Represents the value to compare the specified field against when filtering related records before counting.", "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "comparator", "field", "value" ], "type": "object" }, "FilterCriterionRequest": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" } ], "description": "Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators.", "x-zs-$id": "FilterCriterionRequest" }, "FilterCriterionResponse": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionResponse" }, { "$ref": "#/components/schemas/GroupedFilterCriterionResponse" } ], "description": "Represents the top-level filter criterion returned in the response, supporting both simple field-based filters and complex grouped filters with logical operators.", "x-zs-$id": "FilterCriterionResponse" }, "FilterEmptyFilterObject": { "additionalProperties": false, "description": "Represents the error response returned when a filter object is submitted without any recognized fields — such as group or criteria — where at least one is required for the expression to be valid. The error code is EXPECTED_FIELD_MISSING.", "properties": { "code": { "description": "Indicates the error classification for this failure.\nPossible values:\n**EXPECTED_FIELD_MISSING** - None of the expected filter fields were present in the submitted filter object.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured diagnostic detail about the empty filter object, including the parameter name and the list of fields that were expected but entirely absent from the filter expression.", "properties": { "expected_fields": { "description": "Contains the collection of fields that the filter object was expected to include, of which at least one must be present for the request to be valid. Each entry identifies the field by its API name and JSON path.", "items": { "additionalProperties": false, "description": "Represents a single expected field entry, providing its API name and the JSON path at which it was anticipated within the filter expression.", "properties": { "api_name": { "description": "Represents the API name of a field expected to be present in the filter object.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Indicates the JSON path at which the expected field should be present within the filter object.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "param_name": { "description": "Indicates the name of the filter parameter associated with the empty filter object error. This field is a filter-specific extension to the standard error detail structure.", "maxLength": 256, "type": "string" } }, "required": [ "expected_fields", "param_name" ], "type": "object" }, "message": { "description": "Contains a descriptive message summarizing the empty filter object error.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the outcome status of the API response.\nPossible values:\n**error** - The request failed because the filter object did not contain any of the expected fields.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterEmptyFilterObject" }, "FilterField": { "additionalProperties": false, "description": "Represents the field to use when filtering related records before counting.", "properties": { "api_name": { "description": "Represents the API name of the field to filter on when counting related records.", "example": "api_name30", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsApiName" } ], "resource": "fields" } } }, "required": [ "api_name" ], "type": "object" }, "FilterFieldBase": { "additionalProperties": true, "description": "Represents the base field reference used in filter operations, containing minimal required properties. The field's data_type is not part of this object; resolve it from the corresponding FieldSchema. For formula fields, use formula.return_type as the effective data_type; for rollup_summary fields, use rollup_summary.return_type.", "properties": { "api_name": { "description": "Represents the API name of the field used for filter application. Supports relationship notation, for example, Deals__r.Stage.", "type": "string" }, "id": { "description": "Represents the unique ID of the field used for filter operations.", "format": "int64", "type": "string" } }, "type": "object", "x-zs-$id": "FilterFieldBase" }, "FilterFieldComparatorMismatch": { "additionalProperties": false, "description": "Represents an error response returned when a filter field's comparator value does not match any of the values permitted by the upstream dependee field's value. Contains the offending field's API name and JSONPath location, the dependee field's identity, the filter parameter context, and the list of supported comparator values.", "properties": { "code": { "description": "Indicates the error type for this response.\nPossible values:\n**DEPENDENT_MISMATCH** - The comparator supplied for the field does not match the set of comparators permitted given the current value of the dependee field.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured details about the comparator mismatch, identifying the field in error, the upstream dependee field whose value constrains valid comparators, and the set of comparator values that are permitted.", "properties": { "api_name": { "description": "Indicates the API name of the field whose supplied comparator value does not match the comparators permitted given the current value of the dependee field.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the upstream field whose current value determines which comparators are valid for the field identified in `api_name`. Contains the upstream field's API name and its location within the filter expression.", "properties": { "api_name": { "description": "Indicates the API name of the upstream dependee field whose value constrains the set of comparators permitted for the field currently in error.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Contains the JSONPath expression locating the dependee field within the filter expression submitted in the request.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Contains the JSONPath expression locating the field in error within the filter expression submitted in the request.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Indicates the name of the filter query parameter that carries the filter expression containing the comparator mismatch.", "maxLength": 256, "type": "string" }, "supported_values": { "description": "Contains the complete set of comparator values that are permitted for the field in error, as determined by the current value of the dependee field.", "items": { "description": "Represents a single comparator value that is valid for the field in error given the current value of the dependee field.", "maxLength": 256, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "dependee", "api_name", "json_path", "supported_values", "param_name" ], "type": "object" }, "message": { "description": "Represents a short, descriptive summary of the comparator-field dependency violation.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome of the request.\nPossible values:\n**error** - The request failed due to a comparator value mismatch in the filter criteria.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterFieldComparatorMismatch" }, "FilterFieldComparatorValueMissing": { "additionalProperties": false, "description": "Represents an error response returned when a filter field that requires a comparator value is submitted without one, typically because a required upstream dependee field is absent from the filter expression.", "properties": { "code": { "description": "Indicates the error classification assigned to this response.\nPossible values:\n**DEPENDENT_FIELD_MISSING** - A filter field's required comparator value is absent because its upstream dependee field was not supplied in the filter criteria.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured details about the missing comparator value error, identifying the field in error, the upstream dependee field that constrains it, and the filter parameter context in which the violation occurred.", "properties": { "api_name": { "description": "Indicates the API name of the filter field whose comparator value is absent, identifying which field in the filter expression triggered the error.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the upstream field whose value constrains the comparator requirements of the field currently in error. Contains the API name and JSONPath location of that upstream dependee field within the filter expression.", "properties": { "api_name": { "description": "Indicates the API name of the upstream dependee field whose value constrains the comparator requirements of the field currently in error.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Indicates the JSONPath location of the upstream dependee field within the filter expression.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Indicates the JSONPath location of the field in error within the filter expression, pinpointing where the missing comparator value was detected.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Indicates the name of the filter parameter that carries the filter criteria in which the missing comparator value was detected.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Contains a descriptive message summarizing the missing comparator value error.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the outcome status of the response.\nPossible values:\n**error** - The request failed because a required comparator value was absent from the filter criteria.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterFieldComparatorValueMissing" }, "FilterFieldNested": { "additionalProperties": false, "description": "A nested object representing a filter field available for a module in the portal user type, identified by its unique ID, API name, and display label.", "properties": { "api_name": { "description": "Represents the API name that uniquely identifies the filter field within the CRM module.", "maxLength": 256, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaFiltersApiName" } ], "resource": "portals_meta" } }, "display_label": { "description": "Represents the display label shown to portal users for the filter field.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique numeric identifier of the filter field in Zoho CRM.", "maxLength": 25, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaFiltersId" } ], "resource": "portals_meta" } } }, "type": "object" }, "FilterFieldNotSupportedInCriteria": { "additionalProperties": false, "description": "Represents an error response returned when a filter criteria field references a field type that is not supported for filtering, such as file upload or image upload fields.", "properties": { "code": { "description": "Indicates the error code identifying the category of failure.\nPossible values:\n**INVALID_DATA** - The field referenced in the filter criteria is not supported for filtering.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains details identifying the specific field that is not supported in filter criteria, including its API name, JSON path, and associated parameter name.", "properties": { "api_name": { "description": "Represents the API name of the field that is not supported within the filter criteria expression.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path locating the unsupported field within the filter criteria structure.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Represents the parameter name associated with the unsupported field, as a filter-specific extension to the standard error detail.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Contains a brief error message describing why the specified field is not supported in the filter criteria.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome status of the response.\nPossible values:\n**error** - The request failed because a field type not supported in filter criteria was referenced.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterFieldNotSupportedInCriteria" }, "FilterFieldValueMismatch": { "additionalProperties": false, "description": "Represents the error response returned when a filter field's value carries a data type that does not satisfy the requirement imposed by its dependee field's current value.", "properties": { "code": { "description": "Indicates the category of error associated with this response.\nPossible values:\n**DEPENDENT_MISMATCH** - A filter field's value has a data type that conflicts with the requirement set by the dependee field.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains diagnostic details identifying the offending filter field, its expected data type, the dependee field that governs that expectation, and the filter parameter in which the mismatch was detected.", "properties": { "api_name": { "description": "Indicates the API name of the filter field whose supplied value does not match the data type required by the dependee field.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the field whose current value dictates the required data type for the offending filter field.", "properties": { "api_name": { "description": "Indicates the API name of the dependee field whose value drives the data type requirement for the offending filter field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Indicates the JSON path locating the dependee field within the request payload.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "expected_data_type": { "description": "Indicates the data type expected by the dependee field against which the submitted filter value was validated.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Indicates the JSON path locating the filter field whose value carries the data type mismatch within the request payload.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Represents the filter-specific query parameter name associated with the field that failed value validation.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path", "expected_data_type", "param_name" ], "type": "object" }, "message": { "description": "Contains a descriptive explanation of the filter field value mismatch error.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome status of the response.\nPossible values:\n**error** - The request failed because a filter field value did not match the type required by the dependee field.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterFieldValueMismatch" }, "FilterInvalidComparator": { "additionalProperties": false, "description": "Represents an error response returned when a filter field is provided with a comparator operator that is not supported for that field. The error code is INVALID_DATA.", "properties": { "code": { "description": "Indicates the category of error associated with this response.\nPossible values:\n**INVALID_DATA** - An unsupported comparator operator was provided for the filter field.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured details identifying the filter field that received an unsupported comparator, including its location, parameter name, and the list of valid comparator values accepted for that field.", "properties": { "api_name": { "description": "Represents the API name of the filter field to which an unsupported comparator operator was applied.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path locating the specific filter field within the request payload that carries the unsupported comparator operator.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Indicates the name of the filter parameter whose comparator was rejected, scoped as a filter-specific extension to the standard error detail.", "maxLength": 256, "type": "string" }, "supported_values": { "description": "Contains the list of comparator values that are valid for the offending filter field.", "items": { "description": "Represents a single comparator value that is valid and accepted for the associated filter field.", "maxLength": 256, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "api_name", "json_path", "param_name", "supported_values" ], "type": "object" }, "message": { "description": "Contains a descriptive summary of the invalid-comparator error, identifying the rejected operator and the affected filter parameter.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the overall outcome of the request.\nPossible values:\n**error** - The request failed due to an invalid filter comparator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterInvalidComparator" }, "FilterInvalidFieldDataType": { "additionalProperties": false, "description": "Represents the error response returned when a field within the filter criteria contains a value of an incorrect data type. Includes the API name of the offending field, its JSONPath location within the filter expression, and the data type the field expects.", "properties": { "code": { "description": "Indicates the category of error returned.\nPossible values:\n**INVALID_DATA** - A field in the filter criteria was supplied with an incorrect data type.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains diagnostic details identifying the specific filter field whose value failed the data type check, including its API name, its location in the filter expression, the expected data type, and the name of the filter parameter that carried the criteria.", "properties": { "api_name": { "description": "Indicates the API name of the filter field whose supplied value does not match the field's required data type.", "maxLength": 256, "type": "string" }, "expected_data_type": { "description": "Indicates the data type that the identified filter field requires, against which the submitted value was evaluated and found incompatible.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Indicates the JSONPath location within the filter criteria expression where the data type mismatch was detected.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Indicates the name of the query or body parameter that carried the filter criteria containing the invalid field value.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type", "param_name" ], "type": "object" }, "message": { "description": "Represents a brief description of the data type error encountered for the filter field.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome of the request.\nPossible values:\n**error** - The request failed due to an invalid data type in the filter criteria.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterInvalidFieldDataType" }, "FilterInvalidParamDataType": { "additionalProperties": false, "description": "Represents an error response returned when a filter parameter is supplied with an incorrect data type. Contains the error code, a descriptive message, and details identifying the offending parameter along with its expected data type.", "properties": { "code": { "description": "Represents the error classification code for this response.\nPossible values:\n**INVALID_DATA** - The filter parameter was supplied with an incorrect data type.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured details about the data type mismatch, including the name of the offending filter parameter and the data type it is expected to carry.", "properties": { "expected_data_type": { "description": "Represents the data type that the filter parameter is required to carry for the request to be valid.", "maxLength": 256, "type": "string" }, "param_name": { "description": "Represents the name of the query or body parameter — such as `filters` — that carries the filter criteria and was supplied with an invalid data type.", "maxLength": 256, "type": "string" } }, "required": [ "expected_data_type", "param_name" ], "type": "object" }, "message": { "description": "Represents a descriptive message explaining the data type error encountered for the filter parameter.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the outcome of the request.\nPossible values:\n**error** - The request failed due to an invalid filter parameter data type.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterInvalidParamDataType" }, "FilterMandatoryNotFound": { "additionalProperties": false, "description": "Represents an error response returned when a mandatory field required by the filter criteria is absent from the request. Includes a filter-specific param_name field that extends the standard MANDATORY_NOT_FOUND error structure.", "properties": { "code": { "description": "Indicates the error code identifying the category of failure.\nPossible values:\n**MANDATORY_NOT_FOUND** - A mandatory field was absent from the filter criteria.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains detailed information identifying the mandatory field that is absent from the request, including its API name, JSON path location, and, as a filter-specific extension, its parameter name.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field that was not found in the filter criteria.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path locating the mandatory field that is missing from the filter criteria.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Represents the parameter name associated with the missing mandatory field, as a filter-specific extension to the standard error detail.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Contains a brief error message describing which mandatory field was not found in the filter criteria.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome status of the response.\nPossible values:\n**error** - The request failed because a mandatory field was absent from the filter criteria.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterMandatoryNotFound" }, "FilterNotSupportedApiName": { "additionalProperties": false, "description": "Represents an error response returned when a filter criterion references a field API name that is not supported for filtering. The details object identifies the unsupported field and its location within the filter parameter.", "properties": { "code": { "description": "Indicates the error classification assigned to this response.\nPossible values:\n**NOT_SUPPORTED** - The referenced field API name is not permitted for use in filter criteria.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the contextual details identifying the unsupported field that caused the error, including its API name, its location within the filter expression, and the name of the filter parameter involved.", "properties": { "api_name": { "description": "Represents the API name of the field that is not supported for use in filter criteria and triggered this error.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Indicates the JSONPath location of the unsupported field within the filter expression.", "maxLength": 512, "type": "string" }, "param_name": { "description": "Represents the name of the filter request parameter that carried the unsupported field API name.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Contains a descriptive message summarizing the nature of the error returned by the API.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome status of the API response.\nPossible values:\n**error** - The request failed because an unsupported field API name was used in the filter criteria.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FilterNotSupportedApiName" }, "Filters": { "additionalProperties": false, "description": "Filter definition used to narrow the list of profiles returned by the API.", "properties": { "group": { "description": "A list of filter conditions to apply. You can specify between 1 and 50 conditions.", "items": { "$ref": "#/components/schemas/FilterCondition" }, "maxItems": 50, "minItems": 1, "type": "array" }, "group_operator": { "description": "Logical operator applied between the conditions in `group`. Possible values: `and`, `or`.", "enum": [ "and", "or" ], "example": "or", "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object", "x-zs-$id": "Filters" }, "FiltersNested": { "additionalProperties": false, "description": "A nested object representing the filter configuration for a module in the portal user type, including the filter field's unique identifier, API name, and display label.", "properties": { "api_name": { "description": "Represents the API name of the resource", "maxLength": 256, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaFiltersApiName" } ], "resource": "portals_meta" } }, "display_label": { "description": "Represents the display label of the filter field.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the filter field.", "maxLength": 25, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaFiltersId" } ], "resource": "portals_meta" } } }, "type": "object" }, "FiscalCompletedSurplusError": { "additionalProperties": false, "description": "Represents the error returned when attempting to update the surplus week for a fiscal year that has already been completed.", "properties": { "code": { "description": "Represents the error code. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Cannot edit surplus week for completed fiscal year`.", "enum": [ "Cannot edit surplus week for completed fiscal year" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalCompletedSurplusError" }, "FiscalDeleteCompletedSurplusError": { "additionalProperties": false, "description": "Represents the error returned when attempting to delete the surplus week for a fiscal year that has already been completed.", "properties": { "code": { "description": "Represents the error code. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Cannot delete surplus week for completed fiscal year`.", "enum": [ "Cannot delete surplus week for completed fiscal year" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalDeleteCompletedSurplusError" }, "FiscalIntervalDisplayOptionNotAllowedForGregorianError": { "additionalProperties": false, "description": "Represents the error returned when interval_display_option is provided in the request while the calendar type is gregorian.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1024, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `cannot configure interval_display_option for gregorian calendar`.", "enum": [ "cannot configure interval_display_option for gregorian calendar" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalIntervalDisplayOptionNotAllowedForGregorianError" }, "FiscalInvalidCalendarTypeError": { "additionalProperties": false, "description": "Represents the error returned when the calendar_type value is invalid — either because it contains non-alphabetic characters (returns expected_data_type) or because it is not one of the supported values (returns supported_values).", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details. Contains either `expected_data_type` when the value has non-alphabetic characters, or `supported_values` when the value is not one of the allowed calendar types.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field. Present when the value contains non-alphabetic characters. Possible values: `text`.", "enum": [ "text" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported calendar type values. Present when the value is alphabetic but not a recognized calendar type.", "items": { "description": "Represents a supported value for the calendar_type field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Please give a valid calendar type`.", "enum": [ "Please give a valid calendar type" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Fiscal Year: Invalid Calendar Type Error", "type": "object", "x-zs-$id": "FiscalInvalidCalendarTypeError" }, "FiscalInvalidDataError": { "additionalProperties": false, "description": "Represents the error returned when the request body does not contain any valid fiscal year field to update.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents an empty details object returned with the error.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Please give a valid data`.", "enum": [ "Please give a valid data" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidDataError" }, "FiscalInvalidDisplayBasedOnError": { "additionalProperties": false, "description": "Represents the error returned when the display_based_on field value is invalid.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the invalid field.", "items": { "description": "Represents a supported value for the invalid field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Please give a valid display based on`.", "enum": [ "Please give a valid display based on" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidDisplayBasedOnError" }, "FiscalInvalidEndMonthConfigError": { "additionalProperties": false, "description": "Represents the error returned when end_month is configured as the display option for a custom calendar type with a start date in January or February.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Cannot configure end month as display based option for January and February for custom calendar type`.", "enum": [ "Cannot configure end month as display based option for January and February for custom calendar type" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidEndMonthConfigError" }, "FiscalInvalidIntervalDisplayOptionError": { "additionalProperties": false, "description": "Represents the error returned when the interval_display_option field value is invalid.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the invalid field.", "items": { "description": "Represents a supported value for the invalid field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Please give a valid number_by display option`.", "enum": [ "Please give a valid number_by display option" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidIntervalDisplayOptionError" }, "FiscalInvalidMonthError": { "additionalProperties": false, "description": "Represents the error returned when the start_month value is not a valid month name.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the invalid field.", "items": { "description": "Represents a supported value for the invalid field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Please give a valid month`.", "enum": [ "Please give a valid month" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidMonthError" }, "FiscalInvalidStartDateError": { "additionalProperties": false, "description": "Represents the error returned when the start_date field value is invalid.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Please give a valid start_date`.", "enum": [ "Please give a valid start_date" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidStartDateError" }, "FiscalInvalidStartDateMonthError": { "additionalProperties": false, "description": "Represents the error returned when the start_date value does not match the month component of the configured start_month.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `start_date does not match with start_month`.", "enum": [ "start_date does not match with start_month" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidStartDateMonthError" }, "FiscalInvalidStartMonthForConfiguredDateError": { "additionalProperties": false, "description": "Represents the error returned when the start_month value does not match the month of the existing start_date configured for the custom fiscal year.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Invalid start_month for the start_date configured`.", "enum": [ "Invalid start_month for the start_date configured" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidStartMonthForConfiguredDateError" }, "FiscalInvalidStartYearError": { "additionalProperties": false, "description": "Represents the error returned when the start_date is set to a year other than the current year for a custom fiscal year.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `custom fiscal year can be configured only with current year`.", "enum": [ "custom fiscal year can be configured only with current year" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidStartYearError" }, "FiscalInvalidStructureError": { "additionalProperties": false, "description": "Represents the error returned when the structure field value is not one of the supported patterns.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the invalid field.", "items": { "description": "Represents a supported value for the invalid field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Please give a valid structure`.", "enum": [ "Please give a valid structure" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidStructureError" }, "FiscalInvalidSurpluYearError": { "additionalProperties": false, "description": "Represents the error returned when the surplus week is configured for a year outside the current year or the following year.", "properties": { "code": { "description": "Represents the error code. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the invalid field.", "items": { "description": "Represents a supported value for the invalid field.", "format": "int32", "type": "integer" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Surplus week can be updated only for current year and next year`.", "enum": [ "Surplus week can be updated only for current year and next year" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidSurpluYearError" }, "FiscalInvalidSurplusWeekPeriodValueError": { "additionalProperties": false, "description": "Represents the error returned when the period value in the surplus_week object exceeds the maximum allowed period for the configured quarter.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with the JSON path and the list of supported period values for the configured quarter.", "properties": { "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported period values for the configured quarter.", "items": { "description": "Represents a supported period value.", "format": "int32", "type": "integer" }, "maxItems": 4, "type": "array" } }, "required": [ "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Provide valid period for surplus week`.", "enum": [ "Provide valid period for surplus week" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidSurplusWeekPeriodValueError" }, "FiscalInvalidSurplusWeekQuarterValueError": { "additionalProperties": false, "description": "Represents the error returned when the quarter value in the surplus_week object is not in the allowed range of 1 to 4.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with the JSON path and the list of supported quarter values.", "properties": { "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the quarter field.", "items": { "description": "Represents a supported quarter value.", "format": "int32", "type": "integer" }, "maxItems": 4, "type": "array" } }, "required": [ "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Provide valid quarter for surplus week`.", "enum": [ "Provide valid quarter for surplus week" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalInvalidSurplusWeekQuarterValueError" }, "FiscalNoPermissionError": { "additionalProperties": false, "description": "Represents the error returned when a non-administrator user attempts to update the fiscal year settings.", "properties": { "fiscal_year": { "additionalProperties": false, "description": "Represents the wrapped error response returned when the user does not have permission to update the fiscal year settings.", "properties": { "code": { "description": "Represents the error code. Possible values: `NO_PERMISSION`.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents an empty details object returned with the error.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Only Admin Users can modify the fiscal year settings`.", "enum": [ "Only Admin Users can modify the fiscal year settings" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "fiscal_year" ], "type": "object", "x-zs-$id": "FiscalNoPermissionError" }, "FiscalStartDateNotAllowedForGregorianError": { "additionalProperties": false, "description": "Represents the error returned when start_date is provided in the request while the calendar type is gregorian.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1024, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `cannot configure start_date for gregorian calendar`.", "enum": [ "cannot configure start_date for gregorian calendar" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalStartDateNotAllowedForGregorianError" }, "FiscalStructureNotAllowedForGregorianError": { "additionalProperties": false, "description": "Represents the error returned when structure is provided in the request while the calendar type is gregorian.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1024, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `cannot configure structure for gregorian calendar`.", "enum": [ "cannot configure structure for gregorian calendar" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalStructureNotAllowedForGregorianError" }, "FiscalSurplusWeekNotAllowedForGregorianError": { "additionalProperties": false, "description": "Represents the error returned when surplus_week is provided in the request while the calendar type is gregorian.", "properties": { "code": { "description": "Represents the error code. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with information about the field that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation failure.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the validation failure.", "maxLength": 1024, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `cannot configure surplus week for gregorian calendar`.", "enum": [ "cannot configure surplus week for gregorian calendar" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalSurplusWeekNotAllowedForGregorianError" }, "FiscalSurplusWeekPeriodMissingError": { "additionalProperties": false, "description": "Represents the error returned when the period field is missing from the surplus_week object.", "properties": { "code": { "description": "Represents the error code. Possible values: `DEPENDENT_FIELD_MISSING`.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing period field and the surplus_week object it belongs to.", "properties": { "api_name": { "description": "Represents the API name of the missing period field.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the parent surplus_week field that requires the period to be present.", "properties": { "api_name": { "description": "Represents the API name of the parent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parent field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the missing period field.", "maxLength": 1000, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Provide valid period for surplus week`.", "enum": [ "Provide valid period for surplus week" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalSurplusWeekPeriodMissingError" }, "FiscalSurplusWeekQuarterMissingError": { "additionalProperties": false, "description": "Represents the error returned when the quarter field is missing from the surplus_week object.", "properties": { "code": { "description": "Represents the error code. Possible values: `DEPENDENT_FIELD_MISSING`.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing quarter field and the surplus_week object it belongs to.", "properties": { "api_name": { "description": "Represents the API name of the missing quarter field.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the parent surplus_week field that requires the quarter to be present.", "properties": { "api_name": { "description": "Represents the API name of the parent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parent field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the missing quarter field.", "maxLength": 1000, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Provide valid quarter for surplus week`.", "enum": [ "Provide valid quarter for surplus week" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalSurplusWeekQuarterMissingError" }, "FiscalSurplusWeekYearMissingError": { "additionalProperties": false, "description": "Represents the error returned when the year field is missing from the surplus_week object.", "properties": { "code": { "description": "Represents the error code. Possible values: `DEPENDENT_FIELD_MISSING`.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing year field and the surplus_week object it belongs to.", "properties": { "api_name": { "description": "Represents the API name of the missing year field.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the parent surplus_week field that requires the year to be present.", "properties": { "api_name": { "description": "Represents the API name of the parent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parent field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the missing year field.", "maxLength": 1000, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Provide valid year for surplus week`.", "enum": [ "Provide valid year for surplus week" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "FiscalSurplusWeekYearMissingError" }, "FiscalYearAuthenticationFailureError": { "additionalProperties": false, "description": "Represents the error returned when the OAuth access token is missing or invalid.", "properties": { "code": { "description": "Represents the error code. Possible values: `AUTHENTICATION_FAILURE`.", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents an empty details object returned with the error.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Authentication failed`.", "enum": [ "Authentication failed" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Authentication Failure Error", "type": "object", "x-zs-$id": "AuthenticationFailureError" }, "FiscalYearDependentFieldMissingError": { "additionalProperties": false, "description": "Represents the error returned when a required dependent field is missing from the request.", "properties": { "code": { "description": "Represents the error code. Possible values: `DEPENDENT_FIELD_MISSING`.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing field and the field it depends on.", "properties": { "api_name": { "description": "Represents the API name of the field that requires a dependent field.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that is required to be present in the request.", "properties": { "api_name": { "description": "Represents the API name of the required dependent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the required dependent field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that requires a dependent field.", "maxLength": 1024, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: `Dependent field missing`.", "enum": [ "Dependent field missing" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "DependentFieldMissingError" }, "FiscalYearDetailsNested": { "additionalProperties": false, "description": "Represents the details of the updated fiscal year configuration, including its unique identifier.", "properties": { "id": { "description": "Represents the unique identifier of the updated fiscal year configuration.", "format": "int64", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "FiscalYearDisplayBasedOn": { "description": "Specify whether the fiscal year label is based on the start month or the end month of the fiscal period. When set to `end_month`, the `start_month` cannot be `JANUARY`. Possible values: `start_month`, `end_month`.", "enum": [ "start_month", "end_month" ], "maxLength": 20, "type": "string" }, "FiscalYearDisplayBasedOnForCustom": { "description": "Specify whether the custom fiscal year label is based on the start month or the end month of the fiscal period. When set to `end_month`, the `start_date` cannot fall in January or February. Possible values: `start_month`, `end_month`.", "enum": [ "start_month", "end_month" ], "maxLength": 20, "type": "string" }, "FiscalYearIntervalDisplayOption": { "description": "Specify the display format for the custom fiscal year intervals. Possible values: `year`, `quarter`.", "enum": [ "year", "quarter" ], "maxLength": 7, "type": "string" }, "FiscalYearNested": { "anyOf": [ { "$ref": "#/components/schemas/DisplayBasedOnFiscalYearUpdate" }, { "$ref": "#/components/schemas/StandardFiscalYearUpdate" }, { "$ref": "#/components/schemas/SwitchToStandardFiscalYearUpdate" }, { "$ref": "#/components/schemas/SwitchToCustomFiscalYearUpdate" }, { "$ref": "#/components/schemas/CustomFiscalYearPartialUpdate" } ], "description": "Represents the fiscal year settings to update. Use one of the supported request structures based on the type of fiscal year update being performed." }, "FiscalYearNested1": { "additionalProperties": false, "description": "Represents the response body for a successful fiscal year settings update, including the status code, message, and updated record details.", "properties": { "code": { "description": "Represents the status code of the operation. Possible values: `SUCCESS`.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "$ref": "#/components/schemas/FiscalYearDetailsNested" }, "message": { "description": "Represents the status message of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `success`.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "FiscalYearOAuthScopeMismatchError": { "additionalProperties": false, "description": "Represents the error returned when the OAuth access token does not include the required scope to access this endpoint.", "properties": { "code": { "description": "Represents the error code. Possible values: `OAUTH_SCOPE_MISMATCH`.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents an empty details object returned with the error.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message. Possible values: `invalid oauth scope to access this URL`.", "enum": [ "invalid oauth scope to access this URL" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "OAuth Scope Mismatch Error", "type": "object", "x-zs-$id": "OAuthScopeMismatchError" }, "FiscalYearStartDate": { "description": "Specify the start date of the custom fiscal year. This field can be configured only for the current year.", "format": "date", "maxLength": 10, "type": "string" }, "FiscalYearStartMonth": { "description": "Specify the start month of the fiscal year. Possible values: `JANUARY`, `FEBRUARY`, `MARCH`, `APRIL`, `MAY`, `JUNE`, `JULY`, `AUGUST`, `SEPTEMBER`, `OCTOBER`, `NOVEMBER`, `DECEMBER`.", "enum": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ], "maxLength": 20, "type": "string" }, "FiscalYearStructure": { "description": "Specify the week distribution structure for the custom fiscal year. Possible values: `4-4-5`, `4-5-4`, `5-4-4`, `3-3-3-4`, `3-3-4-3`, `3-4-3-3`, `4-3-3-3`.", "enum": [ "4-4-5", "4-5-4", "5-4-4", "3-3-3-4", "3-3-4-3", "3-4-3-3", "4-3-3-3" ], "maxLength": 10, "type": "string" }, "FlatErrorResponse": { "additionalProperties": false, "description": "Represents a flat (non-array) error response returned when a request-level error occurs.", "properties": { "code": { "description": "Represents the error code for the request failure. Always returned in the response.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the failure. Always returned in the response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response.", "maxLength": 100, "type": "string" } }, "required": [ "code", "message" ], "type": "object", "x-zs-$id": "FlatErrorResponse" }, "FollowUpSummary": { "additionalProperties": false, "description": "Represents a summary of follow-up action counts in a Cadence, broken down by action type.", "properties": { "call_follow_up_count": { "description": "Represents the number of scheduled call follow-up actions in the Cadence.", "format": "int32", "type": "integer" }, "email_follow_up_count": { "description": "Represents the number of email notification follow-up actions in the Cadence.", "format": "int32", "type": "integer" }, "task_follow_up_count": { "description": "Represents the number of task follow-up actions in the Cadence.", "format": "int32", "type": "integer" }, "whatsapp_follow_up_count": { "description": "Represents the number of WhatsApp message follow-up actions in the Cadence.", "format": "int32", "type": "integer" } }, "title": "Follow-Up Summary", "type": "object" }, "FollowUpsUpdateNested": { "additionalProperties": false, "description": "Represents a follow-up action in a Cadence, including its configuration, execution timing, and trigger conditions.", "properties": { "action": { "$ref": "#/components/schemas/ActionNested", "description": "Cadence followup action (Required)" }, "execute_after": { "$ref": "#/components/schemas/ExecuteAfterNested", "description": "Cadence followup execute_after" }, "id": { "description": "Represents the unique identifier of the follow-up action.", "maxLength": 255, "type": "string" }, "parent_follow_up": { "additionalProperties": false, "description": "Represents the parent follow-up action in the Cadence sequence.", "properties": { "id": { "description": "Represents the unique identifier of the parent follow-up action.", "maxLength": 255, "type": "string" }, "reference_id": { "description": "Represents the reference identifier of the parent follow-up action.", "maxLength": 255, "type": "string" } }, "type": "object" }, "reference_id": { "description": "Represents the reference identifier of the follow-up action.", "maxLength": 255, "type": "string" }, "triggers": { "description": "Represents the list of trigger conditions that initiate this follow-up action.", "items": { "description": "Represents a trigger condition for the follow-up action.", "maxLength": 255, "type": "string" }, "maxItems": 500, "type": "array" } }, "type": "object" }, "FollowupActionsRequestObject": { "anyOf": [ { "$ref": "#/components/schemas/AssignmentRulesTaskTypeFollowupActionRequestObject" } ], "description": "Followup action to execute after ownership assignment. Currently supports tasks. Additional types may be added in future versions.", "title": "Followup actions request object" }, "FollowupActionsResponseObject": { "additionalProperties": false, "description": "List of actions to be executed following the assignment of ownership to a record.", "properties": { "resources": { "description": "Represents the list of action details of the given type.", "items": { "$ref": "#/components/schemas/ResourceResponseObject" }, "maxItems": 1, "minItems": 1, "type": "array" }, "type": { "description": "Represents the type of the action.\nPossible values:\n**tasks** - Represents tasks. ", "enum": [ "tasks" ], "type": "string" } }, "required": [ "type" ], "title": "Followup actions response object", "type": "object" }, "ForbiddenByIdErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have permission to access or modify a specific resource identified by its path.", "properties": { "code": { "description": "Represents the error code for the permission denial.\nPossible values:\n**NO_PERMISSION** - The user does not have the required permission to perform the operation.", "enum": [ "NO_PERMISSION" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the permission error.", "properties": { "resource_path_index": { "description": "Index of the resource path segment that caused the permission error", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission denial.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered a permission error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ForbiddenByIdErrorResponse" }, "ForbiddenErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when permission is denied for accessing or modifying locked Custom Views.", "properties": { "custom_views": { "description": "Represents the list of permission error details for each Custom View in the request.", "items": { "additionalProperties": false, "description": "Represents the permission error details for a Custom View, including the error code, message, and field reference.", "properties": { "code": { "description": "Represents the error code identifying the permission issue.\nPossible values:\n**NO_PERMISSION** - The user does not have permission to access or modify the Custom View.", "enum": [ "NO_PERMISSION" ], "maxLength": 50, "type": "string" }, "details": { "$ref": "#/components/schemas/SimpleFieldError" }, "message": { "description": "Represents the error message describing the permission denial for this Custom View.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered a permission error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ForbiddenErrorResponseItem" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "ForbiddenErrorResponse" }, "FormDataContent": { "additionalProperties": false, "description": "Represents the form data body content for webhook requests when body.type is form_data. Contains module merge-field parameters, custom static parameters, and an optional user-defined parameter.", "properties": { "custom_parameters": { "description": "Represents the custom static key-value pairs sent as form data in the webhook request.", "items": { "$ref": "#/components/schemas/WebhookCustomParameters" }, "maxItems": 10, "type": "array" }, "module_parameters": { "description": "Represents the module merge-field parameters resolved at runtime and sent as form data in the webhook request.", "items": { "$ref": "#/components/schemas/WebhookModuleParameters" }, "maxItems": 25, "type": "array" }, "user_defined_parameter": { "$ref": "#/components/schemas/UserDefinedParameter", "description": "A single user-defined key-value parameter sent as a form data field. Note: The API uses singular 'user_defined_parameter' for form_data_content (this field) and plural 'user_defined_parameters' for url_parameters - both are single objects, not arrays." } }, "type": "object", "x-zs-llm-description": "Form data body for webhook when body.type is 'form_data'. Contains module merge-field parameters and custom static parameters." }, "FromAddressNested": { "additionalProperties": false, "description": "Represents the sender address for a mail merge email, containing the address type and an org-verified or current user's email address.", "properties": { "type": { "description": "Represents the type of the address.\nPossible values:\n**email** - Indicates the value is an email address.\n", "enum": [ "email" ], "maxLength": 5, "type": "string" }, "value": { "description": "Represents the sender email address used to send the mail merge email.", "format": "email", "maxLength": 255, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "GET3060320000000666022Nested": { "additionalProperties": false, "description": "Nested schema for tag ID 3060320000000666022 configurations.", "properties": { "AddTags": { "description": "AddTags configurations", "items": { "$ref": "#/components/schemas/GETAddtagsNested" }, "maxItems": 1, "type": "array" }, "RemoveTags": { "description": "RemoveTags configurations", "items": { "$ref": "#/components/schemas/GETRemovetagsNested" }, "maxItems": 1, "type": "array" } }, "required": [ "AddTags", "RemoveTags" ], "type": "object" }, "GET3060320000000666022Nested1": { "additionalProperties": false, "description": "Nested schema for tag ID 3060320000000666022 configurations.", "properties": { "AddTags": { "description": "AddTags configurations", "items": { "$ref": "#/components/schemas/GETAddtagsNested1" }, "maxItems": 1, "type": "array" }, "RemoveTags": { "description": "RemoveTags configurations", "items": { "$ref": "#/components/schemas/GETRemovetagsNested1" }, "maxItems": 1, "type": "array" } }, "required": [ "AddTags", "RemoveTags" ], "type": "object" }, "GET3060320000000666022Nested2": { "additionalProperties": false, "description": "Nested schema for tag ID 3060320000000666022 configurations.", "properties": { "AddTags": { "description": "AddTags configurations", "items": { "$ref": "#/components/schemas/GETAddtagsNested2" }, "maxItems": 3, "type": "array" }, "RemoveTags": { "description": "RemoveTags configurations", "items": { "$ref": "#/components/schemas/GETRemovetagsNested2" }, "maxItems": 2, "type": "array" } }, "required": [ "AddTags", "RemoveTags" ], "type": "object" }, "GETAddtagsNested": { "additionalProperties": false, "description": "Nested schema for AddTags action configurations.", "properties": { "id": { "description": "Unique identifier of the AddTags configuration", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the AddTags configuration", "maxLength": 255, "type": "string" }, "rules": { "description": "Rules associated with the AddTags configuration", "items": { "$ref": "#/components/schemas/GETRulesNested" }, "maxItems": 1, "type": "array" } }, "required": [ "id", "name", "rules" ], "type": "object" }, "GETAddtagsNested1": { "additionalProperties": false, "description": "Nested schema for AddTags action configurations.", "properties": { "id": { "description": "Unique identifier of the AddTags configuration", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the AddTags configuration", "maxLength": 255, "type": "string" }, "rules": { "description": "Rules associated with the AddTags configuration", "items": { "$ref": "#/components/schemas/GETRulesNested1" }, "maxItems": 1, "type": "array" } }, "required": [ "id", "name", "rules" ], "type": "object" }, "GETAddtagsNested2": { "additionalProperties": false, "description": "Nested schema for AddTags action configurations with simplified rules.", "properties": { "id": { "description": "Unique identifier of the AddTags configuration", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the AddTags configuration", "maxLength": 255, "type": "string" }, "rules": { "description": "Rules associated with the AddTags configuration", "items": { "$ref": "#/components/schemas/GETRulesNested2" }, "maxItems": 1, "type": "array" } }, "required": [ "id", "name", "rules" ], "type": "object" }, "GETAppointmentForNested": { "additionalProperties": false, "description": "Represents the customer for whom the appointment was created, including the record ID, name, and module information.", "properties": { "id": { "description": "Represents the unique ID of the customer record.", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/GETModuleNested" }, "name": { "description": "Represents the full name of the customer.", "maxLength": 255, "type": "string" } }, "required": [ "id", "module", "name" ], "type": "object" }, "GETAvailableTimingsNested": { "additionalProperties": false, "description": "Represents the availability time window on a returned service record, defined by a start time (From) and an end time (To).", "properties": { "From": { "description": "Represents the start of the availability time window, in HH:MM (24-hour) format.\n", "maxLength": 255, "type": "string" }, "To": { "description": "Represents the end of the availability time window, in HH:MM (24-hour) format.\n", "maxLength": 255, "type": "string" } }, "required": [ "From", "To" ], "type": "object" }, "GETBlueprintNested": { "additionalProperties": false, "description": "Nested schema for Blueprint configurations.", "properties": { "3060320000000666022": { "$ref": "#/components/schemas/GET3060320000000666022Nested1" } }, "required": [ "3060320000000666022" ], "type": "object" }, "GETConfiguredAreasNested": { "additionalProperties": false, "description": "Nested schema for configured_areas in records count response.", "properties": { "custom_view": { "$ref": "#/components/schemas/GETCustomViewNested" }, "workflow_tagActionRecords": { "$ref": "#/components/schemas/GETWorkflowTagactionrecordsNested" } }, "required": [ "custom_view", "workflow_tagActionRecords" ], "type": "object" }, "GETCustomViewNested": { "additionalProperties": false, "description": "Nested schema for custom_view configurations.", "properties": { "cvids": { "description": "List of custom view IDs", "items": {}, "maxItems": 0, "type": "array" }, "cvmodules": { "description": "List of modules with custom views", "items": {}, "maxItems": 0, "type": "array" }, "cvnames": { "description": "List of custom view names", "items": {}, "maxItems": 0, "type": "array" }, "inaccessible_custom_view_present": { "description": "Indicates whether inaccessible custom views exist", "type": "boolean" } }, "required": [ "cvids", "cvmodules", "cvnames", "inaccessible_custom_view_present" ], "type": "object" }, "GETDataSourceDetailsNested": { "additionalProperties": false, "description": "Represents the $data_source_details block on a returned service record. Carries metadata about the data source from which the record originated.", "type": "object" }, "GETFiscalYearNested": { "additionalProperties": false, "description": "Represents the fiscal year settings configured for the organization, including the calendar type, start month, structure, and surplus week information.", "properties": { "calendar_type": { "description": "Represents the calendar type configured for the fiscal year.", "maxLength": 255, "type": "string" }, "display_based_on": { "description": "Represents whether the fiscal year label is based on the start month or end month of the fiscal period.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the fiscal year configuration.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$id": "FiscalYearId" }, "interval_display_option": { "description": "Represents the display format configured for fiscal periods.", "maxLength": 255, "type": [ "string", "null" ] }, "past_surplus_weeks": { "description": "Represents the surplus week configurations from past fiscal years.", "type": "null" }, "start_date": { "description": "Represents the start date of the custom fiscal year.", "maxLength": 255, "type": [ "string", "null" ] }, "start_month": { "description": "Represents the start month of the fiscal year.", "maxLength": 255, "type": "string" }, "structure": { "description": "Represents the week distribution structure configured for the custom fiscal year.", "maxLength": 255, "type": [ "string", "null" ] }, "surplus_week": { "$ref": "#/components/schemas/GETSurplusWeekNested" } }, "required": [ "calendar_type", "display_based_on", "id", "interval_display_option", "past_surplus_weeks", "start_date", "start_month", "structure", "surplus_week" ], "type": "object" }, "GETHasMoreNested": { "additionalProperties": false, "description": "Indicates whether additional related items exist beyond those included in the response.", "properties": { "Members": { "description": "Indicates whether more members exist than those included in the current response.", "type": "boolean" } }, "required": [ "Members" ], "type": "object" }, "GETInfoNested": { "additionalProperties": false, "description": "Represents pagination and limit information for the tag list response.", "properties": { "allowed_count": { "description": "Represents the maximum number of tags allowed for the module in your plan.", "format": "int32", "type": "integer" }, "count": { "description": "Represents the total number of tags returned in the response.", "format": "int32", "type": "integer" }, "record_limit": { "description": "Represents the maximum number of records a tag can be applied to.", "format": "int32", "type": "integer" } }, "required": [ "allowed_count", "count" ], "type": "object" }, "GETInvitationFieldNested": { "additionalProperties": false, "description": "The invitation field configured for the portal user type. This is the CRM field used to store the portal user's email address, to which portal invitations are sent.", "properties": { "api_name": { "description": "Represents the API name of the CRM field designated as the invitation field for sending portal invitations.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique numeric identifier of the invitation field in Zoho CRM.", "format": "int64", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "GETMembersNested": { "additionalProperties": false, "description": "Represents a member who delivers the returned service, identified by module, name, and ID. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "id": { "description": "Represents the unique ID of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" }, "module": { "description": "Represents the source module of the member. Typically, the Users module.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" } }, "required": [ "id", "module", "name" ], "type": "object" }, "GETMembersNested1": { "additionalProperties": false, "description": "Represents an entry in the Members array of a returned service record, wrapping the member identity together with the relationship ID.", "properties": { "Members": { "$ref": "#/components/schemas/GETMembersNested" }, "id": { "description": "Represents the unique ID of the member on the service record. ", "maxLength": 255, "type": "string" } }, "required": [ "Members", "id" ], "type": "object" }, "GETModuleNested": { "additionalProperties": false, "description": "Represents the module details for the Appointment_For customer record, including the module API name and ID.", "properties": { "api_name": { "description": "Represents the API name of the module for the customer record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the module.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "GETOrchestrationNested": { "additionalProperties": false, "description": "Nested schema for Orchestration configurations.", "properties": { "3060320000000666022": { "$ref": "#/components/schemas/GET3060320000000666022Nested" } }, "required": [ "3060320000000666022" ], "type": "object" }, "GETPersonalityModuleNested": { "additionalProperties": false, "description": "Represents the nested object identifying the personality module configured for the portal user type. The personality module is the CRM module (for example, Contacts) whose records serve as portal user identities.", "properties": { "api_name": { "description": "Represents the API name of the CRM module configured as the personality module for this portal user type.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique numeric identifier of the personality module in Zoho CRM.", "format": "int64", "maxLength": 255, "type": "string" }, "plural_label": { "description": "Represents the plural label of the module.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id", "plural_label" ], "type": "object" }, "GETRemovetagsNested": { "additionalProperties": false, "description": "Nested schema for RemoveTags action configurations.", "properties": { "id": { "description": "Unique identifier of the RemoveTags configuration", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the RemoveTags configuration", "maxLength": 255, "type": "string" }, "rules": { "description": "Rules associated with the RemoveTags configuration", "items": { "$ref": "#/components/schemas/GETRulesNested" }, "maxItems": 1, "type": "array" } }, "required": [ "id", "name", "rules" ], "type": "object" }, "GETRemovetagsNested1": { "additionalProperties": false, "description": "Nested schema for RemoveTags action configurations.", "properties": { "id": { "description": "Unique identifier of the RemoveTags configuration", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the RemoveTags configuration", "maxLength": 255, "type": "string" }, "rules": { "description": "Rules associated with the RemoveTags configuration", "items": { "$ref": "#/components/schemas/GETRulesNested1" }, "maxItems": 1, "type": "array" } }, "required": [ "id", "name", "rules" ], "type": "object" }, "GETRemovetagsNested2": { "additionalProperties": false, "description": "Nested schema for RemoveTags action configurations with simplified rules.", "properties": { "id": { "description": "Unique identifier of the RemoveTags configuration", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the RemoveTags configuration", "maxLength": 255, "type": "string" }, "rules": { "description": "Rules associated with the RemoveTags configuration", "items": { "$ref": "#/components/schemas/GETRulesNested2" }, "maxItems": 1, "type": "array" } }, "required": [ "id", "name", "rules" ], "type": "object" }, "GETRulesNested": { "additionalProperties": false, "description": "Nested schema for rules with detailed properties.", "properties": { "execution_type": { "description": "Execution type of the rule", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the rule", "maxLength": 255, "type": "string" }, "module": { "description": "Module associated with the rule", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the rule", "maxLength": 255, "type": "string" }, "source": { "description": "Source identifier for the rule", "format": "int32", "type": "integer" }, "status": { "description": "Status of the rule (e.g., Active)", "maxLength": 255, "type": "string" }, "subtype": { "description": "Rule subtype identifier", "maxLength": 255, "type": "string" }, "subtype_id": { "description": "Unique identifier of the rule subtype", "maxLength": 255, "type": "string" }, "subtype_name": { "description": "Name of the rule subtype", "maxLength": 255, "type": "string" } }, "required": [ "execution_type", "id", "module", "name", "source", "status", "subtype", "subtype_id", "subtype_name" ], "type": "object" }, "GETRulesNested1": { "additionalProperties": false, "description": "Nested schema for rules within workflow, blueprint, or orchestration configurations.", "properties": { "execution_type": { "description": "Execution type of the rule (e.g., instant, schedule)", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the rule", "maxLength": 255, "type": "string" }, "module": { "description": "Module associated with the rule", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the rule", "maxLength": 255, "type": "string" }, "source": { "description": "Source identifier for the rule", "format": "int32", "type": "integer" }, "subtype": { "description": "Rule subtype identifier", "maxLength": 255, "type": "string" }, "subtype_id": { "description": "Unique identifier of the rule subtype", "maxLength": 255, "type": "string" }, "subtype_name": { "description": "Name of the rule subtype", "maxLength": 255, "type": "string" } }, "required": [ "execution_type", "id", "module", "name", "source", "subtype", "subtype_id", "subtype_name" ], "type": "object" }, "GETRulesNested2": { "additionalProperties": false, "description": "Nested schema for rules with simplified structure.", "properties": { "execution_type": { "description": "Execution type of the rule", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the rule", "maxLength": 255, "type": "string" }, "module": { "description": "Module associated with the rule", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the rule", "maxLength": 255, "type": "string" }, "source": { "description": "Source identifier for the rule", "format": "int32", "type": "integer" }, "subtype": { "description": "Rule subtype identifier", "maxLength": 255, "type": "string" }, "subtype_id": { "description": "Unique identifier of the rule subtype", "maxLength": 255, "type": "string" } }, "required": [ "execution_type", "id", "module", "name", "source", "subtype", "subtype_id" ], "type": "object" }, "GETServiceNameNested": { "additionalProperties": false, "description": "Represents the service for which the appointment was created, including the service ID and name.", "properties": { "id": { "description": "Represents the unique ID of the service.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the service for which the appointment was created.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "GETSurplusWeekNested": { "additionalProperties": false, "description": "Represents the surplus week configuration, including the quarter, period, and year in which the surplus week is placed.", "properties": { "period": { "description": "Represents the period within the quarter in which the surplus week falls.", "format": "int32", "type": "integer" }, "quarter": { "description": "Represents the quarter in which the surplus week falls.", "format": "int32", "type": "integer" }, "year": { "description": "Represents the year for which the surplus week is configured.", "format": "int32", "type": "integer" } }, "required": [ "period", "quarter", "year" ], "type": [ "object", "null" ] }, "GETTagsNested": { "additionalProperties": false, "description": "Represents a tag object returned in the GET response, including its ID, name, color code, timestamps, and audit user details.", "properties": { "color_code": { "description": "Represents the hex color code assigned to the tag, such as **#FF0000**. The value is null when no color is assigned.", "maxLength": 255, "type": [ "string", "null" ] }, "created_by": { "$ref": "#/components/schemas/TagsGETCreatedByNested" }, "created_time": { "description": "Represents the creation date and time of the tag.", "format": "date-time", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the tag.", "maxLength": 255, "type": "string", "x-zs-$id": "TagId" }, "modified_by": { "$ref": "#/components/schemas/TagsGETModifiedByNested" }, "modified_time": { "description": "Represents the last modification date and time of the tag.", "format": "date-time", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the tag.", "maxLength": 255, "type": "string", "x-zs-$id": "TagName" } }, "required": [ "color_code", "created_by", "created_time", "id", "modified_by", "modified_time", "name" ], "type": "object" }, "GETUserTypeByIdNested": { "additionalProperties": false, "description": "The full configuration details of a single portal user type, including identity fields, active status, user counts, audit metadata, and per-module access permissions.", "properties": { "active": { "description": "Indicates whether the portal user type is currently active and available to portal users.", "type": "boolean" }, "active_user_count": { "description": "Represents the number of portal users currently assigned to and active under this user type.", "format": "int32", "type": "integer" }, "deactive_user_count": { "description": "Represents the number of portal users assigned to this user type who have been deactivated.", "format": "int32", "type": "integer" }, "default": { "description": "Whether this is the default portal user type in the organization. The default user type is automatically assigned when no explicit user type is specified.", "type": "boolean" }, "id": { "description": "Represents the unique numeric identifier of the portal user type.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$id": "PortalUserTypeId" }, "invitation_field": { "$ref": "#/components/schemas/GETInvitationFieldNested" }, "modules": { "description": "The list of CRM modules that portal users of this type are permitted to access, along with the permissions and layouts configured for each module.", "items": { "$ref": "#/components/schemas/ModulesNested" }, "maxItems": 500, "type": "array" }, "name": { "description": "Represents the name of the portal user type.", "maxLength": 255, "type": "string" }, "personality_module": { "$ref": "#/components/schemas/GETPersonalityModuleNested" } }, "required": [ "active", "active_user_count", "deactive_user_count", "default", "id", "invitation_field", "modules", "name", "personality_module" ], "type": "object" }, "GETUserTypeNested": { "additionalProperties": false, "description": "A summary representation of a portal user type as returned by the list operation, including identity fields, active status, user counts, and last modification timestamp.", "properties": { "active": { "description": "Indicates whether the portal user type is currently active.", "type": "boolean" }, "active_user_count": { "description": "Represents the number of portal users currently assigned to and active under this user type.", "format": "int32", "type": "integer" }, "created_by": { "$ref": "#/components/schemas/PortalUserTypeGETCreatedByNested" }, "created_time": { "description": "Represents the creation timestamp of the user type.", "maxLength": 255, "type": "string" }, "deactive_user_count": { "description": "Represents the number of portal users assigned to this user type who have been deactivated.", "format": "int32", "type": "integer" }, "default": { "description": "Indicates whether this is the default portal user type in the organization. The default user type is automatically assigned when no explicit user type is specified.", "type": "boolean" }, "id": { "description": "Represents the unique numeric identifier of the portal user type.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$id": "PortalUserTypesId" }, "invitation_field": { "$ref": "#/components/schemas/GETInvitationFieldNested" }, "modified_by": { "$ref": "#/components/schemas/PortalUserTypeGETModifiedByNested" }, "modified_time": { "description": "Represents the ISO 8601 timestamp of when the portal user type was last modified.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the portal user type.", "maxLength": 255, "type": "string" }, "personality_module": { "$ref": "#/components/schemas/GETPersonalityModuleNested" } }, "required": [ "active", "active_user_count", "created_by", "created_time", "deactive_user_count", "default", "id", "invitation_field", "modified_by", "modified_time", "name", "personality_module" ], "type": "object" }, "GETWorkflowNested": { "additionalProperties": false, "description": "Nested schema for Workflow configurations.", "properties": { "3060320000000666022": { "$ref": "#/components/schemas/GET3060320000000666022Nested2" } }, "required": [ "3060320000000666022" ], "type": "object" }, "GETWorkflowTagactionrecordsNested": { "additionalProperties": false, "description": "Nested schema for workflow tag action records.", "properties": { "Blueprint": { "$ref": "#/components/schemas/GETBlueprintNested" }, "Orchestration": { "$ref": "#/components/schemas/GETOrchestrationNested" }, "Workflow": { "$ref": "#/components/schemas/GETWorkflowNested" } }, "required": [ "Blueprint", "Orchestration", "Workflow" ], "type": "object" }, "GeneralErrorResponse": { "additionalProperties": true, "description": "For the error response other than the mentioned ones", "properties": { "code": { "description": "Represents the error code for this error response.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "title": "General Error Response", "type": "object" }, "GeneralInvalidDataError": { "additionalProperties": false, "description": "General error returned when invalid data is provided for a field, including type mismatch or format issues.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid data error.", "properties": { "api_name": { "description": "The API name of the invalid field", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "The expected data type for this field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the invalid field", "maxLength": 1000, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data issue.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "General Invalid Data Error", "type": "object", "x-zs-$id": "GeneralInvalidDataError" }, "GenericInvalidDataError": { "additionalProperties": false, "description": "Error returned when invalid data is provided that exceeds maximum length limits or other validation constraints.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid data error.", "properties": { "api_name": { "description": "The API name of the invalid field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the invalid field", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "The maximum allowed length for this field", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data issue.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Value Error", "type": "object", "x-zs-$id": "GenericInvalidDataError" }, "GetAllAssignmentRulesSuccessResponse": { "additionalProperties": false, "description": "Get all Assignment Rules success response.", "properties": { "assignment_rules": { "description": "Represents the list of all Assignment Rules.", "items": { "$ref": "#/components/schemas/AssignmentRuleResponseObject" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "GetAllAssignmentRulesSuccessResponse" }, "GetAllCustomViewsResponse": { "additionalProperties": false, "description": "Get all custom views of a module", "properties": { "custom_views": { "description": "List of custom views", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomViewGetItem" }, { "description": "Custom view item with required fields", "required": [ "display_value", "system_defined", "default", "created_by", "modified_by", "id", "name", "created_time", "modified_time", "last_accessed_time", "system_name", "locked" ] } ], "description": "Custom view item" }, "maxItems": 200, "type": "array" }, "info": { "allOf": [ { "$ref": "#/components/schemas/CustomViewsCustomViewInfo" }, { "description": "Required pagination fields", "required": [ "per_page", "count", "page", "more_records" ] } ], "description": "Pagination info for the response" } }, "required": [ "custom_views", "info" ], "type": "object", "x-zs-$id": "GetAllCustomViewsResponse" }, "GetByIdCadenceSuccessResp": { "additionalProperties": false, "description": "Represents the response containing the details of a specific Cadence retrieved by its identifier.", "properties": { "cadences": { "description": "Represents the list of Cadences with their full details.", "items": { "additionalProperties": false, "description": "Represents the detailed configuration and metadata for a single Cadence.", "properties": { "created_by": { "$ref": "#/components/schemas/CreatorInfo" }, "created_time": { "$ref": "#/components/schemas/CadencesCreatedTime" }, "custom_view": { "$ref": "#/components/schemas/CadencesCustomViewInfo" }, "description": { "$ref": "#/components/schemas/CadenceDescription" }, "draft_cadence": { "additionalProperties": false, "description": "Represents the draft version of the Cadence, if one exists.", "properties": { "id": { "$ref": "#/components/schemas/CadenceID" }, "name": { "$ref": "#/components/schemas/CadenceName" } }, "type": "object" }, "execution_details": { "additionalProperties": false, "description": "Represents the execution frequency and unenrollment configuration for the Cadence.", "properties": { "execute_every": { "$ref": "#/components/schemas/ExecuteEvery" }, "unenroll_properties": { "description": "Represents the list of conditions under which records are automatically unenrolled from the Cadence.", "items": { "additionalProperties": false, "description": "Represents a single unenrollment condition.", "properties": { "details": { "description": "Represents additional details for the unenrollment condition.", "type": [ "object", "null" ] }, "id": { "description": "Represents the unique identifier of the unenrollment condition.", "maxLength": 255, "type": "string" }, "type": { "description": "Represents the type of unenrollment condition.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "follow_ups": { "description": "Represents the list of follow-up steps configured in the Cadence.", "items": { "additionalProperties": false, "description": "Represents a single follow-up step in the Cadence.", "properties": { "action": { "additionalProperties": true, "description": "Represents the action configured for the follow-up step.", "type": "object" }, "execute_after": { "additionalProperties": false, "description": "Represents the wait period before this follow-up step executes.", "properties": { "id": { "description": "Represents the unique identifier for the execute-after configuration.", "maxLength": 255, "type": "string" }, "period": { "description": "Represents the numeric duration of the wait period.", "maxLength": 255, "type": "string" }, "unit": { "description": "Represents the time unit for the wait period.", "format": "int32", "type": "integer" } }, "type": "object" }, "id": { "description": "Represents the unique identifier of the follow-up step.", "maxLength": 255, "type": "string" }, "parent_follow_up": { "description": "Represents the parent follow-up step that this step branches from.", "properties": { "id": { "description": "Represents the unique identifier of the parent follow-up step.", "maxLength": 255, "type": "string" }, "type": { "description": "Represents the branch type of the parent follow-up connection.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "triggers": { "description": "Represents the list of trigger conditions for the follow-up step.", "items": { "description": "Represents a single trigger condition for the follow-up step.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": [ "array", "null" ] } }, "required": [ "parent_follow_up", "action", "id" ], "title": "Follow-Up Details", "type": "object" }, "maxItems": 200, "type": "array" }, "id": { "$ref": "#/components/schemas/CadenceID", "x-zs-$id": "CadenceId" }, "modified_by": { "$ref": "#/components/schemas/ModifierInfo" }, "modified_time": { "description": "Represents the date and time when the Cadence was last modified.", "maxLength": 255, "type": [ "string", "null" ] }, "module": { "$ref": "#/components/schemas/ModuleInformation" }, "name": { "$ref": "#/components/schemas/CadenceName" }, "parent_cadence": { "additionalProperties": false, "description": "Represents the original Cadence from which this Cadence was cloned.", "properties": { "id": { "$ref": "#/components/schemas/CadenceID" }, "name": { "$ref": "#/components/schemas/CadenceName" } }, "type": "object" }, "status": { "description": "Cadence lifecycle status. draft = not yet published; active = published and enrolling records; inactive = published but currently deactivated.", "maxLength": 255, "type": "string" }, "summary": { "$ref": "#/components/schemas/FollowUpSummary" }, "type": { "$ref": "#/components/schemas/CadenceEnrollmentType" } }, "required": [ "id", "name", "status", "module", "type" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "GetByIdCadenceSuccessResp" }, "GetCustomViewByIdResponse": { "additionalProperties": false, "description": "Get a specific custom view of a module using custom view ID", "properties": { "custom_views": { "description": "List of custom views", "items": { "allOf": [ { "$ref": "#/components/schemas/CustomViewGetItem" }, { "description": "Custom view item with required fields", "required": [ "display_value", "access_type", "category", "system_defined", "default", "created_by", "modified_by", "id", "name", "created_time", "modified_time", "last_accessed_time", "system_name", "locked", "favorite", "criteria", "shared_to", "fields", "sort_by", "sort_order" ] } ], "description": "Custom view detail item" }, "maxItems": 1, "type": "array" }, "info": { "allOf": [ { "$ref": "#/components/schemas/CustomViewsCustomViewInfo" }, { "description": "Custom view info with required fields", "required": [ "translation" ] } ], "description": "Additional information about the response" } }, "required": [ "custom_views", "info" ], "type": "object", "x-zs-$id": "GetCustomViewByIdResponse" }, "GetDuplicateCheckPreference": { "additionalProperties": false, "description": "Schema for getting duplicate check preference.", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Duplicate check preference details.", "properties": { "type": { "description": "Type of duplicate check preference.", "enum": [ "converted_records", "mapped_module_records" ], "type": "string" }, "type_configurations": { "description": "Configurations for the duplicate check preference type", "items": { "additionalProperties": false, "description": "Type configuration details.", "properties": { "field_mappings": { "description": "Field mappings for duplicate check.", "items": { "additionalProperties": false, "description": "Field mapping details.", "properties": { "current_field": { "additionalProperties": false, "description": "Current field details.", "properties": { "api_name": { "description": "Represents the API name of the unique field in the Leads module. Use the [Get Fields Metadata API](fields.json#$.paths./settings/fields.get) to retrieve the API names of the unique fields.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the field. Use the [Get Fields Metadata API](fields.json#$.paths./settings/fields.get) to retrieve the unique ID fields.", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the module that the field belongs to, not the field's own display name. The API returns `Leads` for `current_field` and `Contacts` for `mapped_field`.", "maxLength": 50, "type": "string" } }, "required": [ "id", "api_name", "name" ], "type": "object" }, "mapped_field": { "additionalProperties": false, "description": "Mapped field details.", "properties": { "api_name": { "description": "Represents the API name of the mapped field.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the mapped field.", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the module that the mapped field belongs to, not the field's own display name. The API returns `Contacts`.", "maxLength": 50, "type": "string" } }, "required": [ "id", "api_name", "name" ], "type": "object" } }, "required": [ "current_field", "mapped_field" ], "type": "object" }, "type": "array" }, "mapped_module": { "additionalProperties": false, "description": "Represents the mapped module details.", "properties": { "api_name": { "description": "Represents the API name of the module.", "enum": [ "Contacts" ], "type": "string" }, "id": { "description": "Represents the unique identifier of the module.", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the display name of the module.", "enum": [ "Contacts" ], "type": "string" } }, "required": [ "id", "api_name", "name" ], "type": "object" } }, "required": [ "field_mappings", "mapped_module" ], "type": "object" }, "maxItems": 1, "type": [ "array", "null" ] } }, "required": [ "type", "type_configurations" ], "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "GetDuplicateCheckPreference2" }, "GetEmailTemplates400Error": { "anyOf": [ { "$ref": "#/components/schemas/ErrorItemMandatoryNotFoundForGet" }, { "$ref": "#/components/schemas/ErrorItemInvalidDataForGet" }, { "$ref": "#/components/schemas/ErrorItemPatternNotMatchedForGet" }, { "$ref": "#/components/schemas/EmailTemplatesErrorItemInvalidRequest" } ], "description": "Single error item - can be one of multiple error types", "x-zs-$id": "GetEmailTemplates400Error" }, "GetInventoryTemplates400Error": { "description": "Error response schema for inventory templates operations.", "items": { "additionalProperties": false, "anyOf": [ { "$ref": "#/components/schemas/InventoryTemplatesErrorItemMandatoryNotFound" }, { "$ref": "#/components/schemas/InventoryTemplatesErrorItemInvalidData" }, { "$ref": "#/components/schemas/InventoryTemplatesErrorItemPatternNotMatched" }, { "$ref": "#/components/schemas/InventoryTemplatesErrorItemInvalidRequest" } ], "description": "Represents an individual error item from the inventory templates operation, including the error code, message, status, and details.", "type": "object", "x-zs-$id": "InventoryTemplatesErrorResponseItems" }, "x-zs-$id": "GetInventoryTemplates400Error" }, "GetRelatedRecordsCountAmbiguityDuringProcessingError": { "additionalProperties": false, "description": "Error response for ambiguous data (ID and API name mismatch). Response is wrapped in get_related_records_count array.", "properties": { "get_related_records_count": { "description": "Array containing the error details for ambiguous data", "items": { "additionalProperties": false, "description": "Error details for ambiguous data", "properties": { "code": { "description": "Error code for ambiguous processing", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsAmbiguity" }, "message": { "description": "Human-readable error message describing the ambiguity error", "enum": [ "Ambiguity while processing the request" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "AmbiguityDuringProcessingError" }, "GetRelatedRecordsCountAuthenticationFailureError": { "additionalProperties": false, "description": "Error response for authentication failure", "properties": { "code": { "description": "Error code for authentication failure", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the authentication failure", "enum": [ "Authentication failed" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "AuthenticationFailureError" }, "GetRelatedRecordsCountAuthorizationFailedError": { "additionalProperties": false, "description": "Error response for insufficient permissions to perform the operation", "properties": { "code": { "description": "Error code for authorization failure", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the authorization failure", "enum": [ "You do not have sufficient permission to read the module records" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "AuthorizationFailedError" }, "GetRelatedRecordsCountExpectedFieldMissingError": { "additionalProperties": false, "description": "Error response for missing expected fields (id or api_name). Response is wrapped in get_related_records_count array.", "properties": { "get_related_records_count": { "description": "Array containing the error details for missing expected fields", "items": { "additionalProperties": false, "description": "Error details for missing expected fields", "properties": { "code": { "description": "Error code for missing expected field", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsExpectedFields" }, "message": { "description": "Human-readable error message describing the missing expected fields", "enum": [ "Specify atleast one field" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingError" }, "GetRelatedRecordsCountInternalError": { "additionalProperties": false, "description": "Error response for internal server error", "properties": { "code": { "description": "Error code for internal server error", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the internal error", "enum": [ "Internal Server Error" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InternalError" }, "GetRelatedRecordsCountInvalidDataError": { "additionalProperties": false, "description": "Error response for invalid data in request (record ID, related list ID, or field values). Response is wrapped in get_related_records_count array.", "properties": { "get_related_records_count": { "description": "Array containing the error details for invalid data", "items": { "additionalProperties": false, "description": "Error details for invalid data", "properties": { "code": { "description": "Error code for invalid data", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsFieldInfo" }, "message": { "description": "Human-readable error message describing the invalid data error", "enum": [ "Given related_list is invalid" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "InvalidDataError" }, "GetRelatedRecordsCountInvalidModuleError": { "additionalProperties": false, "description": "Error response for invalid module API name in request URL", "properties": { "code": { "description": "Error code for invalid module", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsResourcePathIndex" }, "message": { "description": "Human-readable error message describing the invalid module error", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, "GetRelatedRecordsCountInvalidRequestError": { "additionalProperties": false, "description": "Error response for invalid request", "properties": { "code": { "description": "Error code for invalid request", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the invalid request error", "enum": [ "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values." ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidRequestError" }, "GetRelatedRecordsCountInvalidRequestMethodError": { "additionalProperties": false, "description": "Error response for incorrect HTTP request method", "properties": { "code": { "description": "Error code for invalid request method", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the invalid request method error", "enum": [ "The http request method type is not a valid one" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, "GetRelatedRecordsCountInvalidTokenError": { "additionalProperties": false, "description": "Error response for invalid or expired access token", "properties": { "code": { "description": "Error code for invalid token", "enum": [ "INVALID_TOKEN" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the invalid token error", "enum": [ "Invalid API token" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidTokenError" }, "GetRelatedRecordsCountInvalidUrlPatternError": { "additionalProperties": false, "description": "Error response for invalid URL pattern", "properties": { "code": { "description": "Error code for invalid URL pattern", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the invalid URL pattern error", "enum": [ "The request URL is incorrect. Please check the URL" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidUrlPatternError" }, "GetRelatedRecordsCountMandatoryNotFoundError": { "additionalProperties": false, "description": "Error response for missing mandatory fields in request. Response is wrapped in get_related_records_count array.", "properties": { "get_related_records_count": { "description": "Array containing the error details for missing mandatory field", "items": { "additionalProperties": false, "description": "Error details for missing mandatory field", "properties": { "code": { "description": "Error code for missing mandatory field", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsFieldInfo" }, "message": { "description": "Human-readable error message describing the missing mandatory field", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, "GetRelatedRecordsCountNoPermissionError": { "additionalProperties": false, "description": "Error response for no permission to read records from the module", "properties": { "code": { "description": "Error code for no permission", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the permission error", "enum": [ "You do not have permission to read records from the module" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "NoPermissionError" }, "GetRelatedRecordsCountNotAllowedError": { "additionalProperties": false, "description": "Error response for not allowed to read related records from the module", "properties": { "code": { "description": "Error code for not allowed operation", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the not allowed error", "enum": [ "You do not have permission to read related records from the module" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "NotAllowedError" }, "GetRelatedRecordsCountOAuthScopeMismatchError": { "additionalProperties": false, "description": "Error response for OAuth scope mismatch", "properties": { "code": { "description": "Error code for OAuth scope mismatch", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the scope mismatch error", "enum": [ "The access token does not have the required scope" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "OAuthScopeMismatchError" }, "GetRelatedRecordsCountPartialSuccessResponse": { "additionalProperties": false, "description": "Multi-Status (HTTP 207) response returned when a request containing multiple related list count items has mixed results - some items succeed with a count while others fail with a per-item error. Each entry in get_related_records_count corresponds positionally to a requested item and independently reports either success (count + related_list) or an error (status, code, message, details).", "properties": { "get_related_records_count": { "description": "Array of per-item results, one entry per requested related list. Each entry is either a RelatedRecordCountResult (success) or a PartialSuccessItemError (failure).", "items": { "$ref": "#/components/schemas/PartialSuccessResponseItem" }, "maxItems": 20, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "PartialSuccessResponse" }, "GetRelatedRecordsCountRequest": { "additionalProperties": false, "description": "Represents the request payload for counting related records. Contains an array of related list count specifications, each identifying a related list and optional filtering criteria.", "properties": { "get_related_records_count": { "description": "Represents the array of related list count request objects. Each object specifies a related list to query and optional filtering criteria to apply before counting.", "items": { "$ref": "#/components/schemas/RelatedRecordCountItem" }, "maxItems": 20, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object" }, "GetRelatedRecordsCountResponse": { "additionalProperties": false, "description": "Represents the response returned when the count operation succeeds. Contains an array of count results, one entry for each related list requested.", "properties": { "get_related_records_count": { "description": "Represents the array of count results, one entry for each related list requested.", "items": { "$ref": "#/components/schemas/RelatedRecordCountResult" }, "maxItems": 20, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "GetRelatedRecordsCountResponse" }, "GetScoringRulesListResponse": { "additionalProperties": false, "description": "Represents the response body for the list Scoring Rules operation.", "properties": { "info": { "$ref": "#/components/schemas/ScoringRulePaginationInfo" }, "scoring_rules": { "description": "Represents an array of Scoring Rule summary objects returned in the list response.", "items": { "$ref": "#/components/schemas/ScoringRuleGET" }, "maxItems": 300, "type": "array" } }, "title": "Get Scoring Rules List Response", "type": "object", "x-zs-$id": "GetScoringRulesListResponse" }, "GetServiceByIdResponse200": { "additionalProperties": true, "description": "Wrapped response that returns a single service record. Contains a data array with exactly one service object carrying the full set of service fields.", "properties": { "data": { "description": "Represents the array containing the requested service record.", "items": { "$ref": "#/components/schemas/ServicesGETDataNested" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "GetServiceByIdResponse200" }, "GetSpecificAssignmentRuleSuccessResponse": { "additionalProperties": false, "description": "Get all Assignment Rules success response.", "properties": { "assignment_rules": { "description": "Represents the list of all Assignment Rules.", "items": { "$ref": "#/components/schemas/AssignmentRuleResponseObjectWithRuleEntries" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "GetSpecificAssignmentRuleSuccessResponse" }, "GetTaskByIdSuccessResponse": { "additionalProperties": false, "description": "Success response for retrieving a single automation task by ID. Contains the full task configuration including field_mappings, module, lock_status, and metadata.", "properties": { "tasks": { "description": "Array containing exactly one task object matching the requested ID.", "items": { "$ref": "#/components/schemas/TaskDetails" }, "maxItems": 1, "type": "array" } }, "required": [ "tasks" ], "title": "Get Task By Id Success Response", "type": "object", "x-zs-$id": "GetTaskByIdSuccessResponse", "x-zs-llm-description": "Full task configuration returned by GET-by-ID. Contains field_map, module context, and all configurable fields." }, "GetTasksListErrorResponse": { "anyOf": [ { "$ref": "#/components/schemas/TaskInvalidModuleSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/TaskNotAllowedSchema" } ], "description": "Error response for invalid GET list query parameters.", "x-zs-$id": "GetTasksListErrorResponse", "x-zs-llm-description": "Union (oneOf) error variants for invalid GET list query parameters. Match on code field to identify the specific error." }, "GetTasksSuccessResponse": { "additionalProperties": false, "description": "Paginated response containing automation tasks and pagination metadata.", "properties": { "info": { "$ref": "#/components/schemas/WorkflowTasksPaginationInfo" }, "tasks": { "description": "List of automation task definitions for the current query page.", "items": { "$ref": "#/components/schemas/TaskDetails" }, "maxItems": 200, "type": "array" } }, "required": [ "tasks", "info" ], "title": "Get Tasks Success Response", "type": "object", "x-zs-$id": "GetTasksSuccessResponse", "x-zs-llm-description": "Paginated list response containing tasks array and info metadata. Check info.more_records for additional pages." }, "GetUserDetails": { "additionalProperties": true, "description": "Represents the details of a Zoho CRM user, including personal information, preferences, role, profile, and account settings.", "properties": { "$current_shift": { "anyOf": [ { "additionalProperties": false, "description": "Represents the current shift assigned to the user, identified by its unique ID and display name.", "properties": { "id": { "description": "Represents the unique ID of the user's current shift.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the user's current shift.", "maxLength": 80, "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-zs-$id": "CurrentShiftAssigned" }, { "description": "Indicates that no current shift is assigned to the user.", "type": "null", "x-zs-$id": "NoCurrentShiftAssigned" } ], "description": "Represents the shift currently assigned to the user, including the shift's ID and name." }, "$next_shift": { "anyOf": [ { "additionalProperties": false, "description": "Represents the upcoming shift assigned to the user, identified by its unique ID and display name.", "properties": { "id": { "description": "Represents the unique ID of the user's upcoming shift.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the user's upcoming shift.", "maxLength": 80, "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-zs-$id": "NextShiftAssigned" }, { "description": "Indicates that no upcoming shift is assigned to the user.", "type": "null", "x-zs-$id": "NoNextShiftAssigned" } ], "description": "Represents the upcoming shift scheduled for the user, including the shift's ID and name." }, "$shift_effective_from": { "anyOf": [ { "description": "Represents the date from which the upcoming shift assignment becomes effective.", "format": "date", "pattern": "([0-9]{4})-([0-9]{2})-([0-9]{2})", "type": "string", "x-zs-$id": "NextShiftEffectiveFromDate" }, { "description": "Indicates that no upcoming shift effective date is set.", "type": "null", "x-zs-$id": "NoNextShiftEffectiveFromDate" } ], "description": "Represents the date on which the user's upcoming shift becomes effective." }, "Confirmed_Time__s": { "anyOf": [ { "description": "Represents the date and time at which the user status was confirmed.", "format": "date-time", "type": "string", "x-zs-$id": "UserConfirmedTime" }, { "description": "Indicates that no confirmation time is recorded for the user.", "type": "null", "x-zs-$id": "NoUserConfirmedTime" } ], "description": "Represents the date and time at which the user's status was confirmed. Returns null if confirmation has not occurred.", "readOnly": true }, "Invited_By__s": { "anyOf": [ { "additionalProperties": false, "description": "Represents the user who invited this user, identified by their unique ID and full name.", "properties": { "id": { "description": "Represents the unique ID of the user who invited this user.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the full name of the user who invited this user.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "UserInvitedBy" }, { "description": "Indicates that no inviting user is associated with this user.", "type": "null", "x-zs-$id": "NoUserInvitedBy" } ], "description": "Represents the user who extended the invitation to this user. Returns null if no inviting user is associated.", "readOnly": true }, "Invited_Time__s": { "anyOf": [ { "description": "Represents the date and time at which the most recent invitation was sent to this user.", "format": "date-time", "readOnly": true, "type": "string", "x-zs-$id": "UserInvitedTime" }, { "description": "Indicates that no invitation has been sent to this user.", "type": "null", "x-zs-$id": "NoUserInvitedTime" } ], "description": "Represents the date and time at which the most recent invitation was sent to this user. Returns null if no invitation has been sent.", "readOnly": true }, "Modified_By": { "anyOf": [ { "additionalProperties": false, "description": "Represents the user who last modified this user record, identified by their unique ID and full name.", "properties": { "id": { "description": "Represents the unique ID of the user who last modified this user record.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the full name of the user who last modified this user record.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "UserModifiedBy" }, { "description": "Indicates that no modification has been recorded for this user record.", "type": "null", "x-zs-$id": "NoUserModifiedBy" } ], "description": "Represents the user who last modified this user record. Returns null if no modification has occurred. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details." }, "Modified_Time": { "anyOf": [ { "description": "Represents the date and time at which this user record was last modified.", "format": "date-time", "readOnly": true, "type": "string", "x-zs-$id": "UserModifiedTime" }, { "description": "Indicates that no modification time is recorded for this user record.", "type": "null", "x-zs-$id": "NoUserModifiedTime" } ], "description": "Represents the date and time at which this user record was last modified, in ISO 8601 format. Returns null if no modification has occurred." }, "Reporting_To": { "anyOf": [ { "additionalProperties": false, "description": "Represents the user to whom this user reports, identified by their unique ID and full name.", "properties": { "id": { "description": "Represents the unique ID of the user to whom this user reports.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the full name of the user to whom this user reports.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "UserReportingTo" }, { "description": "Indicates that no reporting manager is assigned to this user.", "type": "null", "x-zs-$id": "NoReportingToUserId" } ], "description": "Represents the user to whom this user reports within the organizational hierarchy. Returns null if no reporting manager is assigned. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details." }, "Status_Updated_By__s": { "anyOf": [ { "additionalProperties": false, "description": "Represents the user who last updated the status of this user, identified by their unique ID and full name.", "properties": { "id": { "description": "Represents the unique ID of the user who last updated the status of this user.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the full name of the user who last updated the status of this user.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "UserStatusUpdatedBy" }, { "description": "Indicates that no status update has been recorded for this user.", "type": "null", "x-zs-$id": "NoUserStatusUpdatedBy" } ], "description": "Represents the details of the user who last updated the status of this user. Returns null if no status update has been recorded.", "readOnly": true }, "Status_Updated_Time__s": { "description": "Represents the date and time at which the status of this user was last updated.", "format": "date-time", "readOnly": true, "type": "string" }, "alias": { "anyOf": [ { "description": "Represents the alias or short name associated with the user.", "maxLength": 50, "type": "string", "x-zs-$id": "UserAlias" }, { "description": "Indicates that no alias is configured for the user.", "type": "null", "x-zs-$id": "NoUserAlias" } ], "description": "Represents the alias or short name associated with the user. Returns null if no alias is configured." }, "city": { "anyOf": [ { "description": "Represents the city associated with the user.", "maxLength": 100, "type": "string", "x-zs-$id": "UserCity" }, { "description": "Indicates that no city is configured for the user.", "type": "null", "x-zs-$id": "NoUserCity" } ], "description": "Represents the city associated with the user's address. Returns null if no city is configured." }, "confirm": { "description": "Indicates whether the user has accepted the invitation to join the organization.\\n\\nPossible values:\\ntrue - The user has accepted the invitation.\\nfalse - The user has not yet accepted the invitation.", "readOnly": true, "type": "boolean" }, "country": { "anyOf": [ { "description": "Represents the country associated with the user.", "maxLength": 100, "type": "string", "x-zs-$id": "UserCountry" }, { "description": "Indicates that no country is configured for the user.", "type": "null", "x-zs-$id": "NoUserCountry" } ], "description": "Represents the country associated with the user's address. Returns null if no country is configured." }, "country_locale": { "description": "Represents the locale associated with the user's country.", "enum": [ "ps_AF", "sv_AX", "sq_AL", "ar_DZ", "en_AS", "ca_AD", "pt_AO", "en_AI", "en_AQ", "en_AG", "es_AR", "hy_AM", "nl_AW", "en_AU", "de_AT", "az_AZ", "en_BS", "ar_BH", "bn_BD", "en_BB", "be_BY", "nl_BE", "fr_BE", "en_BZ", "fr_BJ", "en_BM", "en_BT", "es_BO", "bs_BA", "en_BW", "no_BV", "pt_BR", "en_IO", "en_VG", "ms_BN", "bg_BG", "fr_BF", "fr_BI", "km_KH", "fr_CM", "en_CA", "fr_CA", "pt_CV", "en_KY", "fr_CF", "ar_TD", "es_CL", "zh_CN", "en_CX", "en_CC", "es_CO", "fr_KM", "en_CK", "es_CR", "hr_HR", "es_CU", "el_CY", "cs_CZ", "fr_CD", "da_DK", "ar_DJ", "en_DM", "es_DO", "es_EC", "ar_EG", "es_SV", "es_GQ", "en_ER", "et_EE", "en_SZ", "am_ET", "en_FK", "fo_FO", "fj_FJ", "fi_FI", "fr_FR", "fr_GF", "fr_PF", "fr_TF", "fr_GA", "en_GM", "ka_GE", "de_DE", "en_GH", "en_GI", "el_GR", "kl_GL", "en_GD", "fr_GP", "en_GU", "es_GT", "fr_GN", "pt_GW", "en_GY", "fr_HT", "en_HM", "es_HN", "zh_HK", "hu_HU", "is_IS", "en_IN", "id_ID", "fa_IR", "ar_IQ", "en_IE", "iw_IL", "it_IT", "en_JM", "ja_JP", "ar_JO", "ru_KZ", "sw_KE", "en_KI", "ar_KW", "uz_KG", "lo_LA", "lv_LV", "ar_LB", "en_LS", "en_LR", "ar_LY", "de_LI", "lt_LT", "fr_LU", "de_LU", "zh_MO", "en_MG", "en_MW", "ms_MY", "dv_MV", "fr_ML", "mt_MT", "en_MH", "fr_MQ", "ar_MR", "en_MU", "fr_YT", "es_MX", "en_FM", "ro_MD", "fr_MC", "mn_MN", "sr_ME", "en_MS", "ar_MA", "pt_MZ", "my_MM", "en_NA", "en_NR", "ne_NP", "nl_NL", "nl_AN", "fr_NC", "en_NZ", "es_NI", "fr_NE", "en_NG", "en_NU", "en_NF", "ko_KP", "mk_MK", "en_MP", "no_NO", "ar_OM", "en_PK", "en_PW", "ar_PS", "es_PA", "en_PG", "es_PY", "es_PE", "en_PH", "en_PN", "pl_PL", "pt_PT", "es_PR", "ar_QA", "fr_CG", "fr_RE", "ro_RO", "ru_RU", "rw_RW", "en_SH", "en_KN", "en_LC", "fr_PM", "en_VC", "en_WS", "it_SM", "pt_ST", "ar_SA", "fr_SN", "sr_RS", "sr_CS", "en_SC", "en_SL", "en_SG", "sk_SK", "sl_SI", "en_SB", "so_SO", "en_ZA", "en_GS", "ko_KR", "es_ES", "si_LK", "ar_SD", "nl_SR", "no_SJ", "sv_SE", "fr_CH", "de_CH", "it_CH", "ar_SY", "zh_TW", "fa_TJ", "sw_TZ", "th_TH", "pt_TL", "fr_TG", "en_TK", "to_TO", "en_TT", "ar_TN", "tr_TR", "tk_TM", "en_TC", "en_TV", "en_UG", "uk_UA", "ar_AE", "en_GB", "en_US", "en_UM", "es_UY", "uz_UZ", "bi_VU", "it_VA", "es_VE", "vi_VN", "en_VI", "fr_WF", "ar_EH", "ar_YE", "en_ZM", "en_ZW", "fr_CI" ], "type": "string" }, "created_by": { "anyOf": [ { "additionalProperties": false, "description": "Represents the user who created this user record, identified by their unique ID and full name.", "properties": { "id": { "description": "Represents the unique ID of the user who created this record.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the full name of the user who created this record.", "maxLength": 100, "type": "string" } }, "readOnly": true, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "UserCreatedBy" }, { "description": "Indicates that no creator information is available for this user record.", "type": "null", "x-zs-$id": "NoUserCreatedBy" } ], "description": "Represents the user who created this user record. Returns null if the creator information is not available. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details." }, "created_time": { "anyOf": [ { "description": "Represents the date and time when this user record was first created.", "format": "date-time", "readOnly": true, "type": "string", "x-zs-$id": "UserCreatedTime" }, { "description": "Indicates that no creation time is available for this user record.", "type": "null", "x-zs-$id": "NoUserCreatedTime" } ], "description": "Represents the date and time when this user record was first added to the system, in ISO 8601 format. Returns null if the creation time is not available." }, "customize_info": { "additionalProperties": true, "description": "Represents a collection of user interface customization preferences associated with the user's account.", "properties": { "bc_view": { "anyOf": [ { "description": "Indicates that the breadcrumb view is displayed for the user.", "type": "boolean", "x-zs-$id": "BcViewValue" }, { "description": "Indicates that the breadcrumb view is not displayed for the user.", "type": "null", "x-zs-$id": "BcViewDefaultValue" } ], "description": "Indicates whether the breadcrumb view is displayed for the user.\\nPossible values:\\ntrue - The breadcrumb view is displayed.\\nfalse - The breadcrumb view is not displayed." }, "notes_desc": { "description": "Indicates whether notes are displayed in descending order for the user.\\nPossible values:\\ntrue - Notes are displayed in descending order.\\nfalse - Notes are not displayed in descending order.", "type": [ "boolean", "null" ] }, "show_detail_view": { "description": "Indicates whether the detail view panel is displayed for the user.\\nPossible values:\\ntrue - The detail view panel is displayed.\\nfalse - The detail view panel is not displayed.", "type": "boolean" }, "show_home": { "description": "Indicates whether the home screen is displayed for the user.\\nPossible values:\\ntrue - The home screen is displayed.\\nfalse - The home screen is not displayed.", "type": "boolean" }, "show_left_panel": { "description": "Indicates whether the left panel is displayed in the user interface.\\n\\nPossible values:\\ntrue - The left panel is shown.\\nfalse - The left panel is hidden.", "type": [ "boolean", "null" ] }, "show_right_panel": { "anyOf": [ { "description": "Indicates that the right panel is displayed in the user interface.", "maxLength": 20, "type": "string", "x-zs-$id": "ShowRightPanelValue" }, { "description": "Indicates that the right panel is not displayed in the user interface.", "type": "null", "x-zs-$id": "ShowRightPanelDefaultValue" } ], "description": "Indicates whether the right panel is displayed in the user interface.\\n\\nPossible values:\\ntrue - The right panel is shown.\\nfalse - The right panel is hidden." }, "unpin_recent_item": { "anyOf": [ { "description": "Indicates that the recent item is unpinned from its fixed position.", "type": "boolean", "x-zs-$id": "UnpinRecentItemValue" }, { "description": "Indicates that the recent item remains pinned in its fixed position.", "type": "null", "x-zs-$id": "UnpinRecentItemDefaultValue" } ], "description": "Indicates whether the recent item is unpinned from its fixed position in the user interface.\\n\\nPossible values:\\ntrue - The recent item is unpinned.\\nfalse - The recent item remains pinned." } }, "type": "object" }, "date_format": { "description": "Represents the user's preferred date format used for displaying date values throughout the application.", "enum": [ "dd-MM-yyyy", "dd/MM/yyyy", "dd.MM.yyyy", "dd MM yyyy", "dd-MM-yy", "dd/MM/yy", "dd.MM.yy", "d.MM.yy", "d-M-yy", "d/M/yy", "d.M.yy", "d.M.yy.", "d-M-yyyy", "d/M/yyyy", "d.M.yyyy", "d. M. yyyy.", "d. M. yyyy", "d MMM, yyyy", "dd MMM, yyyy", "d. MMMM yyyy", "dd.MM.yyyy.", "dd.MM.yy.", "yyyy-MM-dd", "yyyy/MM/dd", "yyyy.MM.dd", "yyyy MM dd", "yy/MM/dd", "yy-MM-dd", "yy.M.d", "yy-M-d", "yy. M. d", "yyyy/M/d", "yyyy年MM月dd日", "yy年M月d日", "yyyy.MM.dd.", "yyyy. MM. dd", "MM-dd-yyyy", "MM/dd/yyyy", "MM.dd.yyyy", "MM dd yyyy", "MM-dd-yy", "MM/dd/yy", "M/dd/yy", "MMM-dd-yyyy", "MMM dd, yyyy", "MMM d, yyyy", "MMMM d, yyyy", "yyyy.dd.MM", "yy.d.M" ], "type": "string" }, "decimal_separator": { "description": "Represents the user's preferred decimal separator character used when displaying numerical values.", "enum": [ "Comma", "Period" ], "type": "string" }, "default_tab_group": { "description": "Represents the default tab group assigned to the user, determining which group of tabs is presented upon login.", "maxLength": 100, "type": "string" }, "distance_preference__s": { "description": "Represents the user's preferred unit of measurement for displaying distance values.", "enum": [ "Kilometers", "Miles" ], "type": "string" }, "dob": { "anyOf": [ { "description": "Represents the user's date of birth.", "format": "date", "type": "string", "x-zs-$id": "UserDOB" }, { "description": "Indicates that no date of birth is set for the user.", "type": "null", "x-zs-$id": "NoUserDOB" } ], "description": "Represents the user's date of birth. Returns null if no date of birth has been set." }, "email": { "description": "Represents the email address associated with the user's account.", "maxLength": 100, "type": "string", "x-zs-$id": "UserEmail" }, "ezuid": { "description": "Represents the encrypted Zoho User ID (ZUID), used to securely identify the user without showing their actual ID.", "maxLength": 100, "readOnly": true, "type": "string", "x-visibility": "internal" }, "fax": { "anyOf": [ { "description": "Represents the user's fax number.", "maxLength": 30, "type": "string", "x-zs-$id": "UserFax" }, { "description": "Indicates that no fax number is configured for the user.", "type": "null", "x-zs-$id": "NoUserFax" } ], "description": "Represents the user's fax number. Returns null if no fax number is configured." }, "first_name": { "anyOf": [ { "description": "Represents the first name of the user.", "maxLength": 50, "type": "string", "x-zs-$id": "UserFirstName" }, { "description": "Indicates that no first name is set for the user.", "type": "null", "x-zs-$id": "NoUserFirstName" } ], "description": "Represents the user's first name. Returns null if no first name is set." }, "full_name": { "description": "Represents the user's full name.", "maxLength": 100, "readOnly": true, "type": "string" }, "id": { "description": "Represents the unique identifier of the user.", "maxLength": 19, "readOnly": true, "type": "string", "x-zs-$id": "UserId" }, "image_link": { "description": "Represents the URL of the user's profile image as provided by the Identity and Access Management (IAM) system.", "maxLength": 100, "type": "string" }, "imap_status": { "description": "Indicates whether IMAP access is enabled for the user.\\nPossible values:\\ntrue - IMAP access is enabled.\\nfalse - IMAP access is disabled.", "type": "boolean", "x-visibility": "internal" }, "language": { "description": "Represents the preferred language of the user. This value can be updated only by the user themselves.", "enum": [ "af_NA", "en_IN", "af_ZA", "ak_GH", "su_ID", "cy_GB", "de_CH", "de_AT", "en_AU", "en_CA", "en_GB", "en_IE", "en_NZ", "en_SG", "en_US", "en_ZA", "ee_GH", "ee_TG", "fy_NL", "ga_GB", "ga_IE", "gv_IM", "ki_KE", "gd_GB", "ha_GH", "ha_NG", "ha_NE", "ig_NG", "rn_BI", "jv_ID", "rw_RW", "sw_CD", "sw_KE", "sw_TZ", "sw_UG", "lg_UG", "lb_LU", "mg_MG", "mt_MT", "ms_BN", "ms_ID", "ms_MY", "ms_SG", "nl_BE", "nl_BQ", "om_ET", "om_KE", "ff_GN", "ff_SN", "qu_BO", "qu_EC", "qu_PE", "so_ET", "so_DJ", "so_KE", "so_SO", "sg_CF", "vi_VN", "lu_CD", "tr_CY", "tr_TR", "wo_SN", "az_AZ", "bm_ML", "bs_BA", "br_FR", "ca_AD", "ca_ES", "ca_FR", "ca_IT", "sn_ZW", "da_DK", "da_GL", "se_NO", "se_SE", "se_FI", "et_EE", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_EC", "es_SV", "es_GT", "es_HN", "es_NI", "es_PA", "es_PY", "es_PE", "es_PR", "es_DO", "es_UY", "es_VE", "eu_ES", "fr_BE", "fr_CA", "fr_CH", "fo_DK", "fo_FO", "gl_ES", "hr_BA", "hr_HR", "nd_ZW", "xh_ZA", "zu_ZA", "it_VA", "it_IT", "it_SM", "it_CH", "kl_GL", "kw_GB", "ku_TR", "lv_LV", "to_TO", "lt_LT", "ln_AO", "ln_CG", "ln_CF", "ln_CD", "hu_HU", "nn_NO", "no_NO", "nb_NO", "nb_SJ", "uz_AF", "uz_UZ", "pl_PL", "ro_MD", "ro_RO", "rm_CH", "sq_XK", "sq_MK", "sq_AL", "sk_SK", "sl_SI", "fi_FI", "sv_FI", "sv_SE", "sv_AX", "mi_NZ", "tk_TM", "yo_BJ", "yo_NG", "is_IS", "cs_CZ", "el_GR", "el_CY", "be_BY", "bg_BG", "os_GE", "os_RU", "ky_KG", "mk_MK", "mn_MN", "ce_RU", "sr_BA", "sr_CS", "sr_RS", "sr_ME", "tt_RU", "tg_TJ", "uk_UA", "kk_KZ", "hy_AM", "ug_CN", "ur_IN", "ur_PK", "ar_JO", "ar_AE", "ar_BH", "ar_DZ", "ar_SD", "ar_IQ", "ar_KW", "ar_MA", "ar_SA", "ar_YE", "ar_TN", "ar_SY", "ar_OM", "ar_QA", "ar_LB", "ar_LY", "sd_PK", "sd_IN", "fa_AF", "fa_IR", "ps_AF", "ps_PK", "ks_IN", "ne_NP", "ne_IN", "mr_IN", "sa_IN", "hi_IN", "as_IN", "bn_BD", "bn_IN", "pa_PK", "pa_IN", "gu_IN", "or_IN", "ta_IN", "ta_LK", "ta_SG", "ta_MY", "te_IN", "kn_IN", "ml_IN", "si_LK", "th_TH", "lo_LA", "bo_IN", "bo_CN", "dz_BT", "my_MM", "ka_GE", "ti_ET", "ti_ER", "am_ET", "km_KH", "zh_MO", "zh_HK", "zh_SG", "zh_CN", "zh_TW", "ja_JP", "ii_CN", "ko_KR", "ko_KP" ], "type": "string" }, "last_name": { "anyOf": [ { "description": "Represents the last name of the user.", "maxLength": 50, "type": "string", "x-zs-$id": "UserLastName" }, { "description": "Indicates that no last name is set for the user.", "type": "null", "x-zs-$id": "NoUserLastName" } ], "description": "Represents the user's last name. Returns null if no last name is set." }, "locale": { "description": "Represents the locale of the user.", "enum": [ "in_ID", "en_IN", "zh_CN", "zh_TW", "da_DK", "de_DE", "en_GB", "en_US", "es_ES", "fr_FR", "iw_IL", "hr_HR", "it_IT", "hu_HU", "nl_NL", "pl_PL", "pt_BR", "pt_PT", "sv_SE", "vi_VN", "tr_TR", "cs_CZ", "bg_BG", "ru_RU", "ar_EG", "hi_IN", "th_TH", "ja_JP", "ko_KR" ], "type": "string" }, "microsoft": { "description": "Indicates whether the user is authenticated via a Microsoft account.\\nPossible values:\\ntrue - The user is a Microsoft account user.\\nfalse - The user is not a Microsoft account user.", "type": "boolean" }, "mobile": { "description": "Represents the user's mobile phone number. Returns null when no mobile number is associated with the account.", "maxLength": 30, "type": [ "string", "null" ] }, "name_format__s": { "description": "Represents the format used to display the user's name.", "enum": [ "Salutation,First Name,Last Name", "Salutation,Last Name,First Name", "First Name,Salutation,Last Name", "First Name,Last Name,Salutation", "Last Name,Salutation,First Name", "Last Name,First Name,Salutation" ], "type": "string" }, "ntc_enabled": { "description": "Indicates whether Notification Template Configuration (NTC) is enabled for the user.\\n\\nPossible values:\\ntrue - NTC is enabled and notification templates are applied to the user.\\nfalse - NTC is disabled and notification templates are not applied to the user.", "type": "boolean", "x-visibility": "internal" }, "ntc_notification_type": { "description": "Represents the list of Notification Template Configuration (NTC) notification type identifiers assigned to the user.", "items": { "description": "Represents the unique identifier of a Notification Template Configuration (NTC) notification type.", "format": "int64", "type": "integer" }, "maxItems": 100, "type": "array", "x-visibility": "internal" }, "number_separator": { "description": "Represents the character used as a separator when formatting numbers for the user. This field is case-insensitive.", "enum": [ "Comma", "Period", "Space", "comma", "period", "space" ], "type": "string" }, "offset": { "description": "Represents the user's current UTC offset in milliseconds, adjusted for Daylight Saving Time (DST) where applicable. For example, a timezone of UTC+5:30 yields an offset value of 19800000 (5.5 hours × 3600 seconds × 1000 milliseconds). This value may be added to the current UTC time to derive the user's local time.", "format": "int32", "readOnly": true, "type": "integer" }, "personal_account": { "description": "Indicates whether the user has a personal account associated with their profile.\\n\\nPossible values:\\ntrue - The user has a personal account.\\nfalse - The user does not have a personal account.", "type": "boolean" }, "phone": { "description": "Represents the user's phone number. Returns null when no phone number is associated with the account.", "maxLength": 30, "type": [ "string", "null" ] }, "profile": { "additionalProperties": false, "description": "Represents the profile associated with the user, including the profile's unique identifier and display name.", "properties": { "id": { "description": "Represents the unique identifier of the profile associated with the user.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the profile associated with the user.", "maxLength": 50, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "role": { "additionalProperties": false, "description": "Represents the role assigned to the user, containing the role's unique identifier and display name.", "properties": { "id": { "description": "Represents the unique identifier of the role assigned to the user.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the role assigned to the user.", "maxLength": 200, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "rtl_enabled": { "description": "Indicates whether Right-to-Left (RTL) text direction is enabled for the user's interface.\\n\\nPossible values:\\ntrue - RTL text direction is enabled for the user.\\nfalse - RTL text direction is not enabled for the user.", "type": "boolean", "x-visibility": "internal" }, "sandboxDeveloper": { "description": "Indicates whether the user is designated as a sandbox developer.\\n\\nPossible values:\\ntrue - The user is a sandbox developer.\\nfalse - The user is not a sandbox developer.", "type": "boolean" }, "share_among_subordinates": { "description": "Indicates whether the user's records are shared with their subordinates.\\n\\nPossible values:\\ntrue - Records are shared with subordinates.\\nfalse - Records are not shared with subordinates.", "type": "boolean" }, "signature": { "description": "Represents the email signature configured for the user. Returns null if no signature has been set.", "maxLength": 200, "type": [ "string", "null" ] }, "sort_order_preference__s": { "description": "Represents the user's preferred sort order for displaying records.", "enum": [ "First Name,Last Name", "Last Name,First Name" ], "type": "string" }, "state": { "anyOf": [ { "description": "Represents the state or province associated with the user.", "maxLength": 100, "type": "string", "x-zs-$id": "UserState" }, { "description": "Indicates that no state or province is set for the user.", "type": "null", "x-zs-$id": "NoUserState" } ], "description": "Represents the user's state or province. Returns null if no state is set." }, "status": { "anyOf": [ { "description": "Represents the current status of the user in the Zoho CRM organization.", "enum": [ "deleted", "disabled", "closed", "disabled dormant" ], "readOnly": true, "type": "string", "x-zs-$id": "UserStatusInGet" }, { "description": "Indicates that no status is set for the user.", "enum": [ "active", "inactive" ], "type": "string", "x-zs-$id": "UserStatusInUpdate" } ], "description": "Represents the current status of the user in the Zoho CRM organization.\nPossible values:\nactive - The user is active and can access the CRM.\ninactive - The user is deactivated and cannot access the CRM.\ndeleted - The user account has been deleted.\ndisabled - The user account is disabled.\nclosed - The user account is closed.\ndisabled dormant - The user account is disabled and dormant." }, "status_reason__s": { "anyOf": [ { "description": "Represents the reason for the user's current status.", "enum": [ "disabled due to license limit reached", "waiting for approval", "disabled due to license downgrade", "disabled due to record is in recycle bin", "disabled manually", "disabled on updation of email" ], "type": "string", "x-zs-$id": "UserStatusReason" }, { "description": "Indicates that no status reason is associated with the user's current status.", "type": "null", "x-zs-$id": "NoUserStatusReason" } ], "description": "Represents the reason for the user's current status. Returns null if no reason is associated with the current status." }, "street": { "anyOf": [ { "description": "Represents the street address associated with the user.", "maxLength": 250, "type": "string", "x-zs-$id": "UserStreet" }, { "description": "Indicates that no street address is set for the user.", "type": "null", "x-zs-$id": "NoUserStreet" } ], "description": "Represents the user's street address. Returns null if no street address is set." }, "telephony_enabled": { "description": "Indicates whether telephony is enabled for the user.\\nPossible values:\\ntrue - Telephony is enabled for the user.\\nfalse - Telephony is not enabled for the user.", "type": "boolean", "x-visibility": "internal" }, "theme": { "additionalProperties": false, "description": "Represents the theme configuration applied to the user's CRM interface. Includes color and display settings for the background, screen, header, normal tab, and selected tab elements.", "properties": { "background": { "description": "Represents the background color of the user's theme.", "format": "hex-color", "type": "string" }, "header": { "additionalProperties": false, "description": "Represents the theme configuration for the header area of the user's CRM interface. Includes the background color and font color settings for the header.", "properties": { "background": { "description": "Represents the background color of the header area in the user's theme.", "format": "hex-color", "type": "string" }, "font_color": { "description": "Represents the font color of the header area in the user's theme.", "format": "hex-color", "type": "string" } }, "type": "object" }, "new_background": { "description": "Represents the updated background color applied to the user's theme.", "format": "hex-color", "type": [ "string", "null" ] }, "normal_tab": { "additionalProperties": false, "description": "Represents the theme configuration for the normal (unselected) tab in the user's CRM interface, including background color and font color settings.", "properties": { "background": { "description": "Represents the background color of the normal tab in the user's theme.", "format": "hex-color", "type": "string" }, "font_color": { "description": "Represents the font color of the normal tab in the user's theme.", "format": "hex-color", "type": "string" } }, "type": "object" }, "screen": { "description": "Represents the screen type or layout setting applied to the user's CRM interface.", "enum": [ "fixed" ], "type": "string" }, "selected_tab": { "additionalProperties": false, "description": "Represents the theme configuration for the currently selected tab in the user's CRM interface, including background color and font color settings.", "properties": { "background": { "description": "Represents the background color of the selected tab in the user's theme.", "format": "hex-color", "type": "string" }, "font_color": { "description": "Represents the font color of the selected tab in the user's theme.", "format": "hex-color", "type": "string" } }, "type": "object" }, "type": { "description": "Represents the type of theme applied to the user's CRM interface.", "enum": [ "default", "custom" ], "type": "string" } }, "readOnly": true, "type": "object" }, "time_format": { "description": "Represents the time format preferred by the user for displaying time values.", "enum": [ "HH:mm", "hh:mm a" ], "type": "string" }, "time_zone": { "description": "Represents the time zone of the user. This value can be updated only by the user themselves.", "maxLength": 150, "type": "string" }, "type__s": { "description": "Represents the account type of the user.", "enum": [ "Sandbox Developer User", "Support User", "Client Portal User", "Regular User", "Team User", "System User", "Digital Employee" ], "readOnly": true, "type": "string" }, "website": { "anyOf": [ { "description": "Represents the website URL associated with the user.", "maxLength": 250, "type": "string", "x-zs-$id": "UserWebsite" }, { "description": "Indicates that no website URL is configured for the user.", "type": "null", "x-zs-$id": "NoUserWebsite" } ], "description": "Represents the user's website URL. Returns null if no website is configured." }, "zip": { "anyOf": [ { "description": "Represents the postal code or ZIP code associated with the user.", "maxLength": 30, "type": "string", "x-zs-$id": "UserPostalCode" }, { "description": "Indicates that no postal code is set for the user.", "type": "null", "x-zs-$id": "NoUserPostalCode" } ], "description": "Represents the user's postal code or ZIP code. Returns null if no postal code is set." }, "zuid": { "anyOf": [ { "description": "Represents the Zoho User ID (ZUID) associated with the user.", "maxLength": 19, "type": "string", "x-zs-$id": "UserZUID" }, { "description": "Indicates that no ZUID is associated with the user.", "type": "null", "x-zs-$id": "NoUserZUID" } ], "description": "Represents the Zoho User ID (ZUID) associated with the user's Zoho account.", "readOnly": true } }, "type": "object" }, "GetWebhookByIdSuccessResponse": { "additionalProperties": false, "description": "Represents the success response for retrieving a single webhook by ID, including the full webhook configuration with headers, body, url_parameters, authentication, and date_time_format.", "properties": { "webhooks": { "description": "Represents the list containing the single requested webhook object with its full configuration.", "items": { "$ref": "#/components/schemas/AutomationWebhooksResponse" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "GetWebhookByIdSuccessResponse", "x-zs-llm-description": "Full webhook detail response from GET-by-ID including headers, body, url_params, authentication, and date_time_format." }, "GetWebhooksSuccessResponse": { "additionalProperties": false, "description": "Represents the paginated success response for listing webhooks. Contains summary-level webhook objects without headers, body, authentication, or date_time_format details.", "properties": { "info": { "$ref": "#/components/schemas/PaginationInfoResponse", "description": "Pagination metadata for navigating the result set." }, "webhooks": { "description": "Represents the list of webhook summary objects returned by the list operation.", "items": { "$ref": "#/components/schemas/AutomationWebhooksResponse" }, "maxItems": 200, "type": "array" } }, "title": "Get Webhooks Success Response", "type": "object", "x-zs-$id": "GetWebhooksSuccessResponse", "x-zs-llm-description": "Paginated list response containing webhook summaries (without body/headers/auth details). Use GET-by-ID for full configuration." }, "GetappointmentssResponse200": { "additionalProperties": true, "description": "Represents the success response for the request to retrieve appointment records, containing the list of appointment objects.", "properties": { "data": { "description": "Represents the list of appointment records returned by the GET request.", "items": { "$ref": "#/components/schemas/AppointmentsGETDataNested" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "GetappointmentssResponse200" }, "GetfiscalyearResponse200": { "additionalProperties": false, "description": "Represents the response body containing the fiscal year settings configured for the organization.", "properties": { "fiscal_year": { "$ref": "#/components/schemas/GETFiscalYearNested" } }, "required": [ "fiscal_year" ], "type": "object", "x-zs-$id": "GetfiscalyearResponse200" }, "GetrecordscountResponse200": { "additionalProperties": false, "description": "Success response for tag records count API.", "properties": { "configured_areas": { "$ref": "#/components/schemas/GETConfiguredAreasNested" }, "count": { "description": "Total count of records associated with the tag", "maxLength": 255, "type": "string" } }, "required": [ "count" ], "type": "object", "x-zs-$id": "GetrecordscountResponse200" }, "GetrecordscountResponse207": { "additionalProperties": false, "description": "Represents the response containing the count of records enrolled in each Cadence.", "properties": { "cadences_records_count": { "description": "Represents the list of Cadences with their corresponding record counts.", "items": { "anyOf": [ { "$ref": "#/components/schemas/CadencesRecordsCountSuccess" }, { "$ref": "#/components/schemas/AllErrorResponse" } ], "description": "Represents the record count details for a single Cadence." }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "GetrecordscountResponse207" }, "GetservicessResponse200": { "additionalProperties": true, "description": "Wrapped response that lists the service records matching the request. Contains a data array with up to 200 service objects, each carrying the full set of service fields.", "properties": { "data": { "description": "Represents the array of service records returned by the request.", "items": { "$ref": "#/components/schemas/ServicesGETDataNested" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "GetservicessResponse200" }, "GettagsResponse200": { "additionalProperties": false, "description": "Represents the response body for a successful tag list retrieval.", "properties": { "info": { "$ref": "#/components/schemas/GETInfoNested" }, "tags": { "description": "Represents an array of tag objects returned for the module.", "items": { "$ref": "#/components/schemas/GETTagsNested" }, "maxItems": 484, "type": "array" } }, "required": [ "info", "tags" ], "type": "object", "x-zs-$id": "GettagsResponse200" }, "GetusertypeByIdResponse200": { "additionalProperties": false, "description": "Returned on a successful request to retrieve a single portal user type by ID. Contains the full configuration of the requested user type.", "properties": { "user_type": { "description": "An array containing the full configuration of the requested portal user type. Always contains exactly one entry.", "items": { "$ref": "#/components/schemas/GETUserTypeByIdNested" }, "maxItems": 1, "type": "array" } }, "required": [ "user_type" ], "type": "object", "x-zs-$id": "GetusertypeByIdResponse200" }, "GetusertypeResponse200": { "additionalProperties": false, "description": "Returned on a successful request to list all portal user types. Contains an array of user type summary objects.", "properties": { "user_type": { "description": "An array of portal user type summary objects, one per user type configured in the portal.", "items": { "$ref": "#/components/schemas/GETUserTypeNested" }, "maxItems": 5, "type": "array" } }, "required": [ "user_type" ], "type": "object", "x-zs-$id": "GetusertypeResponse200" }, "GetworkflowconfigurationsResponse200": { "additionalProperties": false, "description": "Response containing workflow configurations for a module including available triggers, actions, and related trigger details.", "properties": { "workflow_configurations": { "$ref": "#/components/schemas/WorkflowConfigurationsMetadata", "description": "Workflow configuration metadata for the requested module." } }, "title": "Workflow Configurations Response", "type": "object", "x-zs-$id": "GetworkflowconfigurationsResponse200", "x-zs-llm-description": "Use this response as the container for workflow configuration metadata returned for the requested module." }, "GlobalPicklistFilterCriteria": { "additionalProperties": false, "allOf": [ { "description": "A criteria on the boolean key customizable supports only the equal comparator with a boolean value." }, { "description": "A criteria on the string keys api_name and source supports the equal and not_equal comparators with a string value." } ], "description": "A single filter criteria that compares a global picklist key against the given value. The supported comparator and the data type of value depend on the key given in field.", "properties": { "comparator": { "description": "Comparator applied between the key and the given value. Dependent on field. The string keys api_name and source support equal and not_equal, and the boolean key customizable supports only equal.", "enum": [ "equal", "not_equal" ], "type": "string" }, "field": { "additionalProperties": false, "description": "The global picklist key on which the criteria is applied.", "properties": { "api_name": { "description": "The api_name of the key to be filtered on. Only api_name, source and customizable are supported.", "enum": [ "api_name", "source", "customizable" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "anyOf": [ { "description": "Value compared against the string keys api_name and source.", "maxLength": 50, "type": "string", "x-zs-$id": "GlobalPicklistFilterStringValue" }, { "description": "Value compared against the boolean key customizable.", "type": "boolean", "x-zs-$id": "GlobalPicklistFilterBooleanValue" } ], "description": "Value that the key is compared against. Dependent on field. A string of up to 50 characters for the string keys api_name and source, and a boolean for the boolean key customizable." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "GlobalPicklistFilterCriteriaSchema" }, "GlobalPicklistFilters": { "anyOf": [ { "$ref": "#/components/schemas/GlobalPicklistFilterCriteria", "x-zs-$id": "GlobalPicklistFiltersSingleCriteria" }, { "additionalProperties": false, "description": "A group of filter criteria combined using a group operator. Both group_operator and group are mandatory to each other.", "properties": { "group": { "description": "Array of filter criteria to be combined. Criteria cannot be nested inside another group.", "items": { "$ref": "#/components/schemas/GlobalPicklistFilterCriteria" }, "maxItems": 10, "minItems": 1, "type": "array" }, "group_operator": { "description": "Operator used to combine the criteria given in group.", "enum": [ "and", "or" ], "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object", "x-zs-$id": "GlobalPicklistFiltersGroupSchema" } ], "description": "Filter criteria used to select the global picklists by the value of a key. Either a single criteria or a group of criteria combined using a group operator." }, "GlobalPicklistInnerDetailsFilter": { "additionalProperties": false, "description": "A filter applied on one inner detail of the global picklists. Both api_name and filters are mandatory.", "properties": { "api_name": { "description": "The inner resource of the global picklists on which the filter is applied. Only pick_list_values is supported.", "enum": [ "pick_list_values" ], "type": "string" }, "filters": { "$ref": "#/components/schemas/GlobalPicklistInnerDetailsFilters" } }, "required": [ "api_name", "filters" ], "type": "object", "x-zs-$id": "GlobalPicklistInnerDetailsFilterSchema" }, "GlobalPicklistInnerDetailsFilterCriteria": { "additionalProperties": false, "description": "A single criteria that compares a key of the inner resource against the given value.", "properties": { "comparator": { "description": "Comparator applied between the key and the given value. Dependent on field.", "enum": [ "equal", "not_equal" ], "type": "string" }, "field": { "additionalProperties": false, "description": "The inner resource key on which the criteria is applied.", "properties": { "api_name": { "description": "The api_name of the inner resource key to be filtered on. Only type is supported for pick_list_values.", "enum": [ "type" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Value that the key is compared against. Dependent on field.", "enum": [ "used", "unused" ], "type": "string" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "GlobalPicklistInnerDetailsFilterCriteriaSchema" }, "GlobalPicklistInnerDetailsFilters": { "anyOf": [ { "$ref": "#/components/schemas/GlobalPicklistInnerDetailsFilterCriteria", "x-zs-$id": "GlobalPicklistInnerDetailsFiltersSingleCriteria" }, { "additionalProperties": false, "description": "A group of criteria combined using a group operator. Both group_operator and group are mandatory to each other.", "properties": { "group": { "description": "Array of criteria or nested groups to be combined.", "items": { "$ref": "#/components/schemas/GlobalPicklistInnerDetailsFilters" }, "maxItems": 10, "minItems": 1, "type": "array" }, "group_operator": { "description": "Operator used to combine the criteria given in group.", "enum": [ "and", "or" ], "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object", "x-zs-$id": "GlobalPicklistInnerDetailsFiltersGroupSchema" } ], "description": "Criteria used to filter the inner resource. Either a single criteria or a group of criteria combined using a group operator. A group may be nested inside another group." }, "GlobalPicklistOptionDeletionErrorResponse": { "additionalProperties": false, "description": "Returned when attempting to delete a global picklist option, which is not allowed. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Global picklist option cannot be deleted" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklist Option Deletion Error Response", "type": "object", "x-zs-$id": "GlobalPicklistOptionDeletionErrorResponse" }, "GlobalPicklistOptionReplaceErrorResponse": { "additionalProperties": false, "description": "Returned when attempting to replace a global picklist option, which is not allowed. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Global picklist option cannot be replaced" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklist Option Replace Error Response", "type": "object", "x-zs-$id": "GlobalPicklistOptionReplaceErrorResponse" }, "GlobalPicklistsApiName": { "description": "API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.", "example": "api_name30", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string" }, "GlobalPicklistsDependentTypeMismatchError": { "additionalProperties": false, "description": "400 error returned when a filter value does not match the expected data type or dependency for global picklists. Includes code DEPENDENT_MISMATCH, message 'dependent mismatch', status 'error', and details describing the mismatch.", "properties": { "code": { "description": "Error code", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the dependent field", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Field that the dependent field depends on", "properties": { "api_name": { "description": "API name of the dependee field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the dependee field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "expected_data_type": { "description": "Expected data type for the dependent field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the dependent field", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the dependent field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "dependee", "expected_data_type", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "dependent mismatch" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Dependent Type Mismatch Error", "type": "object", "x-zs-$id": "GlobalPicklistsDependentTypeMismatchError" }, "GlobalPicklistsId": { "description": "Id of the resource.", "example": "1385208000000973001", "format": "int64", "type": "string" }, "GlobalPicklistsInvalidApiNameError": { "additionalProperties": false, "description": "400 error returned when the provided api_name is invalid for global picklists operations. Includes code INVALID_DATA, message 'invalid data', status 'error', and details describing the validation failure.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the invalid field", "enum": [ "api_name" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the invalid field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Invalid API Name Error", "type": "object", "x-zs-$id": "GlobalPicklistsInvalidApiNameError" }, "GlobalPicklistsInvalidFilterParamError": { "additionalProperties": false, "description": "400 error returned when the filters or inner_details_filters query parameter contains invalid data while retrieving or filtering global picklists. The param_name detail identifies the query parameter that caused the error. Includes code INVALID_DATA, message 'invalid data', status 'error', and a details object with validation information.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "expected_data_type": { "description": "Expected data type for the parameter", "maxLength": 255, "type": "string" }, "param_name": { "description": "Name of the parameter that caused the error", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type", "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Invalid Filter Param Error", "type": "object", "x-zs-$id": "GlobalPicklistsInvalidFilterParamError" }, "GlobalPicklistsInvalidFiltersError": { "additionalProperties": false, "description": "400 error returned when the filters object contains invalid data while querying global picklists. Includes code INVALID_DATA, message 'invalid data', status 'error', and a details object outlining validation issues.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the invalid field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Invalid Filters Error", "type": "object", "x-zs-$id": "GlobalPicklistsInvalidFiltersError" }, "GlobalPicklistsInvalidGroupOperatorError": { "additionalProperties": false, "description": "400 error returned when the group_operator value in the filters or inner_details_filters query parameter is invalid. The param_name detail identifies the query parameter that caused the error. Includes code INVALID_DATA, message 'invalid data', status 'error', and details with the supported values (and, or).", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name. Always group_operator for this error.", "enum": [ "group_operator" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the invalid field", "maxLength": 255, "type": "string" }, "supported_values": { "description": "List of supported values for the group_operator field.", "items": { "description": "A supported group_operator value.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "param_name", "supported_values" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Invalid Group Operator Error", "type": "object", "x-zs-$id": "GlobalPicklistsInvalidGroupOperatorError" }, "GlobalPicklistsMandatoryApiNameMissingError": { "additionalProperties": false, "description": "400 error returned when a required api_name field is missing in the request context for global picklists. Includes code MANDATORY_NOT_FOUND, message 'required field not found', status 'error', and details identifying the missing field.", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Mandatory API Name Missing Error", "type": "object", "x-zs-$id": "GlobalPicklistsMandatoryApiNameMissingError" }, "GlobalPicklistsMissingComparatorForFieldError": { "additionalProperties": false, "description": "400 error returned when a filter specifies a field but omits the required comparator for global picklists. Includes code DEPENDENT_FIELD_MISSING, message 'Dependent Field missing', status 'error', and details indicating the missing comparator.", "properties": { "code": { "description": "Error code", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the missing dependent field", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Detail field: dependee", "properties": { "api_name": { "description": "Nested detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path to the missing dependent field", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "dependee", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Dependent Field missing" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Missing Comparator For Field Error", "type": "object", "x-zs-$id": "GlobalPicklistsMissingComparatorForFieldError" }, "GlobalPicklistsModuleName": { "description": "Name of the module", "example": "Leads", "maxLength": 100, "type": "string" }, "GlobalPicklistsNotSupportedFieldError": { "additionalProperties": false, "description": "400 error returned when a field api_name value is not supported in the global picklists filters or inner_details_filters query parameter. The param_name detail identifies the query parameter that caused the error. Includes code NOT_SUPPORTED, message 'The value given is not supported', status 'error', and details identifying the unsupported field. The json_path varies based on the parameter and its filter nesting depth (e.g. $.filters.field.api_name, $.filters.group[n].field.api_name, $.inner_details_filters[0].filters.field.api_name, $.inner_details_filters[0].filters.group[n].field.api_name, $.inner_details_filters[0].filters.group[n].group[m].field.api_name, etc.).", "properties": { "code": { "description": "Error code", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name contains unsupported field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the unsupported field. Varies based on filter nesting depth — can point to filters.field.api_name or any nested group level such as filters.group[n].field.api_name or filters.group[n].group[m].field.api_name.", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the unsupported field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The value given is not supported" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Not Supported Field Error", "type": "object", "x-zs-$id": "GlobalPicklistsNotSupportedFieldError" }, "GlobalPicklistsUnsupportedComparatorError": { "additionalProperties": false, "description": "400 error returned when a provided comparator is not supported in a global picklists filter. Includes code INVALID_DATA, message 'The value given is not supported', status 'error', and details about the invalid comparator.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field with unsupported comparator", "maxLength": 255, "type": "string" }, "json_path": { "description": "Invalid JSON path", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the parameter that contains the unsupported comparator", "maxLength": 255, "type": "string" }, "supported_values": { "description": "List of supported comparator values", "items": { "description": "Supported comparator value", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "param_name", "supported_values" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The value given is not supported" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Picklists Unsupported Comparator Error", "type": "object", "x-zs-$id": "GlobalPicklistsUnsupportedComparatorError" }, "GlobalScoringRuleLimitExceededErrorResponse": { "additionalProperties": false, "description": "Error message indicating that the maximum number of scoring rules for a layout has been exceeded, which is capped at 10.", "properties": { "code": { "description": "Represents the error code **LIMIT_EXCEEDED**.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional validation details about the Scoring Rule limit error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the limit exceeded error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that triggered the limit exceeded error.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the maximum number of Scoring Rules allowed per layout.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the Scoring Rule limit per layout has been reached.", "enum": [ "More than 10 scoring rules cannot be created for a layout" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Global Scoring Rule Limit Exceeded Error Response", "type": "object", "x-zs-$id": "GlobalScoringRuleLimitExceededErrorResponse" }, "GroupResourceRequestObject": { "additionalProperties": false, "description": "Group resource reference for Assignment Rule entry.", "properties": { "id": { "description": "Specify the ID of the group. Refer to the [User Groups](user_groups.yaml#$.paths./settings/user_groups.get) resource for valid values.", "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUserGroups", "propertyId": "UserGroupId" }, { "operationId": "createGroup", "propertyId": "UserGroupResultId" } ], "resource": "user_groups" } } }, "required": [ "id" ], "title": "Group Resource Request Object", "type": "object" }, "GroupTypeAssignToRequestObject": { "additionalProperties": false, "description": "Assigns ownership to a group. All users within the specified group are eligible for assignment.", "properties": { "resource": { "$ref": "#/components/schemas/GroupResourceRequestObject", "description": "Details of the group to assign" }, "type": { "description": "Assign to type IDentifier. Must be 'group'.\nPossible values:\n**group** - Represents group.", "enum": [ "group" ], "type": "string" } }, "required": [ "type", "resource" ], "title": "Group type assign to request object", "type": "object", "x-zs-$id": "GroupTypeAssignToRequestObject" }, "GroupedFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a grouped filter criterion containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic.", "properties": { "group": { "description": "Contains an array of filter conditions grouped together and evaluated with the specified logical operator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" } ] }, "maxItems": 25, "minItems": 2, "type": "array" }, "group_operator": { "description": "Represents the logical operator applied between the filter conditions in the group.\nPossible values:\nAND - All conditions in the group must be satisfied.\nOR - At least one condition in the group must be satisfied.\nand - Equivalent to AND; all conditions in the group must be satisfied.\nor - Equivalent to OR; at least one condition in the group must be satisfied.", "enum": [ "AND", "OR", "and", "or" ], "type": "string" } }, "required": [ "group", "group_operator" ], "type": "object", "x-zs-$id": "GroupedFilterCriterionRequest" }, "GroupedFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the grouped filter criterion returned in the response, containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic.", "properties": { "$disrupted": { "description": "Indicates whether the grouped filter criterion is in a disrupted state, typically due to an invalid or unresolvable condition within the group.", "type": "boolean" }, "group": { "description": "Contains an array of filter conditions grouped together and evaluated with the specified logical operator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionResponse" }, { "$ref": "#/components/schemas/GroupedFilterCriterionResponse" } ] }, "maxItems": 25, "minItems": 2, "type": "array" }, "group_operator": { "description": "Represents the logical operator applied between the filter conditions in the group.\nPossible values:\nAND - All conditions in the group must be satisfied.\nOR - At least one condition in the group must be satisfied.\nand - Equivalent to AND; all conditions in the group must be satisfied.\nor - Equivalent to OR; at least one condition in the group must be satisfied.", "enum": [ "AND", "OR", "and", "or" ], "type": "string" } }, "required": [ "group", "group_operator" ], "type": "object", "x-zs-$id": "GroupedFilterCriterionResponse" }, "HolidaysSuccessResponse": { "additionalProperties": false, "description": "Represents the success response body the API returns after creating holidays.", "properties": { "holidays": { "description": "Contains the result for each holiday included in the create request. ", "items": { "additionalProperties": false, "description": "Represents the result for a single holiday creation request.", "properties": { "code": { "description": "Indicates the result code for the holiday operation. Possible values: SUCCESS. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the processed holiday, including its unique identifier. ", "properties": { "id": { "description": "Represents the unique identifier of the created holiday.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Describes the result of the holiday creation operation. ", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the holiday creation operation. Possible values: success. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysSuccessResponse" }, "HttpMethodDependentMismatchError": { "additionalProperties": false, "description": "Represents the error returned when the request includes fields incompatible with the chosen http_method. For example, body with GET or DELETE, or url_parameters with POST or PUT.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**DEPENDENT_MISMATCH** - The value provided for the HTTP method does not match the expected dependent field configuration.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the HTTP method field that caused the dependent mismatch.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field configuration that conflicts with the submitted HTTP method value.", "properties": { "api_name": { "description": "Represents the API name of the dependee or conflicting field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependee or conflicting field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Invalid value provided for the given http method** - The value submitted for the HTTP method field is not valid for the configured dependent field.", "enum": [ "Invalid value provided for the given http method" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "HttpMethodDependentMismatchError", "x-zs-llm-description": "Request body parameters are incompatible with the chosen http_method (e.g., body with GET/DELETE, url_params with POST)." }, "HttpMethodMandatoryError": { "additionalProperties": false, "description": "Represents the error returned when the http_method field is absent from the webhook request body.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**MANDATORY_NOT_FOUND** - The HTTP method field is missing from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the mandatory HTTP method field that is missing.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field that is missing.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the mandatory field that is missing.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The method type is not given** - The HTTP method field is missing from the request body.", "enum": [ "The method type is not given " ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "HttpMethodMandatoryError", "x-zs-llm-description": "The http_method field is missing from the request body. It is mandatory." }, "IdDetail": { "additionalProperties": false, "description": "Represents the ID details for a created or affected resource.", "properties": { "id": { "description": "Represents the unique ID of the created or affected resource.", "format": "int64", "maxLength": 25, "type": "string", "x-zs-$id": "CustomViewResultId" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "IdDetail" }, "IdDetails": { "additionalProperties": false, "description": "Represents error details containing the unique identifier of the resource associated with the error.", "properties": { "id": { "description": "Represents the unique identifier of the resource.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "IdDetails" }, "IdSchema": { "description": "ID of the resource.", "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string", "x-zs-$id": "IdSchema" }, "IdenticalSourceAndTargetErrorResponse": { "additionalProperties": false, "description": "Returned when old_value and new_value reference the same picklist option. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Detail field: dependee", "properties": { "api_name": { "description": "Nested detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "old_value and new_value should not be the same" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Identical Source and Target Error Response", "type": "object", "x-zs-$id": "IdenticalSourceAndTargetErrorResponse" }, "IdsLimitExceededError": { "additionalProperties": false, "description": "Returned when the number of IDs provided in the ids query parameter exceeds the maximum allowed limit of 10.", "properties": { "code": { "description": "Error code indicating the data provided is invalid", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the limit that was exceeded", "properties": { "maximum_length": { "description": "The maximum number of IDs allowed in a single bulk delete request", "format": "int32", "type": "integer" }, "param_name": { "description": "The query parameter that exceeded the limit", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "example": "Ids maximum length exceeded", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Ids Limit Exceeded Error", "type": "object", "x-zs-$id": "IdsLimitExceededError", "x-zs-llm-description": "Too many IDs provided maximum is 10 per bulk delete request. Split into multiple calls." }, "InfoNestedSchema": { "additionalProperties": false, "description": "Represents the pagination metadata included in list response payloads, including the current page, records per page, total count, and whether more records exist.", "properties": { "count": { "description": "Represents the total number of records matching the query.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether more records exist beyond the current page.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of records returned per page.", "format": "int32", "type": "integer" } }, "required": [ "count", "more_records", "page", "per_page" ], "type": "object", "x-zs-llm-description": "Pagination metadata in list responses. Contains per_page (items per page), count (items in current page), page (current page number), more_records (boolean - whether additional pages exist). Use more_records to determine if next page should be fetched." }, "InfoSchema": { "additionalProperties": false, "description": "Represents the pagination details for the response, including the current page, per-page count, total count, and whether more records are available.", "properties": { "count": { "description": "Represents the total number of records returned in the current page.", "format": "int32", "minimum": 0, "type": "integer" }, "more_records": { "description": "Indicates whether more records are available in subsequent pages.", "type": "boolean" }, "page": { "description": "Represents the current page number of the paginated results.", "format": "int32", "minimum": 1, "type": "integer" }, "per_page": { "description": "Represents the number of records returned per page.", "format": "int32", "maximum": 2000, "minimum": 1, "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object", "x-zs-$id": "InfoSchema" }, "InitiateUnsubscribeLinksRequest": { "additionalProperties": false, "description": "Request payload to create one or more unsubscribe links.", "properties": { "unsubscribe_links": { "description": "Array containing the unsubscribe link configuration to create (required)", "items": { "$ref": "#/components/schemas/UnsubscribeLinkCreateItem" }, "maxItems": 1, "type": "array" } }, "required": [ "unsubscribe_links" ], "title": "Unsubscribe Link Creation Request", "type": "object" }, "InstantActionsNestedSchema": { "additionalProperties": false, "description": "Represents the container for instant actions that execute immediately when the workflow rule condition is met.", "properties": { "actions": { "description": "Represents the array of action objects configured for this condition. Required and must be non-empty. Each action object specifies the action type and its configuration or reference ID.", "items": { "anyOf": [ { "$ref": "#/components/schemas/NonAssociateActionsNestedSchema" }, { "$ref": "#/components/schemas/AssociateActionsNestedSchema" } ] }, "maxItems": 50, "type": "array" } }, "required": [ "actions" ], "type": "object", "x-zs-llm-description": "Container for actions that execute immediately when the condition is met. Contains actions array (non-empty required). Each action is either associate (pre-configured entity referenced by type+id) or non-associate (inline type+details). Check getWorkflowConfigurations actions[].associate_action to determine which pattern to use for each action type." }, "InstantActionsUsageListSchema": { "additionalProperties": false, "description": "Represents a container for the list of instant action usage detail objects associated with a workflow rule condition.", "properties": { "actions": { "description": "Represents the array of action usage detail objects for the instant actions configured in this condition.", "items": { "anyOf": [ { "$ref": "#/components/schemas/QueuedActionUsageMetricsSchema" }, { "$ref": "#/components/schemas/ActionUsageMetricsSchema" } ], "x-zs-$id": "InstantActionsUsageListItemsSchema" }, "maxItems": 5, "type": "array" } }, "required": [ "actions" ], "title": "Instant Actions Usage List", "type": "object", "x-zs-llm-description": "Container for instant action usage metrics without tag information. Contains actions array with per-action success/failure/queue counts." }, "InstantActionsUsageWithTagsSchema": { "additionalProperties": false, "description": "Represents a container for instant action usage details that include tag-based metrics, grouped within a workflow rule condition.", "properties": { "actions": { "description": "Represents the array of action usage detail objects, including those associated with tags, for the instant actions configured in this condition.", "items": { "$ref": "#/components/schemas/TaggedActionUsageMetricsSchema" }, "maxItems": 5, "type": "array" } }, "required": [ "actions" ], "title": "Instant Actions Usage With Tags", "type": "object", "x-zs-llm-description": "Container for tagged instant action usage metrics. Contains actions array where each entry includes tag_id alongside success/failure counts." }, "InternalServerErrorResponse": { "additionalProperties": false, "description": "Error response when an unexpected server-side exception occurs.", "properties": { "code": { "description": "Error code", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": {}, "type": "object" }, "message": { "description": "Error message", "example": "Internal Server Error", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Internal Server Error Response", "type": "object", "x-zs-$id": "InternalServerErrorResponse", "x-zs-llm-description": "Unexpected server-side error. Retry after a brief delay; if persistent, report to support." }, "InvalidActionIDErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the action ID provided in the request is invalid or does not match an existing webhook.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook action ID provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the parameter name associated with the invalid action ID.", "properties": { "param_name": { "description": "Represents the name of the parameter that contains the invalid action ID.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**the id given seems to be invalid** - The action ID provided in the request does not match a valid webhook record.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Action ID Error Response", "type": "object", "x-zs-$id": "InvalidActionIDErrorResponse", "x-zs-llm-description": "The action ID in the request is invalid. Verify webhook IDs via GET list." }, "InvalidAvailabilityTypeNotInPicklistError": { "additionalProperties": false, "description": "Error response returned when the Availability_Type value is not one of the supported picklist options.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the provided availability type value is not a valid picklist option.", "enum": [ "The given Availability Type is not in picklist" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidAvailabilityTypeNotInPicklistError" }, "InvalidBodyFormatError": { "additionalProperties": false, "description": "Represents the error returned when body.format contains an unsupported value for the raw body type.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The body format value provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid body format value.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid format value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid format value.", "maxLength": 1000, "type": "string" }, "regex": { "description": "Represents the regex pattern used to validate the body format field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**invalid format passed in body** - The format value provided in the body field does not match the expected pattern.", "enum": [ "invalid format passed in body" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidBodyFormatError", "x-zs-llm-description": "The body.format value is invalid for raw body type." }, "InvalidBodyTypeError": { "additionalProperties": false, "description": "Represents the error returned when body.type contains a value other than form_data, raw, or none.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The body type value provided in the request is not supported.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid field type value.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid body type value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid body type value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**invalid body type passed** - The body type value is not among the supported options.", "enum": [ "invalid body type passed" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidBodyTypeError", "x-zs-llm-description": "The body.type value is invalid. Use: raw, form_data, or none." }, "InvalidComparator": { "additionalProperties": false, "description": "Error schema returned when the comparator specified in a criterion field is not one of the allowed comparator values for the given field type. Returned with error code INVALID_DATA. The details object identifies the offending field by API name and JSON path, and enumerates the supported comparator values.", "properties": { "code": { "description": "Error code identifying the category of error. Possible values: INVALID_DATA.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains structured information about the invalid comparator error. Identifies the offending criterion field by API name and JSON path, and provides the list of supported comparator values valid for the given field type.", "properties": { "api_name": { "description": "API name of the criterion field for which an invalid comparator was specified.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path locating the criterion field with the invalid comparator within the request body.", "maxLength": 512, "type": "string" }, "supported_values": { "description": "Contains the comparator values that are valid for the criterion field type.", "items": { "description": "Represents one valid comparator value accepted for the criterion field type.", "maxLength": 256, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Descriptive error message conveying the nature of the invalid comparator condition to the caller.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the response indicating the outcome of the request. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidComparator" }, "InvalidConnectionNameError": { "additionalProperties": false, "description": "Represents the error returned when the provided connection_name does not exist or is invalid.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The connection name provided in the authentication configuration is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field with the invalid connection name.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Please provide valid connection name** - The connection name in the authentication configuration does not match any existing Zoho Connections integration.\n**invalid data** - The connection name value is not in a valid format.", "enum": [ "Please provide valid connection name", "invalid data" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidConnectionNameError", "x-zs-llm-description": "The connection_name does not exist or is invalid. Verify via Connections settings." }, "InvalidCustomLocationURLError": { "additionalProperties": false, "description": "Error returned when the custom location URL provided is invalid or does not match the expected website format.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid custom location URL error.", "properties": { "api_name": { "description": "The API name of the invalid field", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "The expected data type (e.g., website)", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the invalid field", "maxLength": 1000, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid URL issue.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Custom Location URL Error", "type": "object", "x-zs-$id": "InvalidCustomLocationURLError" }, "InvalidCustomTimeError": { "additionalProperties": false, "description": "Error response returned when a custom time provided in the service availability timings is invalid.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ " The given custom time is invalid" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidCustomTimeError" }, "InvalidData": { "additionalProperties": false, "description": "Represents the error response when a territory request contains invalid field data.", "properties": { "territories": { "description": "Represents the list of territory objects with their error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains invalid data.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the reason for this failure.", "enum": [ "Don't use the special characters like \"^ ~ ` # % ^ & * () + = {} [\\] | \\ ; \" , ' ! <> \"", "The Territory Id given seems to be invalid", "Given Territoryid isn't valid one", "Given transfer_to_id isn't valid one", "required field not found", "Choose correct transfer_to_id value", "Territory id and Transfer_to_id are same.Please choose different transfer_to_id", "Given Reporting To Territory value is invalid", "Access value can't be Null or Empty", "Territory Name character limit exceeded", "Description character limit exceeded", "Territory Name cannot be empty", "Special Characters in Territory Name", "Invalid Parent Id", "Invalid Data" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "InvalidData" }, "InvalidDataBodyError": { "additionalProperties": false, "description": "Error response for an invalid request body data type, providing the expected data type for the body.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid request body error.", "properties": { "expected_data_type": { "description": "Represents the expected data type for the request body.", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid request body issue.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataBodyError" }, "InvalidDataDelete": { "additionalProperties": false, "description": "Represents the error details returned when the Custom View ID provided for deletion is invalid or the view has already been deleted.", "properties": { "code": { "description": "Represents the error code for the invalid data error.\nPossible values:\n**INVALID_DATA** - The Custom View ID in the request is invalid or already deleted.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the invalid Custom View ID.", "properties": { "id": { "description": "Represents the ID of the invalid or already-deleted Custom View.", "format": "int64", "maxLength": 25, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data issue.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataDelete" }, "InvalidDataErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when a query parameter value is invalid.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - A query parameter value provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the name of the parameter with the invalid value.", "properties": { "param_name": { "description": "Represents the name of the parameter that contains the invalid value.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The value provided to the param is Invalid** - The value submitted for the parameter does not match the expected format or allowed values.", "enum": [ "The value provided to the param is Invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Error Response", "type": "object", "x-zs-$id": "InvalidDataErrorResponse", "x-zs-llm-description": "Generic invalid data error. Check details for specifics." }, "InvalidDataErrorSchemaPOST": { "additionalProperties": false, "description": "Represents an invalid data error for a contact role field in a create operation.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **INVALID_DATA** - The contact role data is invalid.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid data.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains invalid data.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidDataErrorSchemaPOST" }, "InvalidDataErrorSchemaPut": { "additionalProperties": false, "description": "Represents an invalid data error for a contact role field in an update operation.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **INVALID_DATA** - The contact role data is invalid.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid data.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the ID of the contact role that triggered the invalid data error.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains invalid data.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidDataErrorSchemaPut" }, "InvalidDataErrorSingle": { "additionalProperties": false, "description": "Error response for invalid data in single record operations", "properties": { "data": { "description": "Array of error results for single record", "items": { "additionalProperties": false, "description": "Error details for invalid data", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error", "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "InvalidDataErrorSingle" }, "InvalidDataErrorType": { "additionalProperties": false, "description": "Error returned when invalid data is provided for a field. The response includes supported values when applicable.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid data error.", "properties": { "api_name": { "description": "The API name of the invalid field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the invalid field", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of valid values for this field", "items": { "description": "Represents a supported value for the field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid value issue.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Error Type", "type": "object", "x-zs-$id": "InvalidDataErrorType" }, "InvalidDataFieldDetails": { "additionalProperties": false, "description": "Details for an INVALID_DATA error identifying the specific field and its location in the request.", "properties": { "api_name": { "description": "API name of the field that caused the validation error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the specific field that failed validation.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "InvalidDataFieldDetails" }, "InvalidDataFieldIndexDetails": { "additionalProperties": false, "description": "Details for an INVALID_DATA error at a specific array index within a field.", "properties": { "api_name": { "description": "API name of the field at the error index.", "maxLength": 100, "type": "string" }, "index": { "description": "Array index at which the validation error occurred.", "format": "int32", "type": "integer" }, "json_path": { "description": "JSON path to the field at the error index.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path", "index" ], "type": "object", "x-zs-$id": "InvalidDataFieldIndexDetails" }, "InvalidDataFieldValidationError": { "additionalProperties": false, "description": "Returned when the API validates a field value against its domain rules and finds it invalid - for example, a non-existent module ID, an unknown field API name, or a name containing disallowed characters. Distinguished from data-type validation errors by the context-specific message.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the invalid field", "properties": { "api_name": { "description": "API name of the field that failed validation", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field in the request body", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Context-specific error message describing the validation failure", "enum": [ "the tabId given seems to be invalid", "the tabName given seems to be invalid", "the fieldId given seems to be invalid", "field update name should not contain the following special character #%^&*()", "the value given seems to be invalid", "the given feature name is invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Field Validation Error", "type": "object", "x-zs-$id": "InvalidDataFieldValidationError", "x-zs-llm-description": "Field value fails domain validation e.g., non-existent module for transfer_ownership, invalid picklist value. Verify against field metadata." }, "InvalidDataFieldValueDetails": { "additionalProperties": false, "description": "Contains the contextual details for the invalid data field value error.", "properties": { "api_name": { "description": "Represents the API name of the field or module.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath location pointing to the field that caused the error.", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "InvalidDataFieldValueDetails" }, "InvalidDataFieldWithSupportedValuesDetails": { "additionalProperties": false, "description": "Details for an INVALID_DATA error on a constrained field, listing the supported values.", "properties": { "api_name": { "description": "API name of the field with invalid value.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid value.", "maxLength": 500, "type": "string" }, "supported_values": { "anyOf": [ { "description": "Represents the supported values as an array of strings.", "items": { "description": "Represents a single supported value for the constrained field.", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array", "x-zs-$id": "SupportedValuesArray" }, { "description": "Represents the supported values as a Boolean validation indicator.", "maxLength": 500, "type": "string", "x-zs-$id": "SupportedValuesString" } ], "description": "Supported values for the field, returned either as an array of strings or as a Boolean validation indicator." } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "InvalidDataFieldWithSupportedValuesDetails" }, "InvalidDataForFieldError": { "additionalProperties": false, "description": "Error response returned when the value provided for a service field does not satisfy its field-level validation requirements.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the limit that the request exceeded.", "format": "int32", "type": "integer" }, "maximum_length": { "description": "Represents the maximum length permitted for the offending field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "Invalid data", "invalid data", "Service timing does not satisfy Duration", "Unavailable from must not be greater than current Time" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataForFieldError" }, "InvalidDataForUpdateCV": { "additionalProperties": false, "description": "Represents the error details returned when the request contains invalid field values for a Custom View update.", "properties": { "code": { "description": "Represents the error code for the invalid data error.\nPossible values:\n**INVALID_DATA** - The request contains invalid field values.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFieldError" }, { "$ref": "#/components/schemas/ApiNameDetail" }, { "$ref": "#/components/schemas/DataTypeMismatchError" }, { "$ref": "#/components/schemas/InvalidTypeRegexValidationError" } ], "description": "Represents the additional details about the invalid field." }, "message": { "description": "Represents the error message describing the invalid data.", "enum": [ "invalid data", "Special Characters are not allowed", "Invalid Data", "Please give a valid comparator", "Invalid Data Type" ], "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataForUpdateCV" }, "InvalidDataGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid data GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the error.", "properties": { "param_name": { "description": "Contains additional context about the error.", "example": "cvid", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataGETError" }, "InvalidDataLengthDetails": { "additionalProperties": false, "description": "Details for an INVALID_DATA error caused by a field value exceeding the maximum allowed length.", "properties": { "api_name": { "description": "API name of the field whose value exceeded the maximum length.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field whose value exceeded the maximum length.", "maxLength": 500, "type": "string" }, "maximum_length": { "description": "Maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "InvalidDataLengthDetails" }, "InvalidDataLimitExceededError": { "additionalProperties": false, "description": "Error response when data array exceeds maximum limit", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "API name of the field that exceeded the limit", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field that exceeded the limit", "maxLength": 500, "type": "string" }, "maximum_length": { "description": "Maximum allowed number of elements in data array", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataLimitExceededError" }, "InvalidDataMaxLengthDetails": { "additionalProperties": false, "description": "Contains the contextual details for the invalid data max length error.", "properties": { "api_name": { "description": "Represents the API name of the field or module.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath location pointing to the field that caused the error.", "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed value or length for the field that failed validation.", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object", "x-zs-$id": "InvalidDataMaxLengthDetails" }, "InvalidDataMaximumLengthError": { "additionalProperties": false, "description": "Returned when a request body field value exceeds the maximum allowed character length. The `details` object identifies the field by API name and JSON path, and includes the configured maximum length.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "The maximum character length allowed for the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataMaximumLengthError" }, "InvalidDataMinimumLengthError": { "additionalProperties": false, "description": "Returned when a request body field value is shorter than the minimum required character length. The `details` object identifies the field and includes the configured minimum length.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" }, "minimum_length": { "description": "The minimum character length required for the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "minimum_length" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataMinimumLengthError" }, "InvalidDataMultiStatusError": { "additionalProperties": true, "description": "Multi-status error item returned when a service record in a bulk operation could not be processed because of invalid data.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents the details providing validation context for the error.", "properties": { "id": { "description": "Represents the unique ID of the service record that could not be processed.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message for the failure.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the response. ", "maxLength": 100, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataMultiStatusError" }, "InvalidDataNoApiNameAndPathSchema": { "additionalProperties": false, "description": "Represents the error response returned when a required parameter such as the module API name or field path is missing from the request.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_DATA", "NOT_ALLOWED", "INVALID_MODULE", "INVALID_REQUEST", "INVALID_REQUEST_METHOD", "AUTHENTICATION_FAILURE", "PATTERN_NOT_MATCHED", "JSON_PARSE_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "api_name": { "description": "Represents the API name of the field or parameter that caused the validation error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the **expected_data_type** value from the error detail object.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the **ID** value from the error detail object.", "maxLength": 20, "type": "string" }, "maximum_length": { "description": "Represents the **maximum_length** value from the error detail object.", "format": "int32", "type": "integer" }, "param_name": { "description": "Represents the **param_name** value from the error detail object.", "enum": [ "ids", "module", "executed_from", "executed_till", "execute_on", "sort_order", "sort_by" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "WorkflowRuleInvalidDataNoApiNameAndPathErrorResponses", "x-zs-llm-description": "Error codes: REQUIRED_PARAM_MISSING, INVALID_DATA, NOT_ALLOWED, INVALID_MODULE, or INVALID_REQUEST. Catch-all for request-level validation failures. REQUIRED_PARAM_MISSING: mandatory query/path param absent. INVALID_MODULE: module doesn't support workflow rules. INVALID_REQUEST: malformed JSON or structural issue. Fix: verify all required parameters and request structure." }, "InvalidDataParameterDetails": { "additionalProperties": false, "description": "Details for an INVALID_DATA error on a query or body parameter, identifying the parameter name and supported values.", "properties": { "param_name": { "description": "Name of the parameter that failed validation. Possible values: **module**, **status**, **layout_id**, **type**, **extra_properties**, **include_inner_details**, **feature_name**. ", "enum": [ "module", "status", "layout_id", "type", "extra_properties", "include_inner_details", "feature_name" ], "type": "string" }, "supported_values": { "description": "List of supported values for the parameter.", "items": { "description": "Represents a single supported value for the parameter.", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "InvalidDataParameterDetails" }, "InvalidDataRecordIdError": { "additionalProperties": false, "description": "Flat error response for invalid record ID in URL path. Unlike other INVALID_DATA errors, this is not wrapped in the get_related_records_count array because the error relates to the URL path parameter rather than a request body field.", "properties": { "code": { "description": "Error code for invalid data", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsResourcePathIndex" }, "message": { "description": "Human-readable error message describing the invalid record ID validation failure.", "maxLength": 500, "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataRecordIdError" }, "InvalidDataRegexError": { "additionalProperties": false, "description": "Returned when a request body field value does not match the required regular expression pattern. The `details` object identifies the field and specifies the expected regex pattern.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" }, "regex": { "description": "The regular expression pattern that the field value must match.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "regex" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataRegexError" }, "InvalidDataResourcePathDetails": { "additionalProperties": false, "description": "Details for an INVALID_DATA error caused by an invalid resource path identifier in the URL.", "properties": { "resource_path_index": { "description": "Index of the resource path segment that contains invalid data.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "InvalidDataResourcePathDetails" }, "InvalidDataResponse": { "additionalProperties": false, "description": "Represents the error response body returned when a holiday request fails due to validation errors.", "properties": { "code": { "description": "Indicates the validation error type. Possible values: DUPLICATE_DATA, INVALID_DATA, DEPENDENT_FIELD_MISSING.", "enum": [ "DUPLICATE_DATA", "INVALID_DATA", "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional information about the validation error.", "type": "object" }, "message": { "description": "Describes the specific validation error that occurred.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the response status. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "HolidaysErrorResponse400UpdateWithoutRoot" }, "InvalidDataSort": { "additionalProperties": false, "description": "Represents the error details returned when the sort field or sort order value in the request is invalid.", "properties": { "code": { "description": "Represents the error code for the invalid data error.\nPossible values:\n**INVALID_DATA** - The sort field or sort order value in the request is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/SimpleFieldError", "description": "Extra details" }, "message": { "description": "Represents the error message describing the invalid sort data.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataSort" }, "InvalidDataSortByError": { "additionalProperties": false, "description": "This error happens when attempting to retrieve records with information that doesn't match expected requirements. For example, an invalid sort_by parameter.", "properties": { "code": { "description": "A unique identifier for this specific type of error that helps identify what went wrong.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Extra information that helps pinpoint the exact problem, such as which field had the invalid data.", "properties": { "param_name": { "description": "Name of the parameter that contained invalid data.", "example": "sort_by", "type": "string" }, "supported_values": { "description": "A list of valid values that can be used for the parameter in question.", "items": { "description": "specific values that are supported for this field.", "maxLength": 255, "type": "string" }, "type": "array" } }, "required": [ "param_name", "supported_values" ], "type": "object" }, "message": { "description": "A clear explanation in plain language describing exactly why the request couldn't be completed.", "type": "string" }, "status": { "description": "Indicates whether the request was successful or failed. This will show 'error' because something went wrong.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataSortByError" }, "InvalidDataSortById": { "additionalProperties": false, "description": "Represents the error details returned when the sort field or sort order value in the sort by ID request is invalid.", "properties": { "code": { "description": "Represents the error code for the invalid data error.\nPossible values:\n**INVALID_DATA** - The sort field or sort order value in the request is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/SimpleFieldError" }, "message": { "description": "Represents the error message describing the invalid sort data.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataSortById" }, "InvalidDataSupportedValuesDetails": { "additionalProperties": false, "description": "Contains the contextual details for the invalid data supported values error.", "properties": { "api_name": { "description": "Represents the API name of the field or module.", "type": "string" }, "json_path": { "description": "Represents the JSONPath location pointing to the field that caused the error.", "type": "string" }, "supported_values": { "description": "Contains the list of valid values accepted for this field.", "items": { "description": "Represents a single item in the InvalidDataSupportedValuesDetails array.", "maxLength": 255, "type": "string" }, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "InvalidDataSupportedValuesDetails" }, "InvalidDataType": { "additionalProperties": false, "description": "Represents the error response returned when a criterion field value is provided with an incorrect data type. Contains the error code, a descriptive message, the response status, and details identifying the offending field and its expected data type.", "properties": { "code": { "description": "Represents the error code that identifies the category of validation failure.\nPossible values:\nINVALID_DATA - Indicates that the value provided for a criterion field does not match the expected data type.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the invalid data type error, including the API name of the offending criterion field, its JSON path within the request body, and the data type that was expected.", "properties": { "api_name": { "description": "Represents the API name of the criterion field whose value was supplied with an invalid data type.", "maxLength": 256, "type": "string" }, "expected_data_type": { "description": "Represents the data type that the API expected for the criterion field identified by the API name, against which the supplied value was validated.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path that locates the specific field within the request body where the invalid data type was detected.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data type failure in a form suitable for display or logging.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the response status for this error response.\nPossible values:\nerror - Indicates that the request failed due to an invalid data type on a criterion field.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataType" }, "InvalidDataTypeDetails": { "additionalProperties": false, "description": "Details for an INVALID_DATA error caused by a data type mismatch, including the expected type.", "properties": { "api_name": { "description": "API name of the field with the data type mismatch.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field. Possible values: **integer**, **text**, **Boolean**, **jsonarray**, **jsonobject**. ", "enum": [ "integer", "text", "boolean", "jsonarray", "jsonobject" ], "type": "string" }, "json_path": { "description": "JSON path to the field with the data type mismatch.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidDataTypeDetails" }, "InvalidDataTypeForDataFieldError": { "additionalProperties": false, "description": "Error response returned when the value provided for the data field has an invalid data type.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum length permitted for the offending field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Type for Field \"data\"", "type": "object", "x-zs-$id": "InvalidDataTypeForDataFieldError" }, "InvalidDataTypeGenericError": { "additionalProperties": false, "description": "Error response returned when a service field is set to a value of the incorrect data type.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the invalid field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataTypeGenericError" }, "InvalidDataTypeMismatchDetails": { "additionalProperties": false, "description": "Contains the contextual details for the invalid data type mismatch error.", "properties": { "api_name": { "description": "Represents the API name of the field or module.", "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the field.", "examples": [ "string", "integer", "boolean", "array", "object" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSONPath location pointing to the field that caused the error.", "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object", "x-zs-$id": "InvalidDataTypeMismatchDetails" }, "InvalidDataTypeMismatchError": { "additionalProperties": false, "description": "Error returned when the data type provided does not match the expected type for a field.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the data type mismatch error.", "properties": { "api_name": { "description": "The API name of the invalid field", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "The expected data type for this field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the invalid field", "maxLength": 1000, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the data type mismatch.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataTypeMismatchError" }, "InvalidDataTypeSupportedValuesDetails": { "additionalProperties": false, "description": "Details structure for an INVALID_DATA error caused by an unsupported value and data type for a field that only accepts a fixed set of values. All four fields - api_name, json_path,expected_data_type and supported_values - are required.", "properties": { "api_name": { "description": "The API name of the field that received an unsupported value.", "type": "string" }, "expected_data_type": { "description": "The type of data that the field expects to receive, such as text, number, true/false value, list, or structured object.", "examples": [ "string", "integer", "boolean", "array", "object" ], "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSONPath location pointing to the field that caused the error.", "type": "string" }, "supported_values": { "description": "Contains the list of valid values accepted for this field.", "items": { "description": "Represents a single item in the InvalidDataSupportedValuesDetails array.", "maxLength": 255, "type": "string" }, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidDataTypeSupportedValuesDetails" }, "InvalidDataTypeSupportedValuesError": { "additionalProperties": false, "description": "This error occurs when the data provided in the request doesn't meet the expected requirements. The details structure varies based on the cause - data type mismatch and unsupported values.", "properties": { "code": { "description": "A unique identifier for this type of error.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/InvalidDataTypeSupportedValuesDetails", "description": "Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error." }, "message": { "description": "A clear explanation of what went wrong and why the operation could not complete.", "type": "string" }, "status": { "description": "Indicates whether the operation succeeded or failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataTypeSupportedValuesError" }, "InvalidDataUrlError": { "additionalProperties": false, "description": "Represents an error response when invalid data is provided in the request URL.", "properties": { "code": { "description": "Represents the error code for this error type. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the URL path segment with invalid data.", "properties": { "resource_path_index": { "description": "Represents the index of the URL path segment that contains invalid data.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data URL Error", "type": "object", "x-zs-$id": "InvalidDataUrlError" }, "InvalidDataUserTypeBodyError": { "additionalProperties": false, "description": "Returned when the `user_type` field in the request body contains a value of the wrong data type.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "expected_data_type": { "description": "The data type that the field value must conform to.", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "body" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataUserTypeBodyError" }, "InvalidDataValueError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid data value error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/InvalidDataFieldValueDetails", "description": "Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error." }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataValueError" }, "InvalidDataValueErrorAlt": { "additionalProperties": false, "description": "Error returned when invalid data is provided that does not meet minimum length requirements.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid data value error.", "properties": { "api_name": { "description": "The API name of the invalid field", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the invalid field", "maxLength": 1000, "type": "string" }, "minimum_length": { "description": "Represents the minimum required length for this field", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "minimum_length" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid value issue.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Value Error Alt", "type": "object", "x-zs-$id": "ErrorResponseCore628955659" }, "InvalidDataWithDataType": { "additionalProperties": false, "description": "Represents error details when a field contains invalid data, specifying the expected data type.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with invalid data.", "maxLength": 500, "type": "string" }, "param_name": { "description": "Represents the parameter name of the field with invalid data.", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidDataWithDataType" }, "InvalidDataWithDataTypeAndSupportedValues": { "additionalProperties": false, "description": "Represents error details when a field contains invalid data, specifying the expected data type and supported values.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with invalid data.", "maxLength": 500, "type": "string" }, "param_name": { "description": "Represents the parameter name of the field with invalid data.", "maxLength": 255, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the field.", "items": { "description": "Represents a supported value for the field.", "maxLength": 500, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "expected_data_type", "supported_values" ], "type": "object", "x-zs-$id": "InvalidDataWithDataTypeAndSupportedValues" }, "InvalidDataWithMaximumLength": { "additionalProperties": false, "description": "Represents the error response when a field value exceeds the maximum allowed length.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name, JSON path, and maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field whose value exceeds the maximum allowed length.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field in the request body whose value exceeds the maximum allowed length.", "maxLength": 250, "minLength": 1, "type": "string" }, "maximum_length": { "description": "Represents the maximum number of characters allowed for the field.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message returned when a field value exceeds the maximum allowed length. Possible values: **invalid data**, **the value of the field exceeds the maximum allowed length**.", "enum": [ "invalid data", "the value of the field exceeds the maximum allowed length" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "InvalidDataWithMaximumLength" }, "InvalidDataWithMaximumLengthAsString": { "additionalProperties": false, "description": "Represents the error response when a field value exceeds the maximum allowed character length.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name, JSON path, and maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field whose value exceeds the maximum allowed length.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field in the request body whose value exceeds the maximum allowed length.", "maxLength": 250, "minLength": 1, "type": "string" }, "maximum_length": { "const": 1, "description": "Represents the maximum number of characters allowed for the field, returned as a string.", "type": "string" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message returned when a field value exceeds the maximum allowed length. Possible values: **invalid data**, **the value of the field exceeds the maximum allowed length**.", "enum": [ "invalid data", "the value of the field exceeds the maximum allowed length" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "InvalidDataWithMaximumLengthAsString" }, "InvalidDateFormatErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the date_format value in date_time_format is invalid.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The date value provided in the request is in an invalid format.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid date format.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid date format.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the date field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the date field with the invalid format.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The Date given is invalid** - The date value does not match the expected format.\n**Please provide a valid date format** - The date format string is not recognized.", "enum": [ "The Date given is invalid", "Please provide a valid date format" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Date Format Error Response", "type": "object", "x-zs-$id": "InvalidDateFormatErrorResponse", "x-zs-llm-description": "The date format string is invalid. Supply a properly formatted date string." }, "InvalidDateRangeErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the date range provided in from and to is invalid. For example, when from is after to.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The date range provided in the request parameters is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the invalid date range parameter.", "properties": { "expected_data_type": { "description": "Represents the expected data type for the date range field.", "maxLength": 255, "type": "string" }, "param_name": { "description": "Represents the name of the parameter that contains the invalid date range value.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The value provided to the param is Invalid** - The date range parameter value does not match the expected format.", "enum": [ "The value provided to the param is Invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Date Range Error Response", "type": "object", "x-zs-$id": "InvalidDateRangeErrorResponse", "x-zs-llm-description": "The date range (from/to) is invalid. Ensure 'from' is before 'to'." }, "InvalidDateTimeFormatErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the datetime_format value in date_time_format is invalid.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The datetime format provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid datetime format.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid datetime format.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid datetime format.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The date time format given is invalid** - The datetime value does not match the expected format.\n**Please provide a valid date time format** - The datetime format string is not recognized.", "enum": [ "The date time format given is invalid", "Please provide a valid date time format" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid DateTime Format Error Response", "type": "object", "x-zs-$id": "InvalidDateTimeFormatErrorResponse", "x-zs-llm-description": "The date-time format string is invalid. Use a valid pattern (e.g., yyyy-MM-dd'T'HH:mm:ssZ)." }, "InvalidDeleteOldValueFlagErrorResponse": { "additionalProperties": false, "description": "Returned when delete_old_value has an invalid boolean format. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Detail field: expected_data_type", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The delete_old_value boolean field type mismatch" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Delete Old Value Flag Error Response", "type": "object", "x-zs-$id": "InvalidDeleteOldValueFlagErrorResponse" }, "InvalidDeleteRequestError": { "additionalProperties": false, "description": "Error body returned when profile deletion is not permitted due to business rules.", "properties": { "code": { "description": "Error code indicating the delete operation is not allowed. Possible values: `CANNOT_DELETE`.", "enum": [ "CANNOT_DELETE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object returned for this error type.", "type": "object" }, "message": { "description": "Human-readable description of why the deletion is not permitted.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDeleteRequestError" }, "InvalidDurationRangeError": { "additionalProperties": false, "description": "Error response returned when the service Duration is greater than 24 hours or less than 5 minutes.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "Duration value should not be greater than 24hrs or less than 5mins" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDurationRangeError" }, "InvalidFeatureTypeError": { "additionalProperties": false, "description": "Represents the error returned when the feature_type value in the request body is not a recognized automation feature type.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The feature type name provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid feature type name.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid feature type value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid feature type value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**the given feature name is invalid** - The feature type value does not match any supported automation feature type.", "enum": [ "the given feature name is invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidFeatureTypeError", "x-zs-llm-description": "The feature_type value is invalid. Use: workflow, approval_process, blueprint, orchestration, kiosk, etc." }, "InvalidFieldDataTypeError": { "additionalProperties": false, "description": "Represents an error response returned when one or more fields contain values with an invalid data type.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the field with an invalid data type.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid data type.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that contains an invalid value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with the invalid data type.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that one or more fields contain values with an invalid data type.", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Field Data Type Error", "type": "object", "x-zs-$id": "ErrorResponseCore1437544616" }, "InvalidFieldIdError": { "additionalProperties": false, "description": "Represents the error response returned when the supplied field ID is invalid for the requested operation.", "properties": { "code": { "description": "Represents the error code for the invalid field ID error.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the invalid field ID error.", "properties": { "resource_path_index": { "description": "Represents the index of the URL path segment that contains the invalid field ID.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message indicating the field ID is invalid.", "enum": [ "The Field Id is Invalid" ], "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Field ID Error", "type": "object", "x-zs-$id": "InvalidFieldIdError" }, "InvalidFieldIdErrorResponse": { "additionalProperties": false, "description": "Returned when the provided field ID is invalid for the requested operation. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The Field Id is Invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Field ID Error Response", "type": "object", "x-zs-$id": "InvalidFieldIdErrorResponse" }, "InvalidFieldIdForPicklistValuesErrorResponse": { "additionalProperties": false, "description": "Returned when the provided field ID is invalid for retrieving picklist values. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The Field Id is Invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Field ID for Picklist Values Error Response", "type": "object", "x-zs-$id": "InvalidFieldIdForPicklistValuesErrorResponse" }, "InvalidFieldUpdateIdError": { "additionalProperties": false, "description": "Represents an invalid field update ID.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Index of the resource path segment that contains the invalid ID.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Field Update Id Error", "type": "object", "x-zs-$id": "InvalidFieldUpdateIdError", "x-zs-llm-description": "The field update ID in the path does not exist or is malformed. Verify via GET list endpoint." }, "InvalidFieldValueTypeError": { "additionalProperties": false, "description": "Returned when a request field value has an invalid data type for the selected field update configuration.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field with the invalid value type.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field in the request body.", "maxLength": 1000, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "example": "Invalid data type", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Field Value Type Error", "type": "object", "x-zs-$id": "InvalidFieldValueTypeError", "x-zs-llm-description": "The request field value has an invalid data type for the selected field update configuration. Check expected types via field metadata." }, "InvalidFormDataContentError": { "additionalProperties": false, "description": "Represents the error returned when body.form_data_content contains invalid or malformed data.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The form data content in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid form data content.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid form data content.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee field object that triggered the form data content requirement.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependee field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the invalid form data content.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.", "enum": [ "inavlid form data content passed in body", "inavlid form data content passed in body, include at least", "inavlid form data content passed in body, include at least " ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidFormDataContentError", "x-zs-llm-description": "The body.form_data_content has invalid data. Verify parameter structure." }, "InvalidIdFav": { "additionalProperties": false, "description": "Represents the error details returned when the Custom View ID in the favorite operation request is invalid.", "properties": { "code": { "description": "Represents the error code for the invalid ID error.\nPossible values:\n**INVALID_DATA** - The Custom View ID in the request is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the invalid Custom View ID.", "properties": { "id": { "description": "Represents the invalid Custom View ID.", "format": "int64", "maxLength": 25, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid ID.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "InvalidIdFav" }, "InvalidIdentifierError": { "additionalProperties": false, "description": "Represents an error response returned when the provided ID in the request path is invalid.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details indicating the path segment that contains the invalid identifier.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element that contains the invalid ID.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the provided ID is invalid.", "enum": [ "Invalid ID" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Identifier Error", "type": "object", "x-zs-$id": "ErrorResponseCore96228106" }, "InvalidIndexFav": { "additionalProperties": false, "description": "Represents the error details returned when the favorite index value in the request is invalid.", "properties": { "code": { "description": "Represents the error code for the invalid index error.\nPossible values:\n**INVALID_DATA** - The favorite index value in the request is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ApiNameDetail" }, "message": { "description": "Represents the error message describing the invalid favorite index.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidIndexFav" }, "InvalidMaxLengthError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid max length error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/InvalidDataMaxLengthDetails", "description": "Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error." }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidMaxLengthError" }, "InvalidMethodTypeErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the http_method value is not a supported HTTP method for webhook operations.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The HTTP method type provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid method type value.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid HTTP method type.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid HTTP method type.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The method type given is invalid** - The HTTP method value does not match the supported values.", "enum": [ "The method type given is invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Method Type Error Response", "type": "object", "x-zs-$id": "InvalidMethodTypeErrorResponse", "x-zs-llm-description": "The HTTP method specified is invalid for webhook operations. Use GET, POST, PUT, or DELETE." }, "InvalidModule": { "additionalProperties": false, "description": "Represents the error response when an invalid module is specified in the URL path.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_MODULE**.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the URL path index of the invalid module.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the URL path segment that contains the invalid module name.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message returned when the specified module is invalid. Possible values: **the module name given seems to be invalid**.", "enum": [ "the module name given seems to be invalid" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModule" }, "InvalidModuleGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid module GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "resource_path_index": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleGETError" }, "InvalidModuleGetDeletedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid module error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "resource_path_index": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "InvalidModuleGetDeletedError" }, "InvalidModuleIdError": { "additionalProperties": false, "description": "Represents the error returned when the module ID in the request body does not correspond to an existing CRM module.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The module ID provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid module ID.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the invalid module ID.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains the invalid module ID.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**the module id given seems to be invalid** - The module ID does not match a valid CRM module.\n**the tabId given seems to be invalid** - The tab ID provided does not match a valid module tab.", "enum": [ "the module id given seems to be invalid", "the tabId given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleIdError", "x-zs-llm-description": "The module ID does not correspond to an existing module. Verify via `getModules`." }, "InvalidModuleName": { "additionalProperties": false, "description": "Represents the error response returned when an invalid module name is provided in the request.", "properties": { "code": { "description": "Represents the error code indicating the type of failure.", "maxLength": 50, "pattern": "^[A-Z_]+$", "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the invalid module name error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.", "maxLength": 50, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleName" }, "InvalidModuleNameErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the module API name in the request URL is invalid or not supported.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "resource_path_index": { "default": 0, "description": "Represents the index of the URL path segment that caused the\nerror. Default value: **0**.\n", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleNameErrorResponse" }, "InvalidModuleParamError": { "additionalProperties": false, "description": "Represents an error response when the module name provided in a request parameter is invalid.", "properties": { "code": { "description": "Represents the error code for this error type. ", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the parameter with an invalid module name.", "properties": { "param_name": { "description": "Represents the name of the parameter that contains the invalid module name.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Param Error", "type": "object", "x-zs-$id": "InvalidModuleParamError" }, "InvalidModuleParamErrorResponse": { "additionalProperties": false, "description": "Represents an error response returned when an invalid module API name is provided in a query parameter.", "properties": { "code": { "description": "Represents the error code for this error response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the validation error.", "properties": { "param_name": { "description": "Represents the name of the query parameter that contains the invalid value.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation issue.", "enum": [ "Please check whether the input values are correct" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Param Error Response", "type": "object", "x-zs-$id": "InvalidModuleParamErrorResponse" }, "InvalidModulePathError": { "additionalProperties": false, "description": "Represents an error response when the module name provided in the URL path is invalid.", "properties": { "code": { "description": "Represents the error code for the failed operation request. ", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the invalid module in the request URL.", "properties": { "resource_path_index": { "description": "Represents the index of the URL path segment that contains the invalid module name.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Path Error", "type": "object", "x-zs-$id": "InvalidModulePathError" }, "InvalidModuleResponse": { "additionalProperties": false, "description": "Represents the error response when the module query parameter value does not correspond to a valid CRM module or a workflow-supported module.", "properties": { "code": { "description": "Represents the error code indicating the module API name is invalid.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the object containing details about the invalid parameter.", "properties": { "param_name": { "description": "Represents the name of the parameter that contains the invalid value.", "enum": [ "module" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "The value provided to the param is Invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Error", "type": "object", "x-zs-$id": "InvalidModuleResponse" }, "InvalidNameErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the webhook name contains invalid or unsupported characters.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook name contains invalid characters.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid name.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid name value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid name value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Special characters not allowed** - The webhook name contains characters that are not permitted.\n**webhook name should not contain the special character #%** - The webhook name includes the # or % characters, which are not allowed.", "enum": [ "Special characters not allowed", "webhook name should not contain the special character #%" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Name Error Response", "type": "object", "x-zs-$id": "InvalidNameErrorResponse", "x-zs-llm-description": "The webhook name contains invalid/unsupported characters. Remove special characters and retry." }, "InvalidPicklistOptionIdErrorResponse": { "additionalProperties": false, "description": "Returned when the specified picklist option ID does not exist or is invalid. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "pickList option is not available" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Picklist Option ID Error Response", "type": "object", "x-zs-$id": "InvalidPicklistOptionIdErrorResponse" }, "InvalidPortalNameError": { "additionalProperties": false, "description": "Returned when the `{portal}` path parameter does not match any portal configured in the organization's Zoho CRM account.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": {}, "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "No portal exists with the given portal name." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidPortalNameError" }, "InvalidQueryParamError": { "additionalProperties": false, "description": "Error response returned when a query parameter contains an invalid value.", "properties": { "code": { "description": "Error code indicating invalid query parameter data. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the query parameter that failed validation.", "properties": { "param_name": { "description": "API name of the query parameter that contains invalid data.", "example": "type", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Human-readable description of the invalid query parameter value.", "example": "invalid data", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidQueryParamError" }, "InvalidRecordIdErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the record ID in the request URL is invalid or does not belong to the specified module.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "resource_path_index": { "default": 1, "description": "Represents the index of the URL path segment that caused the\nerror. Default value: **1**.\n", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "ENTITY_ID_INVALID" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidRecordIdErrorResponse" }, "InvalidRelationNameError": { "additionalProperties": false, "description": "Error response when the user provided an invalid relation name in the request.", "properties": { "code": { "const": "INVALID_DATA", "description": "Error code indicating invalid relation name", "type": "string" }, "details": { "additionalProperties": false, "description": "Error details containing the path index", "properties": { "resource_path_index": { "const": 2, "description": "Index of the path parameter that is invalid (2 for relation name)", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "const": "the relation name given seems to be invalid", "description": "Error message indicating the relation name is invalid", "type": "string" }, "status": { "const": "error", "description": "Response status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidRelationNameError" }, "InvalidReplacePayloadTypeErrorResponse": { "additionalProperties": false, "description": "Returned when the replace_pick_list_values payload has an invalid data type or exceeds allowed constraints. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Detail field: maximum_length", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data type replace_pick_list_values object" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Replace Payload Type Error Response", "type": "object", "x-zs-$id": "InvalidReplacePayloadTypeErrorResponse" }, "InvalidReplacePayloadTypeMinErrorResponse": { "additionalProperties": false, "description": "Returned when the replace_pick_list_values payload fails minimum length or type validations. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" }, "minimum_length": { "description": "Detail field: minimum_length", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "minimum_length" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data type replace_pick_list_values object" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Replace Payload Type (Minimum) Error Response", "type": "object", "x-zs-$id": "InvalidReplacePayloadTypeMinErrorResponse" }, "InvalidRequestPayloadError": { "additionalProperties": false, "description": "Error response returned when the request body for a service update is invalid or fails payload-level validation.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of values supported for the offending field.", "items": { "description": "Each string represents a supported value for the field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Request Payload", "type": "object", "x-zs-$id": "InvalidRequestPayloadError" }, "InvalidResourceIdError": { "additionalProperties": false, "description": "Indicates an invalid identifier in the request URL. Includes code INVALID_DATA and contextual details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "The index of the invalid resource in the URL path.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Resource ID Error", "type": "object", "x-zs-$id": "ErrorResponseCore96228106" }, "InvalidRuleIdErrorResponse": { "additionalProperties": false, "description": "Represents an error response returned when the provided Scoring Rule ID in the request path is invalid.", "properties": { "code": { "description": "Represents the error code for this error response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the validation error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element that contains the invalid identifier.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation issue.", "enum": [ "The id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Rule Id Error Response", "type": "object", "x-zs-$id": "InvalidRuleIdErrorResponse" }, "InvalidShareWithIdErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the recipient ID in **shared_with** is invalid or when the record cannot be shared with the specified entity.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API. \n\n**Possible values**: \n- invalid data\n- invalid user Id\n- invalid role Id\n- invalid group Id\n- cannot share to the user\n", "enum": [ "invalid data", "invalid user Id", "invalid role Id", "invalid group Id", "cannot share to the user" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidShareWithIdErrorResponse" }, "InvalidShareWithValueErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the **shared_with** object in a share entry is invalid due to a dependent field mismatch.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "maxLength": 50, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of the parameter on which this parameter depends.", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path", "dependee" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidShareWithValueErrorResponse" }, "InvalidSourceOptionIdErrorResponse": { "additionalProperties": false, "description": "Returned when the ID provided in old_value (source option) is invalid. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The id given in old_value is invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Source Option ID Error Response", "type": "object", "x-zs-$id": "InvalidSourceOptionIdErrorResponse" }, "InvalidSourceOptionObjectErrorResponse": { "additionalProperties": false, "description": "Returned when old_value is not a valid object or has an unexpected structure. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Detail field: expected_data_type", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "old_value expected data type invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Source Option Object Error Response", "type": "object", "x-zs-$id": "InvalidSourceOptionObjectErrorResponse" }, "InvalidSupportedValuesError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid supported values error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/InvalidDataSupportedValuesDetails", "description": "Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error." }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidSupportedValuesError" }, "InvalidTagColorCodeError": { "additionalProperties": false, "description": "Represents an error response returned when the tag color code value is invalid or exceeds the maximum length.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing validation information.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid color code.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with the invalid color code.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the color code field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid color code.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidTagColorCodeError" }, "InvalidTargetDisplayValueErrorResponse": { "additionalProperties": false, "description": "Returned when the display_value provided in new_value is invalid. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The display_value given in new_value is invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Target Display Value Error Response", "type": "object", "x-zs-$id": "InvalidTargetDisplayValueErrorResponse" }, "InvalidTargetOptionIdErrorResponse": { "additionalProperties": false, "description": "Returned when the ID provided in new_value (target option) is invalid. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The id given in new_value is invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Target Option ID Error Response", "type": "object", "x-zs-$id": "InvalidTargetOptionIdErrorResponse" }, "InvalidTargetOptionObjectErrorResponse": { "additionalProperties": false, "description": "Returned when new_value is not a valid object or has an unexpected structure. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Detail field: expected_data_type", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "new_value expected data type invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Target Option Object Error Response", "type": "object", "x-zs-$id": "InvalidTargetOptionObjectErrorResponse" }, "InvalidTimezoneErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the time_zone value in date_time_format is not a supported timezone identifier.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The timezone identifier provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid timezone value.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid timezone value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid timezone value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The timezone given is invalid** - The timezone identifier does not match a valid timezone.", "enum": [ "The timezone given is invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Timezone Error Response", "type": "object", "x-zs-$id": "InvalidTimezoneErrorResponse", "x-zs-llm-description": "The timezone value is not supported. Use a valid timezone identifier (e.g., America/Los_Angeles)." }, "InvalidTransferToIdError": { "additionalProperties": false, "description": "Error body returned when the `transfer_to` value does not correspond to a valid active profile.", "properties": { "code": { "description": "Error code indicating an invalid `transfer_to` value. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object returned for this error type.", "properties": { "id": { "$ref": "#/components/schemas/ProfilesId", "description": "Invalid transfer_to value." } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable description of the invalid transfer-to ID error.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidTransferToIdError" }, "InvalidTypeErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the `type` or `permission` field in a share entry does not match the expected pattern.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error. \n\n**Possible values**: \n- type\n- permission\n", "enum": [ "type", "permission" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" }, "regex": { "description": "Represents the regular expression pattern expected for the parameter value. ", "enum": [ "private|public", "read_only|read_write|full_access" ], "type": "string" } }, "required": [ "api_name", "json_path", "regex" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidTypeErrorResponse" }, "InvalidTypeRegexValidationError": { "additionalProperties": false, "description": "Represents the validation error details returned when a field value fails regex pattern validation due to an incorrect data type.", "properties": { "api_name": { "description": "Represents the API name of the field for which the regex pattern validation failed.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the field to pass regex pattern validation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that failed regex pattern validation.", "maxLength": 255, "type": "string" }, "regex": { "description": "Represents the expected regex pattern that the field value was required to match.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "regex", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidTypeRegexValidationError" }, "InvalidUnsubscribeLinkIdError": { "additionalProperties": false, "description": "Error returned when an invalid unsubscribe link ID is provided that does not belong to your organization.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid unsubscribe link ID error.", "properties": { "resource_path_index": { "description": "The index position in the URL path where the invalid ID was found", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid ID issue.", "enum": [ "The given Unsubscribe Link id is not part of Org" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Unsubscribe Link ID Error", "type": "object", "x-zs-$id": "InvalidUnsubscribeLinkIdError" }, "InvalidUnsubscribeLinkIdInBody": { "additionalProperties": false, "description": "Error returned when an invalid unsubscribe link ID is provided in the request body that does not belong to your organization.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid unsubscribe link ID error.", "properties": { "api_name": { "description": "The API name of the field with the invalid ID", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the field with the invalid ID", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid ID issue.", "enum": [ "The given Unsubscribe Link id is not part of Org" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Unsubscribe Link ID Error", "type": "object", "x-zs-$id": "InvalidUnsubscribeLinkIdInBody" }, "InvalidUrlErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the url field value is not a valid or well-formed URL.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook URL is not valid or contains a blocked host.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid URL.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid URL.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid URL.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**please enter a valid URL** - The webhook URL is not a valid HTTP or HTTPS URL, or it is blocked for security reasons.", "enum": [ "please enter a valid URL" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid URL Error Response", "type": "object", "x-zs-$id": "InvalidUrlErrorResponse", "x-zs-llm-description": "The URL is invalid or malformed. Provide a valid, well-formed URL (https:// preferred)." }, "InvalidUrlPatternErrorResponse": { "additionalProperties": false, "description": "Error response when the request URL does not match a valid API pattern.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": {}, "type": "object" }, "message": { "description": "Error message", "example": "Please check if the URL trying to access is a correct one", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid URL Pattern Error Response", "type": "object", "x-zs-$id": "InvalidUrlPatternErrorResponse", "x-zs-llm-description": "The request URL does not match any valid API route. Verify the path structure and resource name." }, "InvalidUserTypeNameSpecialCharsError": { "additionalProperties": false, "description": "Returned when the portal user type name contains special characters that are not permitted. Only alphanumeric characters and underscores are allowed in user type names.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" }, "regex": { "description": "The regular expression pattern that the field value must match.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "regex" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidUserTypeNameSpecialCharsError" }, "InvalidValueErrorDetails": { "additionalProperties": false, "description": "Error response returned when the request payload contains invalid data. The Emails array contains per-item error details.", "properties": { "code": { "description": "Error code indicating the type of validation failure. For example, INVALID_DATA.", "enum": [ "INVALID_DATA" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Detailed error context identifying the invalid field.", "properties": { "api_name": { "description": "The API name of the invalid field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "The JSON path of the invalid field in the request payload.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable message describing the validation error.", "enum": [ "invalid data" ], "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation. Always \"error\" for validation failures.", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "InvalidValueErrorDetails" }, "InvalidVariableGroupIdError": { "additionalProperties": false, "description": "Represents an error response returned when the provided variable group ID in the request body is invalid.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the field that contains the invalid variable group ID.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the invalid variable group ID.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains the invalid variable group ID.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the provided variable group ID is invalid.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Variable Group ID Error", "type": "object", "x-zs-$id": "ErrorResponseCore641169645" }, "InvalidVariableGroupsTypeError": { "additionalProperties": false, "description": "Represents an error response returned when the `variable_groups` field in the request contains an invalid data type or format.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the field with the invalid data type or value.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains invalid data.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that exceeded the limit.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the `variable_groups` field contains invalid data.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid variable_groups Type Error", "type": "object", "x-zs-$id": "ErrorResponseCore1251368250" }, "InvalidWebhookIdError": { "additionalProperties": false, "description": "Represents the error returned when the webhook ID in the request body does not match an existing webhook or is malformed.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook ID provided in the request is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the invalid webhook ID.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid webhook ID.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the invalid webhook ID.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The ID given is invalid** - The webhook ID in the request does not match any existing webhook.", "enum": [ "The ID given is invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidWebhookIdError", "x-zs-llm-description": "The webhook ID does not exist or is malformed. Verify via GET list." }, "InvalidWebhookIdPathError": { "additionalProperties": false, "description": "Represents the error returned when the webhook ID in the URL path is invalid or does not match an existing webhook.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook ID provided in the path parameter is not valid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the resource with the invalid webhook ID.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource in the request URL path.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**the id given seems to be invalid** - The webhook ID in the path does not match any existing webhook record.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidWebhookIdPathError", "x-zs-llm-description": "The webhook ID in the URL path is invalid or does not exist." }, "InvalidWrapDataType": { "additionalProperties": false, "description": "Represents the error details returned when the value provided for the wrap text configuration is not a valid data type.", "properties": { "code": { "description": "Represents the error code for the invalid wrap data type error.\nPossible values:\n**INVALID_DATA** - The value provided for the wrap text configuration is not a valid data type.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "allOf": [ { "$ref": "#/components/schemas/DataTypeMismatchError" } ], "description": "Represents the additional details about the invalid wrap data type error." }, "message": { "description": "Represents the error message describing the invalid wrap data type.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidWrapDataType" }, "InventoryTemplateDetail": { "additionalProperties": false, "description": "Complete inventory template object with all detailed information including content", "properties": { "category": { "description": "Represents the category of the inventory template. \nPossible values:\n**normal** - A regular, published inventory template.\n**draft** - A template that is saved as a draft and not yet published.", "enum": [ "normal", "draft" ], "type": "string" }, "content": { "description": "Represents the full HTML content of the inventory template. ", "maxLength": 300000, "type": "string" }, "created_by": { "$ref": "#/components/schemas/InventoryTemplatesUserRef", "description": "User who created the template" }, "created_time": { "description": "Represents the creation timestamp of the inventory template. ", "format": "date-time", "type": "string" }, "editor_mode": { "description": "Represents the editor mode used to create the inventory template. \nPossible values:\n**plain_text** - The template was built from scratch using plain text.\n**rich_text** - The template is a pre-designed custom template.\n**gallery** - The template was chosen from the template gallery and customized.", "enum": [ "plain_text", "rich_text", "gallery" ], "type": "string" }, "favorite": { "description": "Indicates whether the inventory template is marked as a favorite. \nPossible values:\n**true** - The template is marked as a favorite.\n**false** - The template is not marked as a favorite.", "type": "boolean" }, "folder": { "$ref": "#/components/schemas/InventoryTemplatesFolderRef", "description": "Folder containing this template" }, "id": { "description": "Unique template identifier", "maxLength": 50, "type": "string", "x-zs-$id": "InventoryTemplateByIdId" }, "last_usage_time": { "anyOf": [ { "description": "Represents the date and time at which the template was last used.", "format": "date-time", "type": "string", "x-zs-$id": "SingleInventoryTemplateLastUsageTimeString" }, { "description": "Indicates that the template has never been used.", "type": "null", "x-zs-$id": "SingleInventoryTemplateLastUsageTimeNull" } ], "description": "Represents the date and time at which the inventory template was last used, or null if the template has never been used. " }, "modified_by": { "$ref": "#/components/schemas/InventoryTemplatesUserRef", "description": "User who last modified the template" }, "modified_time": { "description": "Represents the date and time at which the inventory template was last modified. ", "format": "date-time", "type": "string" }, "module": { "$ref": "#/components/schemas/InventoryTemplatesModuleRef", "description": "Module this template belongs to" }, "name": { "description": "Represents the name of the inventory template. ", "maxLength": 75, "type": "string" } }, "required": [ "id", "name", "created_time", "modified_time", "last_usage_time", "category", "folder", "module", "created_by", "modified_by", "editor_mode", "favorite", "content" ], "type": "object", "x-zs-$id": "InventoryTemplateDetail" }, "InventoryTemplateDetailResponse": { "additionalProperties": true, "description": "Successful response for single inventory template retrieval", "properties": { "inventory_templates": { "description": "Represents an array containing the details of a single inventory template. ", "items": { "$ref": "#/components/schemas/InventoryTemplateDetail" }, "maxItems": 1, "type": "array" } }, "required": [ "inventory_templates" ], "type": "object", "x-zs-$id": "InventoryTemplateDetailResponse" }, "InventoryTemplateListItem": { "additionalProperties": false, "description": "Represents a summary object for an inventory template as returned in paginated list responses.", "properties": { "category": { "description": "Represents the category of the inventory template. \nPossible values:\n**normal** - A regular, published inventory template.\n**draft** - A template that is saved as a draft and not yet published.", "enum": [ "normal", "draft" ], "type": "string" }, "created_by": { "$ref": "#/components/schemas/InventoryTemplatesUserRef", "description": "User who created the template" }, "created_time": { "description": "Represents the creation timestamp of the inventory template. ", "format": "date-time", "type": "string" }, "editor_mode": { "description": "Represents the editor mode used to create the inventory template. \nPossible values:\n**plain_text** - The template was built from scratch using plain text.\n**rich_text** - The template is a pre-designed custom template.\n**gallery** - The template was chosen from the template gallery and customized.", "enum": [ "plain_text", "rich_text", "gallery" ], "type": "string" }, "favorite": { "description": "Indicates whether the inventory template is marked as a favorite. \nPossible values:\n**true** - The template is marked as a favorite.\n**false** - The template is not marked as a favorite.", "type": "boolean" }, "folder": { "$ref": "#/components/schemas/InventoryTemplatesFolderRef", "description": "Folder containing this template" }, "id": { "description": "Represents the unique ID of the inventory template. ", "maxLength": 50, "type": "string", "x-zs-$id": "InventoryTemplatesId" }, "last_usage_time": { "anyOf": [ { "description": "Represents the date and time at which the template was last used.", "format": "date-time", "type": "string", "x-zs-$id": "LastUsageTimeString" }, { "description": "Indicates that the template has never been used.", "type": "null", "x-zs-$id": "LastUsageTimeNull" } ], "description": "Represents the date and time at which the inventory template was last used, or null if the template has never been used. " }, "modified_by": { "$ref": "#/components/schemas/InventoryTemplatesUserRef", "description": "User who last modified the template" }, "modified_time": { "description": "Represents the date and time at which the inventory template was last modified. ", "format": "date-time", "type": "string" }, "module": { "$ref": "#/components/schemas/InventoryTemplatesModuleRef", "description": "Module this template belongs to" }, "name": { "description": "Represents the name of the inventory template. ", "maxLength": 75, "pattern": "^[A-Za-z0-9]{5}$", "type": "string" } }, "required": [ "created_time", "modified_time", "last_usage_time", "category", "folder", "module", "created_by", "modified_by", "name", "id", "editor_mode", "favorite" ], "type": "object" }, "InventoryTemplateListResponse": { "additionalProperties": false, "description": "Successful response containing inventory_templates array and pagination info.", "properties": { "info": { "$ref": "#/components/schemas/InventoryTemplatesInfoBlock", "description": "Pagination information" }, "inventory_templates": { "description": "Represents the list of inventory templates returned for the current page. ", "items": { "$ref": "#/components/schemas/InventoryTemplateListItem" }, "maxItems": 2000, "type": "array" } }, "required": [ "inventory_templates", "info" ], "type": "object", "x-zs-$id": "InventoryTemplateListResponse" }, "InventoryTemplatesErrorItemBase": { "additionalProperties": false, "description": "Base structure for all error items returned in inventory templates error responses, containing the code, message, status, and details fields.", "properties": { "code": { "description": "Represents the error code for the failed operation. ", "maxLength": 128, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents the additional details about the error, such as the parameter name or field that caused it. ", "type": "object" }, "message": { "description": "Represents the error message describing the issue. ", "maxLength": 1024, "type": "string" }, "status": { "description": "Represents the severity level of the result. \nPossible values:\n**error** - The operation failed due to an error.\n**warning** - The operation completed with warnings.\n**info** - The operation returned an informational status.", "enum": [ "error", "warning", "info" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "InventoryTemplatesErrorItemInvalidData": { "allOf": [ { "$ref": "#/components/schemas/InventoryTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Specialized properties for INVALID_DATA and INVALID_MODULE error codes.", "properties": { "code": { "description": "Represents the error code for invalid data or module errors. \nPossible values:\n**INVALID_DATA** - The data provided in the request is invalid.\n**INVALID_MODULE** - The module name specified in the request is invalid.", "enum": [ "INVALID_DATA", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents the additional details about the invalid data or module error.", "type": "object" } }, "type": "object" } ], "description": "Represents an error item for invalid data or invalid module errors in inventory templates operations.", "x-zs-$id": "ErrorItemInvalidData" }, "InventoryTemplatesErrorItemInvalidRequest": { "additionalProperties": false, "description": "Represents an error item for request-level errors such as **invalid request shape** or **JSON parse failures** in inventory templates operations.", "properties": { "code": { "description": "Represents the error code for request-level errors. \nPossible values:\n**INVALID_REQUEST** - The request payload is invalid or malformed.\n**JSON_PARSE_ERROR** - The request body could not be parsed as valid JSON.\n**INVALID_MODULE** - The module name specified in the request is invalid.", "enum": [ "INVALID_REQUEST", "JSON_PARSE_ERROR", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the request error. ", "type": "object" }, "message": { "description": "Represents the error message describing the issue. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the result. \nPossible values:\n**error** - The operation failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ErrorItemInvalidRequest" }, "InventoryTemplatesErrorItemMandatoryNotFound": { "allOf": [ { "$ref": "#/components/schemas/InventoryTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Specialized properties for MANDATORY_NOT_FOUND error code, indicating a required field is missing.", "properties": { "code": { "description": "Represents the error code for missing mandatory field errors. \nPossible values:\n**MANDATORY_NOT_FOUND** - A required field is missing from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": true, "description": "Represents additional error details with flexible structure for mandatory not found errors.", "type": "object", "x-zs-$id": "ErrorItemMandatoryNotFoundDetails1" }, { "additionalProperties": false, "description": "Represents error details that include the API name of the parent field for the missing mandatory field.", "properties": { "parent_api_name": { "description": "Represents the API name of the parent field containing the missing mandatory field.", "maxLength": 128, "type": "string" } }, "required": [ "parent_api_name" ], "type": "object", "x-zs-$id": "ErrorItemMandatoryNotFoundDetails2" } ], "description": "Represents the additional details about the missing mandatory field error." } }, "type": "object" } ], "description": "Represents an error item for missing mandatory field errors in inventory templates operations.", "x-zs-$id": "ErrorItemMandatoryNotFound" }, "InventoryTemplatesErrorItemPatternNotMatched": { "allOf": [ { "$ref": "#/components/schemas/InventoryTemplatesErrorItemBase" }, { "additionalProperties": false, "description": "Specialized properties for PATTERN_NOT_MATCHED error code, indicating a field value failed pattern validation.", "properties": { "code": { "description": "Represents the error code for pattern validation failures. \nPossible values:\n**PATTERN_NOT_MATCHED** - A field value does not match the required pattern or format.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents error details that include the API name of the field that failed pattern validation.", "properties": { "api_name": { "description": "Represents the API name of the field that failed pattern validation. ", "maxLength": 128, "type": "string" } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "ErrorItemPatternNotMatchedDetailsWithApiName" }, { "additionalProperties": true, "description": "Represents additional error details with flexible structure for pattern not matched errors.", "type": "object", "x-zs-$id": "ErrorItemPatternNotMatchedDetailsAdditional" } ], "description": "Represents the additional details about the pattern validation error." } }, "type": "object" } ], "description": "Represents an error item for pattern validation failures in inventory templates operations.", "x-zs-$id": "ErrorItemPatternNotMatched" }, "InventoryTemplatesFolderRef": { "additionalProperties": false, "description": "Represents a folder reference containing the folder ID and name, used to identify the folder associated with an inventory template.", "properties": { "id": { "description": "Represents the unique ID of the folder. ", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the name of the folder. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "InventoryTemplatesInfoBlock": { "additionalProperties": false, "description": "Represents the pagination metadata for list responses, including page number, items per page, total count, and whether more records are available.", "properties": { "count": { "description": "Represents the number of inventory template records returned in the current page. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional pages of inventory template records are available beyond the current page. \nPossible values:\n**true** - More records are available on subsequent pages.\n**false** - The current page is the last page.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of inventory template records returned per page. ", "format": "int32", "type": "integer" } }, "required": [ "per_page", "page", "count", "more_records" ], "type": "object" }, "InventoryTemplatesModuleRef": { "additionalProperties": false, "description": "Represents a module reference containing the module **API name** and **ID**, used to identify the CRM module associated with an inventory template.", "properties": { "api_name": { "description": "Represents the API name of the CRM module associated with the inventory template. ", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique ID of the CRM module associated with the inventory template. ", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "InventoryTemplatesUserRef": { "additionalProperties": false, "description": "Represents a user reference containing the user ID and display name, used to identify the user associated with an inventory template operation.", "properties": { "id": { "description": "Represents the unique ID of the CRM user. ", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the display name of the CRM user. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "InvitationFieldNested": { "additionalProperties": false, "description": "Represents the nested object used in create and update requests to specify the invitation field for the portal user type. The invitation field determines which CRM field stores the portal user's email address for sending invitations.", "properties": { "api_name": { "description": "Represents the API name of the CRM field to use as the invitation field for this portal user type.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique numeric identifier of the CRM field to use as the invitation field.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" } ], "resource": "fields" } } }, "type": "object" }, "JobSheetNotConfiguredError": { "additionalProperties": false, "description": "Error response returned when Job Sheet has not been enabled in the Services preferences and a job sheet field is provided.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "Job Sheet is not configured in services preferences" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "JobSheetNotConfiguredError" }, "JobSheetSectionDependentMismatchError": { "additionalProperties": false, "description": "Error response returned when Job_Sheet_Section__s is provided but Job_Sheet_Required is not set to Yes.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details block providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the job sheet section depends on a field value that does not match the submitted configuration.", "enum": [ "Job_Sheet_Section__s can have value only when value of Job_Sheet_Required is Yes" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "JobSheetSectionDependentMismatchError" }, "KioskNameChangeNotAllowedError": { "additionalProperties": false, "description": "Represents the error returned when a PUT request attempts to change the name of a webhook with feature_type kiosk. Kiosk action names are immutable.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The kiosk action name cannot be changed after creation.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field for which the kiosk name change is not allowed.", "properties": { "api_name": { "description": "Represents the API name of the field for which the kiosk name change is not allowed.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field for which the kiosk name change is not allowed.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Action name not allow to change for kiosk feature actions** - The kiosk action name field cannot be modified after creation.", "enum": [ "Action name not allow to change for kiosk feature actions" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "KioskNameChangeNotAllowedError", "x-zs-llm-description": "Cannot change the name of a kiosk feature webhook." }, "LayoutActionsAllowed": { "additionalProperties": false, "description": "Represents the set of Boolean permission flags indicating which operations are permitted on a layout, such as editing, renaming, cloning, deactivating, and deleting.", "properties": { "clone": { "description": "Indicates whether the layout can be duplicated to create a new layout with the same field and section configuration. Possible values: `true` — cloning the layout is permitted; `false` — the layout cannot be cloned.", "type": "boolean" }, "deactivate": { "description": "Indicates whether the layout can be deactivated, preventing it from being assigned to new records while preserving existing associations. Possible values: `true` — deactivating the layout is permitted; `false` — the layout cannot be deactivated.", "type": "boolean" }, "delete": { "description": "Indicates whether the layout can be permanently removed from the module configuration. Possible values: `true` — deleting the layout is permitted; `false` — the layout cannot be deleted.", "type": "boolean" }, "downgrade": { "description": "Indicates whether the layout can be downgraded to a lower-tier configuration or reverted to a previous edition-level feature set. Possible values: `true` — downgrading the layout is permitted; `false` — the layout cannot be downgraded.", "type": "boolean" }, "edit": { "description": "Indicates whether the layout's field arrangement, sections, and configuration can be modified. Possible values: `true` — editing the layout is permitted; `false` — the layout is locked against edits.", "type": "boolean" }, "rename": { "description": "Indicates whether the layout's display name can be changed. Possible values: `true` — renaming the layout is permitted; `false` — the layout name is locked.", "type": "boolean" }, "set_layout_permissions": { "description": "Indicates whether profile-level permission assignments for the layout can be configured. Possible values: `true` — managing layout permissions is permitted; `false` — permission settings cannot be modified for this layout.", "type": "boolean" } }, "required": [ "edit", "rename", "clone", "downgrade", "delete", "deactivate", "set_layout_permissions" ], "type": "object" }, "LayoutActivateRequest": { "additionalProperties": false, "description": "Represents the request payload for activating a layout, including the layout identifier and optional profile associations.", "properties": { "layouts": { "description": "Specify the array containing exactly one layout object to activate. The layout includes its unique identifier and optionally the profiles to associate or disassociate. Profile associations can be added (default) or removed (using _delete flag). The array must contain exactly one item.", "items": { "additionalProperties": false, "description": "Specify the layout configuration, including its unique identifier and the profile associations to add or remove during activation.", "properties": { "id": { "description": "Specify the unique identifier of the deactivated layout to activate. Must reference an existing deactivated layout within the specified module. The ID is represented as a string containing a 64-bit integer value. Layout IDs are data center-specific. The status key in the response from the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) indicates whether the layout is **active** or **inactive**.", "example": "4832675000000850800", "examples": [ "4831139000000673152", "4831139000000655701" ], "format": "int64", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" } ], "resource": "layouts" } }, "profiles": { "description": "Specify the profile associations to add to or remove from the layout during activation. Omitting this field or providing an empty array preserves existing profile associations. Refer to the [Get Profiles](profiles.yaml#$.paths./settings/profiles.get) resource for valid values. Use the _delete flag to remove existing associations. Empty array or omitting this field entirely preserves existing profile associations. At least one profile must remain associated with the layout after all operations are applied. While duplicate profile IDs are technically allowed, they cause unnecessary processing and should be avoided.", "items": { "additionalProperties": false, "description": "Specify a profile to associate with or disassociate from the layout.", "properties": { "_delete": { "default": false, "description": "Specify whether to remove this profile's association from the layout. Possible values: **true** - Removes the profile association from the layout. **false** - Adds or retains the profile association on the layout.", "examples": [ true, false ], "type": "boolean" }, "id": { "description": "Specify the unique identifier of the profile to associate with or disassociate from the layout. Must be a profile that exists in the CRM organization and is associated with the specified module. The ID is represented as a string containing a 64-bit integer value. Refer to the [Get Profiles](profiles.yaml#$.paths./settings/profiles.get) resource for valid values.", "example": "4832675000000850800", "examples": [ "4831139000000650385", "4831139000000015972" ], "format": "int64", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object" }, "LayoutDetails": { "additionalProperties": false, "description": "Represents the layout associated with a Scoring Rule, including its display label, API name, and unique ID.", "properties": { "api_name": { "description": "Represents the API name of the layout associated with the Scoring Rule.", "maxLength": 255, "type": "string" }, "display_label": { "description": "Represents the display label of the layout associated with the Scoring Rule.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the layout associated with the Scoring Rule.", "maxLength": 25, "type": "string" } }, "title": "Layout Information", "type": [ "object", "null" ] }, "LayoutErrorDetails": { "additionalProperties": true, "description": "Represents error details specific to layout operations, providing structured diagnostics such as the offending parameter name, JSON path, and any dependency or limit information relevant to the failure.", "properties": { "action": { "description": "Represents the operation that was being executed when the error occurred, providing context for diagnosing which layout action — such as update, delete, or deactivate — triggered the failure.", "example": "delete", "maxLength": 255, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Resource ID related to the error, if applicable." }, "param_name": { "description": "Identifies the specific request parameter whose value or absence caused the layout operation to fail, enabling targeted correction of the offending input.", "example": "transfer_to", "maxLength": 100, "type": "string" }, "resource_path_index": { "description": "Indicates the zero-based position within the request resource path at which the invalid or unrecognised segment was detected, helping to locate the exact path segment that caused the layout operation error.", "example": 2, "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "LayoutErrorDetails" }, "LayoutErrorResponse": { "additionalProperties": false, "description": "Represents the layout-specific error response structure returned when one or more layouts in a batch operation fail, containing per-layout error entries.", "properties": { "layouts": { "description": "Contains the array of layout-specific error entries, each describing a failure encountered for an individual layout within a batch operation.", "items": { "additionalProperties": false, "description": "Represents the error details for a single layout within a batch operation that failed, including the error code, message, and status for that layout.", "properties": { "code": { "description": "Represents the error classification code for the individual layout operation failure, identifying the category of problem encountered.", "enum": [ "NOT_ALLOWED", "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/LayoutErrorDetails" }, "message": { "description": "Contains a descriptive explanation of the error encountered for this individual layout operation, providing context for diagnosing the failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the outcome of the layout operation. Possible values: `error` — the layout operation did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "LayoutErrorResponse" }, "LayoutFieldMissingError": { "additionalProperties": false, "description": "Returned when a layout's required field is absent from the request body. The `details` object identifies the missing field by API name and JSON path, and includes the dependent field reference.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The dependent field object that is required but missing from the request body.", "properties": { "api_name": { "description": "The API name of the dependent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the dependent field in the request body.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "layouts are missing." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "LayoutFieldMissingError" }, "LayoutFieldsResponseSchema": { "additionalProperties": false, "description": "Represents the response returned when the `fields` query parameter trims each layout to the requested keys. Only `id` is guaranteed - it is returned even when it is not requested - every other key appears only when it was asked for, and keys with no value for a layout are returned as null.", "properties": { "layouts": { "description": "Represents the array of layout objects trimmed to the keys requested through the `fields` parameter, ordered by layout name.", "items": { "additionalProperties": false, "description": "Represents an individual layout carrying only the keys requested through the `fields` parameter, plus the always-present `id`.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the layout." }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsUserReference", "description": "User who created the layout." }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "created_time": { "anyOf": [ { "description": "ISO 8601 datetime with timezone offset indicating when the layout was created.", "example": "2024-05-17T09:15:22+05:30", "format": "date-time", "type": "string", "x-zs-$id": "LayoutFieldsCreatedTimeStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "display_label": { "description": "Represents the display label of the layout shown in the CRM interface.", "example": "Standard", "maxLength": 100, "minLength": 1, "type": "string" }, "generated_type": { "description": "Indicates whether the layout was generated by the system or created by a user.", "enum": [ "system", "custom" ], "example": "system", "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the layout." }, "modified_by": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsUserReference", "description": "User who last modified the layout." }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "modified_time": { "anyOf": [ { "description": "ISO 8601 datetime with timezone offset indicating when the layout was last modified.", "example": "2024-05-17T09:15:22+05:30", "format": "date-time", "type": "string", "x-zs-$id": "LayoutFieldsModifiedTimeStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "name": { "description": "Represents the internal API name of the layout.", "example": "Standard", "maxLength": 40, "minLength": 1, "type": "string" }, "show_business_card": { "description": "Indicates whether the business card view is enabled for this layout.", "example": true, "type": "boolean" }, "source": { "description": "Represents the source from which this layout was created.", "enum": [ "crm", "platform_plugin", "marketplace_plugin", "campaign_integration" ], "example": "crm", "type": "string" }, "status": { "description": "Represents the current status of the layout.", "enum": [ "active", "inactive" ], "example": "active", "type": "string" }, "visible": { "description": "Indicates whether the layout is visible to users in the CRM interface.", "example": true, "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "maxItems": 15, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "LayoutFieldsResponseSchema" }, "LayoutMissingSelectedFilterError": { "additionalProperties": false, "description": "Returned when the selected filter-by field is not included in the specified layout. The filter field must be part of the chosen layout.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Layout does not have selected filter in it." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "LayoutMissingSelectedFilterError" }, "LayoutName": { "description": "Name of the layout", "example": "Standard", "maxLength": 50, "type": "string" }, "LayoutNested": { "additionalProperties": false, "description": "Represents the layout used to render the service record. Refer to the [Get layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.", "properties": { "id": { "description": "Specify the unique ID of the layout to use for the service record. Refer to the [Get layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.", "maxLength": 18, "type": [ "string", "null" ] } }, "type": "object" }, "LayoutResponseSchema": { "additionalProperties": false, "description": "Represents the response schema for layout retrieval operations, containing an array of layout objects each with complete configuration details including sections, profiles, and portal user type associations.", "properties": { "layouts": { "description": "Contains the array of layout objects returned for the specified module, each representing a complete layout configuration including sections, fields, profiles, and portal user type associations.", "items": { "additionalProperties": false, "description": "Represents the complete configuration of a single layout in the module, including its sections, field assignments, profile associations, and display metadata.", "properties": { "actions_allowed": { "$ref": "#/components/schemas/LayoutActionsAllowed", "description": "Permissions indicating which operations are allowed on this layout" }, "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the layout", "x-zs-$id": "LayoutApiName" }, "convert_mapping": { "anyOf": [ { "$ref": "#/components/schemas/ConvertMappingModule" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsUserReference", "description": "User who created the layout" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "created_for": { "anyOf": [ { "description": "Represents the integration or system context that prompted the creation of this layout, identifying the source platform or feature responsible for provisioning it.", "maxLength": 100, "type": "string", "x-zs-$id": "CreatedForString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "created_time": { "anyOf": [ { "description": "Represents the ISO 8601 datetime with timezone offset recording when this layout was first created in the CRM.", "example": "2024-05-17T09:15:56+05:30", "format": "date-time", "type": "string", "x-zs-$id": "LayoutCreatedTimeStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "display_label": { "description": "Represents the label of the layout as displayed in the CRM interface, shown in layout selection dropdowns and record settings.", "example": "Standard", "maxLength": 100, "minLength": 1, "type": "string" }, "generated_type": { "description": "Indicates whether this layout originates from automatic system generation or from an administrator's manual configuration. Possible values: `system` — automatically generated by Zoho CRM. `custom` — created manually by an administrator.", "enum": [ "system", "custom" ], "example": "system", "type": "string" }, "has_more_profiles": { "description": "Indicates whether additional profile associations exist for this layout beyond those included in the current response. Possible values: `true` — more profile associations are available; `false` — all profile associations are represented.", "type": "boolean" }, "id": { "$ref": "#/components/schemas/LayoutsId", "x-zs-$id": "LayoutId" }, "modified_by": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsUserReference", "description": "User who last modified the layout" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "modified_time": { "anyOf": [ { "description": "Represents the ISO 8601 datetime with timezone offset recording when this layout's configuration was most recently changed.", "example": "2024-05-17T09:15:56+05:30", "format": "date-time", "type": "string", "x-zs-$id": "LayoutModifiedTimeStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "name": { "description": "Represents the internal API name of the layout, used as a programmatic identifier in API operations and automation configurations.", "example": "Standard", "maxLength": 40, "minLength": 1, "type": "string" }, "portal_user_types": { "description": "Contains the list of portal user type associations for this layout, each specifying which portal user category the layout is associated with and the default view configuration for that user type.", "items": { "additionalProperties": false, "description": "Represents the portal user type configuration entry for this layout, specifying the user type, default view settings, and whether this is the default layout for that user type.", "properties": { "_default_view": { "additionalProperties": false, "description": "Represents the default view assigned to this portal user type for the layout, defining which view is presented to portal users of this type by default.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the default view" }, "name": { "description": "Represents the API name of the default view assigned to this portal user type.", "example": "Standard", "maxLength": 255, "type": "string" }, "type": { "description": "Indicates the category of the default view assigned to this portal user type, such as a layout view or a wizard-based view.", "enum": [ "layout", "wizard" ], "example": "layout", "type": "string" } }, "required": [ "name", "id", "type" ], "type": "object" }, "default": { "description": "Indicates whether this layout is the default for the associated portal user type. Possible values: `true` — this is the default layout for this portal user type; `false` — it is not the default.", "example": true, "type": "boolean" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the portal user type" }, "name": { "description": "Represents the name of the portal user type associated with this layout entry.", "example": "Customer Portal", "maxLength": 255, "type": "string" } }, "required": [ "default", "name", "id", "_default_view" ], "type": "object" }, "maxItems": 50, "type": "array" }, "profiles": { "anyOf": [ { "description": "Represents the list of CRM profiles associated with this layout. Contains an empty array when no profiles are assigned.", "items": { "$ref": "#/components/schemas/ProfileReference" }, "maxItems": 50, "minItems": 1, "type": "array", "x-zs-$id": "ProfileReferenceArray" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "sections": { "description": "Contains the ordered list of sections within this layout, each grouping a set of fields and defining display properties such as column count and tab traversal order.", "items": { "additionalProperties": false, "description": "Represents a single section within the layout, encapsulating the section's field collection, display label, column configuration, and any subform or parent-section relationships.", "properties": { "actions_allowed": { "$ref": "#/components/schemas/ActionsAllowed", "description": "Permissions for section operations. System sections (Score, Visit Summary) will have restricted permissions." }, "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API identifier for the section" }, "column_count": { "description": "Indicates the number of columns in which fields are arranged within this section, controlling the side-by-side or single-column display of fields on record forms.", "enum": [ 1, 2 ], "example": 2, "format": "int32", "type": "number" }, "display_label": { "description": "Represents the name of the section as displayed in the CRM interface, used as the section heading on record create and detail pages.", "example": "Contact Information", "maxLength": 100, "minLength": 1, "type": "string" }, "fields": { "description": "Contains the ordered list of fields assigned to this section. Fields are presented in ascending sequence_number order.", "items": { "$ref": "#/components/schemas/LayoutsFieldSchema" }, "maxItems": 500, "type": "array" }, "generated_type": { "description": "Indicates whether this section originates from automatic system generation or from an administrator's manual configuration. Possible values: `default` — automatically generated by the CRM platform. `custom` — defined manually by an administrator.", "enum": [ "default", "custom" ], "example": "custom", "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "isSubformSection": { "description": "Indicates whether this section renders as an embedded subform that displays related module records inline within the parent record's layout. Possible values: `true` — the section is a subform; `false` — the section is a standard field group.", "type": "boolean" }, "is_parent_section": { "description": "Indicates whether this section acts as the parent container for a dependent subform section, establishing a hierarchical section relationship within the layout. Possible values: `true` — this is a parent section; `false` — this section is not a parent container.", "example": false, "type": "boolean" }, "mode": { "description": "Represents the layout mode for which this section applies, controlling in which view contexts the section and its fields render. Possible values: `all` — applies across all layout modes. `business_card` — applies to the business card view. `quick_create` — applies to the quick-create form. `default_create` — applies to the default record creation form. `create_edit` — applies to both create and edit forms. `view` — applies to the record detail view. `quick_view` — applies to the quick view panel. `subform_default_create` — applies to the default create form within a subform context.", "enum": [ "all", "business_card", "quick_create", "default_create", "create_edit", "view", "quick_view", "subform_default_create" ], "example": "all", "type": "string" }, "name": { "description": "Represents the internal name of the section used to reference it in layout configurations and API operations.", "maxLength": 50, "minLength": 1, "type": "string" }, "parent_section": { "anyOf": [ { "additionalProperties": false, "description": "Represents the parent section reference for a nested section, identifying the containing parent section by name when a hierarchical section relationship exists.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the parent section." }, "name": { "description": "Represents the name of the parent section under which this nested section is organized within the layout.", "example": "Address Information", "maxLength": 100, "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-zs-$id": "ParentSectionStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents a reference to the parent section when this section is nested as a subform or dependent section within the layout hierarchy." }, "properties": { "anyOf": [ { "$ref": "#/components/schemas/SectionProperties" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "sequence_number": { "description": "Represents the ordinal position of this section within the layout, controlling the order in which sections are rendered on record forms.", "format": "int32", "minimum": 1, "type": "number" }, "tab_traversal": { "description": "Indicates the direction of keyboard tab navigation within this section, determining the order in which focus moves between fields when users press Tab. Possible values: `left_to_right` — focus moves horizontally across columns first. `top_to_bottom` — focus moves vertically down each column first.", "enum": [ "left_to_right", "top_to_bottom" ], "example": "left_to_right", "type": "string" }, "type": { "description": "Represents the usage status type of this section within the layout. Possible values: `used` — the section contains fields assigned to it. `unused` — the section exists in the layout but contains no assigned fields.", "enum": [ "used", "unused" ], "example": "used", "type": "string" } }, "required": [ "isSubformSection", "display_label", "mode", "sequence_number", "actions_allowed", "tab_traversal", "api_name", "column_count", "name", "generated_type", "id", "fields" ], "type": "object" }, "maxItems": 100, "minItems": 0, "type": "array" }, "show_business_card": { "description": "Indicates whether the business card view is enabled for this layout, allowing a compact summary of key fields to be shown in preview and lookup contexts. Possible values: `true` — business card view is active; `false` — business card view is not enabled.", "example": true, "type": "boolean" }, "source": { "description": "Represents the origin channel of this layout. Possible values: `crm` — the layout is built into the standard module definition. `platform_plugin` — the layout comes from a Zoho platform plugin. `marketplace_plugin` — the layout comes from a Marketplace extension. `campaign_integration` — the layout comes from a Campaigns integration.", "enum": [ "crm", "platform_plugin", "marketplace_plugin", "campaign_integration" ], "example": "campaign_integration", "type": "string" }, "status": { "description": "Indicates the current operational status of the layout. Possible values: `active` — the layout is in use and can be assigned to profiles; `inactive` — the layout has been deactivated and is not available for new assignments.", "enum": [ "active", "inactive", "downgraded", "hidden" ], "example": "active", "type": "string" }, "total_profiles": { "description": "Indicates the total number of CRM profiles associated with this layout, which may exceed the number of profiles included in the current response when has_more_profiles is true.", "example": 3, "format": "int32", "type": "number" }, "visible": { "description": "Indicates whether this layout is currently visible and accessible to users in the CRM interface. Possible values: `true` — the layout is visible and selectable; `false` — the layout is hidden.", "example": true, "type": "boolean" } }, "required": [ "has_more_profiles", "created_time", "visible", "created_for", "profiles", "source", "sections", "display_label", "show_business_card", "actions_allowed", "modified_time", "api_name", "name", "modified_by", "generated_type", "id", "status" ], "type": "object" }, "maxItems": 15, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "LayoutResponseSchema" }, "LayoutUpdateErrorDetails": { "additionalProperties": true, "description": "Represents the structured error details for a layout update failure, providing diagnostic information such as the offending field's JSON path and API name, dependency violations, ambiguity sources, limit breaches, and expected field constraints.", "properties": { "ambiguity_due_to": { "description": "Contains the list of fields that caused an ambiguity error during layout update processing, identifying conflicting or duplicate field references in the request.", "items": { "additionalProperties": false, "description": "Represents a single field reference that contributed to the ambiguity error, providing its API name and JSON path within the request payload.", "properties": { "api_name": { "description": "Represents the API name of the field that contributed to the layout update ambiguity error.", "example": "id", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field within the layout update request payload that contributed to the ambiguity error.", "example": "$.layouts[0].sections[0].fields[0].association_details.related_field.id", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" }, "api_name": { "description": "Represents the API name of the field whose value or configuration caused the layout update error.", "example": "id", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Contains information about the dependent field that caused a mismatch or dependency violation during the layout update operation.", "properties": { "api_name": { "description": "Represents the API name of the dependent field involved in the layout update dependency error.", "example": "length", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependent field within the layout update request payload.", "example": "$.layouts[0].sections[0].fields[0].length", "maxLength": 500, "type": "string" } }, "type": "object" }, "expected_data_type": { "description": "Indicates the data type that the API expected for the field that failed validation during the layout update.", "example": "text", "maxLength": 50, "type": "string" }, "expected_fields": { "description": "Contains the list of fields of which at least one must be provided for the layout update to proceed, describing a conditional required field constraint.", "items": { "additionalProperties": false, "description": "Represents a single field from the set of conditionally required fields, identifying which field is expected but missing from the layout update request.", "properties": { "api_name": { "description": "Represents the API name of the expected field that is missing from the layout update request.", "example": "id", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the expected field within the layout update request payload.", "example": "$.layouts[0].sections[0].fields[0].association_details.related_field.id", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" }, "json_path": { "description": "Represents the JSON path to the field within the layout update request payload that caused the error, enabling precise identification of the offending input.", "example": "$.layouts[0].sections[0].fields[0].id", "maxLength": 500, "type": "string" }, "limit": { "description": "Indicates the maximum allowed value or count that was exceeded during the layout update, providing the threshold value for the violated constraint.", "example": 100, "format": "int32", "type": "integer" }, "limit_due_to": { "description": "Contains the list of fields responsible for causing a limit to be exceeded during the layout update, identifying which fields contributed to the constraint violation.", "items": { "additionalProperties": false, "description": "Represents a single field reference that caused the layout update limit to be exceeded, including its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that contributed to exceeding the layout update limit.", "example": "id", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field within the layout update request payload that contributed to exceeding the limit.", "example": "$.layouts[0].sections[0].fields[0].association_details.lookup_field.id", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" }, "maximum_length": { "description": "Indicates the maximum character length allowed for the field that failed validation during the layout update.", "example": 255, "format": "int32", "type": "integer" } }, "type": "object" }, "LayoutUpdateErrorResult": { "additionalProperties": false, "description": "Represents the error result returned for a failed layout update operation, containing a classification code, descriptive message, and status indicator.", "properties": { "code": { "description": "Represents the error classification code returned for a failed layout update operation. Possible values: `INVALID_DATA` — a field value fails validation. `MANDATORY_NOT_FOUND` — a required field is absent. `NOT_ALLOWED` — the operation is not permitted for this field. `LIMIT_EXCEEDED` — a maximum count or size limit was exceeded. `DUPLICATE_DATA` — a duplicate value was detected. `EXPECTED_FIELD_MISSING` — a conditionally required field is absent. `DEPENDENT_FIELD_MISSING` — a dependent field required by another field is not provided. `DEPENDENT_MISMATCH` — a dependent field's value does not match the expected configuration. `NOT_SUPPORTED` — the operation is not supported for this field type. `FEATURE_NOT_SUPPORTED` — the requested feature is not available. `AMBIGUITY_DURING_PROCESSING` — conflicting references prevent unambiguous processing.", "enum": [ "INVALID_DATA", "MANDATORY_NOT_FOUND", "NOT_ALLOWED", "LIMIT_EXCEEDED", "DUPLICATE_DATA", "EXPECTED_FIELD_MISSING", "DEPENDENT_FIELD_MISSING", "DEPENDENT_MISMATCH", "NOT_SUPPORTED", "FEATURE_NOT_SUPPORTED", "AMBIGUITY_DURING_PROCESSING" ], "example": "INVALID_DATA", "type": "string" }, "details": { "$ref": "#/components/schemas/LayoutUpdateErrorDetails" }, "message": { "description": "Contains a descriptive explanation of the error encountered during the layout update operation.", "example": "the id given seems to be invalid", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the outcome of the layout update operation. Possible values: `error` — the operation did not complete successfully.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "LayoutUpdateObject": { "additionalProperties": false, "description": "Represents the layout configuration object supplied in an update request, containing at least one of the updatable attributes: name, sections, profiles, or business card display setting.", "minProperties": 1, "properties": { "name": { "description": "Represents the new display name for the layout. Must be unique within the module's layout configurations.", "examples": [ "Updated CL1", "Sales Layout V2" ], "maxLength": 255, "minLength": 1, "type": "string" }, "profiles": { "description": "Contains the array of profile objects to be added to or removed from the layout's profile associations in this update operation.", "items": { "$ref": "#/components/schemas/ProfileUpdateObject" }, "maxItems": 50, "minItems": 1, "type": "array" }, "sections": { "description": "Contains the array of section objects to be created, modified, or deleted as part of this layout update, defining the field and configuration changes within each section.", "items": { "$ref": "#/components/schemas/SectionUpdateObject" }, "maxItems": 5, "minItems": 1, "type": "array" }, "show_business_card": { "description": "Specifies whether the business card view is enabled or disabled for this layout as part of the update.", "examples": [ true, false ], "type": "boolean" } }, "type": "object" }, "LayoutUpdateSuccessResult": { "additionalProperties": false, "description": "Represents the success result returned when a layout update operation completes without error, containing a confirmation code, message, and the identifying details of the updated layout.", "properties": { "code": { "description": "Represents the success code returned when the layout update operation completes without error.", "enum": [ "SUCCESS" ], "example": "SUCCESS", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the identifying details of the layout that was successfully updated, such as its ID.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the updated layout." } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Contains a confirmation message indicating that the layout update operation completed successfully.", "example": "layout updated", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the outcome of the layout update operation. Possible values: `success` — the layout update completes successfully.", "enum": [ "success" ], "example": "success", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "LayoutsApiName": { "description": "Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities.", "example": "Lead_Owner", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$id": "ApiNameStructure" }, "LayoutsErrorDetails": { "additionalProperties": true, "description": "Contains additional context-specific details accompanying an API error response, providing structured diagnostics such as the offending parameter name, expected data type, supported values, or dependency information.", "properties": { "dependee": { "additionalProperties": false, "description": "Contains structured information about the controlling parameter whose presence or value is required before the missing dependent parameter becomes valid or applicable.", "properties": { "param_name": { "description": "Identifies the API parameter name of the dependee — the controlling parameter that must be supplied or satisfied to make the associated dependent parameter applicable in the request.", "example": "transfer_to", "maxLength": 100, "type": "string" } }, "type": "object" }, "expected_data_type": { "description": "Indicates the data type that the API expects for the parameter that failed validation, enabling callers to correct the value format before retrying the request.", "example": "int64", "maxLength": 50, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Resource ID related to the error, if applicable." }, "param_name": { "description": "Identifies the specific request parameter whose value or absence triggered the error, enabling targeted correction of the offending input.", "example": "module", "maxLength": 100, "type": "string" }, "permissions": { "description": "Contains the set of OAuth permission scopes that must be granted to the authenticating user or application before the requested action can be completed. Returned when the request is denied due to insufficient permissions.", "example": [ "Crm_Implied_Customize_Zoho_CRM" ], "items": { "description": "Represents a single OAuth scope string that the caller must hold to perform the attempted operation.", "example": "Crm_Implied_Customize_Zoho_CRM", "maxLength": 100, "type": "string" }, "maxItems": 20, "type": "array" }, "resource_path_index": { "description": "Indicates the zero-based position within a multi-segment URL path at which the invalid or unrecognised segment was detected, helping to locate the exact portion of the resource path that caused the error.", "example": 2, "format": "int32", "type": "integer" }, "supported_values": { "description": "Contains the discrete values accepted for the parameter identified in the error, providing a reference set to correct the offending request.", "example": [ "delete", "deactivate" ], "items": { "description": "Represents one accepted value for the parameter that caused the error.", "maxLength": 100, "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "LayoutsErrorResponse": { "additionalProperties": false, "description": "Represents the standard error response structure returned by the API when a request fails, containing a structured error code, a descriptive message, and a status indicator.", "properties": { "code": { "description": "Identifies the category of error returned by the API. Possible values: `REQUIRED_PARAM_MISSING` — a mandatory parameter was absent from the request; `DEPENDENT_PARAM_MISSING` — a parameter required by another supplied parameter was not provided; `INVALID_MODULE` — the specified module does not exist or is not accessible; `INVALID_DATA` — one or more field values failed validation; `NOT_SUPPORTED` — the requested operation is not supported for the target resource; `NOT_ALLOWED` — the operation is not permitted in the current context; `AUTHENTICATION_FAILURE` — the supplied credentials could not be verified; `OAUTH_SCOPE_MISMATCH` — the OAuth token does not carry the scope required for the operation; `INVALID_REQUEST_METHOD` — the HTTP method used is not accepted by the endpoint; `INTERNAL_ERROR` — an unexpected server-side failure occurred; `NO_PERMISSION` — the authenticated user lacks the CRM profile permission needed to perform the action.", "enum": [ "REQUIRED_PARAM_MISSING", "DEPENDENT_PARAM_MISSING", "INVALID_MODULE", "INVALID_DATA", "NOT_SUPPORTED", "NOT_ALLOWED", "AUTHENTICATION_FAILURE", "OAUTH_SCOPE_MISMATCH", "INVALID_REQUEST_METHOD", "INTERNAL_ERROR", "NO_PERMISSION" ], "type": "string" }, "details": { "$ref": "#/components/schemas/LayoutsErrorDetails" }, "message": { "description": "Contains a short, descriptive explanation of the error condition, providing context that supplements the structured error code.", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the outcome of the request. Possible values: `error` — the request did not complete successfully and the response body contains error details.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponse" }, "LayoutsFieldSchema": { "additionalProperties": false, "description": "Represents a comprehensive schema for a CRM field in a module layout, encapsulating all field-level configuration including data type, display settings, permissions, lookup relationships, formula definitions, and audit metadata.", "properties": { "additional_column": { "anyOf": [ { "description": "Represents the additional column configuration for the field, specifying display settings when the field appears as an extra column in module list views.", "example": "Custom_Column_1", "maxLength": 100, "type": "string", "x-zs-$id": "AdditionalColumnString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "address": { "anyOf": [ { "additionalProperties": false, "description": "Represents the detailed address sub-field configuration when the field is a composite address type, providing the address category classification.", "properties": { "type": { "description": "Represents the classification of the address, distinguishing between address categories such as mailing, billing, or shipping to determine how the composite address field is labeled and used within the module layout.", "example": "shipping", "maxLength": 25, "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "AddressFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the address sub-field configuration applicable when the field represents a composite address type, such as mailing or billing address, grouping individual components like street, city, state, and country into a structured object." }, "allowed_permissions_to_update": { "additionalProperties": false, "description": "Represents the set of permission levels that can be actively assigned to this field across profiles, indicating which visibility and access states are eligible for modification. Returned only when the query parameter `include_inner_details=fields.allowed_permissions_to_update` is specified in the request.", "properties": { "hidden": { "description": "Indicates whether the hidden permission level is eligible to be assigned to this field. Possible values: `true` — the field's visibility can be set to hidden for specific profiles, concealing it entirely from their layout view; `false` — the hidden permission cannot be applied to this field.", "example": false, "type": "boolean" }, "read_only": { "description": "Indicates whether the read-only permission level is eligible to be assigned to this field. Possible values: `true` — the field can be configured as read-only for specific profiles, allowing users to view but not edit its value; `false` — the read-only permission cannot be applied to this field.", "example": true, "type": "boolean" }, "read_write": { "description": "Indicates whether the read-write permission level is eligible to be assigned to this field. Possible values: `true` — the field can be configured for full read and write access for specific profiles, permitting both viewing and editing; `false` — the read-write permission cannot be applied to this field.", "example": true, "type": "boolean" } }, "required": [ "read_write", "hidden", "read_only" ], "type": "object" }, "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API identifier for the field" }, "associated_module": { "anyOf": [ { "additionalProperties": false, "description": "Represents the associated module details when this field is a subform field, including the module API name and the layout used to render the embedded records.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the associated module" }, "layout": { "additionalProperties": false, "description": "Represents the name of the layout applied to the associated module's records when displayed within the subform field, determining which set of fields and sections are rendered in the embedded view.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the layout" }, "name": { "description": "Represents the name of the layout applied to the associated module's records when displayed within the subform field, determining which set of fields and sections are rendered in the embedded view.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "module": { "$ref": "#/components/schemas/LayoutsModuleName", "description": "API name of the associated module" } }, "required": [ "module", "id" ], "type": "object", "x-zs-$id": "AssociatedModuleStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the details of the CRM module linked to this field when the field represents a subform, identifying the related module and the layout governing how its records are embedded and displayed within the parent module's layout." }, "association_details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the lookup association details when this field is connected to another module through a lookup relationship, including the lookup and related field metadata.", "properties": { "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field on the source module that establishes the association, containing identifying metadata such as the field's API name and display label.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the lookup field" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the lookup field" } }, "required": [ "api_name", "id" ], "type": "object" }, "related_field": { "additionalProperties": false, "description": "Represents the corresponding field on the related module that is linked through the association, containing identifying metadata such as the field's API name and display label.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the related field" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the related field" } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "related_field", "lookup_field" ], "type": "object", "x-zs-$id": "AssociationDetailsStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the relationship metadata for fields connected to other records through lookup associations, describing the linked module, the nature of the relationship, and any constraints governing how related records appear or display." }, "auto_number": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active auto-number configuration for this field, containing the prefix, suffix, starting number, and digit length used to generate sequential identifiers.", "properties": { "prefix": { "anyOf": [ { "description": "Represents the text string prepended to each auto-generated number in the sequence.", "example": "INV-", "maxLength": 10, "type": "string", "x-zs-$id": "AutoNumberPrefixString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "start_number": { "anyOf": [ { "description": "Represents the numeric value at which the auto-number sequence begins.", "example": 1, "format": "int32", "type": "number", "x-zs-$id": "AutoNumberStartNumberInteger" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "starting_number_length": { "description": "Represents the total digit length of the starting number used in the auto-number sequence, controlling zero-padding and minimum width of generated values.", "example": 5, "format": "int32", "type": "number" }, "suffix": { "anyOf": [ { "description": "Represents the text string appended to each auto-generated number in the sequence.", "example": "-2024", "maxLength": 10, "type": "string", "x-zs-$id": "AutoNumberSuffixString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] } }, "required": [], "type": "object", "x-zs-$id": "AutoNumberStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "blueprint_supported": { "description": "Indicates whether the field can participate in Blueprint process definitions, enabling it to be referenced in transition conditions and actions within automated workflow stages. Possible values: `true` — the field is eligible for use in Blueprint configurations; `false` — the field cannot be included in Blueprint process logic.", "example": true, "type": "boolean" }, "businesscard_supported": { "description": "Indicates whether the field is eligible to appear on the business card view, which surfaces key record details in compact preview panels across Zoho CRM. Possible values: `true` — the field can be included in the business card layout; `false` — the field is excluded from business card display.", "example": false, "type": "boolean" }, "category": { "description": "Indicates the classification category of the field, used to group fields by their functional role or origin within the module layout, such as standard, custom, or system-defined categories.", "example": 2, "format": "int32", "type": "number" }, "child_fields": { "anyOf": [ { "description": "Represents the ordered list of child field entries for a composite field such as an address field, each associating a sub-field's identity with its display sequence.", "items": { "additionalProperties": false, "description": "Represents a single sub-field entry within a composite field, bundling the field's identity and its display position relative to sibling sub-fields.", "properties": { "field": { "additionalProperties": false, "description": "Contains the identifying attributes of the child field, such as its API name, used to reference the corresponding FieldSchema within the module layout.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the child field" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the child field" }, "name": { "description": "Represents the API name of the child field, used to uniquely identify it within the parent composite field and reference it in layout and data operations.", "example": "Address 1 - City", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "name", "id" ], "type": "object" }, "sequence_number": { "description": "Indicates the ordinal position of the child field within the composite field, determining the rendering order of sub-fields in the layout UI.", "example": 1, "format": "int32", "minimum": 1, "type": "number" } }, "required": [ "sequence_number", "field" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "ChildFieldsArray" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the ordered collection of sub-fields that compose a composite field, such as the individual address components (street, city, state, country, zip) grouped under a single parent field." }, "colour_code_enabled_by_system": { "description": "Indicates whether color-code functionality has been activated for this field by the system platform rather than by a user or administrator. Possible values: `true` — the system has enabled color coding for this field; `false` — color coding on this field is not system-activated.", "example": false, "type": "boolean" }, "column_name": { "description": "Represents the underlying database column identifier mapped to this field, used for direct data-layer references and query construction within the CRM storage layer.", "example": "WEBSITE", "maxLength": 100, "type": "string" }, "convert_mapping": { "anyOf": [ { "additionalProperties": false, "description": "Represents the Leads module field conversion mapping, specifying the destination field API names in the Contacts, Deals, and Accounts modules for this field during lead conversion.", "properties": { "Accounts": { "anyOf": [ { "description": "Represents the API name of the target field in the **Accounts** module for this field's value during lead-to-Accounts conversion.", "example": "Account_Name", "maxLength": 100, "type": "string", "x-zs-$id": "AccountsFieldMapping" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the API name of the destination field in the **Accounts** module to which this field's value is mapped during record conversion, or null when no mapping to Accounts is defined." }, "Contacts": { "anyOf": [ { "description": "Represents the API name of the target field in the **Contacts** module for this field's value during lead-to-Contacts conversion.", "example": "Contact_Name", "maxLength": 100, "type": "string", "x-zs-$id": "ContactsFieldMapping" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the API name of the destination field in the **Contacts** module to which this field's value is mapped during record conversion, or null when no mapping to Contacts is defined." }, "Deals": { "anyOf": [ { "description": "Represents the API name of the target field in the **Deals** module for this field's value during lead-to-Deals conversion.", "example": "Deal_Name", "maxLength": 100, "type": "string", "x-zs-$id": "DealsFieldMapping" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the API name of the destination field in the **Deals** module to which this field's value is mapped during record conversion, or null when no mapping to Deals is defined." } }, "required": [ "Contacts", "Deals", "Accounts" ], "title": "Leads Field Convert Mapping", "type": "object", "x-zs-$id": "LeadsFieldConvertMapping" }, { "additionalProperties": false, "description": "Represents the Quotes module field conversion mapping, specifying the destination field API names in the Invoices and Sales_Orders modules for this field during quote conversion.", "properties": { "Invoices": { "anyOf": [ { "description": "Represents the API name of the target field in the **Invoices** module for this field's value during quote-to-Invoices conversion.", "example": "Account_Name", "maxLength": 100, "type": "string", "x-zs-$id": "QuotesInvoicesFieldMapping" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the API name of the destination field in the **Invoices** module to which this field's value is mapped during record conversion, or null when no mapping to Invoices is defined." }, "Sales_Orders": { "anyOf": [ { "description": "Represents the API name of the target field in the **Sales_Orders** module for this field's value during quote-to-Sales_Orders conversion.", "example": "Account_Name", "maxLength": 100, "type": "string", "x-zs-$id": "SalesOrdersFieldMapping" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the API name of the destination field in the **Sales_Orders** module to which this field's value is mapped during record conversion, or null when no mapping to Sales Orders is defined." } }, "required": [ "Invoices", "Sales_Orders" ], "title": "Quotes Field Convert Mapping", "type": "object", "x-zs-$id": "QuotesFieldConvertMapping" }, { "additionalProperties": false, "description": "Represents the Sales Orders module field conversion mapping, specifying the destination field API name in the Invoices module for this field during Sales Order conversion.", "maxProperties": 1, "minProperties": 1, "properties": { "Invoices": { "anyOf": [ { "description": "Represents the API name of the target field in the **Invoices** module for this field's value during Sales Order-to-Invoices conversion.", "example": "Status", "maxLength": 100, "type": "string", "x-zs-$id": "SalesOrdersInvoicesFieldMapping" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the API name of the destination field in the **Invoices** module to which this field's value is mapped under an alternate conversion schema variant, or null when no mapping to Invoices is defined in this context." } }, "required": [ "Invoices" ], "title": "Sales Orders Field Convert Mapping", "type": "object", "x-zs-$id": "SalesOrdersFieldConvertMapping" }, { "additionalProperties": false, "description": "Represents an empty convert mapping object indicating that no cross-module field mapping is configured for this field.", "maxProperties": 0, "title": "No Convert Mapping", "type": "object", "x-zs-$id": "EmptyConvertMappingObject" } ], "description": "Contains the cross-module field mapping configuration that governs how this field's value is transferred to corresponding fields in target modules (such as Accounts, Contacts, Deals, Invoices, or Sales Orders) when a record conversion is performed." }, "created_source": { "description": "Indicates the origin channel through which this field originates in the module. Possible values: `default` — the field is part of the standard CRM module definition; `extension` — the field was added through a CRM extension or plug-in package; `integration` — the field was provisioned via a third-party integration.", "enum": [ "", "default", "extension", "integration" ], "example": "default", "maxLength": 60, "type": "string" }, "created_time": { "anyOf": [ { "description": "Represents the ISO 8601 datetime with timezone offset recording when this field definition was first created in the CRM.", "example": "2024-05-17T09:15:56+05:30", "format": "date-time", "type": "string", "x-zs-$id": "CreatedTimeDateTime" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the date and time at which the field definition was first created in the CRM, recorded for audit and chronological tracking purposes." }, "crypt": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the encryption settings applied to this field, specifying how sensitive data stored in the field is protected at rest within the CRM platform." }, "currency": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active currency configuration for this field, specifying the decimal precision and rounding rule applied when storing and displaying monetary values.", "properties": { "precision": { "description": "Indicates the number of decimal places retained when storing and displaying currency values for this field, controlling the granularity of monetary amounts.", "example": 2, "format": "int32", "type": "number" }, "rounding_option": { "description": "Specifies the rounding rule applied to currency values when the raw amount exceeds the configured precision. Possible values: `round_up` — always rounds the value up. `round_down` — always rounds the value down. `round_off` — rounds to the nearest value. `normal` — no rounding applied.", "enum": [ "round_up", "round_down", "round_off", "normal" ], "example": "round_off", "maxLength": 25, "type": "string" } }, "type": "object", "x-zs-$id": "CurrencyFieldConfigurationStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the currency-specific display and calculation settings for the field, including the number of decimal places to retain and the rounding strategy applied when storing or presenting monetary values." }, "custom_field": { "description": "Indicates whether this field was defined by an administrator or developer beyond the standard module schema, rather than being a built-in system field. Possible values: `true` — the field is user-created and does not belong to the default module definition; `false` — the field is a standard, system-defined field.", "example": true, "type": "boolean" }, "customizable_properties": { "anyOf": [ { "description": "Represents the list of field attribute names that administrators can modify through the layout editor, with unique values only.", "items": { "description": "Represents the API name of a single field attribute that can be modified by an administrator, identifying a specific configurable aspect of the field such as its label, tooltip, or mandatory setting.", "example": "mandatory", "maxLength": 50, "type": "string" }, "maxItems": 100, "type": "array", "uniqueItems": true, "x-zs-$id": "CustomizablePropertiesArray" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the set of field attributes that administrators are permitted to modify through the CRM layout editor, such as label, required status, or visibility, reflecting which aspects of the field definition are not locked by the system." }, "data_type": { "description": "Identifies the data category assigned to the field, such as text, integer, decimal, date, Boolean, picklist, or lookup, which governs validation rules, storage format, and applicable UI controls.", "example": "text", "maxLength": 50, "type": "string" }, "decimal_place": { "anyOf": [ { "description": "Represents the number of decimal places configured for the field, defining the precision applied when storing and displaying fractional values.", "example": 2, "format": "int32", "type": "number", "x-zs-$id": "DecimalPlaceInteger" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "default_value": { "anyOf": [ { "description": "Represents the default string or numeric value pre-populated in this field when a new record is saved.", "maxLength": 255, "type": "string", "x-zs-$id": "DefaultValueString" }, { "description": "Represents the default Boolean value pre-populated in this field when a new record is saved.", "type": "boolean", "x-zs-$id": "DefaultValueBoolean" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the pre-populated value automatically applied to this field when a new record is saved, serving as a baseline entry that users can override during data entry." }, "display_field": { "description": "Indicates whether this field is designated as the primary display field for the module, used to represent the record in lookups, related lists, and search results. Possible values: `true` — the field serves as the record's display identifier; `false` — the field is not the primary display field.", "example": false, "type": "boolean" }, "display_format": { "anyOf": [ { "description": "Represents the active display format pattern for this field, such as a date format string or number format template applied when rendering the field's value in the UI.", "example": "slider", "maxLength": 50, "type": "string", "x-zs-$id": "DisplayFormatString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Specifies the presentation pattern applied when rendering the field's value in the UI, such as a date format string, a time pattern, or a number format template controlling separators and symbol placement." }, "display_format_properties": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active supplementary rendering configuration for this field type, such as phone split settings or radio button orientation.", "properties": { "radio_display_type": { "description": "Specifies the layout orientation used to render radio button options in the UI, such as arranging choices horizontally in a row or vertically in a stacked column.", "example": "all", "maxLength": 25, "type": "string" }, "split": { "description": "Indicates the formatting pattern applied to split a phone number into its dial-code prefix and local number segments when rendering the field in the UI.", "example": 3, "format": "int32", "type": "number" } }, "type": "object", "x-zs-$id": "DisplayFormatPropertiesStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains supplementary rendering configuration for field types that require additional display directives beyond a simple format string, such as phone number dial-code positioning or the orientation and layout style of radio button groups." }, "display_label": { "description": "Represents the name of the field displayed in the module layout, used as the visible title in forms, list views, and detail pages.", "example": "Last Name", "maxLength": 100, "minLength": 1, "type": "string" }, "display_type": { "description": "Indicates the internal numeric code that controls how the field is rendered in the CRM UI, mapping to predefined display modes such as text box, drop-down, or date picker.", "example": 1, "format": "int32", "type": "number" }, "element_type": { "description": "Represents the structural element type of this entry in the layout, distinguishing standard data fields from mirror fields. Possible values: `field` — a standard data field that accepts or displays a value. `mirror_field` — a field that reflects a value from a related module through a lookup relationship.", "enum": [ "field", "mirror_field" ], "example": "field", "maxLength": 50, "type": "string" }, "enable_colour_code": { "description": "Indicates whether color coding is currently active for this field, allowing field values to be visually differentiated by color in list views and kanban boards. Possible values: `true` — color coding is enabled for the field; `false` — color coding is not active.", "example": false, "type": "boolean" }, "enable_record_category": { "description": "Indicates if the record category feature is enabled for this picklist field. Only returned when the record category feature is available.", "example": false, "type": "boolean" }, "enable_transition_for_record_category": { "description": "Indicates if transitions between record categories are enabled. Only returned when enable_record_category is true.", "example": false, "type": "boolean" }, "external": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the integration configuration for fields that receive or expose values through external systems, such as third-party connectors or Zoho marketplace extensions." }, "field_label": { "description": "Represents the label assigned to the field, displayed in forms, detail views, and list columns within the module layout.", "example": "Last Name", "maxLength": 100, "minLength": 1, "type": "string" }, "field_read_only": { "description": "Indicates whether the field is locked against user edits at the field level, independent of profile-based permissions. Possible values: `true` — the field value cannot be modified by users; `false` — the field is editable subject to applicable profile permissions.", "example": false, "type": "boolean" }, "file_upolad_optionlist": { "anyOf": [ { "description": "Represents the list of permitted file upload source options available for this field, each identifying an upload channel by its display label and internal value.", "items": { "additionalProperties": false, "description": "Represents a single permitted file source entry, identifying an upload channel such as local device storage, cloud drive, or URL by its display label and internal value.", "properties": { "actual_value": { "description": "Represents the system-level identifier for the file upload source, used internally to route the upload request to the correct provider.", "example": "Upload File", "maxLength": 100, "type": "string" }, "display_value": { "description": "Represents the label shown in the CRM interface for the file upload source option, communicating the upload channel name to the end user.", "example": "Upload File", "maxLength": 100, "type": "string" } }, "required": [ "display_value", "actual_value" ], "type": "object" }, "maxItems": 20, "type": "array", "x-zs-$id": "FileUploadOptionListArray" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the list of permitted file source options for file-upload fields, defining where users may select files from when populating the field." }, "filterable": { "description": "Indicates whether the field can be used as a filter criterion in record search, list view filtering, and report conditions. Possible values: `true` — the field is available as a filter option; `false` — the field cannot be used for filtering.", "example": true, "type": "boolean" }, "formula": { "anyOf": [ { "additionalProperties": true, "description": "Represents the active formula configuration for this calculated field, containing the expression, return type, evaluation order, and any conditional stop logic.", "properties": { "assume_default": { "description": "Indicates whether null or missing operand values in the formula expression are treated as zero or an equivalent default, rather than causing the formula result to be null. Possible values: `true` — null operands are substituted with default values; `false` — null operands propagate as null through the calculation.", "example": false, "type": "boolean" }, "dynamic": { "description": "Indicates whether the formula is recalculated in real time as dependent field values change, rather than being evaluated only at save time. Possible values: `true` — the formula updates dynamically during record editing; `false` — the formula is evaluated only when the record is saved.", "example": false, "type": "boolean" }, "evaluation_order": { "description": "Indicates the relative priority in which this formula field is evaluated when multiple formula fields exist in the same module and share dependencies, ensuring upstream values are resolved before downstream ones.", "example": 1, "format": "int32", "minimum": 1, "type": "integer" }, "expression": { "description": "Contains the formula expression string that defines the calculation logic, composed of function calls, field API name references, and operators that the CRM engine evaluates to produce the field's computed value.", "example": "Substring(${Lead_Source},2,5)", "maxLength": 3000, "type": "string" }, "return_type": { "description": "Identifies the data type produced by the formula expression, such as string, integer, decimal, date, or Boolean, which determines how the computed value is stored and displayed.", "example": "text", "maxLength": 25, "type": "string" }, "stop_compute_conditionally": { "description": "Indicates whether the formula evaluation halts when a specified logical condition is met. Possible values: `true` — the formula stops computing once the stop condition expression evaluates to true; `false` — the formula computes to completion regardless of intermediate conditions.", "example": false, "type": "boolean" }, "stop_compute_expression": { "anyOf": [ { "description": "Represents the active logical expression evaluated to determine whether formula computation should be halted before completion.", "example": "${Status} == 'Closed'", "maxLength": 3000, "type": "string", "x-zs-$id": "StopComputeExpressionString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the logical expression evaluated at runtime to determine whether formula computation should be interrupted. When the expression resolves to true and stop_compute_conditionally is enabled, further formula processing is skipped and the current interim value is retained." }, "sub_return_type": { "anyOf": [ { "description": "Represents the active secondary type classification for the formula's return value. Possible values: `small` — a compact representation. `medium` — a standard-size representation. `large` — a large-size representation.", "enum": [ "small", "medium", "large" ], "example": "small", "maxLength": 25, "type": "string", "x-zs-$id": "SubReturnTypeString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents a secondary classification of the formula's output type, refining the primary return type to indicate a more specific data size or unit. Possible values: `small` — a compact representation of the return type. `medium` — a standard-size representation. `large` — a large-size representation." } }, "required": [ "return_type", "expression", "dynamic", "stop_compute_conditionally", "stop_compute_expression" ], "type": "object", "x-zs-$id": "FormulaFieldStructure" }, { "additionalProperties": false, "description": "Represents an empty formula configuration object indicating that no formula calculation is configured for this field.", "maxProperties": 0, "title": "No Formula", "type": "object", "x-zs-$id": "EmptyFormulaObject" } ], "description": "Contains the formula configuration for fields whose values are automatically calculated from expressions referencing other fields or functions, rather than being entered directly by users." }, "global_map_dependency": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active global map dependency configuration linking this field to a shared organizational mapping definition.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the global map dependency." } }, "required": [ "id" ], "type": "object", "x-zs-$id": "GlobalMapDependencyStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the global map dependency linked to this field, which governs how the field's available values or behavior are influenced by a shared mapping configuration defined at the organization level. Contains identifying metadata for the associated global map dependency, or is absent when no such dependency applies." }, "global_picklist": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active global picklist configuration linking this field to a shared organization-level picklist definition.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the global picklist" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the global picklist" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "GlobalPicklistStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the organization-level picklist configuration shared across multiple modules that this field draws its allowed values from. When present, the field's pick options are centrally managed through the referenced global picklist rather than defined locally on the field itself." }, "hipaa_compliance": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active HIPAA compliance configuration for this field, specifying the access restriction and export suppression settings applied when HIPAA compliance is enabled.", "properties": { "restricted": { "description": "Indicates whether access to this field's value is restricted under HIPAA compliance rules, limiting visibility to only those users or roles authorized to handle protected health information. Possible values: `true` — the field is treated as restricted PHI and access controls are enforced; `false` — the field is not subject to HIPAA access restrictions.", "example": false, "type": "boolean" }, "restricted_in_export": { "description": "Indicates whether this field's value is suppressed or masked when records are exported, in accordance with HIPAA data handling requirements. Possible values: `true` — the field is excluded or redacted in exported data sets; `false` — the field value is included in exports without HIPAA-based redaction.", "example": false, "type": "boolean" } }, "required": [ "restricted_in_export", "restricted" ], "type": "object", "x-zs-$id": "HIPAAComplianceStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "hipaa_compliance_enabled": { "description": "Indicates whether HIPAA compliance enforcement is active for this field, determining whether the associated HIPAA access and export restrictions are applied at runtime. Possible values: `true` — HIPAA compliance rules are enforced for this field; `false` — HIPAA compliance is not enforced and the field is treated as non-PHI data.", "example": false, "type": "boolean" }, "history_tracking": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active history tracking configuration for this field, detailing the retention duration, tracked fields, associated module, and related list configuration.", "properties": { "duration_configuration": { "description": "Contains the settings that govern the time window over which field value changes are retained in the history log, such as the retention period length and applicable time units used to define how far back historical data is preserved.", "example": "7_DAYS", "maxLength": 120, "type": "string" }, "duration_configured_field": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active configuration of the field designated to supply the retention duration value for history tracking.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the duration field" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the duration field" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "DurationConfiguredFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "followed_fields": { "description": "Contains the collection of fields whose value changes are actively monitored and recorded as part of this field's history tracking configuration, allowing administrators to scope audit trail capture to a defined subset of related fields.", "items": { "additionalProperties": false, "description": "Represents an individual field entry being tracked for history, including its identifying metadata and the module context in which changes to that field are captured for the audit log.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the followed field" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the followed field" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "module": { "additionalProperties": false, "description": "Represents the CRM module with which this field's history tracking is associated, providing the module-level context required to correctly scope, store, and surface field change records in the appropriate audit trail.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the history tracking module" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the history tracking module" } }, "required": [ "api_name", "id" ], "type": "object" }, "related_list_name": { "description": "Represents the display name of the related list through which the field's historical change records are surfaced on the associated module's detail view, allowing end users to review the audit trail directly within the record context.", "example": "Module_Histories", "maxLength": 100, "type": "string" } }, "type": "object", "x-zs-$id": "HistoryTrackingStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the history tracking configuration for this field, capturing how and for how long changes to the field's value are recorded in the audit trail. Includes details about tracked duration, associated modules, related list linkage, and the specific fields whose changes are followed." }, "history_tracking_enabled": { "description": "Indicates whether change history recording is active for this field, controlling whether updates to the field's value are logged in the audit trail. Possible values: `true` — field value changes are captured and retained in history tracking; `false` — changes to this field are not recorded in the audit trail.", "example": false, "type": "boolean" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the field" }, "json_type": { "description": "Represents the primitive JSON data type used to serialize this field's value in API request and response payloads. Possible values: `string` — a text value. `integer` — a whole number. `boolean` — a true or false value. `double` — a decimal number. `long` — a large integer. `jsonobject` — a structured object. `jsonarray` — an array of values.", "enum": [ "jsonarray", "integer", "string", "jsonobject", "boolean", "double", "long" ], "example": "string", "maxLength": 25, "type": "string" }, "length": { "description": "Represents the maximum number of characters or digits permitted for this field's value, defining the storage and input boundary enforced by the CRM when records are saved.", "example": 255, "format": "int32", "type": "number" }, "lookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active lookup field configuration, encapsulating the target module reference, the lookup field's API name, display label, unique identifier, and any query filter settings.", "properties": { "api_name": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the lookup field" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "display_label": { "anyOf": [ { "description": "Represents the active display label of the lookup field, shown to users in the CRM interface when the lookup relationship is referenced.", "example": "Related List Label 1", "maxLength": 50, "type": "string", "x-zs-$id": "LookupDisplayLabelString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "id": { "anyOf": [ { "$ref": "#/components/schemas/LayoutsId" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the unique system-generated identifier for the lookup field definition within the target module. May be null for lookups created implicitly by the system rather than explicitly configured by an administrator." }, "module": { "additionalProperties": false, "description": "Represents the target CRM module that this lookup field references, providing the module's identifying metadata — such as its name and encryption status — required to resolve and navigate the cross-module relationship.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the lookup module" }, "crypt": { "description": "Indicates whether data stored in the lookup's target module is encrypted at rest, informing consumers that records retrieved through this lookup relationship may be subject to field-level encryption policies. Possible values: `true` — the target module's data is encrypted; `false` — the target module's data is not encrypted.", "example": false, "type": "boolean" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the lookup module" } }, "type": "object" }, "query_details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active query configuration with field-level filter criteria used to narrow the selectable records in the lookup dropdown.", "properties": { "criteria": { "additionalProperties": false, "description": "Represents the field-level filter condition applied to the lookup query, defining the field, comparison operator, value, and type of criterion used to narrow the set of records displayed in the lookup.", "properties": { "comparator": { "description": "Represents the comparison operator applied when evaluating the filter criterion, such as equals, contains, starts with, or greater than, determining how the field value is tested against the specified filter value.", "example": "not_equal", "maxLength": 50, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field used as the left-hand operand in the lookup filter criterion, identifying which field's value is evaluated against the specified comparator and value.", "properties": { "api_name": { "description": "Represents the API name of the field used in the lookup filter criterion, which may reference a standard field, a custom field, or a related field accessed through dot notation.", "example": "Contact_Name.Full_Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the field used in the criteria." } }, "type": "object" }, "type": { "description": "Indicates whether the filter value is a static literal or a dynamic reference, controlling how the comparison value is resolved at runtime when the lookup list is rendered.", "example": "value", "maxLength": 50, "type": "string" }, "value": { "anyOf": [ { "description": "Represents a string value used as the right-hand operand when evaluating the lookup filter criterion.", "example": "${EMPTY}", "maxLength": 255, "type": "string", "x-zs-$id": "LookupCriteriaValueString" }, { "description": "Represents a numeric value used as the right-hand operand when evaluating the lookup filter criterion.", "example": 100, "type": "number", "x-zs-$id": "LookupCriteriaValueNumber" }, { "description": "Represents a Boolean value used as the right-hand operand when evaluating the lookup filter criterion.", "example": true, "type": "boolean", "x-zs-$id": "LookupCriteriaValueBoolean" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the value compared against the selected field when evaluating the lookup filter criterion. Can be a string, number, or Boolean depending on the field type and the configured comparator." } }, "required": [ "comparator", "field", "type" ], "type": "object" }, "query_id": { "anyOf": [ { "description": "Represents the custom query identifier as a string value, referencing a predefined query configuration that filters the lookup's selectable records.", "example": "4832675000000850792", "format": "int64", "maxLength": 30, "type": "string", "x-zs-$id": "LookupQueryIdString" }, { "description": "Represents the custom query identifier as an integer value, referencing a predefined query configuration that filters the lookup's selectable records.", "example": 4832675000001314000, "format": "int64", "type": "integer", "x-zs-$id": "LookupQueryIdInteger" } ], "description": "Represents the unique identifier of the custom query used to filter the lookup's selectable records, referencing a predefined query configuration that determines which records appear in the dropdown." }, "system_query_id": { "anyOf": [ { "description": "Represents the system-assigned query identifier as a string, referencing a platform-managed query that filters the lookup's record list.", "example": "4832675000000850800", "format": "int64", "maxLength": 30, "type": "string", "x-zs-$id": "LookupSystemQueryIdString" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the system-assigned identifier for a platform-managed query that filters the lookup's record list, used when the filter logic is maintained by the CRM system rather than defined by a custom query." } }, "required": [ "query_id", "criteria", "system_query_id" ], "title": "Query Details with Criteria", "type": "object", "x-zs-$id": "LookupQueryDetailsWithCriteria" }, { "additionalProperties": false, "description": "Represents the query configuration variant that contains only a system query identifier, without custom filter criteria, used when the lookup filter logic is entirely managed by the CRM platform.", "properties": { "system_query_id": { "anyOf": [ { "description": "Represents the system-assigned query identifier as a string in the system-query-only variant, referencing a platform-managed filter for the lookup.", "example": "4832675000000850800", "format": "int64", "maxLength": 30, "type": "string", "x-zs-$id": "LookupSystemQueryIdStringOnly" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the system-assigned identifier for an alternate platform-managed query variant that filters the lookup's record list in this configuration schema variant." } }, "required": [ "system_query_id" ], "title": "Query Details System Only", "type": "object", "x-zs-$id": "LookupQueryDetailsSystemOnly" } ], "description": "Contains the query configuration used to filter the selectable records in the lookup dropdown, restricting available options based on field criteria or system-defined query identifiers." }, "revalidate_filter_during_edit": { "description": "Indicates whether the lookup's filter criteria are re-evaluated each time the record is opened in edit mode, ensuring that the selectable records reflect current field values rather than the values at the time the record was first created. Possible values: `true` — filter criteria are reapplied during edit; `false` — filter criteria are applied only at initial field population.", "example": true, "type": "boolean" } }, "type": "object", "x-zs-$id": "LookupFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the lookup configuration that links this field to records in another CRM module, encapsulating the target module reference, the field's API name and display label within that module, and the unique identifier of the lookup relationship." }, "lookup_field": { "additionalProperties": false, "description": "Represents the source lookup field on which a mirror field is based, identifying the cross-module lookup relationship from which this field's value is derived.", "example": { "api_name": "Contact_Name", "id": "3477061000002058001" }, "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "type": "object" }, "mask_details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the partial masking configuration where a specified number of characters at the beginning and end of the field value are revealed while the middle portion is masked.", "properties": { "complete_mask": { "description": "Indicates whether the entire field value is hidden from unauthorized users rather than partially revealed. Possible values: `true` — the value is completely obscured; `false` — partial character reveal rules defined by show_first and show_last apply.", "example": false, "type": "boolean" }, "profiles": { "description": "Contains the list of CRM profiles whose members are permitted to view the unmasked field value, exempting those users from the masking rules applied to all other profiles.", "items": { "$ref": "#/components/schemas/MaskDetailsProfile" }, "maxItems": 50, "type": "array" }, "show_first": { "description": "Indicates the number of characters revealed at the start of the field value when partial masking is applied, allowing a prefix of the data to remain visible while the remainder is hidden.", "example": 3, "format": "int32", "maximum": 50, "minimum": 0, "type": "integer" }, "show_last": { "description": "Indicates the number of characters revealed at the end of the field value when partial masking is applied, allowing a suffix of the data to remain visible while the preceding portion is hidden.", "example": 1, "format": "int32", "maximum": 50, "minimum": 0, "type": "integer" } }, "required": [ "show_first", "complete_mask", "show_last", "profiles" ], "title": "Partial Mask", "type": "object", "x-zs-$id": "PartialMaskDetails" }, { "additionalProperties": false, "description": "Represents the complete masking configuration where the entire field value is hidden from users who do not have an exempted profile.", "properties": { "complete_mask": { "description": "Indicates whether the entire field value is hidden in this alternate masking schema variant. Possible values: `true` — the value is completely obscured; `false` — partial reveal rules apply.", "example": true, "type": "boolean" }, "profiles": { "description": "Contains the list of CRM profiles whose members can view the unmasked field value in this alternate masking schema variant, exempting those users from the masking rules applied to all other profiles.", "items": { "$ref": "#/components/schemas/MaskDetailsProfile" }, "maxItems": 50, "type": "array" } }, "required": [ "complete_mask", "profiles" ], "title": "Complete Mask", "type": "object", "x-zs-$id": "CompleteMaskDetails" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the field masking configuration that controls how the field's stored value is partially or fully hidden from users who do not have permission to view sensitive data, including rules for how many characters are revealed and which profiles can bypass masking." }, "mass_update": { "description": "Indicates whether this field can be updated simultaneously across multiple records using the mass update operation. Possible values: `true` — the field is available for mass update; `false` — the field cannot be modified through bulk update actions.", "example": true, "type": "boolean" }, "modified_time": { "anyOf": [ { "description": "Represents the ISO 8601 datetime with timezone offset recording when this field's configuration was most recently changed.", "example": "2024-05-17T09:15:56+05:30", "format": "date-time", "type": "string", "x-zs-$id": "ModifiedTimeDateTime" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the date and time at which the field's definition or configuration was most recently changed in the CRM, recorded for audit and change-tracking purposes." }, "multi_module_lookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active multi-module lookup configuration, specifying the participating modules, display label, and dynamic addition settings.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the multi module lookup field" }, "display_label": { "description": "Represents the identifying label of the multi-module lookup field in the CRM interface, identifying the lookup relationship across its participating modules.", "example": "Appointments", "maxLength": 50, "type": "string" }, "dynamic_module_addition_allowed": { "description": "Indicates whether additional CRM modules can be incorporated into this multi-module lookup relationship at runtime without requiring a layout reconfiguration. Possible values: `true` — new modules may be added dynamically; `false` — the participating modules are fixed at configuration time.", "example": true, "type": "boolean" }, "modules": { "description": "Contains the collection of CRM modules that participate in this multi-module lookup relationship, each representing a valid source from which the user can select a referenced record.", "items": { "additionalProperties": false, "description": "Represents a single module entry included in the multi-module lookup configuration, encapsulating identifying and display attributes for that module.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the module" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the module" }, "module_name": { "description": "Indicates the internal API name of the module participating in the multi-module lookup, used to identify the module programmatically across CRM operations.", "example": "Leads", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "module_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "MultiModuleLookupStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the multi-module lookup configuration for fields that can reference records from more than one CRM module within a single lookup relationship, including the participating modules and dynamic addition settings." }, "multiselectlookup": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active multi-select lookup configuration for this field, including the connected module details, linking module information, and related list configuration.", "properties": { "connected_details": { "additionalProperties": false, "description": "Contains metadata about the target module and its associated layouts and fields that the multi-select lookup field resolves records against.", "properties": { "field": { "additionalProperties": false, "description": "Represents the specific field in the connected module that is referenced by the multi-select lookup, used to surface a meaningful value from the related record.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "field_label": { "description": "Contains the display label of the referenced field in the connected module, as shown to users when viewing or configuring the multi-select lookup.", "example": "Account Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "layouts": { "description": "Contains the collection of layouts within the connected module in which the multi-select lookup field is available or rendered.", "items": { "additionalProperties": false, "description": "Represents a single layout entry from the connected module, identifying a page layout in which the multi-select lookup field participates.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "module": { "additionalProperties": false, "description": "Represents the target module to which the multi-select lookup field resolves, providing display and identification attributes for that module.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "plural_label": { "description": "Contains the plural display name of the connected module, typically shown in list views and relationship panels referencing multiple records.", "example": "Accounts", "maxLength": 100, "type": "string" } }, "required": [ "plural_label", "api_name", "id" ], "type": "object" } }, "required": [ "field", "module", "layouts" ], "type": "object" }, "linking_details": { "additionalProperties": false, "description": "Contains the configuration of the intermediary linking module that joins the source and target modules in a multi-select lookup relationship, including the relevant lookup fields on each side.", "properties": { "connected_lookup_field": { "additionalProperties": false, "description": "Represents the lookup field on the linking module that points toward the connected (target) module, completing the many-to-many association in the multi-select lookup.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "field_label": { "description": "Contains the display label of the lookup field on the linking module that references the connected target module, as presented in the CRM interface.", "example": "Account Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field on the linking module that points back toward the source module, establishing the origin side of the multi-select lookup relationship.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "field_label": { "description": "Contains the display label of the lookup field on the linking module that references the source module, as presented in the CRM interface.", "example": "Contact Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Represents the intermediary linking module that bridges the source and target modules in a multi-select lookup, storing the join records that implement the many-to-many relationship.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "plural_label": { "description": "Contains the plural display name of the linking module, as shown in navigation and relational UI elements within the CRM.", "example": "Contacts", "maxLength": 100, "type": "string" }, "visibility": { "description": "Indicates the visibility state of the linking module, controlling whether it appears in the CRM interface and navigation for end users.", "example": 1, "format": "int32", "type": "number" } }, "required": [ "visibility", "plural_label", "api_name", "id" ], "type": "object" } }, "required": [ "module", "lookup_field", "connected_lookup_field" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Represents the related list configuration associated with the multi-select lookup field, defining how linked records from the target module are displayed within the source record's detail view.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "display_label": { "description": "Contains the label for the related list panel as rendered on the source record's detail page, identifying the collection of linked target-module records.", "example": "Related List Label 1", "maxLength": 50, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "required": [ "display_label", "api_name", "id" ], "type": "object" } }, "required": [], "type": "object", "x-zs-$id": "MultiModuleLookupFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "multiuserlookup": { "additionalProperties": false, "description": "Represents the configuration of a multi-user lookup field, which enables associating a record with multiple CRM users through a linking module rather than a single user reference.", "properties": { "linking_details": { "additionalProperties": false, "description": "Contains the configuration of the linking module and its lookup fields that connect the source module to multiple CRM users in a multi-user lookup relationship.", "properties": { "connected_lookup_field": { "additionalProperties": false, "description": "Represents the lookup field on the linking module that references the Users module, forming the user-side join in the multi-user lookup relationship.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "field_label": { "description": "Contains the display label of the lookup field on the linking module that points to the Users module, as presented in the CRM interface.", "example": "Role Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field on the linking module that references the source module, establishing the origin side of the multi-user lookup relationship.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "field_label": { "description": "Contains the display label of the lookup field on the linking module that references the source module, as presented in the CRM interface.", "example": "User Name", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Represents the linking module that intermediates the connection between the source module and the Users module in a multi-user lookup relationship.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "plural_label": { "description": "Contains the plural display name of the linking module used in the multi-user lookup, as shown in navigation and relational panels within the CRM.", "example": "Users", "maxLength": 100, "type": "string" } }, "required": [ "plural_label", "api_name", "id" ], "type": "object" } }, "required": [ "module", "lookup_field", "connected_lookup_field" ], "type": "object" }, "record_access": { "description": "Indicates whether the multi-user lookup grants the associated users access to the record being linked, in addition to recording the relationship. Possible values: `true` — linked users gain record-level access; `false` — the relationship is recorded without affecting the users' access to the record.", "example": true, "type": "boolean" } }, "required": [ "linking_details", "record_access" ], "type": "object" }, "operation_type": { "additionalProperties": false, "description": "Represents the set of operations permitted on this field, specifying independently whether values can be supplied or modified through API-based create/update calls and through the CRM web interface create/update forms.", "properties": { "api_create": { "description": "Indicates whether this field accepts a value when a record is saved through the API during creation. Possible values: `true` — the field value can be set via API during record creation; `false` — the field value cannot be set via API at record creation time.", "example": false, "type": "boolean" }, "api_update": { "description": "Indicates whether this field accepts a new value when a record is saved through the API during an update. Possible values: `true` — the field can be modified via API during a record update; `false` — the field is read-only for API-based update operations.", "example": false, "type": "boolean" }, "web_create": { "description": "Indicates whether this field appears and accepts a value when a record is saved through the CRM web interface during creation. Possible values: `true` — the field is editable in the web create form; `false` — the field does not appear or is locked in the web create form.", "example": false, "type": "boolean" }, "web_update": { "description": "Indicates whether this field accepts a new value when a record is saved through the CRM web interface during an update. Possible values: `true` — the field is editable in the web edit form; `false` — the field is read-only or hidden in the web update form.", "example": false, "type": "boolean" } }, "required": [ "web_update", "api_create", "web_create", "api_update" ], "type": "object" }, "parent_field": { "anyOf": [ { "additionalProperties": false, "description": "Represents the parent field reference for nested composite fields such as address child components, identifying the parent field by its API name.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the parent field" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the parent field" }, "name": { "description": "Represents the API name of the parent field under which this nested field is organized within the module layout.", "example": "Address 1 - Coordinates", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "name", "id" ], "type": "object", "x-zs-$id": "ParentFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the parent field reference for nested or composite fields such as address components, identifying the field under which this field is grouped in the module layout." }, "pick_list_values": { "anyOf": [ { "description": "Represents the active list of picklist options for this field, ordered by sequence number, each containing the stored value, display label, and associated metadata.", "items": { "additionalProperties": false, "description": "Represents a single picklist option, encapsulating the stored value, the display label, and any associated metadata such as color coding, deal category, or forecast information.", "properties": { "actual_value": { "description": "Represents the internal value stored in the database when this picklist option is selected, which may differ from the label displayed to the user.", "example": "Option 1", "maxLength": 120, "type": "string" }, "colour_code": { "anyOf": [ { "description": "Represents the hexadecimal color code in #RRGGBB format associated with this picklist option when color coding is active.", "example": "#FF5733", "maxLength": 7, "minLength": 7, "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string", "x-zs-$id": "HexColorCode" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the color associated with this picklist option when color-coded list views are enabled for the field, used to visually distinguish records by their selected value." }, "deal_category": { "description": "Represents the deal pipeline category classification associated with this picklist option, used to group and report on deals by their stage category.", "example": "Open", "maxLength": 100, "type": "string" }, "display_value": { "description": "Represents the label displayed to users for this picklist option in forms, detail views, and filter dropdowns, which may be a localized version of the stored actual value.", "example": "Option 1", "maxLength": 120, "type": "string" }, "forecast_category": { "additionalProperties": false, "description": "Represents the sales forecast classification associated with this picklist option, grouping deals in a given stage into a defined forecast bucket such as Pipeline, Best Case, or Closed Won.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the forecast category" }, "name": { "description": "Represents the name of the forecast category assigned to this picklist option, identifying the forecast bucket to which deals at this stage are attributed.", "maxLength": 100, "type": "string" } }, "type": "object" }, "forecast_type": { "description": "Indicates the type of forecast behavior associated with this picklist option, classifying how deals at this stage are treated in forecast calculations.", "example": "Open", "maxLength": 50, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the pick list value" }, "maps": { "description": "Contains the dependent picklist mapping configuration for this option, defining which values become available in dependent fields when this option is selected in the parent picklist.", "items": { "additionalProperties": false, "description": "Represents a single dependent field mapping entry, associating this parent picklist option with a specific set of allowed values in a dependent picklist field.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the dependent picklist field." }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the dependent picklist field." }, "pick_list_values": { "description": "Contains the subset of picklist values available in the dependent field when this parent option is selected, restricting user choices to contextually appropriate options.", "items": { "additionalProperties": false, "description": "Represents a single allowed value entry in the dependent picklist, defining one option that becomes selectable in the dependent field when the parent picklist option is chosen.", "properties": { "actual_value": { "description": "Represents the internal value stored when this dependent picklist option is selected, used as the system identifier for the choice in data storage and API responses.", "example": "Option 1", "maxLength": 120, "type": "string" }, "colour_code": { "anyOf": [ { "description": "Represents the hexadecimal color code in #RRGGBB format for this dependent picklist option when color coding is active.", "example": "#c9651a", "maxLength": 7, "minLength": 7, "pattern": "^#[0-9A-Fa-f]{6}$", "type": "string", "x-zs-$id": "DependentPicklistColorCode" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the hexadecimal color code associated with this dependent picklist option, used to color-code records by their selected value when color coding is enabled for the field." }, "display_value": { "description": "Represents the label displayed in the CRM interface for this dependent picklist option, which may differ from its stored actual value.", "example": "Option 1", "maxLength": 120, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the picklist value." } }, "required": [ "display_value", "colour_code", "actual_value", "id" ], "type": "object" }, "maxItems": 500, "type": "array" } }, "required": [ "api_name", "id", "pick_list_values" ], "type": "object" }, "maxItems": 4000, "type": "array" }, "probability": { "description": "Represents the percentage probability of deal closure associated with this picklist option, used in forecast calculations and reporting for deal stage fields.", "example": 10, "format": "int32", "maximum": 100, "minimum": 0, "type": "number" }, "record_category_value": { "additionalProperties": false, "description": "Reference to an existing record category value mapped to this picklist option. **At least one identifier must be provided**: `id`, `rid`, or `api_name`. Multiple identifiers can be provided for validation purposes. Server-side validation enforces this requirement.", "properties": { "api_name": { "description": "API name of the record category value", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the record category value", "format": "int64", "type": "string" } }, "type": "object" }, "reference_value": { "description": "Represents the system-internal reference identifier for this picklist option, used in cross-field mapping and dependent picklist resolution where the display value alone is insufficient to uniquely identify the option.", "example": "option_1", "maxLength": 120, "type": "string" }, "sequence_number": { "description": "Indicates the ordinal position of this picklist option within the field's list of available choices, determining the display order in dropdown menus and filter panels.", "example": 1, "format": "int32", "minimum": 1, "type": "number" }, "type": { "description": "Represents the classification type of this picklist option, distinguishing system-defined choices from user-created ones or categorizing options by their behavioral role within the field.", "example": "used", "maxLength": 50, "type": "string" } }, "required": [ "display_value", "sequence_number", "maps", "actual_value" ], "type": "object" }, "maxItems": 4000, "type": "array", "x-zs-$id": "PickListValuesArray" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the list of selectable options defined for a picklist field, each representing a distinct choice that users can select when populating the field on a record." }, "pick_list_values_sorted_lexically": { "description": "Indicates whether the picklist options for this field are automatically sorted in alphabetical order for display, rather than in the administrator-defined sequence order. Possible values: `true` — options are sorted alphabetically; `false` — options appear in the order defined by the administrator.", "example": false, "type": "boolean" }, "portal_user_types": { "description": "Contains the list of portal user type permission configurations for this field, specifying which portal user type categories can view or edit the field's value when accessing records through a customer or partner portal.", "items": { "additionalProperties": false, "description": "Represents the permission configuration for a single portal user type, defining the level of access that users of that type have to this field when interacting through the portal.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the portal user type" }, "name": { "description": "Represents the name of the portal user type, identifying the category of external users whose field permissions are described in this entry.", "example": "Customer Portal", "maxLength": 255, "type": "string" }, "permission_type": { "description": "Represents the access level granted to portal users of this type for the field. Possible values: `read_write` — full read and write access; portal users can view and edit the field. `read_only` — view access only; portal users can see but cannot modify the field value. `hidden` — the field is not visible to portal users of this type.", "enum": [ "read_write", "read_only", "hidden" ], "example": "read_write", "type": "string" } }, "required": [ "permission_type", "name", "id" ], "type": "object" }, "maxItems": 50, "type": "array" }, "private": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active privacy configuration for this field, specifying the access restriction type and export suppression settings when the field is marked as private.", "properties": { "export": { "description": "Indicates whether this field's value is included when records are exported from the CRM, subject to the field's privacy settings. Possible values: `true` — the field is included in exports; `false` — the field is excluded from exported data.", "example": false, "type": "boolean" }, "restricted": { "description": "Indicates whether this field is subject to privacy restrictions that limit its visibility to the record owner and administrators. Possible values: `true` — access to the field value is restricted based on record ownership; `false` — the field is accessible to all users with the appropriate module permissions.", "example": false, "type": "boolean" }, "type": { "description": "Represents the privacy restriction level applied to this field. Possible values: `High` — high-level privacy restriction with strict access control. `Low` — low-level privacy restriction with relaxed access control.", "enum": [ "High", "Low" ], "example": "High", "maxLength": 25, "type": "string" } }, "required": [ "restricted", "type", "export" ], "type": "object", "x-zs-$id": "PrivateFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "profiles": { "description": "Contains the list of profile-level permission entries for this field, each describing the access level a specific CRM profile has to view or edit the field's value.", "items": { "additionalProperties": false, "description": "Represents the permission assignment for a single CRM profile, specifying whether users of that profile can view, edit, or are restricted from accessing this field.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the profile" }, "name": { "description": "Represents the name of the CRM profile for which this field permission entry applies.", "example": "Administrator", "maxLength": 60, "type": "string" }, "permission_type": { "description": "Represents the level of access granted to users of this profile for the field. Possible values: `read_write` — full read and write access; users can view and edit the field. `read_only` — view access only; users can see but cannot modify the field value. `hidden` — the field is not visible to users of this profile.", "enum": [ "read_write", "read_only", "hidden" ], "example": "read_write", "maxLength": 25, "type": "string" } }, "required": [ "permission_type", "name", "id" ], "type": "object" }, "maxItems": 100, "type": "array", "uniqueItems": true }, "public": { "description": "Indicates whether this field's value is accessible to external users or public-facing integrations. Possible values: `true` — the field is marked as public and may be exposed through portals or external APIs; `false` — the field is restricted to internal CRM users.", "example": true, "type": "boolean" }, "query_details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active query configuration for this field's lookup filter, using field-level criteria expressions to narrow selectable records.", "properties": { "criteria": { "additionalProperties": false, "description": "Represents the field-level filter condition for the query, specifying the field, comparator, type, and value used to narrow down the set of records or options.", "properties": { "comparator": { "description": "Represents the comparison operator used in the filter criterion, such as equals, contains, or greater than, applied when evaluating whether a record or value satisfies the filter.", "example": "equal", "maxLength": 25, "type": "string" }, "field": { "additionalProperties": false, "description": "Identifies the field whose value is evaluated against the comparator and filter value in the query criteria.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the field used in the criteria." }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the field used in the criteria." } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Indicates whether the comparison value in the filter criterion is a static literal or a dynamic contextual reference resolved at runtime.", "example": "value", "maxLength": 50, "type": "string" }, "value": { "anyOf": [ { "description": "Represents a string value used as the comparison operand in the field-level lookup filter criterion.", "example": "Option 1", "maxLength": 255, "type": "string", "x-zs-$id": "CriteriaValueString" }, { "description": "Represents a numeric value used as the comparison operand in the field-level lookup filter criterion.", "example": 100, "type": "number", "x-zs-$id": "CriteriaValueNumber" }, { "description": "Represents a Boolean value used as the comparison operand in the field-level lookup filter criterion.", "example": true, "type": "boolean", "x-zs-$id": "CriteriaValueBoolean" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the value compared against the selected field when evaluating the query filter criterion." } }, "required": [ "comparator", "field", "type" ], "type": "object" }, "query_id": { "description": "Represents the unique identifier of the custom query used to filter this field's selectable options or lookup results.", "example": 4832675000001314000, "format": "int64", "type": "integer" } }, "required": [ "query_id", "criteria" ], "type": "object", "x-zs-$id": "QueryDetailsStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the query configuration applied to filter the selectable records in this field's lookup or dependent logic, using either custom query identifiers or field-level criteria expressions." }, "quick_sequence_number": { "description": "Represents the ordinal position of this field in the quick-create form layout, determining the display order of fields when users create records through abbreviated entry panels.", "example": "1", "maxLength": 10, "type": "string" }, "range": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active numeric range constraint for this field, specifying the minimum and maximum allowed values.", "properties": { "from": { "anyOf": [ { "description": "Represents the lower bound of the numeric range constraint, defining the minimum value the field accepts.", "example": 1, "format": "double", "type": "number", "x-zs-$id": "RangeFromDoubleStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "to": { "anyOf": [ { "description": "Represents the upper bound of the numeric range constraint, defining the maximum value the field accepts.", "example": 100, "format": "double", "type": "number", "x-zs-$id": "RangeToDoubleStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] } }, "required": [ "from", "to" ], "type": "object", "x-zs-$id": "NumericRangeStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the numeric range constraint applied to this field, specifying the minimum and maximum values that the field accepts when a record is saved." }, "read_only": { "description": "Indicates whether this field is locked against user edits through the CRM interface and API, preventing any modification of its value after it has been set. Possible values: `true` — the field cannot be modified; `false` — the field is editable subject to applicable permissions.", "example": false, "type": "boolean" }, "record_category_tracking_field": { "anyOf": [ { "additionalProperties": false, "description": "Field reference for tracking record category changes.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the tracking field." }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the tracking field." } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "RecordCategoryTrackingFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Reference to the field used to track record category changes over time in the timeline view. Only present when enable_record_category is true and a tracking field is configured." }, "record_category_values": { "description": "List of record category values defined for this picklist field. Only returned when enable_record_category is true.", "items": { "additionalProperties": false, "description": "Individual record category configuration.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the record category." }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the record category." }, "nature_of_category": { "description": "Nature of the record category indicating sentiment or outcome.", "enum": [ "none", "thumbs_up", "thumbs_down" ], "example": "thumbs_up", "type": "string" }, "value": { "description": "Display value of the record category.", "example": "Closed Won", "maxLength": 120, "type": "string" } }, "required": [ "id", "api_name", "value", "nature_of_category" ], "type": "object" }, "maxItems": 50, "type": "array" }, "refer_from_field": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active reference field configuration for a mirror field, identifying the source lookup field from which this field's value is derived.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the reference field" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the reference field" } }, "type": "object", "x-zs-$id": "ReferFromFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the source field from which this mirror or derived field obtains its value, establishing a read-through relationship where the field reflects data from another field in a related module." }, "required": { "description": "Indicates whether this field must contain a value before a record can be saved. Possible values: `true` — the field is mandatory and a value must be supplied; `false` — the field is optional.", "example": false, "type": "boolean" }, "rollup_summary": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active rollup summary configuration for this field, detailing the aggregation function, child module, filter criteria, and related list used to compute the summarized value.", "properties": { "based_on_module": { "additionalProperties": false, "description": "Represents the child module from which related records are aggregated when computing the rollup summary value for this field.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the base module" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the base module" } }, "required": [ "api_name", "id" ], "type": "object" }, "expression": { "additionalProperties": false, "description": "Contains the expression configuration for the rollup summary calculation, including the aggregation function, the field being summarized, and any filter criteria applied to restrict which related records are included.", "properties": { "criteria": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active filter criteria configuration for the rollup summary, specifying the conditions that child module records must satisfy to be included in the aggregation.", "properties": { "comparator": { "description": "Represents the comparison operator used in the rollup filter criterion, applied when evaluating whether a related record's field value satisfies the filter condition.", "example": "equals", "maxLength": 25, "type": "string" }, "field": { "additionalProperties": false, "description": "Identifies the field in the child module whose value is tested against the comparator and filter value when determining which related records are included in the rollup.", "properties": { "api_name": { "description": "Represents the API name of the child module field used in the rollup filter criterion.", "example": "Status", "maxLength": 100, "type": "string" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the criteria field" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Indicates whether the filter value in the rollup criterion is a static literal or a dynamic reference resolved at runtime.", "example": "custom", "maxLength": 25, "type": "string" }, "value": { "description": "Represents the value compared against the child module field when evaluating the rollup filter criterion.", "example": "Approved", "maxLength": 100, "type": "string" } }, "required": [ "comparator", "field", "type", "value" ], "type": "object", "x-zs-$id": "RollupSummaryCriteriaStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the filter conditions applied to limit which related records in the child module are included in the rollup summary calculation." }, "function": { "description": "Represents the aggregation function applied to the child module records when computing the rollup summary, such as SUM, COUNT, MIN, MAX, or AVERAGE.", "example": "SUM", "maxLength": 25, "type": "string" }, "function_parameters": { "description": "Contains the list of parameters passed to the rollup aggregation function, specifying which fields or values are used as inputs to the calculation.", "items": { "additionalProperties": false, "description": "Represents a single parameter supplied to the rollup aggregation function, identifying a field or constant value used as an input to the summary calculation.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the parameter field" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "function_parameters", "function" ], "type": "object" }, "related_list": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active related list configuration for the rollup summary, identifying the child module relationship from which records are drawn for aggregation.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the related list" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the related list" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "RelatedListStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the related list configuration that defines the child module relationship from which records are drawn for the rollup summary calculation." }, "return_type": { "description": "Indicates the data type of the value produced by the rollup summary calculation, such as integer, decimal, or date, which determines how the computed result is stored and displayed.", "example": "number", "maxLength": 50, "type": "string" }, "rollup_based_on": { "description": "Indicates the basis of the rollup calculation, specifying whether the aggregation operates on all related records or only on a filtered subset defined by the expression criteria.", "example": "Created_Time", "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "RollupSummaryFieldStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the rollup summary configuration for this field, defining how aggregated values from related records in a child module are calculated and displayed in the parent record's field." }, "searchable": { "description": "Indicates whether this field's value can be used as a search term in the CRM's global and module-level search functionality. Possible values: `true` — the field is indexed for search and returns results when matched; `false` — the field is excluded from search indexing.", "example": true, "type": "boolean" }, "section_id": { "description": "Indicates the numeric identifier of the section within the module layout that contains this field, used to group fields and determine their organizational placement on record forms.", "format": "int32", "type": "number" }, "separator": { "description": "Indicates whether this field functions as a visual separator element in the layout rather than a data-entry field. Possible values: `true` — the element is a layout separator that creates a visual break between sections or field groups; `false` — the element is a standard data field.", "example": false, "type": "boolean" }, "sequence_number": { "description": "Represents the ordinal position of this field within its containing section, controlling the order in which fields are rendered on record forms. Sequence numbering generally starts from one but may contain gaps.", "format": "int32", "minimum": 1, "type": "number" }, "sharing_properties": { "additionalProperties": false, "description": "Contains the sharing configuration for this field, defining how its value participates in record-level sharing rules and whether specific sharing preferences are active.", "properties": { "scheduler_status": { "anyOf": [ { "description": "Represents the active status of the sharing scheduler for this field, indicating the current state of sharing rule propagation.", "example": "enabled", "maxLength": 50, "type": "string", "x-zs-$id": "SchedulerStatusStringStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "share_permission": { "description": "Represents the sharing access level assigned to this field, controlling whether users who receive shared record access can read, edit, or are restricted from this field's value.", "example": "read_write", "maxLength": 50, "type": "string" }, "share_preference_enabled": { "description": "Indicates whether the sharing preference configuration is active for this field. Possible values: `true` — sharing preference settings are applied to this field; `false` — sharing preference is not enabled.", "example": true, "type": "boolean" }, "share_with_superiors": { "description": "Indicates whether this field's value is shared with users in superior roles in the CRM role hierarchy when record sharing propagates upward. Possible values: `true` — the field is shared with superior role users; `false` — the field is not shared with superiors.", "example": false, "type": "boolean" } }, "required": [ "scheduler_status", "share_permission", "share_preference_enabled" ], "type": "object" }, "show_type": { "description": "Represents the internal numeric code that controls the display behavior or rendering mode of the field in the CRM UI, supplementing the data_type classification with additional display context.", "example": 1, "format": "int32", "type": "number" }, "sortable": { "description": "Indicates whether records can be sorted by this field's value in list views, reports, and search results. Possible values: `true` — the field is available as a sort key; `false` — the field cannot be used for sorting.", "example": true, "type": "boolean" }, "static_field": { "description": "Indicates whether this field is a static layout element with a fixed value that does not accept user input. Possible values: `true` — the field is a static display-only element; `false` — the field accepts dynamic user-entered or system-computed values.", "example": false, "type": "boolean" }, "static_values": { "anyOf": [ { "description": "Represents the active list of static value options available for this field, each containing a sequence number and stored value.", "items": { "additionalProperties": false, "description": "Represents a single option within the field's static value list, encapsulating the option's display order and the stored value associated with that choice.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the static value option." }, "sequence_number": { "description": "Indicates the display order of this static option within the field's predefined choice list, determining the position in which the option appears to users.", "example": 1, "format": "int32", "minimum": 1, "type": "integer" }, "value": { "description": "Represents the stored value for this static option, used as the system identifier and the data written to the record when the option is selected.", "example": "Option 1", "maxLength": 255, "type": "string" } }, "required": [ "sequence_number", "id", "value" ], "type": "object" }, "maxItems": 500, "type": "array", "x-zs-$id": "StaticValuesArray" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the predefined option list for fields with a fixed set of choices, such as static picklists and radio button fields, where the available values are defined at layout configuration time." }, "subform": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active subform reference configuration for this field, including the API name of the associated subform module and any layout reference for embedded record rendering.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the subform tab." }, "module": { "description": "Represents the API name of the module whose records are embedded as a subform in the parent module's layout.", "example": "Ordered_Items", "maxLength": 50, "type": "string" } }, "required": [ "module", "id" ], "type": "object", "x-zs-$id": "SubformStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the subform configuration for fields that embed a related module's records inline within the parent module's layout, including the API name of the associated subform module and its subform tab identifier." }, "subform_properties": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active subform display configuration for this field, specifying column width and pinning behavior when the field appears in a subform section.", "properties": { "custom_width": { "anyOf": [ { "description": "Represents the active custom column width in pixels for this field when displayed in a subform section.", "example": 265, "format": "int32", "maximum": 1000, "minimum": 50, "type": "integer", "x-zs-$id": "CustomWidthInteger" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Indicates the custom column width in pixels assigned to this field when it is displayed as a column in a subform, overriding the default column sizing." }, "pinned_column": { "description": "Indicates whether this field's column is frozen in place when users scroll horizontally through a subform, keeping the field visible regardless of scroll position. Possible values: `true` — the column is pinned; `false` — the column scrolls with the subform.", "example": false, "type": "boolean" } }, "required": [ "custom_width", "pinned_column" ], "type": "object", "x-zs-$id": "SubformPropertiesStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Contains the display configuration settings for this field when it appears within a subform section, such as custom column width and column pinning behavior." }, "system_mandatory": { "description": "Indicates whether this field is enforced as mandatory by the CRM system itself, as opposed to being made required through an administrator's layout configuration. Possible values: `true` — the field is system-level mandatory and cannot be made optional; `false` — the mandatory status is controlled by layout configuration.", "example": false, "type": "boolean" }, "textarea": { "additionalProperties": false, "description": "Contains the textarea-specific configuration for fields that render as multi-line text input areas, including details about the text area subtype.", "properties": { "type": { "description": "Represents the subtype of the textarea field, distinguishing between multi-line input variants that affect formatting and storage behavior. Possible values: `small` — a compact single-line or short textarea. `large` — a standard multi-line plain text area. `rich_text` — a rich text editor with formatting support.", "enum": [ "small", "large", "rich_text" ], "example": "large", "maxLength": 50, "type": "string" } }, "required": [ "type" ], "type": "object" }, "tooltip": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active tooltip configuration for this field, specifying the help text and delivery mechanism shown to users when they interact with the field.", "properties": { "name": { "description": "Indicates the delivery mechanism for the tooltip, such as whether it is rendered as a static label or as a modal help popup.", "example": "info_icon", "maxLength": 25, "type": "string" }, "value": { "description": "Contains the help text displayed in the tooltip when users interact with this field, providing contextual guidance on the field's purpose or expected input.", "example": "Enter last name", "maxLength": 255, "type": "string" } }, "required": [ "name", "value" ], "type": "object", "x-zs-$id": "FieldTooltipStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the tooltip configuration attached to this field, defining contextual help text displayed to users when they hover over or focus on the field in a record form." }, "type": { "description": "Indicates the field's layout usage status, determining whether the field appears in layout sections. Possible values: `used` — the field is placed in at least one layout section. `unused` — the field exists in the module but has no assignment to any section. `all` — the field appears regardless of layout placement status.", "enum": [ "all", "unused", "used" ], "example": "used", "maxLength": 25, "type": "string" }, "ui_type": { "description": "Represents the internal numeric code that identifies the UI component type used to render and interact with this field in the CRM interface, such as a text input, date picker, or reference selector.", "example": 1, "format": "int32", "type": "number" }, "unique": { "additionalProperties": false, "description": "Represents the uniqueness constraint configuration for this field, controlling whether duplicate values are permitted across records in the module and whether the check is case-sensitive.", "properties": { "case_sensitive": { "description": "Indicates whether the field's uniqueness constraint treats values differing only in letter case as distinct. Possible values: `true` — case-sensitive comparison is applied and values with different casing are treated as unique; `false` — the uniqueness check is case-insensitive.", "example": false, "type": "boolean" } }, "type": "object" }, "validation_rule": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active Validation Rule reference applied to this field, identifying the rule used to enforce input constraints when a record is saved.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the validation rule applied to this field." } }, "required": [ "id" ], "type": "object", "x-zs-$id": "ValidationRuleStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the Validation Rule configuration applied to this field, referencing the rule that governs acceptable input formats, value ranges, or logical conditions evaluated when a record is saved." }, "view_type": { "additionalProperties": false, "description": "Represents the view-mode availability settings for this field, specifying in which CRM interaction contexts — such as record creation, editing, viewing, or quick-create — the field is shown or editable.", "properties": { "create": { "description": "Indicates whether this field is presented in the record creation form. Possible values: `true` — the field is shown when creating a new record; `false` — the field does not appear in the create form.", "example": true, "type": "boolean" }, "edit": { "description": "Indicates whether this field is presented and editable in the record edit form. Possible values: `true` — the field is shown in edit mode; `false` — the field is hidden or read-only during editing.", "example": true, "type": "boolean" }, "quick_create": { "description": "Indicates whether this field is included in the abbreviated quick-create form. Possible values: `true` — the field appears in the quick-create panel; `false` — the field is excluded from quick-create.", "example": true, "type": "boolean" }, "view": { "description": "Indicates whether this field is visible when a record is viewed in detail mode. Possible values: `true` — the field is displayed on the record detail page; `false` — the field is hidden from the detail view.", "example": true, "type": "boolean" } }, "required": [ "view", "edit", "quick_create", "create" ], "type": "object" }, "virtual_field": { "description": "Indicates whether this field is a computed or transient field that exists only at the API layer and does not map to a persistent database column. Possible values: `true` — the field is virtual and its value is derived at runtime; `false` — the field is backed by a database column.", "example": false, "type": "boolean" }, "visible": { "description": "Indicates whether this field is currently displayed in the module layout. Possible values: `true` — the field is shown in the layout and visible to users with appropriate permissions; `false` — the field is hidden from the layout.", "example": true, "type": "boolean" }, "webhook": { "description": "Indicates whether webhook notifications are triggered when this field's value changes on a record. Possible values: `true` — changes to this field trigger configured webhook endpoints; `false` — field changes do not initiate webhook notifications.", "example": false, "type": "boolean" } }, "type": "object" }, "LayoutsId": { "description": "Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$id": "IdStructure" }, "LayoutsModuleName": { "description": "Represents the API name of a CRM module, used as a programmatic identifier in API requests, automation configurations, and cross-module references.", "example": "Leads", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "LayoutsNested": { "additionalProperties": false, "description": "Represents the nested object representing a CRM layout that portal users can access for a given module. Identified by a unique numeric ID, name, and display label.", "properties": { "_default_view": { "$ref": "#/components/schemas/DefaultViewNested" }, "display_label": { "description": "Represents the display label of the CRM layout.", "maxLength": 255, "type": "string" }, "id": { "description": "Specifies the unique identifier of the CRM layout.", "maxLength": 25, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaLayoutsId" } ], "resource": "portals_meta" } }, "name": { "description": "Represents the internal name of the CRM layout.", "maxLength": 255, "type": "string" } }, "type": "object" }, "LayoutsReferenceId": { "description": "Represents a temporary identifier used to reference a section or element within a layout update request payload, enabling cross-referencing between newly created elements before their permanent IDs are assigned.", "example": "{{12345}}", "maxLength": 255, "pattern": "\\{\\{[a-zA-Z0-9]+\\}\\}", "type": "string" }, "LayoutsTypeNull": { "description": "Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.", "type": "null", "x-zs-$id": "TypeNullStructure" }, "LayoutsUserReference": { "additionalProperties": false, "description": "Represents a reference to the CRM user who performed an action, such as creating or modifying a layout, identified by their unique ID and display name.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId" }, "name": { "description": "Represents the display name of the CRM user, shown in audit fields and reference contexts such as created_by and modified_by.", "example": "John Doe", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "UserReferenceStructure" }, "LimitExceededForCreateCV": { "additionalProperties": false, "description": "Represents the error response returned when the request exceeds the maximum number of Custom Views allowed.", "properties": { "code": { "description": "Represents the error code for the limit exceeded error.\nPossible values:\n**LIMIT_EXCEEDED** - The maximum number of Custom Views allowed for the edition has been reached.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details for this error type. No structured detail data exists for this error.", "type": "object" }, "message": { "description": "Represents the error message describing the Custom View limit.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "LimitExceededForCreateCV" }, "LimitExceededGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a limit exceeded GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "limit": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" }, "param_name": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "limit", "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "LimitExceededGETError" }, "LimitExceededSchema": { "additionalProperties": false, "description": "Represents the error response returned when a configured limit, such as the maximum number of conditions or actions per rule, is exceeded.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "LOOKUP_LIMIT_EXCEEDED", "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "api_name": { "description": "Represents the **api_name** value from the error detail object.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the **json_path** value from the error detail object.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the **limit** value from the error detail object.", "format": "int32", "type": "integer" }, "lookupFields": { "description": "Represents the **lookupFields** value from the error detail object.", "items": { "description": "Represents the name of a lookup field that contributed to the limit being exceeded.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "actions limit exceeded", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleLimitExceededErrorResponses", "x-zs-llm-description": "Error codes: LIMIT_EXCEEDED or LOOKUP_LIMIT_EXCEEDED. LIMIT_EXCEEDED: org has reached maximum rules, conditions, or actions per rule - check getWorkflowRulesCount for limits. LOOKUP_LIMIT_EXCEEDED: too many lookup-based field_update actions. Resolution: remove unused rules/actions or upgrade plan." }, "LinkLimitExceededError": { "additionalProperties": false, "description": "Error returned when the maximum allowed limit for creating unsubscribe links has been exceeded. You need to delete existing links before creating new ones.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional information about the unsubscribe link limit that has been exceeded.", "properties": { "limit": { "description": "The maximum number of unsubscribe links allowed in your account", "format": "int32", "type": "integer" }, "limit_due_to": { "description": "The field(s) that caused the limit to be exceeded", "items": { "additionalProperties": false, "description": "Represents a factor contributing to the unsubscribe link limit.", "properties": { "api_name": { "description": "Represents the API name of the field that is contributing to the limit.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field contributing to the limit.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "limit", "limit_due_to" ], "type": "object" }, "message": { "description": "Represents the error message describing the limit exceeded issue.", "enum": [ "Unsubscribe Link limit exceeded" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Link Limit Exceeded Error", "type": "object", "x-zs-$id": "LinkLimitExceededError" }, "ListPageInfo": { "additionalProperties": false, "description": "Represents the pagination metadata for the scheduled jobs list, including per-page size, current page, item count, and whether more records are available.", "properties": { "count": { "description": "Represents the count of the jobids.", "format": "int32", "type": "integer" }, "more_records": { "description": "Represents the more records available.", "type": "boolean" }, "page": { "description": "Represents the page number.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the per page count.", "format": "int32", "type": "integer" } }, "required": [ "count", "more_records", "page", "per_page" ], "title": "List Pagination Info", "type": "object" }, "LockStatusSchema": { "additionalProperties": false, "description": "Represents the lock configuration of a workflow rule, including the lock state and the identity of the user who applied the lock.", "properties": { "locked_by": { "anyOf": [ { "$ref": "#/components/schemas/LockedByObjectSchema" }, { "description": "Represents a null value indicating the workflow rule is not currently locked by any user.", "type": "null", "x-zs-$id": "LockedByNullSchema" } ], "description": "Represents the details of the CRM user who locked the workflow rule." }, "message": { "description": "Represents the note or label indicating the reason or context for locking the rule.", "format": "string", "type": [ "string", "null" ] }, "status": { "description": "Indicates whether the workflow rule is locked.\nPossible values:\ntrue - The rule is locked.\nfalse - The rule is not locked.", "type": "boolean" } }, "title": "Lock Status", "type": "object", "x-zs-llm-description": "Lock state of a workflow rule. Contains status (boolean - is currently locked), locked_by (user object), and message (lock reason string). Locked rules cannot be deleted or updated - returns RECORD_LOCKED error." }, "LockedByObjectSchema": { "additionalProperties": false, "description": "Represents the identity of the CRM user who locked the workflow rule, including their display name and unique ID.", "properties": { "id": { "description": "Represents the unique ID of the CRM user who locked the workflow rule.", "format": "string", "type": "string" }, "name": { "description": "Represents the name of the CRM user who locked the workflow rule.", "format": "string", "type": "string" } }, "type": "object", "x-zs-$id": "LockedByObjectSchema", "x-zs-llm-description": "User reference within lock status showing who locked the workflow rule. Contains name and id." }, "LookupLimitExceeded": { "additionalProperties": false, "description": "Represents the error response returned when the count of lookup fields used in criterion expressions exceeds the allowed limit. The error code is LOOKUP_LIMIT_EXCEEDED. The details object contains a used_in array (minItems: 1, maxItems: 10) in which each entry identifies an affected location by name and provides the relevant lookup fields and the applicable lookup limit.", "properties": { "code": { "description": "Identifies the error code that signals the lookup field limit has been exceeded. Possible values: LOOKUP_LIMIT_EXCEEDED.", "enum": [ "LOOKUP_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Provides structured information about the locations where the lookup field count exceeded the allowed limit. The required used_in array contains objects that each specify a location name (such as \"criteria\" or \"cross_filters\"), the lookup fields in use, and the applicable lookup limit.", "properties": { "used_in": { "description": "Lists the locations (for example, \"criteria\" or \"cross_filters\") where lookup field usage exceeded the allowed limit. Each entry in the array contains a location name, the lookup fields involved, and the applicable lookup limit. The array contains between 1 and 10 items.", "items": { "additionalProperties": false, "description": "Represents one location — such as criteria or cross_filters — where lookup field usage has exceeded the allowed limit. Each entry identifies the location by name, lists the offending lookup fields, and specifies the maximum number of lookup fields permitted in that location.", "properties": { "lookup_fields": { "description": "Lists the lookup fields present in the specified location that contributed to exceeding the allowed lookup field limit. Contains between 1 and 100 entries, each identifying a single lookup field by its API name.", "items": { "additionalProperties": false, "description": "Represents one lookup field used in the specified criterion location that was counted against the lookup field limit. Each entry exposes the API name of the offending field.", "properties": { "api_name": { "description": "Specifies the API name of a lookup field that was counted against the lookup field limit for the specified location.", "maxLength": 256, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "lookup_limit": { "description": "Specifies the maximum number of lookup fields permitted in the associated location, such as criteria or cross_filters.", "format": "int32", "type": "integer" }, "name": { "description": "Identifies the location — such as criteria or cross_filters — where the lookup field count exceeded the allowed limit.", "maxLength": 256, "type": "string" } }, "required": [ "name", "lookup_fields", "lookup_limit" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "used_in" ], "type": "object" }, "message": { "description": "Contains a descriptive error message explaining why the lookup field limit was exceeded.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the outcome of the request. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "LookupLimitExceeded" }, "MailMergeDetailsNested": { "additionalProperties": false, "description": "Represents the response details returned upon successful initiation of the send mail merge operation.", "properties": { "report_link": { "description": "Represents the URL of the mail merge job report.", "format": "uri", "maxLength": 255, "type": "string" } }, "type": "object" }, "MailMergeExpectedFieldMissingError": { "additionalProperties": false, "description": "Represents an error response when at least one of the expected fields is absent from the request.", "properties": { "code": { "description": "Represents the error code for the failed operation. ", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details listing the expected fields, at least one of which must be provided.", "properties": { "expected_fields": { "description": "Represents the list of expected fields, at least one of which must be included in the request.", "items": { "additionalProperties": false, "description": "Represents an expected field entry with its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the expected field in the request body.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "specify atleast one field" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Expected Field Missing Error", "type": "object", "x-zs-$id": "ExpectedFieldMissingError" }, "MailMergeInvalidDataMaxLengthError": { "additionalProperties": false, "description": "Represents an error response when a field value exceeds the maximum allowed length.", "properties": { "code": { "description": "Represents the error code for the failed request. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with field validation information.", "properties": { "api_name": { "description": "Represents the API name of the field that failed validation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that failed validation.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that failed validation.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message describing the failure. ", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Max Length Error", "type": "object", "x-zs-$id": "InvalidDataMaxLengthError" }, "MailMergeInvalidDataParamError": { "additionalProperties": false, "description": "Represents an error response when invalid data is provided in a request parameter.", "properties": { "code": { "description": "Represents the error code for the failed operation. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the parameter with invalid data.", "properties": { "param_name": { "description": "Represents the name of the request parameter that contains invalid data.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the error response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Param Error", "type": "object", "x-zs-$id": "InvalidDataParamError" }, "MailMergeInvalidDataTypeError": { "additionalProperties": false, "description": "Represents an error response when a field value has an invalid data type.", "properties": { "code": { "description": "Represents the error code for the requested operation. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with field validation information.", "properties": { "api_name": { "description": "Represents the API name of the field that has an invalid data type.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that failed validation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that has an invalid data type.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Type Error", "type": "object", "x-zs-$id": "InvalidDataTypeError" }, "MailMergeInvalidRequestMethodError": { "additionalProperties": false, "description": "Represents an error response when the HTTP request method used is not supported for the endpoint.", "properties": { "code": { "description": "Represents the error code for the failed operation. ", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for an invalid request method error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "The http request method type is not a valid one" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Request Method Error", "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, "MailMergeMandatoryFieldNotFoundError": { "additionalProperties": false, "description": "Represents an error response when a required field is missing from the request.", "properties": { "code": { "description": "Represents the error code for this error type. ", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory field in the request.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "Represents the error response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Mandatory Field Not Found Error", "type": "object", "x-zs-$id": "MandatoryFieldNotFoundError" }, "MailMergeRequiredParamMissingError": { "additionalProperties": false, "description": "Represents an error response when a required URL or query parameter is not provided in the request.", "properties": { "code": { "description": "Represents the error code for this error type.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing required parameter.", "properties": { "param_name": { "description": "Represents the name of the required parameter that is missing from the request.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "mandatory param missing" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Required Param Missing Error", "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "MailMergeTemplateNested": { "additionalProperties": false, "description": "Represents the mail merge template reference, identified by the template name.", "properties": { "name": { "description": "Represents the name of the mail merge template to use for the operation.", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "type": "object" }, "MandatoryFieldIdMissingError": { "additionalProperties": false, "description": "Represents an error response returned when the required `id` field is missing from the request body.", "properties": { "code": { "description": "Represents the error code **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the missing required `id` field.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing required field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the required field was not found.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Mandatory Field 'id' Missing Error", "type": "object", "x-zs-$id": "ErrorResponseCore119104918" }, "MandatoryFieldNotFoundBodyError": { "additionalProperties": false, "description": "Represents an error response when a required field is absent from the request body.", "properties": { "code": { "description": "Represents the error code for this error type. ", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory field in the request body.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message. ", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the error response status. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Mandatory Field Not Found Body Error", "type": "object", "x-zs-$id": "MandatoryFieldNotFoundBodyError" }, "MandatoryFieldNotFoundErrorSchema": { "additionalProperties": false, "description": "Represents an error when a required field is missing from the request.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **MANDATORY_NOT_FOUND** - A required field is missing from the request.\n", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the missing field.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing required field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "MandatoryFieldNotFoundErrorSchema" }, "MandatoryFieldNotFoundMultiStatusError": { "additionalProperties": true, "description": "Multi-status error item returned when a service record in a bulk operation is missing a required field.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that a mandatory field was not found in the multi-status request.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the response. ", "maxLength": 100, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MandatoryFieldNotFoundMultiStatusError" }, "MandatoryInvalidDataCommonApiNameJsonPath": { "additionalProperties": false, "description": "Represents error details when a mandatory field contains invalid data.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field with invalid data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the mandatory field with invalid data.", "maxLength": 500, "type": "string" }, "param_name": { "description": "Represents the parameter name of the mandatory field with invalid data.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "MandatoryInvalidDataCommonApiNameJsonPath" }, "MandatoryNotFoundBulkError": { "additionalProperties": false, "description": "Represents an error response returned in bulk operations when a mandatory field is missing from the request data, with the result wrapped in a **data** array.", "properties": { "data": { "description": "Array of error results.", "items": { "additionalProperties": false, "description": "Individual error result.", "properties": { "code": { "description": "Error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Error details with field information.", "properties": { "api_name": { "description": "API name of the mandatory field that is missing.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSONPath to the missing field in request payload.", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MandatoryNotFoundBulkError" }, "MandatoryNotFoundErrorWithSupportedValues": { "additionalProperties": false, "description": "Represents the error response when a required field is missing from the request body, including the list of valid options.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name, JSON path, and list of accepted values.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the validation error.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field in the request body that caused the validation error.", "maxLength": 250, "minLength": 1, "type": "string" }, "supported_values": { "description": "Represents the list of accepted values for the field.", "items": { "description": "Represents a single accepted value for the field.", "maxLength": 100, "type": "string" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message returned when a required field is absent. Possible values: **required field not found**.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "MandatoryNotFoundErrorWithSupportedValues" }, "MandatoryNotFoundForSort": { "additionalProperties": false, "description": "Represents the error details returned when a required field is missing from a sort request.", "properties": { "code": { "description": "Represents the error code for the missing required field.\nPossible values:\n**MANDATORY_NOT_FOUND** - A required field is missing from the sort request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "allOf": [ { "$ref": "#/components/schemas/SimpleFieldError" } ], "description": "Represents the additional details about the missing required field." }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundForSort" }, "MandatoryNotFoundForUpdateCVById": { "additionalProperties": false, "description": "Represents the error details returned when a required field is missing from a Custom View update request.", "properties": { "code": { "description": "Represents the error code for the missing required field.\nPossible values:\n**MANDATORY_NOT_FOUND** - A required field is missing from the update request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFieldError" }, { "$ref": "#/components/schemas/ApiNameDetail" } ], "description": "Represents the additional details about the missing required field." }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundForUpdateCVById" }, "MandatoryNotFoundLayoutRuleError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a mandatory not found layout rule error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "example": "Designation", "maxLength": 50, "type": "string" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "example": "$.data[0].Designation", "type": "string" }, "layout_rule": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "layout_rule", "api_name", "json_path", "id" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundLayoutRuleError" }, "MandatoryNotFoundLayoutRuleWriteError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a mandatory not found layout rule write error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "example": "Phone", "maxLength": 50, "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "example": "$.data[0].Phone", "type": "string" }, "layout_rule": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "layout_rule", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundLayoutRuleWriteError" }, "MandatoryNotFoundProfileError": { "additionalProperties": false, "description": "A MANDATORY_NOT_FOUND error returned when a required field is missing from the request.", "properties": { "code": { "description": "Error code indicating a missing mandatory field. \n**Possible values:**\n **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "A JSONPath expression that indicates the location of the missing field in the request payload.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "A human-readable message describing the missing mandatory field.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundProfileError" }, "MandatoryNotFoundRecordIdError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a mandatory not found record ID error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "example": "Single_Line_1", "maxLength": 50, "type": "string" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "example": "$.data[0].Single_Line_1", "type": "string" } }, "required": [ "api_name", "json_path", "id" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundRecordIdError" }, "MandatoryNotFoundTerritoriesError": { "additionalProperties": false, "description": "Represents the error response when the mandatory territories field is missing from the request body.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name and JSON path of the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field that is missing from the request.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the mandatory field that is missing from the request body.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when a required field is absent. Possible values: **required field not found**.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "MandatoryNotFoundTerritoriesError" }, "MandatoryParamMissingError": { "additionalProperties": false, "description": "Represents the error returned when a mandatory request body field is absent. The details object includes the missing field's api_name and json_path.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**MANDATORY_NOT_FOUND** - A required query or path parameter is missing from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the mandatory parameter that is missing.", "properties": { "api_name": { "description": "Represents the API name of the mandatory parameter that is missing.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the mandatory parameter that is missing.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\n\n**Possible values**:\n**mandatory param missing** - A required parameter was not provided in the request.\n**required field not found** - A required field is absent from the request.", "enum": [ "mandatory param missing", "required field not found" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryParamMissingError", "x-zs-llm-description": "A mandatory request body field is missing. Check details for the missing field api_name." }, "MandatoryPersonalityAndNotesModulesError": { "additionalProperties": false, "description": "Returned when the request body does not include both the personality module and the Notes module, which are mandatory when configuring module access for a portal user type.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": {}, "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Personality module and Notes module are mandatory modules." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MandatoryPersonalityAndNotesModulesError" }, "MapDependencyFieldReference": { "additionalProperties": false, "description": "Represents a reference to a field, identified by its unique ID and API name.", "properties": { "api_name": { "description": "Represents the API name of the field.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the field. ", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "MapDependencySuccessResponse": { "additionalProperties": false, "description": "Represents the success response returned after a create, update, or delete operation.", "properties": { "code": { "description": "Represents the success code for the operation. Possible values: **SUCCESS**. \n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the result details for the operation. ", "properties": { "id": { "description": "Represents the unique identifier of the dependency the operation created, updated, or deleted. ", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Describes the result of the operation.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**. \n", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "MappingMismatchErrorResponse": { "additionalProperties": false, "description": "Error indicating a mapping mismatch between fields.", "properties": { "code": { "description": "Error code", "enum": [ "MAPPING_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field with mapping mismatch", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with mapping mismatch", "maxLength": 1000, "type": "string" }, "mapped_field": { "additionalProperties": false, "description": "Field mapping details", "properties": { "api_name": { "description": "API name of the mapped field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the mapped field", "maxLength": 1000, "type": "string" } }, "type": "object" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MappingMismatchErrorResponse" }, "MarketplaceWebhookNotAllowedError": { "additionalProperties": false, "description": "Represents the error returned when a request attempts to modify or delete a webhook created by a Marketplace extension or CommandCenter.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The webhook was created by a Marketplace extension and cannot be modified or deleted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the marketplace webhook restriction.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource in the request URL path for the marketplace webhook.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Webhook is associated with MarketPlace** - The webhook was created by a Marketplace extension and cannot be modified or deleted by the requesting user.", "enum": [ "Webhook is associated with MarketPlace" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MarketplaceWebhookNotAllowedError", "x-zs-llm-description": "Cannot modify/delete a webhook created by a Marketplace extension or Command Center." }, "MaskDetailsProfile": { "additionalProperties": false, "description": "Represents a CRM profile that is permitted to view the unmasked value of a masked field, exempting users of this profile from the field's masking rules.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the profile." }, "name": { "description": "Represents the name of the CRM profile that is permitted to view the unmasked field value, identifying which user group is exempt from the field's masking rules.", "example": "Administrator", "maxLength": 60, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "MaskDetailsProfileStructure" }, "MassDeleteTagsErrorResponse": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error payload returned when a required field is missing from the request to a mass delete tag operation.", "properties": { "code": { "description": "Represents the error code indicating that a required field is missing from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "maxLength": 30, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details that identify the missing required field.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path that points to the missing required field in the request body.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the missing required field.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the error response.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsErrorMandatoryNotFound" }, { "additionalProperties": false, "description": "Represents the error payload returned when a field in the request to a mass delete tag operation contains invalid data, an unsupported data type, or violates a size limit. ", "properties": { "code": { "description": "Represents the error code indicating that invalid data was provided in the request.", "enum": [ "INVALID_DATA" ], "maxLength": 20, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details that identify the invalid field and the validation that failed.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 50, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type of the field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path that points to the field with invalid data in the request body.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed number of items or characters for the field that failed validation.", "format": "int32", "minimum": 0, "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the message that describes the invalid data in the request.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the error response.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsErrorInvalidData" }, { "additionalProperties": false, "description": "Represents the error payload returned when the module ID and the module API name in the request refer to different modules.", "properties": { "code": { "description": "Represents the error code indicating that the module ID and the module API name in the request refer to different modules.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "maxLength": 40, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details that identify the conflicting module identifiers in the request.", "properties": { "ambiguity_due_to": { "description": "Represents the list of conflicting field identifiers that produced the ambiguity in the module reference.", "items": { "additionalProperties": false, "description": "Represents one conflicting field identifier that contributed to the ambiguity.", "properties": { "api_name": { "description": "Represents the API name of the conflicting field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the conflicting field in the request body.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the message that describes the ambiguous module identifiers in the request.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the error response.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsErrorAmbiguity" }, { "additionalProperties": false, "description": "Represents the error payload returned when one or more tags cannot be deleted because they are associated with CRM features such as Blueprint or Workflow Rules.", "properties": { "code": { "description": "Represents the error code indicating that one or more tags cannot be deleted because they are associated with CRM features.", "enum": [ "NOT_ALLOWED" ], "maxLength": 20, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details that identify the tag whose association blocks the deletion.", "properties": { "api_name": { "description": "Represents the API name of the field related to the restricted deletion attempt.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path that points to the tag identifier whose association blocks the deletion.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the restriction preventing the deletion of the tags.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the error response.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsErrorNotAllowed" }, { "additionalProperties": false, "description": "Represents the error payload returned when the user profile does not have the permissions required to perform the mass delete tag operation.", "properties": { "code": { "description": "Represents the error code indicating that the user does not have permission to perform the action.", "enum": [ "NO_PERMISSION" ], "maxLength": 20, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details that identify the permissions missing from the user profile.", "properties": { "permissions": { "description": "Represents the list of permission identifiers that the user profile is missing.", "items": { "description": "Represents the name of a permission identifier required to perform the action.", "maxLength": 100, "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the message that describes the permission denial.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the error response.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsErrorNoPermission" }, { "additionalProperties": false, "description": "Represents the wrapped error payload returned by the mass delete tag status query when the supplied job_id is invalid or does not match any scheduled job.", "properties": { "mass_delete": { "description": "Represents the wrapper array that carries the error for the queried mass delete tag job.", "items": { "additionalProperties": false, "description": "Represents the error entry for the queried mass delete tag job.", "properties": { "code": { "description": "Represents the error code indicating that the provided job_id is invalid.", "enum": [ "INVALID_DATA" ], "maxLength": 20, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details that identify the invalid job_id value provided in the request.", "properties": { "job_id": { "description": "Represents the invalid or unknown job_id value that was provided in the query parameter.", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the invalid job query.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the error response.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsGetErrorItem" }, "maxItems": 1, "type": "array" } }, "required": [ "mass_delete" ], "type": "object", "x-zs-$id": "MassDeleteTagsGetErrorWrapper" } ], "description": "Represents the error payload returned by the mass delete tag operations. It provides the error structures for missing mandatory fields, invalid data, ambiguous module identifiers, restricted tag deletion, missing permissions, and invalid job queries.", "x-zs-$id": "MassDeleteTagsErrorResponse" }, "MaximumLengthApiNameJsonPath": { "additionalProperties": false, "description": "Represents error details when a field value exceeds the maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeded the maximum length.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that exceeded the maximum length.", "maxLength": 500, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object", "x-zs-$id": "MaximumLengthApiNameJsonPath" }, "MaximumLengthError": { "additionalProperties": false, "description": "Details about a failed API request.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Detailed error context, including field-specific validation information.", "properties": { "api_name": { "description": "The API name of the field or module that caused the validation error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "The JSON path of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "The maximum allowed length for the field that failed validation.", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable error message describing the issue.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status. Always \"error\".", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "type": "object", "x-zs-$id": "MaximumLengthError" }, "MembersAssociationLimitExceededError": { "additionalProperties": false, "description": "Error response returned when more than 100 users are associated with a single service.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the limit that the request exceeded.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing that the number of member associations exceeds the allowed limit.", "enum": [ "More than 100 users cannot be associated" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MembersAssociationLimitExceededError" }, "MembersBase": { "additionalProperties": true, "description": "Base schema for a member of the service. Identifies the user by module, name, and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "properties": { "id": { "description": "Specify the unique ID of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "enum": [ "4671651000000635001" ], "maxLength": 100, "type": [ "string", "null" ] }, "module": { "description": "Specify the source module of the member. Typically set to the module Users.", "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Specify the display name of the user who delivers the service.", "enum": [ "Madeshwaran G" ], "maxLength": 100, "type": [ "string", "null" ] } }, "type": "object" }, "MembersNested": { "additionalProperties": false, "description": "Represents a member who delivers the service. Identifies the user by name and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "properties": { "Members": { "$ref": "#/components/schemas/MembersNested", "description": "contains member details" }, "id": { "description": "Specify the unique ID of the user who delivers the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "maxLength": 18, "type": [ "string", "null" ] }, "name": { "description": "Specify the display name of the user who delivers the service.", "maxLength": 120, "type": [ "string", "null" ] } }, "type": "object" }, "MembersNotActiveError": { "additionalProperties": false, "description": "Error response returned when one of the users provided in the Members array is inactive.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" }, "user_status": { "description": "Represents the current status of the referenced user (for example, inactive or unconfirmed).", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "user_status" ], "type": "object" }, "message": { "description": "Represents the error message describing that one or more referenced members are not active.", "enum": [ "Members is not Active" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MembersNotActiveError" }, "MembersNotConfirmedError": { "additionalProperties": false, "description": "Error response returned when one of the users provided in the Members array has not confirmed their CRM account.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" }, "user_status": { "description": "Represents the current status of the referenced user (for example, inactive or unconfirmed).", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "user_status" ], "type": "object" }, "message": { "description": "Represents the error message describing that one or more referenced members have not confirmed their membership.", "enum": [ "Members is not Confirmed" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MembersNotConfirmedError" }, "MembersitemBase": { "additionalProperties": true, "description": "Base schema for a member item in the service Members array. Wraps the member identity together with the relationship ID.", "properties": { "Members": { "$ref": "#/components/schemas/MembersBase" }, "id": { "description": "Specify the unique relationship ID of the member entry on the service record.", "maxLength": 100, "type": [ "string", "null" ] } }, "type": "object" }, "MergeFieldMapping": { "additionalProperties": false, "description": "Represents a merge_field-type mapping whose value is resolved at execution time by substituting token references with live field data. Supports direct field tokens (${!Module.Field}), traversal tokens (${!Module.Lookup.Field}), and system tokens (${CURRENTTIME}, ${CURRENTUSER}). Applies to text-based fields such as Subject, Description, and custom text fields. Targeting owner or lookup fields with this type produces a DEPENDENT_MISMATCH error; those fields require a static mapping using an object with a numeric identifier and an optional name. Multiple tokens may be chained with surrounding text for multi-line fields, while single-value fields such as email or URL accept exactly one token.", "properties": { "allow_agent_user": { "default": false, "description": "Controls whether agent users are eligible for record assignment. Possible values:\n**true** — agent users are included in the assignment pool alongside standard users.\n**false** — agent users are excluded from assignment.\nApplies to mapping types role, group, profile, merge_field, and criteria. Does not apply to user or assignment_rule types.", "type": "boolean" }, "display_value": { "description": "The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests.", "maxLength": 500, "type": "string" }, "field": { "$ref": "#/components/schemas/AutomationFieldAttributes", "description": "Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING." }, "type": { "const": "merge_field", "description": "Identifies the mapping strategy for this field assignment. The value must be `merge_field`, which instructs the automation engine to resolve the field value dynamically from a merge field token at execution time rather than from a static literal.", "type": "string" }, "value": { "$ref": "#/components/schemas/MergeFieldStringValue", "description": "A string containing one or more ${!...} merge-field tokens resolved at runtime." } }, "required": [ "field", "type", "value" ], "title": "Merge Field Mapping", "type": "object", "x-zs-$id": "MergeFieldMapping", "x-zs-llm-description": "type='merge_field' mapping. Value contains ${!Module.Field} tokens resolved at execution time. ONLY for text-based fields (Subject, Description, etc.) using on date/number/picklist fields returns DEPENDENT_MISMATCH. Supports lookup traversal: ${!Module.Lookup.Field}. Multi-module not supported." }, "MergeFieldStringValue": { "description": "Represents the string value carried by a merge_field mapping, containing one or more runtime-resolved token references. Supports direct field tokens (${!Module.Field}), lookup traversal tokens (${!Module.Lookup.Field}), and system tokens (${CURRENTTIME}, ${CURRENTUSER}). Tokens may be combined with surrounding text for multi-line field targets. Fields that hold a single typed value such as email or URL accept exactly one token.", "example": "${!Leads.First_Name}", "maxLength": 1000, "type": "string", "x-zs-$id": "MergeFieldStringValue", "x-zs-llm-description": "String containing merge-field tokens for type=merge_field mappings. Resolved at runtime. Formats: ${!Module.Field} (direct access), ${!Module.Lookup.Field} (traverse lookup). Multiple tokens can be combined in one string. Unsupported tokens return UNSUPPORTED_MERGE_FIELD error." }, "MergeTagInvalidIdError": { "additionalProperties": false, "description": "Error returned when the master tag ID in the URL path is invalid.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Error details identifying the invalid field", "properties": { "api_name": { "description": "Name of the invalid field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data", "Invalid data", "Invalid data type" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Merge Tag Invalid ID Error", "type": "object", "x-zs-$id": "MergeTagInvalidIdError" }, "MinimumPicklistOptionConstraintErrorResponse": { "additionalProperties": false, "description": "Returned when deletion would leave no options in a layout (must have at least one option). Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "PickList field should have at least one option in the layouts", "PickList field should have at least two option in the layouts" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Minimum Picklist Option Constraint Error Response", "type": "object", "x-zs-$id": "MinimumPicklistOptionConstraintErrorResponse" }, "MissingDeleteIdParameterError": { "additionalProperties": false, "description": "Indicates that no field update ID was provided for the delete operation.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "Name of the missing required parameter.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Missing Delete Id Parameter Error", "type": "object", "x-zs-$id": "MissingDeleteIdParameterError", "x-zs-llm-description": "No field update ID was provided for the delete operation. Supply IDs via the 'ids' query parameter." }, "MissingFieldUpdateIdError": { "additionalProperties": false, "description": "Indicates that no field update ID was provided for the edit operation.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "Name of the missing required parameter.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Missing Field Update Id Error", "type": "object", "x-zs-$id": "MissingFieldUpdateIdError", "x-zs-llm-description": "No field update ID was provided for the edit/delete operation. Include the ID in the URL path." }, "MissingIncludeInnerDetailsParamError": { "additionalProperties": false, "description": "Returned when the 'include_inner_details' query parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "Name of the missing required parameter.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "One of the expected param is missing" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Missing Include Inner Details Param Error", "type": "object", "x-zs-$id": "MissingIncludeInnerDetailsParamError", "x-zs-llm-description": "The include_inner_details query parameter is required but missing. Add include_inner_details=true to the request." }, "MissingModuleParameterError": { "additionalProperties": false, "description": "Error response returned when the required **module** query parameter is absent from the request.", "properties": { "code": { "description": "Error code indicating the required **module** parameter is missing. Possible values: **REQUIRED_PARAM_MISSING**. ", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Validation details identifying the missing parameter.", "properties": { "param_name": { "description": "Name of the missing required parameter. Possible values: **module**. ", "enum": [ "module", "type" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Error message indicating a required parameter is missing. Possible values: **One of the expected parameter is missing**. ", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Response status indicating an error occurred. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Missing Module Parameter Error", "type": "object", "x-zs-$id": "MissingModuleParameterError" }, "MissingRequiredParameterErrorResponse": { "additionalProperties": false, "description": "Missing required parameter error response", "properties": { "code": { "description": "Error code indicating missing parameters", "enum": [ "EXPECTED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including missing parameter names", "properties": { "param_names": { "description": "List of missing parameter names", "items": { "description": "Parameter name", "enum": [ "criteria", "email", "phone", "word" ], "type": "string" }, "maxItems": 4, "type": "array" } }, "required": [ "param_names" ], "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MissingRequiredParameterErrorResponse" }, "ModifiedBySchema": { "additionalProperties": false, "description": "Nested schema for modified_by", "properties": { "id": { "description": "Unique numeric ID of the user who last modified the scoring rule.", "maxLength": 25, "type": "string" }, "name": { "description": "Full name of the user who last modified the scoring rule.", "maxLength": 255, "type": "string" }, "zuid": { "description": "Zoho unique ID (ZUID) of the user who last modified the scoring rule.", "maxLength": 255, "type": "string" } }, "title": "Nullable User Information", "type": [ "object", "null" ] }, "ModifiedTime": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/Timestamp" } ], "description": "Profile last-modified timestamp.", "x-zs-$id": "ModifiedTimeValue" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesTypeNull" } ], "description": "Null when modification time is not available.", "x-zs-$id": "ModifiedTimeNull" } ], "description": "Last modification timestamp of the profile - an ISO 8601 datetime string, or null when the modification time is not available." }, "ModifierDetails": { "additionalProperties": false, "description": "Provides details about the individual who modified an entity, including their name and ID.", "properties": { "id": { "description": "Unique Zoho CRM user ID of the modifier.", "maxLength": 255, "type": "string" }, "name": { "description": "Display name of the user who last modified this resource.", "maxLength": 255, "type": "string" } }, "title": "Modifier Details", "type": "object", "x-zs-llm-description": "Read-only audit field showing who last modified this task. Contains name and id." }, "ModifierInfo": { "additionalProperties": false, "description": "Represents the identifier and name of the user who last modified the record.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified the record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the full name of the user who last modified the record.", "maxLength": 255, "type": "string" } }, "title": "Modifier Information", "type": [ "object", "null" ] }, "Module": { "additionalProperties": false, "description": "CRM module metadata with ID and API name.", "properties": { "api_name": { "description": "API name of the CRM module (e.g., Leads, Contacts, Accounts). Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module API names.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the CRM module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs.", "maxLength": 19, "type": "string" } }, "required": [ "id", "api_name" ], "type": "object" }, "ModuleChangeNotAllowedError": { "additionalProperties": false, "description": "Represents the error returned when a PUT request attempts to change the module of an existing webhook. The module field is immutable after creation.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The module field cannot be changed after the webhook is created.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field for which the module change is not allowed.", "properties": { "api_name": { "description": "Represents the API name of the field for which the module change is not allowed.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field for which the module change is not allowed.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**old value cannot be changed with new value for this field** - The module field is immutable after webhook creation and cannot be updated.", "enum": [ "old value cannot be changed with new value for this field" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModuleChangeNotAllowedError", "x-zs-llm-description": "Cannot change the module on an existing webhook. Create a new webhook for a different module." }, "ModuleForbiddenErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have the required permissions for the specified module.", "properties": { "code": { "description": "Represents the error code for the permission error.\nPossible values:\n**NO_PERMISSION** - The user does not have the required permission for this module.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the permission error, including the required permissions.", "properties": { "permissions": { "description": "Represents the list of permissions required to perform the action on this module.", "items": { "description": "Represents a required permission scope string.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission denial.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered a permission error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ModuleForbiddenErrorResponse" }, "ModuleIdApiNameAmbiguityError": { "additionalProperties": false, "description": "Represents module ID and API name do not match the same module.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "ambiguity_due_to": { "description": "Module references whose id and api_name values do not match, causing the ambiguity.", "items": { "additionalProperties": false, "description": "One module reference whose id and api_name values conflict.", "properties": { "api_name": { "description": "API name of the conflicting module reference.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the conflicting module reference.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "The given moduleid seems to be invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Module Id Api Name Ambiguity Error", "type": "object", "x-zs-$id": "ModuleIdApiNameAmbiguityError", "x-zs-llm-description": "The module ID and api_name do not refer to the same module. Supply only one identifier or fix the mismatch." }, "ModuleInformation": { "additionalProperties": false, "description": "Represents the API name and identifier of a CRM module.", "properties": { "api_name": { "description": "Represents the API name of the CRM module.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Represents the unique identifier of the CRM module.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" }, { "operationId": "createModules", "propertyId": "ModuleDetailsId" } ], "resource": "modules" } } }, "title": "Module Information", "type": "object" }, "ModuleNested": { "additionalProperties": false, "description": "Represents the module details for the Appointment_For customer record lookup, including the module API name and ID. Test8", "properties": { "api_name": { "description": "Represents the API name of the module for the customer record.", "maxLength": 8, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the module.", "maxLength": 18, "type": [ "string", "null" ] } }, "type": "object" }, "ModuleOrFieldNestedSchema": { "additionalProperties": false, "description": "Represents a CRM module or field reference using its API name and unique numeric ID.", "minProperties": 1, "properties": { "api_name": { "description": "Represents the API name of the module or field, such as **Leads**, **Contacts**, or a custom field API name.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique numeric ID of the module or field.", "maxLength": 20, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "ModuleOrFieldNestedSchema", "x-zs-llm-description": "Reusable reference object for modules and fields. Both api_name and id must be provided - API returns MANDATORY_NOT_FOUND if id is missing. Used across: rule module, action module, criteria field, field_mappings field, lookup_field." }, "ModuleSearchErrorDetails": { "additionalProperties": false, "description": "Represents additional details about the error, including information about the specific parameter or value that caused the issue.", "type": "object" }, "ModuleSearchErrorResponse": { "additionalProperties": false, "description": "Represents the standard error response structure returned by the API, containing the error code, the message, and the response status.", "properties": { "code": { "description": "Represents the error code for the response.", "enum": [ "INVALID_DATA", "INVALID_QUERY", "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" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ModuleSearchErrorDetails" }, "message": { "description": "Represents the error message describing the reason for the failure.", "maxLength": 1000, "type": "string" }, "status": { "default": "error", "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "StandardErrorResponse" }, "ModuleSearchInvalidModuleErrorResponse": { "additionalProperties": false, "description": "Invalid module error response", "properties": { "code": { "description": "Error code indicating invalid module", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including resource path information", "properties": { "resource_path_index": { "description": "Index of the invalid resource path segment", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidModuleErrorResponse" }, "ModuleSpecificActionsCountSchema": { "additionalProperties": false, "description": "Represents the workflow rule count details for a specific CRM module, including the number of active rules and total rules configured.", "properties": { "active_rules_configured": { "description": "Represents number of currently active workflow rules configured.", "format": "int32", "type": "integer" }, "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema" }, "total_rules_configured": { "description": "Represents total number of workflow rules configured (active + inactive).", "format": "int32", "type": "integer" } }, "required": [ "active_rules_configured", "module", "total_rules_configured" ], "title": "Module Workflow Rule Count", "type": "object", "x-zs-llm-description": "Per-module rule count entry. Contains active_rules_configured, total_rules_configured, and module reference. Use to assess module-level capacity." }, "ModuleSpecificCountsResponseAllSchema": { "additionalProperties": false, "description": "Represents an alternate response model containing the workflow rule counts aggregated by CRM module.", "properties": { "module_specific_count": { "description": "Represents action counts broken down by CRM module.", "items": { "$ref": "#/components/schemas/ModuleSpecificActionsCountSchema" }, "maxItems": 500, "type": "array" } }, "required": [ "module_specific_count" ], "title": "Module-Specific Counts Response (Alternate)", "type": "object", "x-zs-$id": "ModuleSpecificCountsResponseAllSchema", "x-zs-llm-description": "Response from getModuleSpecificActionsCount. Contains module_specific_count array with per-module breakdowns of configured rules and actions." }, "ModuleWebTabLink": { "additionalProperties": false, "description": "Represents a web tab link associated with a CRM module, including the tab identifier (id, int64), display name(name), and configured URL(web_link).", "properties": { "id": { "description": "Represents the unique ID of the web tab.", "format": "int64", "maxLength": 20, "minLength": 18, "pattern": "\\d+", "type": "string" }, "name": { "description": "Represents the display name of the web tab.", "maxLength": 50, "minLength": 3, "type": "string" }, "web_link": { "description": "Represents the URL configured for the web tab.", "maxLength": 1000, "type": "string" } }, "required": [ "id", "name", "web_link" ], "title": "Module Web Tab Link", "type": "object" }, "ModuleWebTabLinkResponse": { "additionalProperties": false, "description": "Represents the response containing the generated web tab link for a CRM module, with the link details available in the generate_link property.", "properties": { "generate_link": { "$ref": "#/components/schemas/ModuleWebTabLink" } }, "required": [ "generate_link" ], "title": "Module Web Tab Link Response", "type": "object", "x-zs-$id": "ModuleWebTabLinkResponse" }, "ModulepluralLabel": { "description": "Plural label of the module.", "example": "tranPlur", "maxLength": 25, "type": "string" }, "ModulesNested": { "additionalProperties": false, "description": "Represents a CRM module to which the portal user type grants access. Includes the module's unique identifier, API name, shared type, plural label, and the lists of allowed layouts, filter fields, and field-level permissions.", "properties": { "api_name": { "description": "Represents the API name that uniquely identifies the CRM module being granted portal access.", "maxLength": 25, "pattern": "^[A-Za-z0-9_]{1,25}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaModuleApiName" } ], "resource": "portals_meta" } }, "fields": { "description": "Represents the list of CRM fields within this module that portal users are permitted to access. Each entry specifies the field identifier, API name, read-only flag, and per-field CRUD permissions.", "items": { "$ref": "#/components/schemas/FieldsNested" }, "maxItems": 500, "type": [ "array", "null" ] }, "filters": { "description": "Represents the list of filter field configurations that portal users can use to filter records in this module.", "items": { "$ref": "#/components/schemas/FilterFieldNested" }, "maxItems": 1, "type": [ "array", "null" ] }, "id": { "description": "Represents the unique identifier of the CRM module. This field is required when specifying module access in a portal user type.", "maxLength": 25, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaModuleId" } ], "resource": "portals_meta" } }, "layouts": { "description": "The list of CRM layouts that portal users can access within this module.", "items": { "$ref": "#/components/schemas/LayoutsNested" }, "maxItems": 7, "type": [ "array", "null" ] }, "permissions": { "$ref": "#/components/schemas/PermissionsNested", "description": "The access permissions granted to portal users for this module. The `view` permission is required; all other permissions are optional and module-dependent." }, "plural_label": { "description": "Represents the plural display label of the CRM module.", "maxLength": 255, "type": [ "string", "null" ] }, "shared_type": { "description": "Specifies how records in this module are shared with portal users. This field is required. Possible values: `all_records`, `selected_records`, `related_records`.", "enum": [ "private", "public" ], "maxLength": 255, "minLength": 6, "type": "string" }, "views": { "$ref": "#/components/schemas/ViewsNested", "description": "The list view (canvas view or custom view) visible to portal users when browsing records in this module.", "type": [ "object", "null" ] } }, "required": [ "id", "permissions", "shared_type" ], "type": "object" }, "ModulesNestedV2": { "additionalProperties": false, "description": "Used in update requests to modify module-level properties for an existing portal user type. Supports updating the shared type, allowed layouts, and filter-by field for the specified module.", "properties": { "filters": { "description": "Represents the updated filter-by field configuration for the module. Specifies the CRM field by which portal users can filter records.", "items": { "$ref": "#/components/schemas/FiltersNested" }, "maxItems": 1, "type": [ "array", "null" ] }, "id": { "description": "Represents the unique numeric identifier of the CRM module to be updated within the portal user type.", "maxLength": 25, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaModuleId" } ], "resource": "portals_meta" } }, "layouts": { "description": "Represents the updated list of CRM layouts accessible to portal users for this module.", "items": { "$ref": "#/components/schemas/LayoutsNested" }, "maxItems": 1, "type": [ "array", "null" ] }, "permissions": { "$ref": "#/components/schemas/PermissionsNestedV2", "description": "The updated CRUD permissions for portal users on this module." }, "shared_type": { "description": "The updated sharing mode for this module. Possible values: `public` (all records are shared with the portal user, and can be restricted using secondary conditions) or `private` (only records matching configured filter or secondary conditions are shared with the portal user).", "enum": [ "public", "private" ], "maxLength": 7, "minLength": 6, "type": [ "string", "null" ] }, "views": { "$ref": "#/components/schemas/ViewsNested", "description": "The updated list view (canvas view or custom view) accessible to portal users for this module." } }, "type": "object" }, "MultiSelectLookupFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a filter criterion for the include_all, include_any, exclude_all, and exclude_any comparators. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. The value must be an array of SimpleFilterCriterionValueObjectRequest lookup objects.", "properties": { "comparator": { "description": "Represents the multi-select lookup comparison operator applied to the criterion. Applicable only when the field's data_type is multiuserlookup or multiselectlookup.\nPossible values:\ninclude_all - Matches records that include all specified lookup values.\ninclude_any - Matches records that include at least one of the specified lookup values.\nexclude_all - Matches records that exclude all specified lookup values.\nexclude_any - Matches records that exclude at least one of the specified lookup values.", "enum": [ "include_all", "include_any", "exclude_all", "exclude_any" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the multi-select lookup filter criterion.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the multi-select lookup filter criterion is applied. The field must have a data_type of multiuserlookup or multiselectlookup." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "description": "Contains an array of lookup object references used in the multi-select comparison.", "items": { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectRequest", "x-zs-$id": "MultiSelectLookupFilterCriterionRequestValueArrayItems" }, "maxItems": 5, "minItems": 1, "type": "array", "x-zs-$id": "MultiSelectLookupFilterCriterionRequestValueArray" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "MultiSelectLookupFilterCriterionRequest" }, "MultiSelectLookupFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the response for a filter criterion using the include_all, include_any, exclude_all, and exclude_any comparators. Applicable only when the field's data_type is multiuserlookup or multiselectlookup.", "properties": { "$disrupted": { "description": "Indicates whether the multi-select lookup filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.", "type": "boolean" }, "comparator": { "description": "Represents the multi-select lookup comparison operator returned for the criterion. Applicable only when the field's data_type is multiuserlookup or multiselectlookup.\nPossible values:\ninclude_all - Matches records that include all specified lookup values.\ninclude_any - Matches records that include at least one of the specified lookup values.\nexclude_all - Matches records that exclude all specified lookup values.\nexclude_any - Matches records that exclude at least one of the specified lookup values.", "enum": [ "include_all", "include_any", "exclude_all", "exclude_any" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the multi-select lookup filter criterion response.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the multi-select lookup filter criterion was applied. The field has a data_type of multiuserlookup or multiselectlookup." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "description": "Contains an array of lookup object references returned for the multi-select comparison.", "items": { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectResponse", "x-zs-$id": "MultiSelectLookupFilterCriterionResponseValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "MultiSelectLookupFilterCriterionResponseValueArray" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "MultiSelectLookupFilterCriterionResponse" }, "MultipleLayoutAssociationDeletionErrorResponse": { "additionalProperties": false, "description": "Returned when the picklist option exists in multiple layouts and cannot be deleted. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "PickList field should be in at most one layout or in unused state in all layouts" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Multiple Layout Association Deletion Error Response", "type": "object", "x-zs-$id": "MultipleLayoutAssociationDeletionErrorResponse" }, "MultipleOrMultiErrorsError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a multiple or multi errors error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "MULTIPLE_OR_MULTI_ERRORS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "errors": { "description": "Contains additional context about the error.", "items": { "additionalProperties": false, "description": "Represents a single item in the MultipleOrMultiErrorsError array.", "properties": { "code": { "description": "Contains additional context about the error.", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "duplicate_record": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "Owner": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 101, "type": "string" }, "zuid": { "description": "Contains additional context about the error.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "id" ], "type": "object" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" }, "more_records": { "description": "Contains additional context about the error.", "type": "boolean" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Contains additional context about the error.", "type": "string" }, "status": { "description": "Contains additional context about the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "errors" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MultipleOrMultiErrorsError" }, "MultiselectLookupConfig": { "additionalProperties": false, "description": "Represents the multiselectlookup configuration for a related list, including the lookup field, linking module, and connected module details.", "properties": { "connected_details": { "additionalProperties": false, "description": "Details of the connected module and field in the multiselectlookup relationship.", "properties": { "field": { "additionalProperties": false, "description": "Field configuration in the connected module for the multiselectlookup relationship.", "properties": { "api_name": { "description": "API name of the field in the connected module.", "maxLength": 100, "type": "string" }, "field_label": { "description": "Display label of the field in the connected module.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique identifier of the field in the connected module.", "format": "int64", "type": "string" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Connected module information in the multiselectlookup relationship.", "properties": { "api_name": { "description": "API name of the connected module.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique identifier of the connected module.", "format": "int64", "type": "string" }, "plural_label": { "description": "Plural display label of the connected module.", "maxLength": 100, "type": "string" } }, "required": [ "plural_label", "api_name", "id" ], "type": "object" }, "related_list": { "additionalProperties": false, "description": "Related list information in the connected module.", "properties": { "api_name": { "description": "API name of the related list in the connected module.", "maxLength": 100, "type": "string" }, "display_label": { "description": "Display label of the related list in the connected module.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique identifier of the related list in the connected module.", "format": "int64", "type": "string" } }, "required": [ "display_label", "api_name", "id" ], "type": "object" } }, "required": [ "field", "module", "related_list" ], "type": "object" }, "field": { "additionalProperties": false, "description": "Lookup field configuration for the multiselectlookup relationship.", "properties": { "api_name": { "description": "API name of the lookup field.", "maxLength": 100, "type": "string" }, "field_label": { "description": "Display label of the lookup field.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique identifier of the lookup field.", "format": "int64", "type": "string" } }, "required": [ "api_name", "field_label", "id" ], "type": "object" }, "field_enabled": { "description": "Indicates whether the multiselectlookup field is enabled. Possible values: **true**, **false**. ", "type": "boolean" }, "linking_details": { "additionalProperties": false, "description": "Details of the linking module that connects the two entities in the multiselectlookup.", "properties": { "connected_lookup_field": { "additionalProperties": false, "description": "Lookup field in the linking module that references the connected module.", "properties": { "api_name": { "description": "API name of the connected lookup field in the linking module.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique identifier of the connected lookup field in the linking module.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "lookup_field": { "additionalProperties": false, "description": "Lookup field in the linking module that references the source module.", "properties": { "api_name": { "description": "API name of the lookup field in the linking module that references the source module.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique identifier of the lookup field in the linking module.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Linking module information for the multiselectlookup relationship.", "properties": { "api_name": { "description": "API name of the linking module.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique identifier of the linking module.", "format": "int64", "type": "string" }, "plural_label": { "description": "Plural display label of the linking module.", "maxLength": 100, "type": "string" } }, "required": [ "plural_label", "api_name", "id" ], "type": "object" }, "visibility": { "description": "Visibility flag for the linking module relationship.", "format": "int32", "type": "integer" } }, "required": [ "visibility", "module", "lookup_field", "connected_lookup_field" ], "type": "object" } }, "required": [ "field", "linking_details", "connected_details", "field_enabled" ], "type": "object", "x-zs-$id": "MultiselectLookupConfig" }, "MultiselectPicklistReplaceNotAllowedErrorResponse": { "additionalProperties": false, "description": "Returned when attempting to replace picklist options on a multiselect picklist field, which is not supported.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "resource_path_index": { "description": "Resource path index", "format": "int64", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "PickList option replace not allowed" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Multiselect Picklist Replace Not Allowed Error Response", "type": "object", "x-zs-$id": "MultiselectPicklistReplaceNotAllowedErrorResponse" }, "NameLimitExceededErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the webhook name exceeds the maximum allowed character length.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook name exceeds the maximum allowed length.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field for which the name length limit is exceeded.", "properties": { "api_name": { "description": "Represents the API name of the field for which the name length limit is exceeded.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field for which the name length limit is exceeded.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field value.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The lenght of name has exceeded the limit** - The webhook name exceeds the maximum allowed character limit.", "enum": [ "The lenght of name has exceeded the limit" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Name Character Limit Exceeded Error Response", "type": "object", "x-zs-$id": "NameLimitExceededErrorResponse", "x-zs-llm-description": "Webhook name exceeds the maximum character limit. Shorten the name." }, "NoPermission": { "additionalProperties": false, "description": "Error envelope returned when the authenticated user does not have permission to access the data enrichment feature.", "properties": { "code": { "description": "Identifies the permission failure that was raised.\n\nPossible values:\n**NO_PERMISSION** - The authenticated user lacks the profile permission required to access the data enrichment feature.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the permission failure. This object remains empty for this error.", "properties": {}, "type": "object" }, "message": { "description": "You do not have the Manage or View Data Enrichment permission to access this feature.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because the user lacks the required permission.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NoPermission" }, "NoPermissionContactsError": { "additionalProperties": false, "description": "Represents the error response when the user does not have permission to view contacts.", "properties": { "code": { "const": "NO_PERMISSION", "description": "Error code indicating lack of permission", "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing permissions", "properties": { "permissions": { "description": "List of required permissions that are missing", "items": { "const": "Crm_Implied_View_Contacts", "description": "Permission identifier for viewing contacts", "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "const": "permission denied", "description": "Error message indicating permission denial", "type": "string" }, "status": { "const": "error", "description": "Response status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NoPermissionContactsError" }, "NoPermissionDealsError": { "additionalProperties": false, "description": "Represents the error response when the user does not have permission to view deals.", "properties": { "code": { "const": "NO_PERMISSION", "description": "Error code indicating lack of permission", "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing permissions", "properties": { "permissions": { "description": "List of required permissions that are missing", "items": { "const": "Crm_Implied_View_Potentials", "description": "Permission identifier for viewing deals", "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "const": "permission denied", "description": "Error message indicating permission denial", "type": "string" }, "status": { "const": "error", "description": "Response status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NoPermissionDealsError" }, "NoPermissionManagePortalsDisabledError": { "additionalProperties": false, "description": "Returned when the 'Manage Portals' permission has been disabled for the authenticated user's profile, preventing access to portal configuration APIs.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An empty object included for consistency with other error response shapes. No additional details are provided for this error condition.", "properties": {}, "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "NoPermissionManagePortalsDisabledError" }, "NoPermissionSchema": { "additionalProperties": false, "description": "Represents the error response returned when the authenticated user does not have permission to access the requested feature or module.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "NO_PERMISSION", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents error details. For NO_PERMISSION, contains the list of permissions needed. For FEATURE_NOT_SUPPORTED, empty object.", "properties": { "permissions": { "description": "Represents the list of CRM profile permissions required to perform the requested action.", "items": { "description": "Represents the name of a CRM profile permission required for the requested action.", "maxLength": 255, "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "feature not available in this edition", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "NoPermissionSchema", "x-zs-llm-description": "Error codes: NO_PERMISSION or FEATURE_NOT_SUPPORTED. Returned when the user lacks ManageAutomation permission or the workflow feature is not available in the current CRM edition. Resolution: verify user permissions and edition capabilities." }, "NoSharingAvailableToRevokeErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when no sharing exists for the record through which the revoke operation can be performed.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "CANNOT_PROCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "No sharing through this record is available to revoke" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NoSharingAvailableToRevokeErrorResponse" }, "NoTagPermissionError": { "additionalProperties": false, "description": "Represents an error response returned when the user does not have permission to manage tags.", "properties": { "code": { "description": "Represents the error code **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing permission information.", "properties": { "permissions": { "description": "Represents an array of the required permissions for the operation.", "items": { "description": "Represents a required permission string for the tag operation.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message indicating insufficient permissions.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "NoTagPermissionError" }, "NonAssociateActionsNestedSchema": { "anyOf": [ { "$ref": "#/components/schemas/AssignOwnerActionSchema" }, { "$ref": "#/components/schemas/CreateRecordActionSchema" }, { "$ref": "#/components/schemas/CreateConnectedRecordActionSchema" }, { "$ref": "#/components/schemas/AddMeetingActionSchema" }, { "$ref": "#/components/schemas/ScheduleCallActionSchema" }, { "$ref": "#/components/schemas/AddTagsActionSchema" }, { "$ref": "#/components/schemas/RemoveTagsActionSchema" }, { "$ref": "#/components/schemas/ConvertActionSchema" }, { "$ref": "#/components/schemas/ChatNotificationActionSchema" }, { "$ref": "#/components/schemas/CircuitsActionSchema" }, { "$ref": "#/components/schemas/ZohoFlowActionSchema" }, { "$ref": "#/components/schemas/SocialActionSchema" }, { "$ref": "#/components/schemas/EmailCreateRecordActionSchema" } ], "description": "Represents an inline action configuration that is defined directly within the workflow rule condition, rather than referencing a pre-created action entity by ID.", "discriminator": { "propertyName": "type" }, "x-zs-$id": "NonAssociateActionsNestedSchema", "x-zs-llm-description": "Union (oneOf) for inline action configurations. Routes by type to: AssignOwnerActionSchema, CreateRecordActionSchema, AddMeetingActionSchema, ScheduleCallActionSchema, AddTagsActionSchema, RemoveTagsActionSchema, ConvertActionSchema, ChatNotificationActionSchema, CircuitsActionSchema, ZohoFlowActionSchema, SocialActionSchema, EmailCreateRecordActionSchema, CreateConnectedRecordActionSchema. Each carries type + details with full inline config." }, "NotAllowedDataValueError": { "additionalProperties": false, "description": "This error occurs when the data provided in the request doesn't meet the expected requirements. The details structure varies based on the cause not allowed value", "properties": { "code": { "description": "A unique identifier for this type of error.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/InvalidDataFieldValueDetails", "description": "Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error." }, "message": { "description": "A clear explanation of what went wrong and why the operation could not complete.", "type": "string" }, "status": { "description": "Indicates whether the operation succeeded or failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedDataValueError" }, "NotAllowedDeleteErrorResponse": { "additionalProperties": false, "description": "Represents the error response when deleting a territory is not permitted.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the ID of the territory that cannot be deleted.", "properties": { "id": { "description": "Represents the unique ID of the territory that cannot be deleted.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message returned when a territory cannot be deleted. Possible values: **Territory can't be deleted as it's having child**, **Org Territory cannot be deleted**, **Reporting_to id should not be the child of given territory. Chosse another territory as Reporing_to**.", "enum": [ "Territory can't be deleted as it's having child", "Org Territory cannot be deleted", "Org Territory cannot be deleted.", "Reporting_to id should not be the child of given territory. Chosse another territory as Reporing_to" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "NotAllowedDeleteErrorResponse" }, "NotAllowedDeleteErrorResponseInURL": { "additionalProperties": false, "description": "Represents the error response when a territory cannot be deleted because it has child territories.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the URL path index of the invalid resource.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the URL path segment that identifies the resource that cannot be deleted.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message returned when the territory cannot be deleted. Possible values: **Territory can't be deleted as it's having child**, **Org Territory cannot be deleted**.", "enum": [ "Territory can't be deleted as it's having child", "Org Territory cannot be deleted" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "NotAllowedDeleteErrorResponseInURL" }, "NotAllowedDetails": { "additionalProperties": false, "description": "Represents the details of associations that prevent the deletion of a Custom View, including the association type and the list of associated resources.", "properties": { "associations": { "description": "Represents the list of associations that prevent the deletion of the Custom View.", "items": { "additionalProperties": false, "description": "Represents an association entry containing the association type and the list of associated resources.", "properties": { "resources": { "description": "Represents the list of resources associated with this association type.", "items": { "additionalProperties": false, "description": "Represents a resource that prevents deletion when associated with the Custom View.", "properties": { "id": { "description": "Represents the unique identifier of the associated resource.", "format": "int64", "maxLength": 25, "type": "string" }, "name": { "description": "Represents the display name of the associated resource.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "maxItems": 100, "type": "array" }, "type": { "description": "Represents the association type, indicating the feature or module the resource belongs to.", "maxLength": 50, "type": "string" } }, "required": [ "type", "resources" ], "type": "object" }, "maxItems": 50, "type": "array" }, "id": { "description": "Represents the unique ID of the Custom View that cannot be deleted.", "format": "int64", "maxLength": 25, "type": "string" } }, "required": [ "id", "associations" ], "type": "object", "x-zs-$id": "NotAllowedDetails" }, "NotAllowedDetailsDelete": { "additionalProperties": false, "description": "Represents the error details returned when a Custom View cannot be deleted due to active associations.", "properties": { "code": { "description": "Represents the error code for the not allowed deletion.\nPossible values:\n**NOT_ALLOWED** - The Custom View cannot be deleted because it has active associations.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/NotAllowedDetails" }, "message": { "description": "Represents the error message describing why the deletion is not allowed.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedDetailsDelete" }, "NotAllowedDetailsUpdate": { "additionalProperties": false, "description": "Represents the error details returned when a resource cannot be updated due to active associations.", "properties": { "code": { "description": "Represents the error code for the not allowed update.\nPossible values:\n**NOT_ALLOWED** - The resource cannot be updated because it has active associations.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/NotAllowedDetails" }, "message": { "description": "Represents the error message describing why the update is not allowed.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedDetailsUpdate" }, "NotAllowedErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the specified module is not supported for webhook operations.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The operation is not allowed for the specified module.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the unsupported module or resource.", "properties": { "api_name": { "description": "Represents the API name of the unsupported module.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the unsupported module field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The given module is not supported** - The module specified in the request does not support webhook automation.", "enum": [ "The given module is not supported" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedErrorResponse", "x-zs-llm-description": "The specified module is not supported for webhook operations." }, "NotAllowedForUpdateCVById": { "additionalProperties": false, "description": "Represents the error details returned when the update request contains a field that cannot be modified.", "properties": { "code": { "description": "Represents the error code for the not allowed update.\nPossible values:\n**NOT_ALLOWED** - The specified field cannot be updated.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the field that triggered the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the NOT_ALLOWED error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the field that triggered the NOT_ALLOWED error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the update is not allowed.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedForUpdateCVById" }, "NotAllowedOperationError": { "additionalProperties": false, "description": "Error returned when attempting to perform an operation on the default unsubscribe link, which is not allowed.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the not-allowed operation error.", "properties": { "api_name": { "description": "The API name of the field causing the error", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the field causing the error", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the not-allowed operation.", "enum": [ "The given Unsubscribe Link id is Default" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedOperationError" }, "NotAllowedOrgTerritoryUpdate": { "additionalProperties": false, "description": "Represents the error response when updating the root organization territory is not permitted.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for the organization territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when the organization territory cannot be updated. Possible values: **Organization territory can only be updated**, **Cannot update the Org Territory except Name**.", "enum": [ "Organization territory can only be updated", "Cannot update the Org Territory except Name" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "NotAllowedOrgTerritoryUpdate" }, "NotAllowedUnsubscribeLinkIdError": { "additionalProperties": false, "description": "Error returned when attempting to update or delete the default unsubscribe link, which is not allowed.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the not-allowed operation on a default link.", "properties": { "resource_path_index": { "description": "The index position in the URL path where the default link ID was found", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the not-allowed operation on a default unsubscribe link.", "enum": [ "The given Unsubscribe Link id is Default" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedUnsubscribeLinkIdError" }, "NotApprovedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a not approved error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "NOT_APPROVED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "resource_path_index": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotApprovedError" }, "NotEqualFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a filter criterion for the not_equal comparator. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime fields; SimpleFilterCriterionValueNumber for integer, currency, or double fields; SimpleFilterCriterionValueBoolean for Boolean fields; SimpleFilterCriterionValueObjectRequest for lookup, ownerlookup, or userlookup fields; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders.", "properties": { "comparator": { "description": "Represents the not-equal comparison operator applied to the criterion.\nPossible values:\nnot_equal - Matches records where the field value does not equal the specified filter value.", "enum": [ "not_equal" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the not-equal filter criterion.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the not-equal filter criterion is applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Contains an array of filter values for the not_equal comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectRequest" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" } ], "x-zs-$id": "NotEqualFilterCriterionRequestValueArrayItemsObject" } ], "x-zs-$id": "NotEqualFilterCriterionRequestValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "NotEqualFilterCriterionRequestValueArray" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueBoolean" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectRequest" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueAgeDuePredefined" } ], "description": "Represents the filter value used in the not_equal comparator. Accepts a scalar or an array of values, depending on the field's data_type." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "NotEqualFilterCriterionRequest" }, "NotEqualFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the response for a filter criterion using the not_equal comparator. The value type is determined by the field's data_type: SimpleFilterCriterionValueString for text-based types; SimpleFilterCriterionValueNumber for numeric types; SimpleFilterCriterionValueBoolean for Boolean; SimpleFilterCriterionValueObjectResponse for lookup types; and SimpleFilterCriterionValueObjectPredefined for predefined user or role placeholders.", "properties": { "$disrupted": { "description": "Indicates whether the not-equal filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.", "type": "boolean" }, "comparator": { "description": "Represents the not-equal comparison operator returned for the criterion.\nPossible values:\nnot_equal - Matches records where the field value does not equal the specified filter value.", "enum": [ "not_equal" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the not-equal filter criterion response.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the not-equal filter criterion was applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "value", "pre_defined", "field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Contains an array of filter values returned for the not_equal comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectResponse" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" } ], "x-zs-$id": "NotEqualFilterCriterionResponseValueArrayItemsObject" } ], "x-zs-$id": "NotEqualFilterCriterionResponseValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "NotEqualFilterCriterionResponseValueArray" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueBoolean" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectResponse" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectPredefined" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueAgeDuePredefined" } ], "description": "Represents the filter value returned for the not_equal comparator. Contains a scalar or an array of values, depending on the field's data_type." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "NotEqualFilterCriterionResponse" }, "NotInUseStatusWithFutureUnavailableFromError": { "additionalProperties": false, "description": "Error response returned when the service Status is Not In Use but Unavailable_From is later than the current date.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the service cannot have a future Unavailable From date when the status is Not in Use.", "enum": [ "Services status cannot be marked as Not In Use when Unavailable From falls after the current Date" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Not In Use Status Conflicts with Future Unavailable From", "type": "object", "x-zs-$id": "NotInUseStatusWithFutureUnavailableFromError" }, "NotReviewedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a not reviewed error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "NOT_REVIEWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotReviewedError" }, "NotSupportedApiName": { "additionalProperties": false, "description": "Represents the error response returned when the API name specified in a criterion field is not supported by the target module. Contains the error code, a descriptive message, the response status, and details identifying the unsupported field and its location in the request body.", "properties": { "code": { "description": "Represents the error code that identifies the category of validation failure.\nPossible values:\nNOT_SUPPORTED - Indicates that the API name specified for the criterion field is not supported by the target module.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains detailed information identifying the criterion field whose API name is not supported by the target module, including the field API name and its location within the request body.", "properties": { "api_name": { "description": "Represents the API name of the criterion field that is not supported by the target module.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path that locates the unsupported criterion field within the request body.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the criterion field API name is not supported by the target module.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the outcome status of the response for this error condition.\nPossible values:\nerror - Indicates the request failed because the specified criterion field API name is not supported by the target module.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotSupportedApiName" }, "NotSupportedFieldsInFilters": { "additionalProperties": false, "description": "Represents the error response when unsupported fields are used in filter parameters.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the name of the unsupported filter parameter.", "properties": { "param_name": { "description": "Represents the name of the unsupported filter parameter. Possible values: **filters**.", "enum": [ "filters" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message returned when an unsupported field is used in filters. Possible values: **The given api_name(description) is not supported**, **The given api_name(reporting_to) is not supported**, **The given api_name(manager) is not supported**, **Specify Atleast one field**.", "enum": [ "The given api_name(description) is not supported", "The given api_name(reporting_to) is not supported", "The given api_name(manager) is not supported", "Specify Atleast one field" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "NotSupportedFieldsInFilters" }, "NotSupportedFiltersError": { "additionalProperties": false, "description": "Error response when filters are not supported for the specified module's related list. Response is wrapped in get_related_records_count array.", "properties": { "get_related_records_count": { "description": "Array containing the error details for unsupported filters", "items": { "additionalProperties": false, "description": "Error details for unsupported filters", "properties": { "code": { "description": "Error code for unsupported operation", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsNotSupportedFilters" }, "message": { "description": "Human-readable error message describing the unsupported filters", "enum": [ "Filters are not supported for this modules" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "NotSupportedFiltersError" }, "NotSupportedForCriteriaOnModuleDisable": { "additionalProperties": false, "description": "Represents the error response when a criteria field references a module that is disabled.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name and JSON path associated with the disabled module.", "properties": { "api_name": { "description": "Represents the API name of the field whose criteria cannot be set because the module is disabled.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field in the request body that references the disabled module.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when criteria cannot be set for a disabled module. Possible values: **Unable to set rules criteria for disabled module**, **Lead Rule Disabled**, **Deal Rule Disabled**, **Territory Deal Rule Disabled**, **Territory Lead Rule Disabled**, **Inactive User**.", "enum": [ "Unable to set rules criteria for disabled module", "Lead Rule Disabled", "Deal Rule Disabled", "Territory Deal Rule Disabled", "Territory Lead Rule Disabled", "Inactive User" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "NotSupportedForCriteriaOnModuleDisable" }, "NotSupportedRelatedListError": { "additionalProperties": false, "description": "Error response when the given related list ID is not supported in API. Response is wrapped in get_related_records_count array.", "properties": { "get_related_records_count": { "description": "Array containing the error details for unsupported related list", "items": { "additionalProperties": false, "description": "Error details for unsupported related list", "properties": { "code": { "description": "Error code for unsupported related list", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsEmpty" }, "message": { "description": "Human-readable error message describing the unsupported related list", "enum": [ "The given related list id is not supported in api" ], "type": "string" }, "status": { "description": "The status of the response, always 'error' for error responses", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "NotSupportedRelatedListError" }, "NotesCannotPerformActionError": { "additionalProperties": false, "description": "Error response when user cannot perform action on a record", "properties": { "data": { "description": "Array of error results", "items": { "additionalProperties": false, "description": "Error details for cannot perform action", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CannotPerformActionError" }, "NotesCannotPerformActionErrorSingle": { "additionalProperties": false, "description": "Error response when user cannot perform action on a record in single record operations", "properties": { "data": { "description": "Array of error results for single record", "items": { "additionalProperties": false, "description": "Error details for cannot perform action", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CannotPerformActionErrorSingle" }, "NotesDiscretePaginationLimitExceededError": { "additionalProperties": false, "description": "Error response for pagination limit exceeded", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "DISCRETE_PAGINATION_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the pagination limit", "properties": { "limit": { "description": "Maximum number of records that can be retrieved without page_token", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DiscretePaginationLimitExceededError" }, "NotesExpectedFieldMissingError": { "additionalProperties": false, "description": "Error response for missing expected fields", "properties": { "data": { "description": "Array of error results", "items": { "additionalProperties": false, "description": "Error details for missing expected fields", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "expected_fields": { "description": "List of expected fields that are missing", "items": { "additionalProperties": false, "description": "Expected field details", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the expected field", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingError" }, "NotesFileSizeExceedsError": { "additionalProperties": false, "description": "Error response when attachment file size exceeds the limit", "properties": { "data": { "description": "Array of error results", "items": { "additionalProperties": false, "description": "Error details for file size exceeded", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "FILE_SIZE_EXCEEDS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "API name of the field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "FileSizeExceedsError" }, "NotesInvalidDataError": { "additionalProperties": false, "description": "Error response for invalid field data", "properties": { "data": { "description": "Array of error results", "items": { "additionalProperties": false, "description": "Error details for invalid data", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error, can include various constraint information", "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "InvalidDataError" }, "NotesInvalidIdError": { "additionalProperties": false, "description": "Error response when an invalid record ID is provided", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "resource_path_index": { "description": "Index in the resource path where the invalid ID was found", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidIdError" }, "NotesMandatoryNotFoundError": { "additionalProperties": false, "description": "Error response for mandatory field not found", "properties": { "data": { "description": "Array of error results", "items": { "additionalProperties": false, "description": "Error details for missing mandatory field", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "The API name of the missing mandatory field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the missing field", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, "NotesNoPermissionError": { "additionalProperties": false, "description": "Error response when user lacks required permissions", "properties": { "data": { "description": "Array of error results", "items": { "additionalProperties": false, "description": "Error details for permission denied", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about required permissions", "properties": { "permissions": { "description": "List of required permissions", "items": { "description": "Permission name", "maxLength": 255, "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NoPermissionError" }, "NotesNotAllowedError": { "additionalProperties": false, "description": "Error response when operation is not allowed", "properties": { "data": { "description": "Array of error results", "items": { "additionalProperties": false, "description": "Error details for not allowed operation", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "API name of the field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotAllowedError" }, "NotesNotAllowedErrorSingle": { "additionalProperties": false, "description": "Error response when operation is not allowed in single record operations", "properties": { "data": { "description": "Array of error results for single record", "items": { "additionalProperties": false, "description": "Error details for not allowed operation", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "API name of the field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotAllowedErrorSingle" }, "NotesRequiredParamMissingError": { "additionalProperties": false, "description": "Error response for required parameter missing", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error", "properties": { "param_name": { "description": "The name of the missing parameter", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Error message returned when the operation fails.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "NotificationsErrorDetails": { "additionalProperties": false, "description": "Represents the detailed error information associated with a specific parameter or field that caused the request to fail.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields that caused ambiguity during request processing.", "items": { "additionalProperties": false, "description": "Represents a field that contributed to the ambiguity during processing.", "properties": { "api_name": { "description": "Represents the API name of the field that caused ambiguity.", "maxLength": 64, "type": "string" }, "json_path": { "description": "Represents the JSON path indicating the location of the ambiguous field in the request payload.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" }, "api_name": { "description": "Represents the API name of the parameter or field that caused the error.", "maxLength": 64, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of a required dependent field that was missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the missing dependent field.", "maxLength": 64, "type": "string" }, "json_path": { "description": "Represents the JSON path indicating the location of the missing dependent field in the request payload.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "expected_data_type": { "description": "Represents the expected data type for the parameter or field that caused the error.", "maxLength": 64, "type": "string" }, "expected_fields": { "description": "Represents the list of fields required when at least one of several expected fields is missing.", "items": { "additionalProperties": false, "description": "Represents a field that is required but was not found in the request.", "properties": { "api_name": { "description": "Represents the API name of the required field.", "maxLength": 64, "type": "string" }, "json_path": { "description": "Represents the JSON path indicating the location of the required field in the request payload.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" }, "json_path": { "description": "Represents the JSON path indicating the location of the error in the request payload.", "maxLength": 256, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the parameter or field that caused the error.", "format": "int32", "type": "integer" }, "supported_values": { "description": "Represents the list of supported values for the parameter or field that caused the error.", "items": { "description": "Represents a single supported value for the parameter or field.", "maxLength": 64, "type": "string" }, "maxItems": 2, "type": "array" } }, "type": "object" }, "NotificationsErrorResponse": { "additionalProperties": false, "description": "Represents the standard error response structure returned when a request fails.", "properties": { "code": { "description": "Represents the specific error code identifying the type of failure.", "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" ], "type": "string" }, "details": { "$ref": "#/components/schemas/NotificationsErrorDetails" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "default": "error", "description": "Represents the response status.\n**Possible values:**\n**error** - Indicates an error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponse" }, "NotifyMembersWithoutFeeds": { "additionalProperties": false, "description": "Represents the error response returned when **notify_shared_members** is requested but Feeds is not enabled or is not supported for the share type.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "enum": [ "notify_shared_members" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the notify_shared_members parameter that caused the error. ", "enum": [ "$.notify_shared_members" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents the response message returned by the API. \n\n**Possible values**: \n- Feeds is not enabled for this org.\n- Feeds Notification is not allowed for this type.\n", "enum": [ "Feeds is not enabled for this org", "Feeds Notification is not allowed for this type" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotifyMembersWithoutFeeds" }, "OAuthScopeMismatchErrorResponse": { "additionalProperties": false, "description": "Error response when access token does not include the required OAuth scope.", "properties": { "code": { "description": "Error code", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": {}, "type": "object" }, "message": { "description": "Error message", "example": "Unauthorized", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "OAuth Scope Mismatch Error Response", "type": "object", "x-zs-$id": "OAuthScopeMismatchErrorResponse", "x-zs-llm-description": "The access token lacks the required OAuth scope. Re-authorize with the correct scope (ZohoCRM.settings.automation.ALL or ZohoCRM.settings.automation.CREATE/UPDATE/DELETE)." }, "OrderingFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a filter criterion for the less_than, less_equal, greater_than, and greater_equal comparators. The value must be a scalar; arrays and objects are not supported. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields.", "properties": { "comparator": { "description": "Represents the ordering comparison operator applied to the criterion.\nPossible values:\nless_than - Matches records where the field value is less than the specified filter value.\nless_equal - Matches records where the field value is less than or equal to the specified filter value.\ngreater_than - Matches records where the field value is greater than the specified filter value.\ngreater_equal - Matches records where the field value is greater than or equal to the specified filter value.", "enum": [ "less_than", "less_equal", "greater_than", "greater_equal" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the ordering filter criterion.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the ordering filter criterion is applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueAgeDuePredefined" } ], "description": "Represents the scalar filter value used in the ordering comparator. Arrays and objects are not supported for ordering comparators." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "OrderingFilterCriterionRequest" }, "OrderingFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the response for a filter criterion using the less_than, less_equal, greater_than, and greater_equal comparators. The value is a scalar; arrays and objects are not valid.", "properties": { "$disrupted": { "description": "Indicates whether the ordering filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.", "type": "boolean" }, "comparator": { "description": "Represents the ordering comparison operator returned for the criterion.\nPossible values:\nless_than - Matches records where the field value is less than the specified filter value.\nless_equal - Matches records where the field value is less than or equal to the specified filter value.\ngreater_than - Matches records where the field value is greater than the specified filter value.\ngreater_equal - Matches records where the field value is greater than or equal to the specified filter value.", "enum": [ "less_than", "less_equal", "greater_than", "greater_equal" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the ordering filter criterion response.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the ordering filter criterion was applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueAgeDuePredefined" } ], "description": "Represents the scalar filter value returned for the ordering comparator." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "OrderingFilterCriterionResponse" }, "OrgDetails": { "additionalProperties": false, "description": "Represents the organization details for the Zoho CRM account, including company information, currency settings, license details, and hierarchy preferences.", "properties": { "alias": { "anyOf": [ { "description": "Represents the alias of the organization when one is set.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgAlias" }, { "description": "Represents a null value when no alias is set for the organization.", "type": "null", "x-zs-$id": "OrgAliasNull" } ], "description": "Represents the alias name of the organization." }, "city": { "anyOf": [ { "description": "Represents the city where the organization is located when a value is available.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgCity" }, { "description": "Represents a null value when no city is set for the organization.", "type": "null", "x-zs-$id": "OrgCityNull" } ], "description": "Represents the city where the organization is located." }, "company_name": { "anyOf": [ { "description": "Represents the name of the organization when one is set.", "maxLength": 100, "type": "string", "x-zs-$id": "OrgCompanyName" }, { "description": "Represents a null value when the company name has not been set.", "readOnly": true, "type": "null", "x-zs-$id": "OrgCompanyNameNull" } ], "description": "Represents the name of the organization." }, "country": { "anyOf": [ { "description": "Represents the country of the organization when a value is available.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgCountry" }, { "description": "Represents a null value when no country is set for the organization.", "type": "null", "x-zs-$id": "OrgCountryNull" } ], "description": "Represents the country of the organization." }, "country_code": { "anyOf": [ { "description": "Represents the country code of the organization when a value is available.", "maxLength": 10, "type": "string", "x-zs-$id": "OrgCountryCode" }, { "description": "Represents a null value when no country code is set for the organization.", "type": "null", "x-zs-$id": "OrgCountryCodeNull" } ], "description": "Represents the country code of the organization." }, "created_time": { "description": "Represents the creation date and time of the organization.", "format": "date-time", "readOnly": true, "type": "string" }, "currency": { "description": "Represents the home currency of the organization.", "maxLength": 30, "type": "string" }, "currency_locale": { "description": "Represents the locale code for the organization's home currency. For instance, 'en_IN'.", "maxLength": 10, "type": "string" }, "currency_symbol": { "description": "Represents the currency symbol for the organization's home currency.", "maxLength": 5, "minLength": 1, "type": "string" }, "deletable_org_account": { "description": "Indicates whether the organization account can be deleted.\nPossible values:\n**true** - The organization can be deleted.\n**false** - The organization cannot be deleted.", "readOnly": true, "type": "boolean" }, "description": { "anyOf": [ { "description": "Represents the description of the organization when one is provided.", "maxLength": 250, "type": "string", "x-zs-$id": "OrgDescription" }, { "description": "Represents a null value when no description is set for the organization.", "type": "null", "x-zs-$id": "OrgDescriptionNull" } ], "description": "Represents the description of the organization." }, "domain_name": { "description": "Represents the domain name of the organization. For instance, org694902300.", "maxLength": 30, "pattern": "[a-z][a-z0-9]{4,30}", "type": "string" }, "employee_count": { "anyOf": [ { "description": "Represents the number of employees in the organization when a value is available.", "maxLength": 18, "pattern": "[0-9]+", "type": "string", "x-zs-$id": "OrgEmployeeCount" }, { "description": "Represents a null value when no employee count is set for the organization.", "type": "null", "x-zs-$id": "OrgEmployeeCountNull" } ], "description": "Represents the number of employees in the organization." }, "fax": { "anyOf": [ { "description": "Represents the fax number of the organization when one is provided.", "maxLength": 30, "type": "string", "x-zs-$id": "OrgFax" }, { "description": "Represents a null value when no fax number is set for the organization.", "type": "null", "x-zs-$id": "OrgFaxNull" } ], "description": "Represents the fax number of the organization." }, "gapps_enabled": { "description": "Indicates whether Google Apps integration is enabled for the organization.\nPossible values:\n**true** - Google Apps integration is enabled.\n**false** - Google Apps integration is not enabled.", "readOnly": true, "type": "boolean" }, "hierarchy_preferences": { "additionalProperties": false, "description": "Represents the hierarchy preferences configured for the organization.", "properties": { "strictly_reporting": { "description": "Indicates whether data visibility is restricted to the direct reporting chain.\nPossible values:\n**true** - Data is visible only to the CEO and administrators.\n**false** - Data is visible to any user higher in the hierarchy.", "type": [ "boolean", "null" ] }, "type": { "description": "Represents the hierarchy type configured for the organization. \nPossible values:\n**Role_Hierarchy** - Access is based on the user's role in the hierarchy.\n**Reporting_To_Hierarchy** - Access is based on the user's reporting structure.", "enum": [ "Role_Hierarchy", "Reporting_To_Hierarchy" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "hipaa_compliance_enabled": { "description": "Indicates whether [HIPAA compliance](https://www.zoho.com/crm/developer/docs/api/v8/hipaa-compliance.html) is enabled for the organization.\nPossible values:\n**true** - HIPAA compliance is enabled.\n**false** - HIPAA compliance is not enabled.", "readOnly": true, "type": "boolean" }, "id": { "description": "Represents the unique ID of the organization.", "maxLength": 19, "readOnly": true, "type": "string", "x-zs-$id": "OrgId" }, "iso_code": { "description": "Represents the ISO code of the organization's home currency.", "maxLength": 10, "type": "string" }, "license_details": { "additionalProperties": false, "description": "Represents the license and subscription details for the organization.", "properties": { "paid": { "description": "Indicates whether the organization has a paid subscription.\nPossible values:\n**true** - The organization has a paid subscription.\n**false** - The organization does not have a paid subscription.", "readOnly": true, "type": "boolean" }, "paid_expiry": { "anyOf": [ { "description": "Represents the license details variant.", "format": "date-time", "type": "string", "x-zs-$id": "OrgLicenseDetailsPaidExpiry" }, { "description": "Represents the license details variant.", "type": "null", "x-zs-$id": "OrgLicenseDetailsPaidExpiryNull" } ], "description": "Represents the expiry date of the paid license for the organization.", "readOnly": true }, "paid_type": { "description": "Represents the license type for the organization.\nPossible values:\n**free** - Free edition.\n**standard** - Standard edition.\n**professional** - Professional edition.\n**enterprise** - Enterprise edition.\n**ultimate** - Ultimate edition.\n**crmplus** - CRM Plus edition.\n**zohoone** - Zoho One edition.", "enum": [ "free", "standard", "professional", "enterprise", "ultimate", "crmplus", "zohoone" ], "readOnly": true, "type": "string" }, "portal_users_license_purchased": { "description": "Represents the number of portal user licenses purchased for the organization.", "format": "int32", "readOnly": true, "type": "integer" }, "trial_expiry": { "anyOf": [ { "description": "Represents the license details variant.", "format": "date-time", "type": "string", "x-zs-$id": "OrgLicenseDetailsTrialExpiry" }, { "description": "Represents the license details variant.", "type": "null", "x-zs-$id": "OrgLicenseDetailsTrialExpiryNull" } ], "description": "Represents the expiry date of the trial subscription for the organization." }, "trial_type": { "anyOf": [ { "description": "Represents the license details variant.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgLicenseDetailsTrialType" }, { "description": "Represents the license details variant.", "type": "null", "x-zs-$id": "OrgLicenseDetailsTrialTypeNull" } ], "description": "Represents the type of trial subscription for the organization.", "readOnly": true }, "users_license_purchased": { "description": "Represents the number of user licenses purchased for the organization.", "format": "int32", "readOnly": true, "type": "integer" } }, "readOnly": true, "required": [ "users_license_purchased", "paid", "paid_type", "portal_users_license_purchased" ], "type": "object" }, "lite_users_enabled": { "description": "Indicates whether lite users are enabled for the organization.\nPossible values:\n**true** - Lite users are enabled.\n**false** - Lite users are not enabled.", "readOnly": false, "type": "boolean" }, "mc_status": { "description": "Indicates the multi-currency status of the organization.\nPossible values:\n**true** - Multi-currency is enabled.\n**false** - Multi-currency is not enabled.", "readOnly": true, "type": [ "boolean", "null" ] }, "mobile": { "anyOf": [ { "description": "Represents the mobile phone number of the organization when one is provided.", "maxLength": 30, "pattern": "^[+]?([0-9A-Za-z()\\.\\-\\s]){1,30}$", "type": "string", "x-zs-$id": "OrgMobile" }, { "description": "Represents a null value when no mobile number is set for the organization.", "type": "null", "x-zs-$id": "OrgMobileNull" } ], "description": "Represents the mobile phone number of the organization." }, "phone": { "anyOf": [ { "description": "Represents the phone number of the organization when one is provided.", "maxLength": 30, "pattern": "^[+]?([0-9A-Za-z()\\.\\-\\s]){1,30}$", "type": "string", "x-zs-$id": "OrgPhone" }, { "description": "Represents a null value when no phone number is set for the organization.", "type": "null", "x-zs-$id": "OrgPhoneNull" } ], "description": "Represents the primary phone number of the organization." }, "photo_id": { "anyOf": [ { "description": "Represents the photo ID of the organization's logo when one is available. Refer to the [POST - Upload Files to Zoho File System (ZFS) API](files.yaml#$.path./files.post) for more details.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgPhotoID" }, { "description": "Represents a null value when no logo is set for the organization.", "type": "null", "x-zs-$id": "OrgPhotoIDNull" } ], "description": "Represents the photo ID of the organization's logo. Refer to [upload files API](https://www.zoho.com/crm/developer/docs/api/v8/upload-files-to-zfs.html) for more details.", "readOnly": true }, "primary_email": { "anyOf": [ { "description": "Represents the email address of the super admin when one is assigned to the organization.", "maxLength": 100, "type": "string", "x-zs-$id": "OrgPrimaryEmail" }, { "description": "Represents a null value when no super admin is assigned to the organization.", "type": "null", "x-zs-$id": "OrgPrimaryEmailNull" } ], "description": "Represents the email address of the super admin of the organization." }, "primary_zuid": { "anyOf": [ { "description": "Represents the Zoho user ID (ZUID) of the super admin when one is assigned.", "maxLength": 19, "type": "string", "x-zs-$id": "OrgPrimaryZuid" }, { "description": "Represents a null value when no super admin is assigned to the organization.", "readOnly": true, "type": "null", "x-zs-$id": "OrgPrimaryZuidNull" } ], "description": "Represents ZUID of the organization. This is the ID visible in the profile details in Zoho CRM UI." }, "privacy_settings": { "description": "Indicates whether privacy settings are enabled for the organization.\nPossible values:\n**true** - Privacy settings are enabled.\n**false** - Privacy settings are not enabled.", "readOnly": true, "type": "boolean" }, "state": { "anyOf": [ { "description": "Represents the state or province of the organization when a value is available.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgState" }, { "description": "Represents a null value when no state is set for the organization.", "type": "null", "x-zs-$id": "OrgStateNull" } ], "description": "Represents the state or province where the organization is located." }, "street": { "anyOf": [ { "description": "Represents the street address of the organization when one is provided.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgStreet" }, { "description": "Represents a null value when no street address is set for the organization.", "type": "null", "x-zs-$id": "OrgStreetNull" } ], "description": "Represents the street address of the organization." }, "time_zone": { "description": "Represents the time zone configured for the organization.", "maxLength": 30, "type": "string" }, "translation_enabled": { "description": "Indicates whether translation is enabled for the organization.\nPossible values:\n**true** - Translation is enabled.\n**false** - Translation is not enabled.", "readOnly": true, "type": "boolean" }, "type": { "description": "Represents the type of the Zoho CRM organization.\nPossible values:\n**bigin** - Bigin organization.\n**production** - Standard production CRM organization.\n**sandbox** - Sandbox organization for testing.\n**developer** - Developer organization.", "enum": [ "bigin", "production", "sandbox", "developer" ], "readOnly": true, "type": "string" }, "website": { "anyOf": [ { "description": "Represents the website URL of the organization when one is provided.", "maxLength": 50, "type": "string", "x-zs-$id": "OrgWebsite" }, { "description": "Represents a null value when no website is set for the organization.", "type": "null", "x-zs-$id": "OrgWebsiteNull" } ], "description": "Represents the website URL of the organization." }, "zgid": { "description": "Represents the unique Zoho Group ID (ZGID) of the organization.", "maxLength": 19, "readOnly": true, "type": "string" }, "zia_portal_id": { "anyOf": [ { "description": "Represents the Zia portal ID associated with the organization when one exists.", "format": "int32", "type": "integer", "x-zs-$id": "OrgZiaPortalId" }, { "description": "Represents a null value when no Zia portal is associated with the organization.", "type": "null", "x-zs-$id": "OrgZiaPortalIdNull" } ], "description": "Represents Zia portal ID of the organization, if configured.", "readOnly": true }, "zip": { "anyOf": [ { "description": "Represents the postal code of the organization when one is provided.", "maxLength": 20, "type": "string", "x-zs-$id": "OrgZip" }, { "description": "Represents a null value when no postal code is set for the organization.", "type": "null", "x-zs-$id": "OrgZipNull" } ], "description": "Represents the postal code of the organization." } }, "type": "object" }, "OwnerBase": { "additionalProperties": true, "description": "Base schema for the service owner. Identifies the user who owns the service record by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "properties": { "email": { "description": "Specify the email address of the user who owns the service record.", "maxLength": 100, "type": [ "string", "null" ] }, "id": { "description": "Specify the unique ID of the user who owns the service record. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "enum": [ "4671651000000635001" ], "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Specify the display name of the user who owns the service record.", "enum": [ "Madeshwaran G" ], "maxLength": 100, "type": [ "string", "null" ] } }, "type": "object" }, "OwnerNestedV2": { "allOf": [ { "$ref": "#/components/schemas/OwnerBase" }, { "additionalProperties": true, "description": "Required fields for the Owner object when updating a service.", "required": [ "email" ], "type": "object" } ], "description": "Service owner schema used in update requests, where the email of the owner is required." }, "PaginationInfoResponse": { "additionalProperties": false, "description": "Represents the pagination metadata returned with list responses.", "properties": { "count": { "description": "Represents the total number of webhooks returned in the current page.", "format": "int32", "type": "integer" }, "max_limit": { "description": "Represents the maximum number of records allowed per page for this resource.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional pages of results are available.\nPossible values:\n**true** - More records exist beyond the current page.\n**false** - The current page contains the last records.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of records returned per page in the paginated response.", "format": "int32", "type": "integer" } }, "title": "Pagination Information Response", "type": "object", "x-zs-llm-description": "Pagination metadata for list responses. Use more_records to decide whether to fetch the next page." }, "PaginationLimitExceededGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a pagination limit exceeded GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "PAGINATION_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "param_name": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PaginationLimitExceededGETError" }, "ParamNameDetails": { "additionalProperties": false, "description": "Represents error details containing the parameter name associated with the error.", "properties": { "param_name": { "description": "Represents the parameter name associated with the error detail.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "ParamNameDetails" }, "ParamNameWithEnumDetails": { "additionalProperties": false, "description": "Represents error details containing the parameter name associated with the error.", "properties": { "param_name": { "description": "Represents the parameter name associated with the error detail.\nPossible values:\nids - The ids query parameter.", "enum": [ "ids" ], "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "ParamNameWithEnumDetails" }, "ParameterNameValueMandatoryError": { "additionalProperties": false, "description": "Represents the error returned when a parameter entry in module_parameters or custom_parameters is missing its name or value. Both fields are required for each entry.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**MANDATORY_NOT_FOUND** - Both name and value are required for each parameter entry in the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the parameter entry with the missing name or value.", "properties": { "api_name": { "description": "Represents the API name of the parameter field that is missing the required name or value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the parameter field that is missing the required name or value.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**the given parameter is invalid, specify both name and value** - Each parameter entry must include both a name and a value.", "enum": [ "the given parameter is invalid, specify both name and value" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ParameterNameValueMandatoryError", "x-zs-llm-description": "A parameter entry is missing its name or value. Both fields are required." }, "PartialSuccessItemError": { "additionalProperties": false, "description": "Per-item error entry inside the get_related_records_count array of a partial-success (HTTP 207) response. Indicates that this particular related list count request failed while other items in the same array may have succeeded.", "properties": { "code": { "description": "Error code identifying the failure reason for this item", "enum": [ "INVALID_DATA", "EXPECTED_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING", "NOT_SUPPORTED" ], "type": "string" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/ErrorDetailsFieldInfo" }, { "$ref": "#/components/schemas/ErrorDetailsExpectedFields" }, { "$ref": "#/components/schemas/ErrorDetailsAmbiguity" }, { "$ref": "#/components/schemas/ErrorDetailsNotSupportedFilters" }, { "$ref": "#/components/schemas/ErrorDetailsEmpty" } ], "description": "Additional context about the per-item error (field info, expected fields, ambiguity info, or unsupported-filter info depending on the error code)" }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \nPossible values:\n**error** - The request was unsuccessful.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PartialSuccessItemError" }, "PartialSuccessMandatoryNotFoundItemError": { "additionalProperties": false, "description": "Per-item MANDATORY_NOT_FOUND error entry inside the get_related_records_count array of a partial-success (HTTP 207) response. Indicates that a required field (such as related_list) was missing from this particular request item.", "properties": { "code": { "description": "Error code for missing mandatory field", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ErrorDetailsFieldInfo" }, "message": { "description": "Human-readable error message describing the missing mandatory field", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "The status of this item, always 'error' for failed items", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PartialSuccessMandatoryNotFoundItemError" }, "PartialSuccessMandatoryNotFoundResponse": { "additionalProperties": false, "description": "Multi-Status (HTTP 207) response returned when a request contains multiple related list count items where some succeed and others fail because a required field (such as related_list) is missing. Each entry in get_related_records_count corresponds positionally to a requested item and independently reports either success (count + related_list) or a MANDATORY_NOT_FOUND error (status, code, message, details).", "properties": { "get_related_records_count": { "description": "Array of per-item results, one entry per requested related list. Each entry is either a RelatedRecordCountResult (success) or a PartialSuccessMandatoryNotFoundItemError (failure).", "items": { "$ref": "#/components/schemas/PartialSuccessMandatoryNotFoundResponseItem" }, "maxItems": 20, "minItems": 1, "type": "array" } }, "required": [ "get_related_records_count" ], "type": "object", "x-zs-$id": "PartialSuccessMandatoryNotFoundResponse" }, "PartialSuccessMandatoryNotFoundResponseItem": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordCountResult" }, { "$ref": "#/components/schemas/PartialSuccessMandatoryNotFoundItemError" } ], "description": "A single entry inside the get_related_records_count array of a partial-success MANDATORY_NOT_FOUND response. Each entry is independently either a successful count result or a per-item MANDATORY_NOT_FOUND error.", "x-zs-$id": "PartialSuccessMandatoryNotFoundResponseItem" }, "PartialSuccessResponseItem": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordCountResult" }, { "$ref": "#/components/schemas/PartialSuccessItemError" } ], "description": "A single entry inside the get_related_records_count array of a partial-success response. Each entry is independently either a successful count result or a per-item error.", "x-zs-$id": "PartialSuccessResponseItem" }, "PastEndDateStatusConflictError": { "additionalProperties": false, "description": "Error response returned when Available_Till is earlier than the current date and the service Status is being set to Available, Scheduled, or Temporarily Unavailable.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the service status cannot be changed because the end date has already passed.", "enum": [ "End Date of service availability falls before the current Date, so service cannot be marked as Available or Scheduled or Temporarily Unavailable" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Past End Date Status Conflict", "type": "object", "x-zs-$id": "PastEndDateStatusConflictError" }, "PatchAssociationDetails": { "anyOf": [ { "additionalProperties": false, "description": "Represents the association details for a Field-Of-Lookup relationship, providing the lookup field and the related field that together define the association being updated.", "properties": { "lookup_field": { "additionalProperties": false, "description": "Represents the lookup field used to establish the association, identifiable by its ID, API name, or a combination of both.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "reference_id": { "$ref": "#/components/schemas/LayoutsReferenceId" } }, "type": "object" }, "related_field": { "additionalProperties": false, "description": "Represents the related field on the associated module used to complete the lookup association, identifiable by its ID or API name.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" } }, "type": "object" } }, "required": [ "related_field", "lookup_field" ], "type": "object", "x-zs-$id": "PatchAssociationDetails" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "PatternNotMatchedGetDeletedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a pattern not matched error.", "properties": { "code": { "description": "Error code indicating pattern not matched.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional contextual information about the error.", "properties": { "param_name": { "description": "Name of the query parameter that failed pattern matching.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Human-readable explanation of the error.", "type": "string" }, "status": { "description": "Indicates the request resulted in an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "PatternNotMatchedGetDeletedError" }, "PatternNotMatchedGetError": { "additionalProperties": false, "description": "Error indicating a pattern was not matched when retrieving records.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "param_name": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "PatternNotMatchedGetError" }, "PermissionDeniedErrorResponse": { "additionalProperties": false, "description": "Returned when the user lacks permission to access the requested picklist resource. Includes error code, message, status, and details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "permissions": { "description": "Detail field: permissions", "items": { "description": "Detail Field: permissions", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Permission Denied Error Response", "type": "object", "x-zs-$id": "PermissionDeniedErrorResponse" }, "PermissionErrorResponse": { "additionalProperties": false, "description": "Error body returned when the user lacks the CRM permission required to perform the operation.", "properties": { "code": { "description": "Error code indicating the permission denial. Possible values: `NO_PERMISSION`.", "enum": [ "NO_PERMISSION" ], "example": "NO_PERMISSION", "type": "string" }, "details": { "additionalProperties": false, "description": "Details object listing the permissions required for the operation.", "properties": { "permissions": { "description": "List of permission identifiers required to perform this operation.", "items": { "description": "Represents single permission identifier string.", "example": "Crm_Implied_Manage_Profiles", "maxLength": 100, "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Human-readable description of the permission error.", "example": "permission denied", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PermissionErrorResponse" }, "PermissionsNested": { "additionalProperties": false, "description": "Defines the access permissions granted to portal users for a specific CRM module. Includes flags for create, edit, delete, view, and attachment operations.", "properties": { "create": { "description": "Denotes whether portal users can create new records in this module. Set to `true` to enable create access.", "type": [ "boolean", "null" ] }, "create_attachment": { "description": "Denotes whether portal users can add attachments to notes associated with records in this module.", "type": [ "boolean", "null" ] }, "delete": { "description": "Denotes whether portal users can delete records in this module. Set to `true` to enable delete access.", "type": [ "boolean", "null" ] }, "delete_attachment": { "description": "Denotes whether portal users can delete attachments from notes associated with records in this module.", "type": [ "boolean", "null" ] }, "edit": { "description": "Denotes whether portal users can edit records in this module that they created. Set to `true` to enable edit access for portal-user-created records.", "type": [ "boolean", "null" ] }, "edit_shared_records": { "description": "Denotes whether portal users can edit records in this module that were shared with them from CRM, but not created by them.", "type": [ "boolean", "null" ] }, "view": { "description": "Denotes whether portal users can view records in this module. View permission must be `true` for any other permission to take effect.", "type": "boolean" } }, "required": [ "view" ], "type": "object" }, "PermissionsNestedV2": { "additionalProperties": false, "description": "Used in update requests to modify the CRUD and shared-record permissions for a module within an existing portal user type.", "properties": { "create": { "description": "Represents the updated create permission for portal users on this module. Set to `true` to allow portal users to create records.", "type": "boolean" }, "delete": { "description": "Represents the updated delete permission for portal users on this module. Set to `true` to allow portal users to delete records.", "type": "boolean" }, "edit": { "description": "Represents the updated edit permission for portal users on records they created in this module.", "type": "boolean" }, "edit_shared_records": { "description": "Represents the updated permission for portal users to edit records shared from CRM into this module.", "type": "boolean" }, "view": { "description": "Represents the updated view permission for portal users on this module.", "type": "boolean" } }, "type": "object" }, "PersonalityModuleChangeNotAllowedError": { "additionalProperties": false, "description": "Returned when a request attempts to change the personality module of the default portal user type, which is not permitted.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Change of personality module of default user type is not allowed." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "PersonalityModuleChangeNotAllowedError" }, "PersonalityModuleNested": { "additionalProperties": false, "description": "A nested object used in create and update requests to specify the personality module for the portal user type. The personality module is the CRM module whose records serve as portal user identities and whose records portal invitations are sent to.", "properties": { "api_name": { "description": "Represents the API Name of the Personality Module.", "maxLength": 25, "pattern": "^[A-Za-z0-9_]{1,25}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaModuleApiName" } ], "resource": "portals_meta" } }, "id": { "description": "The unique numeric identifier of the personality module in Zoho CRM.", "format": "int64", "maxLength": 18, "type": "string" } }, "type": "object" }, "PersonalityModuleNested1": { "additionalProperties": false, "description": "Represents the nested object representing the personality module as returned in response bodies, containing the module's unique identifier, API name, and display label.", "properties": { "api_name": { "description": "Represents the API name of the resource.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the resource.", "format": "int64", "maxLength": 255, "type": "string" }, "plural_label": { "description": "Represents the plural label of the module.", "maxLength": 255, "type": "string" } }, "type": "object" }, "PickListActualValue": { "description": "Actual value of the picklist field.", "example": "Colder", "maxLength": 120, "type": "string" }, "PickListDisplayValue": { "description": "The picklist display value(translated value if translation enabled).", "example": "Cold", "maxLength": 120, "type": "string" }, "PickListReferenceValue": { "description": "Reference value of the picklist field.", "example": "Colder", "maxLength": 120, "type": "string" }, "PickListValue": { "additionalProperties": false, "description": "Represents a single picklist option, including its display value, stored value, and visual configuration.", "properties": { "actual_value": { "description": "Stored value for this picklist option.", "maxLength": 255, "type": "string" }, "colour_code": { "description": "Color code assigned to this picklist value for visual representation.", "maxLength": 7, "type": [ "string", "null" ] }, "display_value": { "description": "Display value shown to the user in the picklist.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the picklist value.", "format": "int64", "type": "string" }, "reference_value": { "description": "Internal reference value associated with this picklist option.", "maxLength": 255, "type": "string" }, "sequence_number": { "description": "Display sequence position of this picklist value.", "format": "int32", "type": "integer" }, "type": { "description": "Type classification of the picklist value.", "enum": [ "used", "unused" ], "type": "string" } }, "required": [ "display_value", "sequence_number", "reference_value", "colour_code", "actual_value", "id", "type" ], "type": "object", "x-zs-$id": "PickListValue" }, "PickListValuesInvalidModuleErrorResponse": { "additionalProperties": false, "description": "Returned when the specified module name is invalid. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "Detail field: param_name", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Error Response", "type": "object", "x-zs-$id": "InvalidModuleErrorResponse" }, "PicklistLayoutAssociation": { "additionalProperties": false, "description": "Identifies a layout where the picklist option is available, including the layout API name, display name, and unique association ID.", "properties": { "api_name": { "description": "Api Name of the layout", "maxLength": 255, "type": "string" }, "id": { "description": "Unique Id of the picklist option", "format": "int64", "type": "string" }, "name": { "description": "Name of the layout", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id", "name" ], "title": "Picklist Layout Association", "type": "object" }, "PicklistMappingCreate": { "additionalProperties": false, "description": "Represents a parent picklist option and its mapped child picklist values for dependency creation.", "properties": { "actual_value": { "description": "Represents the actual stored value of the parent picklist option.", "maxLength": 120, "type": "string" }, "display_value": { "description": "Represents the display label of the parent picklist option as shown in the CRM interface.", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of the parent picklist option. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) to get the ID of the picklist. ", "format": "int64", "type": "string" }, "maps": { "description": "Lists the child picklist options associated with this parent picklist value.", "items": { "additionalProperties": false, "description": "Each object represents a child picklist option mapped to this parent value.", "properties": { "actual_value": { "description": "Represents the actual stored value of the child picklist option.", "maxLength": 120, "type": "string" }, "display_value": { "description": "Represents the display label of the child picklist option as shown in the CRM interface.", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of the child picklist option. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) to get the details of the picklist. ", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 2000, "type": "array" } }, "required": [ "id", "maps" ], "type": "object" }, "PicklistMappingRead": { "additionalProperties": false, "description": "Represents a parent picklist option with its complete set of mapped child picklist values, as returned in GET responses.", "properties": { "actual_value": { "description": "Represents the actual stored value of the parent picklist option. ", "maxLength": 120, "type": "string" }, "display_value": { "description": "Represents the display label of the parent picklist option as shown in the CRM interface. ", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of the parent picklist option. ", "format": "int64", "type": "string" }, "maps": { "description": "Lists the child picklist options associated with this parent picklist value. ", "items": { "$ref": "#/components/schemas/PicklistOption" }, "maxItems": 2000, "type": "array" } }, "required": [ "id", "actual_value", "display_value", "maps" ], "type": "object" }, "PicklistMappingUpdate": { "additionalProperties": false, "description": "Represents a parent picklist option and its mapped child picklist values for dependency updates. Supports removal of individual child mappings using the **_delete** property.", "properties": { "actual_value": { "description": "Represents the actual stored value of the parent picklist option.", "maxLength": 120, "type": "string" }, "display_value": { "description": "Represents the display label of the parent picklist option as shown in the CRM interface.", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of the parent picklist option.", "format": "int64", "type": "string" }, "maps": { "description": "Lists the child picklist options associated with this parent picklist value.", "items": { "additionalProperties": true, "description": "Represents a child picklist option in the dependency update. Supports deletion using the **_delete** property.", "properties": { "_delete": { "description": "Indicates that this child option mapping should be deleted. Set to **null** to remove the mapping.", "type": "null" }, "actual_value": { "description": "Represents the actual stored value of the child picklist option.", "maxLength": 120, "type": "string" }, "display_value": { "description": "Represents the display label of the child picklist option as shown in the CRM interface.", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of the child picklist option.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 2000, "type": "array" } }, "required": [ "id", "maps" ], "type": "object" }, "PicklistOption": { "additionalProperties": false, "description": "Represents a picklist option with its unique identifier, actual value, and display label.", "properties": { "actual_value": { "description": "Represents the actual stored value of the picklist option.", "maxLength": 120, "type": "string" }, "display_value": { "description": "Represents the display label of the picklist option as shown in the CRM interface. ", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of the picklist option. ", "format": "int64", "type": "string" } }, "required": [ "id", "actual_value", "display_value" ], "type": "object" }, "PicklistOptionDeletionResponse": { "additionalProperties": false, "description": "Accepted response indicating picklist option deletion has been scheduled. Returns an array of deletion results.", "properties": { "pick_list_values": { "description": "pick list values", "items": { "$ref": "#/components/schemas/PicklistOptionDeletionResult" }, "maxItems": 1, "minItems": 0, "type": "array" } }, "required": [ "pick_list_values" ], "title": "Picklist Option Deletion Response", "type": "object", "x-zs-$id": "PicklistOptionDeletionResponse" }, "PicklistOptionDeletionResult": { "additionalProperties": false, "description": "Represents the scheduled deletion outcome for a picklist option, including status, code, message, and async job details.", "properties": { "code": { "description": "picklist option deletion code", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/AsyncJobDetails" }, "message": { "description": "Picklist option deletion message", "enum": [ "Picklist Option deletion scheduled successfully" ], "type": "string" }, "status": { "description": "Picklist option deletion status", "enum": [ "success" ], "maxLength": 7, "minLength": 5, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Picklist Option Deletion Result", "type": "object" }, "PicklistOptionDetail": { "additionalProperties": false, "description": "Full metadata for a picklist option, including unique ID, actual/reference/display values, sequence order, usage type (used/unused), optional color code, and associated layouts.", "properties": { "actual_value": { "description": "Actual value of the picklist option.", "maxLength": 120, "type": "string" }, "colour_code": { "description": "Color code of the picklist option when the picklist field in color code enabled", "maxLength": 9, "type": [ "string", "null" ] }, "display_value": { "description": "Display value of the picklist option which are localised or translated", "maxLength": 120, "type": "string" }, "id": { "description": "Unique Id of the picklist option", "format": "int64", "type": "string" }, "layout_associations": { "description": "Layout Association of the picklist option", "items": { "$ref": "#/components/schemas/PicklistLayoutAssociation" }, "maxItems": 6, "minItems": 0, "type": [ "array", "null" ] }, "reference_value": { "description": "Reference value of the picklist option which are localised or updated", "maxLength": 120, "type": "string" }, "sequence_number": { "description": "sort order of the option respective to field", "format": "int32", "type": "integer" }, "type": { "description": "Presence of the option in layouts and in the module", "enum": [ "used", "unused" ], "type": "string" } }, "required": [ "actual_value", "colour_code", "display_value", "id", "layout_associations", "reference_value", "sequence_number", "type" ], "title": "Picklist Option Detail", "type": "object" }, "PicklistOptionInUseErrorResponse": { "additionalProperties": false, "description": "Returned when the picklist option is used by other features and cannot be modified. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "_associations": { "description": "Detail field: _associations", "items": { "additionalProperties": false, "description": "Detail Field: _associations", "properties": { "resources": { "description": "Nested detail field: resources", "items": { "additionalProperties": false, "description": "Detail Field: resources", "properties": { "_details": { "additionalProperties": true, "description": "Nested detail field: _details", "type": [ "object", "null" ] }, "id": { "description": "Nested detail field: id", "maxLength": 255, "type": "string" }, "name": { "description": "Nested detail field: name", "maxLength": 255, "type": "string" } }, "required": [ "_details", "id", "name" ], "type": "object" }, "maxItems": 25, "type": "array" }, "type": { "description": "Nested detail field: type", "maxLength": 255, "type": "string" } }, "required": [ "resources", "type" ], "type": "object" }, "maxItems": 25, "type": "array" }, "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "_associations", "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The picklist option is used in features" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Picklist Option In Use Error Response", "type": "object", "x-zs-$id": "PicklistOptionInUseErrorResponse" }, "PicklistOptionLookupResponse": { "additionalProperties": false, "description": "Successful response containing the list of picklist options that match the specified pick list value ID for the given field.", "properties": { "pick_list_values": { "description": "PickList option of the mention picklist unique Id", "items": { "$ref": "#/components/schemas/PicklistOptionDetail" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pick_list_values" ], "title": "Picklist Option Lookup Response", "type": "object", "x-zs-$id": "PicklistOptionLookupResponse" }, "PicklistReplaceInstructionItem": { "additionalProperties": false, "description": "A structured instruction that pairs a source and target picklist option, with an option to delete the source after replacement.", "properties": { "delete_old_value": { "description": "Boolean value to delete the old_value along with replace", "type": [ "boolean", "null" ] }, "new_value": { "$ref": "#/components/schemas/PicklistReplaceTargetValue", "description": "The option to be replaced with the option (Required)" }, "old_value": { "$ref": "#/components/schemas/PicklistReplaceSourceValue", "description": "The option which is to be replaced (Required)" } }, "required": [ "new_value", "old_value" ], "title": "Picklist Replace Instruction Item", "type": "object" }, "PicklistReplaceRequestBody": { "additionalProperties": false, "description": "Container for the replace_pick_list_values array, listing one or more instructions to perform picklist value replacements.", "properties": { "replace_pick_list_values": { "description": "Replace picklist value with from and to options (Required)", "items": { "$ref": "#/components/schemas/PicklistReplaceInstructionItem" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "replace_pick_list_values" ], "title": "Picklist Replace Request Body", "type": "object" }, "PicklistReplaceResponse": { "additionalProperties": false, "description": "Accepted response indicating picklist replace operations have been scheduled. Returns an array of scheduling results.", "properties": { "replace_pick_list_values": { "description": "Description of the replace option on schedule", "items": { "$ref": "#/components/schemas/PicklistReplaceScheduleResult" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "replace_pick_list_values" ], "title": "Picklist Replace Response", "type": "object", "x-zs-$id": "PicklistReplaceResponse" }, "PicklistReplaceScheduleResult": { "additionalProperties": false, "description": "Result entry for a scheduled replace operation, including status, code, message, and asynchronous job details.", "properties": { "code": { "description": "Code of the scheduler response", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/AsyncJobDetails" }, "message": { "description": "Message of the scheduled details", "enum": [ "Picklist option replace operation scheduled successfully" ], "type": "string" }, "status": { "description": "status on replace operation of the scheduler", "enum": [ "success" ], "maxLength": 7, "minLength": 5, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Picklist Replace Schedule Result", "type": "object" }, "PicklistReplaceSourceValue": { "additionalProperties": false, "anyOf": [ { "required": [ "id" ] }, { "required": [ "display_value" ] } ], "description": "Represents the picklist option to be replaced, providing the display value and unique identifier. At least one of id or display_value must be provided.", "properties": { "display_value": { "description": "Specify the display value of the option to be replaced", "maxLength": 120, "type": [ "string", "null" ] }, "id": { "description": "Specify the option id which is to be replaced (Unique)", "format": "int64", "maxLength": 20, "minLength": 13, "type": [ "string", "null" ] } }, "title": "Picklist Replace Source Value", "type": "object" }, "PicklistReplaceTargetValue": { "additionalProperties": false, "anyOf": [ { "required": [ "id" ] }, { "required": [ "display_value" ] } ], "description": "Represents the picklist option that will act as the replacement, providing the display value and unique identifier. At least one of id or display_value must be provided.", "properties": { "display_value": { "description": "Display value of the option", "maxLength": 120, "type": [ "string", "null" ] }, "id": { "description": "The option id (Unique)", "format": "int64", "maxLength": 20, "minLength": 13, "type": [ "string", "null" ] } }, "title": "Picklist Replace Target Value", "type": "object" }, "PipelineCreateErrorResponse": { "additionalProperties": false, "description": "Batch error response for pipeline operations maintaining 1:1 correspondence with request items when validation fails.", "properties": { "pipeline": { "description": "Array of individual error responses matching the request pipeline items.", "items": { "additionalProperties": false, "description": "Individual pipeline item error response.", "properties": { "code": { "description": "Represents the error code indicating the specific validation failure.", "enum": [ "DUPLICATE_DATA", "INVALID_DATA", "MANDATORY_NOT_FOUND" ], "example": "DUPLICATE_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Error-specific context including field name and JSON path location.", "properties": { "api_name": { "description": "API field name that caused the error.", "example": "display_value", "format": "string", "type": "string" }, "json_path": { "description": "JSON path pointing to the exact location of the error in the request.", "example": "$.pipeline[0].display_value", "format": "string", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the explanation of the specific error.", "example": "Duplicate pipeline label found", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator for this item.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-$id": "PipelineCreateErrorResponse" }, "PipelineCreateRequest": { "additionalProperties": false, "description": "Request body for creating a pipeline configuration with a custom pipeline label and mapped stage values for a specific Deals layout.", "properties": { "pipeline": { "description": "Array of pipeline picklist configurations to create or update.", "items": { "additionalProperties": false, "description": "Picklist value configuration for pipeline customization, including stage mappings.", "properties": { "default": { "description": "Indicates if this picklist value should be set as the default option.", "example": false, "type": "boolean" }, "display_value": { "description": "User-facing display name for the picklist value.", "example": "adfadf12adf", "format": "string", "type": "string" }, "maps": { "description": "Array of stage mappings defining which stages this picklist value connects to and their sequence.", "items": { "additionalProperties": false, "description": "Mapping configuration for associating a picklist value with a specific pipeline stage.", "properties": { "display_value": { "description": "User-facing display name for the pipeline stage.", "example": "Needs Analysis", "format": "string", "type": "string" }, "id": { "description": "Unique identifier of the target pipeline stage to map.", "example": "2766660000000007106", "format": "int64", "type": "string" }, "sequence_number": { "description": "Optional position of this stage mapping in the pipeline sequence (overrides default positioning).", "example": 2, "format": "int32", "type": "integer" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "display_value", "maps" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-llm-description": "The pipeline array accepts exactly 1 item (minItems and maxItems are both 1) — one request creates one pipeline. Each maps[].id must reference an existing stage ID already defined on the layout." }, "PipelineGetErrorResponse": { "additionalProperties": false, "description": "Standard error response format used across API endpoints for validation and business logic errors.", "properties": { "code": { "description": "Represents the error code indicating the type of error (e.g., 'INVALID_DATA', 'RESOURCE_NOT_FOUND').", "enum": [ "INVALID_DATA" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context about the specific error, typically identifying the problematic parameter.", "properties": { "param_name": { "description": "Name of the parameter that caused the validation error.", "enum": [ "layout_id" ], "example": "layout_id", "format": "string", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error messsage.", "example": "Invalid layoutid", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator ('error' or 'success').", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PipelineGetErrorResponse" }, "PipelineGetResponse": { "additionalProperties": false, "description": "Root response object containing all pipeline configurations configured for a given Deals layout in Zoho CRM.", "properties": { "pipeline": { "description": "Array of pipeline configuration items.", "items": { "additionalProperties": false, "description": "Picklist option representing a pipeline configuration with associated stage mappings.", "properties": { "actual_value": { "description": "Internal API value for the picklist option.", "example": "Standard (Standard)", "format": "string", "type": "string" }, "default": { "description": "Indicates if this is the default picklist value.", "example": true, "type": "boolean" }, "display_value": { "description": "Display name of the picklist value as shown to users.", "example": "Standard (Standard)", "format": "string", "type": "string" }, "id": { "description": "Unique identifier for this picklist value.", "example": "2766660000054211007", "format": "int64", "type": "string", "x-zs-$id": "PipelineId" }, "maps": { "description": "Array of stage mappings for this picklist value.", "items": { "additionalProperties": false, "description": "Mapping between a picklist value and a specific pipeline stage, including its position and forecasting details.", "properties": { "actual_value": { "description": "Internal system value/API name for the stage.", "example": "Needs Analysis", "format": "string", "type": "string" }, "colour_code": { "description": "Hexadecimal color code associated with the stage for UI representation.", "example": "#FF5733", "format": "string", "type": "string" }, "display_value": { "description": "User-facing display name of the pipeline stage.", "example": "Needs Analysis", "format": "string", "type": "string" }, "forecast_category": { "additionalProperties": false, "description": "Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting.", "properties": { "id": { "description": "Unique system identifier for the forecast category.", "example": "2766660000000007092", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted').", "example": "Pipeline", "format": "string", "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "forecast_type": { "description": "Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost').", "example": "Open", "format": "string", "type": "string" }, "id": { "description": "Unique identifier for this stage mapping.", "example": "2766660000000007106", "format": "int64", "type": "string" }, "sequence_number": { "description": "Position of this stage in the pipeline sequence (1-based indexing).", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "display_value", "sequence_number", "forecast_category", "actual_value", "id", "forecast_type" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "display_value", "maps", "actual_value", "id" ], "type": "object" }, "maxItems": 90, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-$id": "PipelineGetResponse" }, "PipelineMaximumLengthErrorResponse": { "additionalProperties": false, "description": "Error response when maximum length constraint is violated.", "properties": { "code": { "description": "Represents the error code indicating the type of error.", "enum": [ "INVALID_DATA" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context about the specific error.", "properties": { "api_name": { "description": "API field name that caused the error.", "example": "pipeline", "format": "string", "type": "string" }, "json_path": { "description": "JSON path pointing to the exact location of the error in the request.", "example": "$.pipeline", "format": "string", "type": "string" }, "maximum_length": { "description": "The maximum allowed length for the field.", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents theexplanation of the error suitable for display to end users.", "example": "invalid data", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MaximumLengthErrorResponse" }, "PipelineNoPermissionErrorResponse": { "additionalProperties": false, "description": "Error response when the user lacks required permissions to perform the operation.", "properties": { "code": { "description": "Represents the error code indicating the type of error (e.g., 'NO_PERMISSION').", "enum": [ "NO_PERMISSION" ], "example": "NO_PERMISSION", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context about the specific error.", "properties": { "permissions": { "description": "The required permission that is missing.", "example": "Crm_Implied_Customize_Zoho_CRM", "format": "string", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the explanation of the error suitable for display to end users.", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator ('error' or 'success').", "format": "string", "type": "string" } }, "type": "object", "x-zs-$id": "NoPermissionErrorResponse" }, "PipelineSuccessResponse": { "additionalProperties": false, "description": "Batch success response for pipeline creation/update operations, maintaining 1:1 correspondence with request items.", "properties": { "pipeline": { "description": "Array of individual success responses matching the request pipeline items.", "items": { "additionalProperties": false, "description": "Individual success response for a pipeline operation, mirroring the request structure.", "properties": { "code": { "description": "Represents the success code indicating the type of successful operation.", "enum": [ "SUCCESS" ], "example": "SUCCESS", "type": "string" }, "details": { "additionalProperties": false, "description": "Operation-specific success details including resource identifiers.", "properties": { "id": { "description": "Unique identifier of the newly created pipeline configuration.", "example": "2766660000056473305", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the confirmation of the successful operation.", "example": "Pipeline created", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator.", "enum": [ "success" ], "example": "success", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-$id": "PipelineSuccessResponse" }, "PipelineTransferErrorResponse": { "additionalProperties": false, "description": "Batch error response for pipeline transfer operations with detailed validation failure information.", "properties": { "transfer_pipeline": { "description": "Array of individual pipeline transfer error responses matching request items.", "items": { "additionalProperties": false, "description": "Individual pipeline transfer validation error.", "properties": { "code": { "description": "Represents the error code for the validation failure.", "enum": [ "INVALID_DATA", "MANDATORY_NOT_FOUND", "ALREADY_SCHEDULED", "ALREADY_USED" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error context identifying the problematic field and its location.", "properties": { "api_name": { "description": "Represents the API field name that failed validation.", "example": "from", "format": "string", "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Represents where the value already exists.", "properties": { "json_path": { "description": "JSON path where the value already exists.", "format": "string", "type": "string" } }, "type": "object" }, "json_path": { "description": "JSON path to the exact location of the validation error.", "format": "string", "type": "string" }, "value": { "description": "Represents the invalid value that caused the error.", "format": "string", "type": "string" } }, "type": "object" }, "message": { "description": "error explanation.", "example": "Invalid from id", "format": "string", "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "transfer_pipeline" ], "type": "object", "x-zs-$id": "PipelineTransferErrorResponse" }, "PipelineTransferResponse": { "additionalProperties": false, "description": "Response confirming pipeline transfer operation with source-to-target mappings for pipeline and stages.", "properties": { "transfer_pipeline": { "description": "Array of pipeline transfer mappings showing source and target configurations.", "items": { "additionalProperties": false, "description": "Individual pipeline transfer mapping.", "properties": { "pipeline": { "additionalProperties": false, "description": "Pipeline-level transfer mapping from source to target pipeline.", "properties": { "from": { "description": "Source pipeline ID.", "example": "2766660000056473266", "format": "int64", "type": "string" }, "to": { "description": "Target pipeline ID.", "example": "2766660000056473305", "format": "int64", "type": "string" } }, "required": [ "from", "to" ], "type": "object" }, "stages": { "description": "Array of stage mappings showing which stages transferred to which target stages.", "items": { "additionalProperties": false, "description": "Individual stage transfer mapping.", "properties": { "from": { "description": "Source stage ID.", "example": "2766660000000007110", "format": "int64", "type": "string" }, "to": { "description": "Target stage ID.", "example": "2766660000000007104", "format": "int64", "type": "string" } }, "required": [ "from", "to" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "pipeline", "stages" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "transfer_pipeline" ], "type": "object" }, "PipelineTransferSuccessResponse": { "additionalProperties": false, "description": "Success response for pipeline transfer scheduling operation with job tracking information.", "properties": { "transfer_pipeline": { "description": "Array of pipeline transfer scheduling results maintaining 1:1 correspondence with request.", "items": { "additionalProperties": false, "description": "Individual pipeline transfer scheduling result.", "properties": { "code": { "description": "Represents the success code indicating the type of successful operation.", "enum": [ "SUCCESS" ], "example": "SUCCESS", "type": "string" }, "details": { "additionalProperties": false, "description": "Success details including the scheduled job identifier.", "properties": { "job_id": { "description": "Unique identifier of the scheduled pipeline transfer job for tracking.", "example": "2766660000056808404", "format": "int64", "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the confirmation of the pipeline transfer scheduling.", "example": "transfer pipeline scheduled successfully", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator.", "enum": [ "success" ], "example": "success", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "transfer_pipeline" ], "type": "object", "x-zs-$id": "PipelineTransferSuccessResponse" }, "PipelineUpdateOrDeleteErrorResponse": { "additionalProperties": false, "description": "Batch error response for pipeline operations maintaining 1:1 correspondence with request items when validation fails.", "properties": { "pipeline": { "description": "Array of individual error responses matching the request pipeline items.", "items": { "additionalProperties": false, "description": "Individual pipeline item error response.", "properties": { "code": { "description": "Represents the error code indicating the specific validation failure.", "enum": [ "DUPLICATE_DATA", "INVALID_DATA", "MANDATORY_NOT_FOUND", "ALREADY_SCHEDULED", "CANNOT_DELETE" ], "example": "DUPLICATE_DATA", "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Error-specific context including field name and JSON path location.", "properties": { "api_name": { "description": "API field name that caused the error.", "example": "display_value", "format": "string", "type": "string" }, "json_path": { "description": "JSON path pointing to the exact location of the error in the request.", "example": "$.pipeline[0].display_value", "format": "string", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "PipelineUpdateOrDeleteErrorResponseDetails" }, { "additionalProperties": false, "description": "Error-specific context including field name and JSON path location.", "properties": { "api_name": { "description": "API field name that caused the error.", "example": "display_value", "format": "string", "type": "string" }, "json_path": { "description": "JSON path pointing to the exact location of the error in the request.", "example": "$.pipeline[0].display_value", "format": "string", "type": "string" }, "value": { "description": "The invalid value that caused the error.", "format": "int64", "type": "string" } }, "required": [ "api_name", "value", "json_path" ], "type": "object", "x-zs-$id": "PipelineUpdateOrDeleteErrorResponseDetails1" }, { "additionalProperties": false, "description": "Error-specific context including field name and JSON path location.", "properties": { "id": { "description": "ID of the pipeline item that caused the error.", "example": "2766660000054211007", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "PipelineUpdateOrDeleteErrorResponseDetailsById" }, { "additionalProperties": false, "description": "Empty details object for errors without specific context.", "properties": {}, "type": "object", "x-zs-$id": "PipelineUpdateOrDeleteErrorResponseEmptyDetails" } ], "description": "Represents details about the error." }, "message": { "description": "Represents the explanation of the specific error.", "example": "Duplicate pipeline label found", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator for this item.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-$id": "PipelineUpdateOrDeleteErrorResponse" }, "PipelineUpdateOrDeleteUrlErrorResponse": { "additionalProperties": false, "description": "Invalid pipeline error response", "properties": { "code": { "description": "The error code indicating the type of error (e.g., 'INVALID_DATA', 'RESOURCE_NOT_FOUND').", "enum": [ "INVALID_DATA" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context about the specific error, typically identifying the problematic parameter.", "properties": { "resource_path_index": { "description": "Unique identifier of the pipeline that caused the validation error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents theexplanation of the error suitable for display to end users.", "example": "Invalid pipeline id", "format": "string", "type": "string" }, "status": { "description": "Overall status indicator ('error' or 'success').", "enum": [ "error" ], "example": "error", "format": "string", "type": "string" } }, "type": "object", "x-zs-$id": "PipelineUpdateOrDeleteUrlErrorResponse" }, "PipelineUpdateRequest": { "additionalProperties": false, "description": "Request body for updating or creating pipeline configurations with custom picklist values and stage mappings.", "properties": { "pipeline": { "description": "Array of pipeline picklist configurations to create or update.", "items": { "additionalProperties": false, "description": "Picklist value configuration for pipeline customization, including stage mappings.", "properties": { "_delete": { "additionalProperties": false, "description": "Deletion metadata object.", "properties": { "permanent": { "description": "Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null.", "example": null, "type": [ "null" ], "x-zs-llm-description": "Always send null — the schema only accepts null (no boolean values). Presence of this _delete object (with permanent: null) is what triggers deletion; the value itself carries no true/false meaning." } }, "required": [ "permanent" ], "type": "object", "x-zs-llm-description": "To delete this pipeline, include this object with permanent set to null (the only accepted value) and omit display_value/maps from the item. This field is a delete marker, not a soft/permanent-delete flag." }, "default": { "description": "Indicates if this picklist value should be set as the default option.", "example": false, "type": "boolean" }, "display_value": { "description": "User-facing display name for the picklist value.", "example": "adfadf12adf", "format": "string", "type": "string" }, "id": { "description": "ID of the pipeline", "format": "int64", "type": "string" }, "maps": { "description": "Array of stage mappings defining which stages this picklist value connects to and their sequence.", "items": { "additionalProperties": false, "description": "Mapping configuration for associating a picklist value with a specific pipeline stage.", "properties": { "_delete": { "additionalProperties": false, "description": "Deletion metadata object.", "properties": { "permanent": { "description": "Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null.", "example": null, "type": [ "null" ], "x-zs-llm-description": "Always send null — the schema only accepts null (no boolean values). Presence of this _delete object (with permanent: null) is what triggers deletion of the stage mapping." } }, "required": [ "permanent" ], "type": "object", "x-zs-llm-description": "To delete this stage mapping, include this object with permanent set to null (the only accepted value). At least one stage mapping must remain on the pipeline after deletion." }, "display_value": { "description": "User-facing display name for the pipeline stage.", "example": "Needs Analysis", "format": "string", "type": "string" }, "id": { "description": "Unique identifier of the target pipeline stage to map.", "example": "2766660000000007106", "format": "int64", "type": "string" }, "sequence_number": { "description": "Optional position of this stage mapping in the pipeline sequence (overrides default positioning).", "example": 2, "format": "int32", "type": "integer" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-llm-description": "Used only by the body-identified PATCH/PUT operations on /settings/pipeline, so each item requires id to identify the target pipeline (unlike PipelineUpdateRequestUrl, whose path parameter already identifies it). To delete the pipeline, set _delete.permanent on the item instead of display_value/maps." }, "PipelineUpdateRequestUrl": { "additionalProperties": false, "description": "Request body for updating or creating pipeline configurations with custom picklist values and stage mappings.", "properties": { "pipeline": { "description": "Array of pipeline picklist configurations to create or update.", "items": { "additionalProperties": false, "description": "Picklist value configuration for pipeline customization, including stage mappings.", "properties": { "_delete": { "additionalProperties": false, "description": "Deletion metadata object.", "properties": { "permanent": { "description": "Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null.", "example": null, "type": [ "null" ], "x-zs-llm-description": "Always send null — the schema only accepts null (no boolean values). Presence of this _delete object (with permanent: null) is what triggers deletion; the value itself carries no true/false meaning." } }, "required": [ "permanent" ], "type": "object", "x-zs-llm-description": "To delete this pipeline, include this object with permanent set to null (the only accepted value) and omit display_value/maps from the item. This field is a delete marker, not a soft/permanent-delete flag." }, "default": { "description": "Indicates if this picklist value should be set as the default option.", "example": false, "type": "boolean" }, "display_value": { "description": "User-facing display name for the picklist value.", "example": "adfadf12adf", "format": "string", "type": "string" }, "maps": { "description": "Array of stage mappings defining which stages this picklist value connects to and their sequence.", "items": { "additionalProperties": false, "description": "Mapping configuration for associating a picklist value with a specific pipeline stage.", "properties": { "_delete": { "additionalProperties": false, "description": "Deletion metadata object.", "properties": { "permanent": { "description": "Indicates if the deletion was permanent (true), soft delete (false), or status unknown/null.", "example": null, "type": [ "null" ], "x-zs-llm-description": "Always send null — the schema only accepts null (no boolean values). Presence of this _delete object (with permanent: null) is what triggers deletion of the stage mapping." } }, "required": [ "permanent" ], "type": "object", "x-zs-llm-description": "To delete this stage mapping, include this object with permanent set to null (the only accepted value). At least one stage mapping must remain on the pipeline after deletion." }, "display_value": { "description": "User-facing display name for the pipeline stage.", "example": "Needs Analysis", "format": "string", "type": "string" }, "id": { "description": "Unique identifier of the target pipeline stage to map.", "example": "2766660000000007106", "format": "int64", "type": "string" }, "sequence_number": { "description": "Optional position of this stage mapping in the pipeline sequence (overrides default positioning).", "example": 2, "format": "int32", "type": "integer" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-llm-description": "Used only by the by-ID PATCH/PUT operations (path parameter identifies the pipeline), so items in this schema have no id field. To delete the pipeline, set _delete.permanent on the item instead of display_value/maps; to delete a specific stage, set _delete.permanent on that maps entry." }, "PortalUserTypeDetailsNested": { "additionalProperties": false, "description": "A nested object containing additional detail fields returned with error responses, such as the field API name and JSON path that identify where the validation failure occurred.", "properties": { "id": { "description": "Represents the unique numeric identifier of the resource referenced in the error detail.", "format": "int64", "maxLength": 255, "type": "string" } }, "type": "object" }, "PortalUserTypeGETCreatedByNested": { "additionalProperties": false, "description": "Represents nested object identifying the Zoho CRM user who created the portal user type, containing the user's unique identifier and display name.", "properties": { "id": { "description": "Represents the unique numeric identifier of the Zoho CRM user who created the portal user type.", "format": "int64", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the Zoho CRM user who created the portal user type.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "PortalUserTypeGETModifiedByNested": { "additionalProperties": false, "description": "Represents the nested object identifying the Zoho CRM user who last modified the portal user type, containing the user's unique identifier and display name.", "properties": { "id": { "description": "Represents the unique numeric identifier of the Zoho CRM user who last modified the portal user type.", "format": "int64", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the Zoho CRM user who last modified the portal user type.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "PortalUserTypeInvalidDataSupportedValuesError": { "additionalProperties": false, "description": "Returned when a request body field value is not among the allowed values. The `details` object identifies the field and lists the supported values.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of values that are accepted for the field.", "items": { "description": "One of the accepted values for the field. The request body value must match one of the values in this list.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataSupportedValuesError" }, "PortalUserTypeInvalidDataTypeError": { "additionalProperties": false, "description": "Returned when a request body field value is provided in the wrong data type. The `details` object identifies the field and specifies the expected data type.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "The data type that the field value must conform to.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataTypeError" }, "PortalUserTypeLicenseLimitExceededError": { "additionalProperties": false, "description": "Returned when the organization has reached the maximum number of portal user types allowed under its current Zoho CRM license plan.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "LICENSE_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": {}, "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "License limit exceeded." ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "LicenseLimitExceededError" }, "PortalUserTypeMandatoryFieldMissingError": { "additionalProperties": false, "description": "Returned when a required field is absent from the request body. The `details` object identifies the missing field by API name and JSON path.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MandatoryFieldMissingError" }, "PortalUserTypeNoPermissionError": { "additionalProperties": false, "description": "Returned when the authenticated user does not have permission to manage portal user types in the target organization.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "permissions": { "description": "The list of permission entries associated with the error condition.", "items": { "description": "Each item represents the permission entry issue.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "No permission" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "NoPermissionError" }, "PortalUserTypeRequiredParamMissingError": { "additionalProperties": false, "description": "Returned when the request body is missing the `read_only` field, which is required when specifying field-level permissions for a portal user type module.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "Possible403ErrorResponsesInManagingAR": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseNoPermissionToAccessAPI" }, { "$ref": "#/components/schemas/ErrorResponseNoPermissionToManageAR" }, { "$ref": "#/components/schemas/ErrorResponseNoPermissionToManageAROfPrivateModule" } ], "description": "Error response for forbidden access.", "title": "Possible 403 Error Cases In Managing AR", "type": "object", "x-zs-$id": "Possible403ErrorResponsesInManagingAR" }, "PostCadencesRequest": { "additionalProperties": false, "description": "Represents the request payload for enrolling or un-enrolling records in one or more Cadences.", "properties": { "cadences_ids": { "description": "A list of Cadence IDs to use for the enrollment or un-enrollment operation.", "items": { "description": "A unique identifier of a Cadence.", "maxLength": 255, "type": "string" }, "maxItems": 5, "maxLength": 255, "type": "array", "x-zs-$ref": { "origins": [ { "operationId": "getCadences", "propertyId": "CadenceId" }, { "operationId": "postCadences", "propertyId": "CadenceResultId" } ], "resource": "cadences" } }, "ids": { "description": "Specify the list of record IDs to enroll in or un-enroll from the specified Cadences.", "items": { "description": "A unique identifier of a record.", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "cadences_ids", "ids" ], "type": "object" }, "PostTasksAuthenticationErrorResponse": { "anyOf": [ { "$ref": "#/components/schemas/OAuthScopeMismatchErrorResponse" }, { "$ref": "#/components/schemas/AuthenticationFailureErrorResponse" } ], "description": "Authentication or OAuth scope error response for POST automation tasks.", "x-zs-$id": "PostTasksAuthenticationErrorResponse", "x-zs-llm-description": "Union (oneOf) authentication or OAuth scope error. Check the code to determine if it is a scope mismatch or token issue." }, "PostWorkflowRuleSchema": { "additionalProperties": false, "description": "Represents the request body wrapper for creating a new workflow rule. Contains a single-element array with the workflow rule configuration.", "properties": { "workflow_rules": { "description": "Represents the array containing the workflow rule object to create. The array must contain exactly one object per request.", "items": { "$ref": "#/components/schemas/WorkflowRulePostNestedSchema" }, "maxItems": 1, "type": "array" } }, "required": [ "workflow_rules" ], "type": "object", "x-zs-llm-description": "Top-level request body for POST /settings/automation/workflow_rules. Contains a single-element workflow_rules array. The rule object structure is defined in WorkflowRulePostNestedSchema." }, "PostaddtagsRequest": { "additionalProperties": false, "description": "Request body schema for adding tags to records.", "properties": { "ids": { "description": "JSON array string of record IDs to associate tags with. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.\n", "enum": [ "[\"3060320000002538026\"]" ], "maxLength": 102, "type": [ "string", "null" ] }, "over_write": { "description": "If true, replaces all existing tags. If false, appends tags to existing ones.", "type": [ "boolean", "null" ] }, "tags": { "description": "Array of tags to associate with the records (Required)", "items": { "$ref": "#/components/schemas/TagsActionsTagsNested" }, "maxItems": 3, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "PostaddtagsResponse200": { "additionalProperties": false, "description": "Success response when tags are associated successfully to records.", "properties": { "data": { "description": "Array of operation results for each record", "items": { "$ref": "#/components/schemas/TagsActionsDataNested" }, "maxItems": 20, "type": "array" }, "ids": { "description": "Record IDs that were processed", "maxLength": 102, "type": "string" }, "locked_count": { "description": "Number of records that were locked and could not be updated", "maxLength": 255, "type": "string" }, "over_write": { "description": "Indicates whether tags were replaced or appended", "type": "boolean" }, "success_count": { "description": "Number of records that were successfully updated", "maxLength": 255, "type": "string" }, "tags": { "description": "Root key for tags", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "PostaddtagsResponse200" }, "PostappointmentssDependentFieldMissingAddressLocationErrorItem": { "additionalProperties": false, "description": "Represents an error item returned when the Address field is provided in the request without the Location field being set to Client Address.", "properties": { "code": { "description": "Represents the error code for the address-location dependent-field-missing failure.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the address-location dependency failure, including the dependee field and the missing field.", "properties": { "api_name": { "description": "Represents the API name of the missing dependent field in the address-location dependency.", "enum": [ "Address" ], "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of the field that triggers the address dependency requirement.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the address dependency.", "enum": [ "Location" ], "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the address dependency.", "enum": [ "$.data[0].Location" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the missing dependent field for the address-location dependency.", "enum": [ "$.data[0].Address" ], "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the address-location dependency failure.", "enum": [ "Dependent Field missing" ], "type": "string" }, "status": { "description": "Indicates the response status for the address-location dependency failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PostappointmentssDependentFieldMissingAddressLocationErrorItem" }, "PostappointmentssDependentFieldMissingCancellationStatusErrorItem": { "additionalProperties": false, "description": "Represents an error item returned when a cancellation information field is provided without the required dependent field in the create appointment request.", "properties": { "code": { "description": "Represents the error code for the dependent-field-missing failure.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the dependent-field-missing failure, including the dependee field and the missing dependent field.", "properties": { "api_name": { "description": "Represents the API name of the missing dependent field.", "enum": [ "Status" ], "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of the field that triggers the dependency requirement.", "properties": { "api_name": { "description": "Represents the API name of the field that triggers the dependency requirement.", "enum": [ "Cancellation_Reason" ], "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggers the dependency requirement.", "enum": [ "$.data[0].Cancellation_Reason" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the missing dependent field in the request.", "enum": [ "$.data[0].Status" ], "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the dependent-field-missing failure.", "enum": [ "To Update the fields of Cancellation Information Section, value of Status should be Cancelled" ], "type": "string" }, "status": { "description": "Indicates the response status for the dependent-field-missing failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PostappointmentssDependentFieldMissingCancellationStatusErrorItem" }, "PostappointmentssDependentMismatchCancellationStatusErrorItem": { "additionalProperties": false, "description": "Represents an error item returned when cancellation information fields are provided in the request but the appointment Status is not set to Cancelled.", "properties": { "code": { "description": "Represents the error code for the dependent-mismatch failure.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the dependent-mismatch failure, including the dependee field and the mismatched field.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the dependency mismatch.", "enum": [ "Status" ], "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of the field whose value determines the dependency.", "properties": { "api_name": { "description": "Represents the API name of the field whose value determines the dependency.", "enum": [ "Cancellation_Reason" ], "type": "string" }, "json_path": { "description": "Represents the JSON path to the field whose value determines the dependency.", "enum": [ "$.data[0].Cancellation_Reason" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that caused the dependency mismatch in the request.", "enum": [ "$.data[0].Status" ], "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the dependent-mismatch failure.", "enum": [ "To Update the fields of Cancellation Information Section, value of Status should be Cancelled" ], "type": "string" }, "status": { "description": "Indicates the response status for the dependent-mismatch failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PostappointmentssDependentMismatchCancellationStatusErrorItem" }, "PostappointmentssInvalidDataRangeErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when a field value in the create appointment request exceeds the allowed numeric range.", "properties": { "data": { "description": "Represents the list of invalid data error objects returned for range validation failures.", "items": { "additionalProperties": false, "description": "Represents a single error object containing the code, details, message, and status for a range validation failure.", "properties": { "code": { "description": "Represents the error code for the range validation failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the range validation failure, including the field name, JSON path, and allowed range.", "properties": { "api_name": { "description": "Represents the API name of the field that contains a value outside the allowed range.", "enum": [ "unit" ], "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that contains a value outside the allowed range.", "enum": [ "$.data[0].Remind_At[0].unit" ], "type": "string" }, "range": { "additionalProperties": false, "description": "Represents the allowed numeric range for the field, defined by minimum and maximum values.", "properties": { "from": { "description": "Represents the lower bound of the accepted numeric range for the field.", "enum": [ 0 ], "format": "int32", "type": "integer" }, "to": { "description": "Represents the upper bound of the accepted numeric range for the field.", "enum": [ 100 ], "format": "int32", "type": "integer" } }, "required": [ "from", "to" ], "type": "object" } }, "required": [ "api_name", "json_path", "range" ], "type": "object" }, "message": { "description": "Represents the error message describing the range validation failure.", "enum": [ "Please check whether the input values are correct" ], "type": "string" }, "status": { "description": "Indicates the response status for the range validation failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostappointmentssInvalidDataRangeErrorResponse" }, "PostappointmentssInvalidDataSupportedValuesErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when a field value in the create appointment request does not match the supported values.", "properties": { "data": { "description": "Represents the list of invalid data error objects returned when field values do not match the supported values.", "items": { "additionalProperties": false, "description": "Represents a single error object containing the code, details, message, and status for a supported-values validation failure.", "properties": { "code": { "description": "Represents the error code for the supported-values validation failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the supported-values validation failure, including the field name, JSON path, and accepted values.", "properties": { "api_name": { "description": "Represents the API name of the field that contains an unsupported value.", "enum": [ "period" ], "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that contains an unsupported value.", "enum": [ "$.data[0].Remind_At[0].period" ], "type": "string" }, "supported_values": { "description": "Represents the list of accepted values for the field.", "items": { "description": "Represents an accepted value for the field.", "enum": [ "minutes", "hours", "days" ], "type": "string" }, "maxItems": 3, "minItems": 3, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message describing the supported-values validation failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "status": { "description": "Indicates the response status for the supported-values validation failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostappointmentssInvalidDataSupportedValuesErrorResponse" }, "PostappointmentssRequest": { "additionalProperties": false, "description": "Represents the request body schema for creating appointment records.", "properties": { "data": { "description": "Represents the data array containing the appointment objects to create.", "items": { "$ref": "#/components/schemas/AppointmentsDataNested" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" }, "PostappointmentssResponse200": { "additionalProperties": false, "description": "Represents the success response for the request to create appointment records, containing the result for each appointment.", "properties": { "data": { "description": "Represents the list of result objects for each created appointment record.", "items": { "$ref": "#/components/schemas/AppointmentsDataNested1" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PostappointmentssResponse200" }, "PostappointmentssResponse207ErrorItem": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseCore1168955151" }, { "$ref": "#/components/schemas/ErrorResponseCore622374562" }, { "$ref": "#/components/schemas/ErrorResponseCore261228299" }, { "$ref": "#/components/schemas/ErrorResponseCore1207168962" }, { "$ref": "#/components/schemas/ErrorResponseCore1818284114" }, { "$ref": "#/components/schemas/ErrorResponseCore1277582131" }, { "$ref": "#/components/schemas/ErrorResponseCore1593946428" }, { "$ref": "#/components/schemas/ErrorResponseCore2114620743" }, { "$ref": "#/components/schemas/ErrorResponseCore1332683101" }, { "$ref": "#/components/schemas/ErrorResponseCore1090893661" }, { "$ref": "#/components/schemas/ErrorResponseCore653152835" }, { "$ref": "#/components/schemas/ErrorResponseCore899638570" }, { "$ref": "#/components/schemas/ErrorResponseCore496791912" }, { "$ref": "#/components/schemas/ErrorResponseCore201487910" }, { "$ref": "#/components/schemas/ErrorResponseCore55175210" } ], "description": "Represents a single result item in the Multi-Status response for appointment updates, which is either a success response or an error response for the corresponding appointment record.", "x-zs-$id": "PostappointmentssResponse207ErrorItem" }, "PostcadencesResponse200": { "additionalProperties": false, "description": "Represents the successful response body for a Cadence enrollment or un-enrollment operation.", "properties": { "data": { "description": "Represents the list of operation results for the request.", "items": { "$ref": "#/components/schemas/SuccessDataNested" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "PostcadencesResponse200" }, "PostcadencesResponse202": { "additionalProperties": false, "description": "Represents the asynchronous acceptance response returned when the enrollment or unenrollment request is queued for background processing.", "properties": { "data": { "description": "Represents a single-entry array containing the SCHEDULED status marker for the queued enrollment request.", "items": { "$ref": "#/components/schemas/ScheduledDataNested" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PostcadencesResponse202" }, "PostcadencesResponse207": { "additionalProperties": false, "description": "Specify the multi-status response body for a Cadence enrollment or un-enrollment operation where some records succeeded and others failed.", "properties": { "data": { "description": "Specify the list of per-record operation results. Each item indicates success or failure for the corresponding record in the request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SuccessDataNested" }, { "$ref": "#/components/schemas/ErrorDataNested" } ], "description": "Specify a single per-record result that indicates success or failure for a specific record in the request." }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "PostcadencesResponse207" }, "PostdownloadmailmergeRequest": { "additionalProperties": false, "description": "Represents the request body schema for the download mail merge operation.", "properties": { "download_mail_merge": { "description": "Represents the list of download mail merge request objects. Contains one object per request.", "items": { "$ref": "#/components/schemas/DownloadMailMergeNested" }, "maxItems": 1, "type": "array" } }, "required": [ "download_mail_merge" ], "type": "object" }, "PostfieldupdatesResponse201": { "additionalProperties": false, "description": "Success response returned when a field update action is created. Contains an array with a single result object indicating the outcome and the server-generated ID of the new field update.", "properties": { "field_updates": { "description": "Array containing the result of the create operation. Always contains exactly one item since only one field update can be created per request.", "items": { "$ref": "#/components/schemas/FieldUpdateActionResult" }, "maxItems": 1, "type": "array" } }, "title": "Create Field Update Success Response", "type": "object", "x-zs-$id": "PostfieldupdatesResponse201", "x-zs-llm-description": "Success response after POST creation. Contains the created field update action ID in the result details." }, "PostmergeRequest": { "additionalProperties": false, "description": "Request body schema for merging tags.", "properties": { "tags": { "description": "Array containing the tag to merge (Required)", "items": { "$ref": "#/components/schemas/TagsActionsTagsNested" }, "maxItems": 1, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "PostmergeResponse200": { "additionalProperties": false, "description": "Success response when tags are merged successfully.", "properties": { "tags": { "description": "Array containing the merged tag details", "items": { "$ref": "#/components/schemas/TagsNested2" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PostmergeResponse200" }, "PostremovetagsRequest": { "additionalProperties": false, "description": "Request body schema for removing tags from records.", "properties": { "ids": { "description": "JSON array string of record IDs to remove tags from. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.\n", "enum": [ "[\"3060320000002496003\"]" ], "maxLength": 99, "type": [ "string", "null" ] }, "tags": { "description": "Array of tags to remove from the records (Required)", "items": { "$ref": "#/components/schemas/TagsActionsTagsNested" }, "maxItems": 1, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "PostremovetagsResponse200": { "additionalProperties": false, "description": "Success response when tags are removed from records successfully.", "properties": { "data": { "description": "Array of operation results for each record", "items": { "$ref": "#/components/schemas/TagsActionsDataNested" }, "maxItems": 20, "type": "array" }, "locked_count": { "description": "Number of records that were locked and could not be updated", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "PostremovetagsResponse200" }, "PostsendmailmergeRequest": { "additionalProperties": false, "description": "Represents the request body schema for the send mail merge operation.", "properties": { "send_mail_merge": { "description": "Represents the list of send mail merge request objects. Contains one object per request.", "items": { "$ref": "#/components/schemas/SendMailMergeNested" }, "maxItems": 1, "type": "array" } }, "required": [ "send_mail_merge" ], "type": "object" }, "PostsendmailmergeResponse200": { "additionalProperties": false, "description": "Represents the response body returned upon successful initiation of the send mail merge operation.", "example": { "send_mail_merge": [ { "code": "SUCCESS", "details": { "report_link": "https://example.com/report/12345" }, "message": "Mail merge sent successfully", "status": "success" } ] }, "properties": { "send_mail_merge": { "description": "Represents the list of send mail merge response objects.", "items": { "$ref": "#/components/schemas/SendMailMergeNested1" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PostsendmailmergeResponse200" }, "PostservicessRequest": { "additionalProperties": false, "description": "Request body schema for creating services. Contains a data array of service objects to be created and an optional skip_mandatory flag.", "properties": { "data": { "description": "Specify the array of service objects to be created. You can include up to 100 objects.", "items": { "$ref": "#/components/schemas/ServicesDataNested" }, "maxItems": 100, "minItems": 1, "type": "array" }, "skip_mandatory": { "description": "Specify whether to skip mandatory-field validation when creating service records.", "type": [ "boolean", "null" ] } }, "required": [ "data" ], "type": "object" }, "PostservicessResponse201": { "additionalProperties": false, "description": "Wrapped response for a service create request. Contains a per-record status array with the success code, persisted ID, and audit metadata for each service record processed.", "properties": { "data": { "description": "Represents the per-record status array, with one entry for each service record processed in the create request.", "items": { "$ref": "#/components/schemas/ServicesDataNested1" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PostservicessResponse201" }, "PostsignmailmergeRequest": { "additionalProperties": false, "description": "Represents the request body schema for the sign mail merge operation.", "properties": { "sign_mail_merge": { "description": "Represents the list of sign mail merge request objects. Contains one object per request.", "items": { "$ref": "#/components/schemas/SignMailMergeNested" }, "maxItems": 1, "type": "array" } }, "required": [ "sign_mail_merge" ], "type": "object" }, "PostsignmailmergeResponse200": { "additionalProperties": false, "description": "Represents the response body returned upon successful initiation of the sign mail merge operation.", "example": { "sign_mail_merge": [ { "code": "SUCCESS", "details": { "report_link": "https://example.com/sign/abc123xyz", "sign_resource_id": "abc123xyz" }, "message": "Document sent for signature successfully", "status": "success" } ] }, "properties": { "sign_mail_merge": { "description": "Represents the list of sign mail merge response objects.", "items": { "$ref": "#/components/schemas/SignMailMergeNested1" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PostsignmailmergeResponse200" }, "PosttagsRequest": { "additionalProperties": false, "description": "Represents the request body schema for the create tag operation.", "properties": { "tags": { "description": "Represents an array of tag objects to create. The array can contain a maximum of one item.", "items": { "$ref": "#/components/schemas/TagsTagsNested" }, "maxItems": 1, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "PosttagsResponse201": { "additionalProperties": false, "description": "Represents the response body for a successful tag creation.", "properties": { "tags": { "description": "Represents an array containing the result of the tag creation operation.", "items": { "$ref": "#/components/schemas/TagsTagsNested1" }, "maxItems": 20, "type": "array" } }, "type": "object", "x-zs-$id": "PosttagsResponse201" }, "PostusertypeRequest": { "additionalProperties": false, "description": "The request body schema for the create portal user type operation. Contains the `user_type` array with the configuration of the user type to be created.", "properties": { "user_type": { "description": "An array containing the portal user type configuration to create. Must contain exactly one user type object.", "items": { "$ref": "#/components/schemas/UserTypeNested" }, "maxItems": 1, "type": "array" } }, "required": [ "user_type" ], "type": "object" }, "PostusertypeResponse201": { "additionalProperties": false, "description": "Returned on successful creation of a new portal user type. Contains the identifier and name of the newly created user type.", "properties": { "user_type": { "description": "An array containing the full configuration of the newly created portal user type, including its generated identifier.", "items": { "$ref": "#/components/schemas/UserTypeNested1" }, "maxItems": 1, "type": "array" } }, "required": [ "user_type" ], "type": "object", "x-zs-$id": "PostusertypeResponse201" }, "PrivateModulePermissionsRequiredError": { "additionalProperties": false, "description": "Returned when the request attempts to configure a private CRM module without providing the required permissions. Private modules require explicit permission assignments.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "PrivateModulePermissionsRequiredError" }, "ProcessingAmbiguityError": { "additionalProperties": false, "description": "Represents an error response returned when ambiguity occurs while processing the request, typically when conflicting field references are detected in the same batch.", "properties": { "code": { "description": "Represents the error code **AMBIGUITY_DURING_PROCESSING**.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details containing the list of fields that caused the processing ambiguity.", "properties": { "ambiguity_due_to": { "description": "Represents an array of field references that caused the processing ambiguity.", "items": { "additionalProperties": false, "description": "Represents a single field reference that contributed to the processing ambiguity.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the processing ambiguity.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the processing ambiguity.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that ambiguity occurred during request processing.", "enum": [ "Ambiguity while processing the request" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Processing Ambiguity Error", "type": "object", "x-zs-$id": "ErrorResponseCore1916271986" }, "ProfileName": { "description": "Display name for the profile, up to 50 characters, excluding the special characters `~`, `` ` ``, `#`, `%`, `^`, `&`, `*`, `(`, `)`, `+`, `|`, `,`, `=`, `{`, `}`, `;`, `[`, `]`, `\"`.", "example": "Administrator", "maxLength": 50, "minLength": 1, "pattern": "^[^~`#%^&*()+|,={};\\[\\]\"]+$", "type": "string" }, "ProfileReference": { "additionalProperties": true, "description": "Represents the profile associated with a layout, including the profile's display name, type classification, default view assignment, and whether this is the default layout for that profile.", "properties": { "_default_assignment_view": { "additionalProperties": false, "description": "Represents the default view configuration used for record assignment for users belonging to this profile and layout combination.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId" }, "name": { "description": "Represents the name of the view used as the default for record assignment for this profile.", "example": "Standard", "maxLength": 100, "minLength": 1, "type": "string" }, "type": { "description": "Indicates the type of view used for record assignment. Possible values: `canvas` — a custom canvas view; `layout` — a standard field layout.", "enum": [ "canvas", "layout" ], "example": "layout", "type": "string" } }, "required": [ "name", "id", "type" ], "type": "object" }, "_default_view": { "additionalProperties": false, "description": "Represents the default view assigned to this profile for the layout, used when users of this profile open a record in the standard detail context.", "properties": { "id": { "$ref": "#/components/schemas/LayoutsId" }, "name": { "description": "Represents the name of the default view assigned to this profile for the layout.", "example": "Standard", "maxLength": 100, "minLength": 1, "type": "string" }, "type": { "description": "Indicates the type of the default view assigned to this profile. Possible values: `layout` — a standard field layout; `wizard` — a guided multi-step wizard.", "enum": [ "layout", "wizard" ], "example": "layout", "type": "string" } }, "required": [ "name", "id", "type" ], "type": "object" }, "default": { "description": "Indicates whether this profile is the default profile assignment for the layout. Possible values: `true` — this is the default profile; `false` — this is not the default profile.", "type": "boolean" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "name": { "description": "Represents the display name of the CRM profile associated with this layout assignment.", "example": "Administrator", "maxLength": 60, "minLength": 1, "type": "string" }, "type": { "description": "Represents the classification type of the profile, distinguishing between available profile tiers. Possible values: `normal_profile` — a full-access standard CRM profile. `lite_profile` — a restricted-access lite profile.", "enum": [ "normal_profile", "lite_profile" ], "example": "normal_profile", "type": "string" } }, "required": [ "_default_assignment_view", "default", "name", "id", "_default_view" ], "type": "object" }, "ProfileResourceRequestObject": { "additionalProperties": false, "description": "Profile resource reference for Assignment Rule entry.", "properties": { "id": { "description": "Specify the iD of the profile. Refer to the [Profiles API](profiles.yaml#$.paths./settings/profiles.get) resource for valid values.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" }, { "operationId": "cloneProfile", "propertyId": "ProfileResultId" } ], "resource": "profiles" } } }, "required": [ "id" ], "title": "Profile Resource Request Object", "type": "object" }, "ProfileTypeAssignToRequestObject": { "additionalProperties": false, "description": "Assigns ownership to a profile. All users under the specified profile are eligible for assignment.", "properties": { "resource": { "$ref": "#/components/schemas/ProfileResourceRequestObject", "description": "Details of the profile to assign" }, "type": { "description": "Assign to type IDentifier. Must be 'profile'.\nPossible values:\n**profile** - Represents profile.", "enum": [ "profile" ], "type": "string" } }, "required": [ "type", "resource" ], "title": "Profile type assign to request object", "type": "object", "x-zs-$id": "ProfileTypeAssignToRequestObject" }, "ProfileUpdateObject": { "additionalProperties": false, "description": "Represents a profile operation object used in layout update requests to add a profile to or remove a profile from the layout's permission associations.", "properties": { "_delete": { "description": "Indicates whether this profile's association with the layout should be removed. Possible values: `true` — the profile is disassociated from the layout; `false` — the profile association is retained or added.", "examples": [ true ], "type": "boolean" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the profile." } }, "required": [ "id" ], "type": "object" }, "ProfilesApiName": { "description": "API name of the profile, composed of alphanumeric characters and underscores and starting with a letter.", "example": "Team_User", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string" }, "ProfilesAuthenticationFailureError": { "additionalProperties": false, "description": "Error body returned when the OAuth access token is absent, expired, or otherwise invalid.", "properties": { "code": { "description": "Error code indicating the authentication failure. Possible values: `AUTHENTICATION_FAILURE`.", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object included with the authentication error.", "type": "object" }, "message": { "description": "Human-readable description of the authentication failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AuthenticationFailureError" }, "ProfilesCreatedBy": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/ProfilesUserReference" } ], "description": "User who created the profile.", "x-zs-$id": "CreatedByValue" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesTypeNull" } ], "description": "Null when creator information is not available.", "x-zs-$id": "CreatedByNull" } ], "description": "Creator of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when creator information is not available." }, "ProfilesCreatedTime": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/Timestamp" } ], "description": "Profile creation timestamp.", "x-zs-$id": "CreatedTimeValue" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesTypeNull" } ], "description": "Null when creation time is not available.", "x-zs-$id": "CreatedTimeNull" } ], "description": "Creation timestamp of the profile - an ISO 8601 datetime string, or null when creation time is not available." }, "ProfilesId": { "description": "Unique record identifier - a 64-bit integer encoded as a string of 1 to 19 decimal digits.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string" }, "ProfilesInternalServerError": { "additionalProperties": false, "description": "Error body returned when an unexpected server-side error prevents the request from completing.", "properties": { "code": { "description": "Error code for the internal server error. Possible values: `INTERNAL_ERROR`.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object included with the internal error.", "type": "object" }, "message": { "description": "Human-readable description of the internal server error.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InternalServerError" }, "ProfilesInvalidIdError": { "additionalProperties": false, "description": "Error body returned when the profile ID in the request path is invalid or refers to a deleted profile.", "properties": { "code": { "description": "Error code indicating an invalid profile ID. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the path segment that contains the invalid ID.", "properties": { "resource_path_index": { "description": "Zero-based index of the URL path segment that contains the invalid profile ID.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable description of the invalid ID error.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidIdError" }, "ProfilesInvalidRequestMethodError": { "additionalProperties": false, "description": "Error response returned when the endpoint does not support the specified HTTP method.", "properties": { "code": { "description": "Error code indicating an unsupported HTTP method. Possible values: `INVALID_REQUEST_METHOD`.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object included with the invalid method error.", "type": "object" }, "message": { "description": "Human-readable description of the invalid request method.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, "ProfilesLicenseLimitExceededError": { "additionalProperties": false, "description": "A LICENSE_LIMIT_EXCEEDED error returned when the organization has reached the maximum number of profiles allowed by its license.", "properties": { "code": { "description": "Error code indicating the license limit has been exceeded. \n**Possible values:**\n **LICENSE_LIMIT_EXCEEDED**.", "enum": [ "LICENSE_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object containing the license limit value.", "properties": { "limit": { "description": "Maximum number of profiles allowed by the organization's license.", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "A human-readable message describing the license limit exceeded error.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "LicenseLimitExceededError" }, "ProfilesModifiedBy": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/ProfilesUserReference" } ], "description": "User who last modified the profile.", "x-zs-$id": "ModifiedByValue" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesTypeNull" } ], "description": "Null when modifier information is not available.", "x-zs-$id": "ModifiedByNull" } ], "description": "Last modifier of the profile - a [UserReference](users.yaml#$.paths./users.get) object, or null when modifier information is not available." }, "ProfilesOAuthScopeMismatchError": { "additionalProperties": false, "description": "Error body returned when the access token does not include the OAuth scope required for the operation.", "properties": { "code": { "description": "Error code indicating an OAuth scope mismatch. Possible values: `OAUTH_SCOPE_MISMATCH`.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object included with the scope mismatch error.", "type": "object" }, "message": { "description": "Human-readable description of the scope mismatch.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "OAuthScopeMismatchError" }, "ProfilesTypeNull": { "description": "Represents a null value for optional fields.", "type": "null", "x-zs-$id": "TypeNull" }, "ProfilesUserReference": { "additionalProperties": false, "description": "Reference to the CRM user who performed an action on a profile.", "properties": { "id": { "$ref": "#/components/schemas/ProfilesId" }, "name": { "description": "Display name of the user as shown in Zoho CRM.", "example": "John Doe", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "UserReference" }, "PutScoringRulesPartialSuccessResponse": { "additionalProperties": false, "description": "Represents the multi-status response body for the bulk update Scoring Rules operation when some items succeed and others fail.", "properties": { "scoring_rules": { "description": "Represents an array of per-item operation statuses for the multi-status Scoring Rule operation.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 300, "type": "array" } }, "title": "Put Scoring Rules Partial Success Response", "type": "object", "x-zs-$id": "PutScoringRulesPartialSuccessResponse" }, "PutServiceByIdResponse200": { "additionalProperties": false, "description": "Wrapped response for a single service update request. Contains a data array with one status object carrying the success code, persisted ID, audit metadata, and affected_data block.", "properties": { "data": { "description": "Represents the per-record status array containing the result for the updated service record.", "items": { "$ref": "#/components/schemas/ServicesDataNested1" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PutServiceByIdResponse200" }, "PutactivateRequest": { "additionalProperties": false, "description": "Represents the request body schema for activating one or more Cadences.", "properties": {}, "type": "object" }, "PutappointmentByIdError403": { "additionalProperties": false, "description": "Represents the error response for Forbidden failures when updating a single appointment, containing a list of permission-error objects.", "properties": { "data": { "description": "Represents the list of permission-error objects returned for the failed appointment update action.", "items": { "$ref": "#/components/schemas/ErrorResponseCoreNoPermission" }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutappointmentByIdError403" }, "PutappointmentssRequest": { "additionalProperties": false, "description": "Represents the request body schema for updating appointment records.", "properties": { "data": { "description": "Represents the data array containing the appointment objects to update. ", "items": { "$ref": "#/components/schemas/AppointmentsDataNested" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" }, "PutappointmentssResponse200": { "additionalProperties": false, "description": "Represents the success response for the request to update appointment records.", "properties": { "data": { "description": "Represents the list of result objects for each updated appointment record.", "items": { "$ref": "#/components/schemas/AppointmentsDataNested1" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PutappointmentssResponse200" }, "PutfiscalyearRequest": { "additionalProperties": false, "description": "Represents the request body for updating the fiscal year settings of the Zoho CRM organization.", "properties": { "fiscal_year": { "$ref": "#/components/schemas/FiscalYearNested", "description": "Root key of the API (Required)" } }, "required": [ "fiscal_year" ], "type": "object" }, "PutpublishRequest": { "additionalProperties": false, "description": "Represents the request body schema for publishing one or more Cadences.", "properties": { "cadences": { "description": "Represents the list of Cadences to publish.", "items": { "additionalProperties": false, "description": "Represents the publish configuration for a single Cadence.", "properties": { "process_existing_records": { "description": "Represents whether existing records should be enrolled in the Cadence upon publication.", "type": "boolean" } }, "type": [ "object", "null" ] }, "maxItems": 1, "type": "array" } }, "required": [ "cadences" ], "type": "object" }, "PutservicesByIdError400Wrapper": { "additionalProperties": false, "description": "Represents the error response for a single service update request. It contains a data array with one or more error objects describing the validation failures that caused the request to fail.", "properties": { "data": { "description": "Represents the array of error objects, with each entry corresponding to a validation failure encountered during the service update request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataTypeGenericError" }, { "$ref": "#/components/schemas/InvalidDataForFieldError" }, { "$ref": "#/components/schemas/ServicesDuplicateDataError" }, { "$ref": "#/components/schemas/ServicesRecordLockedError" }, { "$ref": "#/components/schemas/AvailableDaysNotInBusinessDaysError" }, { "$ref": "#/components/schemas/ServiceTimeNotInBusinessTimingError" }, { "$ref": "#/components/schemas/ServicesInvalidDataGenericError" }, { "$ref": "#/components/schemas/DurationNotSatisfyServiceTimingError" }, { "$ref": "#/components/schemas/ServicesDependentFieldMissingError" }, { "$ref": "#/components/schemas/MembersAssociationLimitExceededError" }, { "$ref": "#/components/schemas/ActiveServicesLimitExceededError" }, { "$ref": "#/components/schemas/JobSheetSectionDependentMismatchError" }, { "$ref": "#/components/schemas/ToValueMustBeGreaterThanFromError" }, { "$ref": "#/components/schemas/AvailableDatesInHolidayOrNonBusinessDayError" }, { "$ref": "#/components/schemas/MembersNotConfirmedError" }, { "$ref": "#/components/schemas/MembersNotActiveError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableFromFutureError" }, { "$ref": "#/components/schemas/ScheduledServiceStatusRestrictionError" }, { "$ref": "#/components/schemas/NotInUseStatusWithFutureUnavailableFromError" }, { "$ref": "#/components/schemas/ScheduledStatusPastStartDateError" }, { "$ref": "#/components/schemas/PastEndDateStatusConflictError" }, { "$ref": "#/components/schemas/UnavailableFromTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/UnavailableTillTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/InvalidRequestPayloadError" }, { "$ref": "#/components/schemas/InvalidDurationRangeError" }, { "$ref": "#/components/schemas/JobSheetNotConfiguredError" }, { "$ref": "#/components/schemas/ServiceAvailabilityInvalidStatusChangeError" }, { "$ref": "#/components/schemas/InvalidAvailabilityTypeNotInPicklistError" }, { "$ref": "#/components/schemas/ServicesMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/ServiceUnavailableTillFutureError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableWindowRuleError" }, { "$ref": "#/components/schemas/UnavailableWindowOrderError" }, { "$ref": "#/components/schemas/RequiredFieldNotFoundError" }, { "$ref": "#/components/schemas/InvalidCustomTimeError" } ], "description": "Represents one error object within the service update error response. Each entry corresponds to a specific validation failure encountered during the request." }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "title": "Wrapped PUT Service By Id Error Response", "type": "object", "x-zs-$id": "PutservicesByIdError400Wrapper" }, "PutservicessBulkRequest": { "additionalProperties": false, "description": "Request body schema for updating multiple services. Contains a data array with up to 100 service objects, each identified by its ID and carrying the fields to be updated.", "properties": { "data": { "description": "Specify the array of service objects to be updated. You can include up to 100 objects.", "items": { "$ref": "#/components/schemas/DataNestedV2" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutservicessBulkRequest" }, "PutservicessRequest": { "additionalProperties": false, "description": "Request body schema for updating a single service. Contains a data array with exactly one service object that carries the fields to be updated.", "properties": { "data": { "description": "Specify the array containing the single service object to be updated.", "items": { "$ref": "#/components/schemas/DataNestedV2" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" }, "PutservicessResponse200": { "additionalProperties": false, "description": "Wrapped response for a bulk service update request. Contains a per-record status array with the success code and audit metadata for each processed service.", "properties": { "data": { "description": "Represents the per-record status array, with one entry for each service record processed in the bulk update.", "items": { "$ref": "#/components/schemas/ServicesDataNested1" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PutserviessResponse200" }, "PuttagsRequest": { "additionalProperties": true, "description": "Represents the request body schema for the update tag operation.", "properties": { "tags": { "description": "Represents an array of tag objects to update. The array can contain a maximum of one item.", "items": { "$ref": "#/components/schemas/TagsTagsNested" }, "maxItems": 1, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "PuttagsResponse200": { "additionalProperties": false, "description": "Represents the response body returned when a tag update operation completes successfully.", "properties": { "tags": { "description": "Represents an array containing the result of the tag update operation.", "items": { "$ref": "#/components/schemas/TagsTagsNested1" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PuttagsResponse200" }, "PutusertypeRequest": { "additionalProperties": false, "description": "The request body schema for the update portal user type operation. Contains the `user_type` array with the fields to be updated.", "properties": { "user_type": { "description": "An array containing the portal user type configuration to update. Must contain exactly one user type object with the fields to be modified.", "items": { "$ref": "#/components/schemas/UserTypeNestedV2" }, "maxItems": 1, "type": "array" } }, "required": [ "user_type" ], "type": "object" }, "PutusertypeResponse200": { "additionalProperties": false, "description": "Returned on successful update of a portal user type. Contains the identifier and name of the updated user type.", "properties": { "user_type": { "description": "An array containing the result of the update operation, including the updated user type identifier.", "items": { "$ref": "#/components/schemas/UserTypeNested2" }, "maxItems": 1, "type": "array" } }, "required": [ "user_type" ], "type": "object", "x-zs-$id": "PutusertypeResponse200" }, "QueuedActionUsageMetricsSchema": { "additionalProperties": false, "description": "Represents usage metrics for a single queued workflow action, including success, failure, and queue counts within a queried date range.", "properties": { "associated_time": { "description": "Represents the ISO 8601 timestamp indicating when this queued action was last associated with or modified on a workflow rule.", "maxLength": 255, "type": "string" }, "failure_count": { "description": "Represents the total number of failed executions recorded for this queued action within the queried date range.", "format": "int32", "type": "integer" }, "id": { "description": "Represents the unique ID of the QueuedActionUsageMetrics within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the workflow rule or its associated queued action as configured in Zoho CRM.", "maxLength": 255, "type": "string" }, "queue_count": { "description": "Represents the number of executions currently queued and pending for this action.", "format": "int32", "type": "integer" }, "related_details": { "$ref": "#/components/schemas/EmailEngagementMetricsSchema" }, "success_count": { "description": "Represents the total number of successful executions recorded for this queued action within the queried date range.", "format": "int32", "type": "integer" }, "type": { "description": "Represents the category of queued workflow action. Possible values include **email_notifications**, **field_updates**, **tasks**, **webhooks**, **functions**, **assign_owner**, **add_tags**, **remove_tags**, **create_record**, **add_meeting**, **schedule_call**, and **convert**.", "maxLength": 255, "type": "string" } }, "required": [ "associated_time", "failure_count", "id", "name", "queue_count", "related_details", "success_count", "type" ], "title": "Queued Action Usage Metrics", "type": "object", "x-zs-$id": "QueuedActionUsageMetricsSchema", "x-zs-llm-description": "Action usage entry with queue tracking. Contains queue_count (pending executions), success_count, failure_count, related_details (email engagement if applicable), name, id, type, and associated_time." }, "ReOrderSuccessResponseSchema": { "additionalProperties": false, "description": "Represents the success response returned after reordering workflow rules.", "properties": { "reorder": { "description": "Represents the array of workflow rule objects with their updated execution order.", "items": { "$ref": "#/components/schemas/SuccessResponseNestedSchema" }, "maxItems": 125, "type": "array" } }, "type": "object", "x-zs-$id": "ReOrderSuccessResponseSchema", "x-zs-llm-description": "Success response wrapper for the reorderWorkflowRules operation. Contains reorder array confirming the new execution sequence was applied." }, "ReadOnlyWebhookDeleteNotAllowedError": { "additionalProperties": false, "description": "Represents the error returned when a request attempts to delete a read-only webhook.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The read-only webhook cannot be deleted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the webhook ID that cannot be deleted.", "properties": { "id": { "description": "Represents the ID of the read-only webhook that cannot be deleted.", "maxLength": 20, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Insufficient privileges to delete Read only webhook** - The requesting user does not have permission to delete this read-only webhook.", "enum": [ "Insufficient privileges to delete Read only webhook" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ReadOnlyWebhookDeleteNotAllowedError", "x-zs-llm-description": "Cannot delete a read-only webhook." }, "ReadOnlyWebhookNotAllowedError": { "additionalProperties": false, "description": "Represents the error returned when a request attempts to edit a read-only webhook created by a Marketplace extension.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The read-only webhook cannot be edited.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the webhook ID that cannot be edited.", "properties": { "api_name": { "description": "Represents the API name of the field on the read-only webhook that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field on the read-only webhook that triggered the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Insufficient privileges to edit Read only webhook** - The requesting user does not have permission to edit this read-only webhook.", "enum": [ "Insufficient privileges to edit Read only webhook" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ReadOnlyWebhookNotAllowedError", "x-zs-llm-description": "Cannot edit/delete a read-only webhook (created by extensions or marketplace apps)." }, "RecipientNested": { "additionalProperties": false, "description": "Represents the recipient details for a signing or approval action, including the identifier type and value.", "properties": { "type": { "description": "Represents the type of recipient identifier.\nPossible values:\n**email** - The recipient is identified by a direct email address.\n**merge_field** - The recipient is identified by a mail merge field reference.\n", "enum": [ "email", "merge_field" ], "maxLength": 11, "type": "string" }, "value": { "description": "Represents the email address or mail merge field reference for the recipient. When **type** is **email**, provide a valid email address. When **type** is **merge_field**, provide a merge field reference such as **${!Leads.Email}**.", "maxLength": 255, "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "RecordAuthenticationFailureResponse": { "additionalProperties": false, "description": "Represents the response schema for the record authentication failure operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordAuthenticationFailureResponse" }, "RecordAuthorizationFailedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a authorization failed error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "resource_path_index": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AuthorizationFailedError" }, "RecordCountErrorResponse": { "additionalProperties": false, "description": "Represents a standard error response returned by the Zoho CRM API when a request fails.", "properties": { "code": { "description": "Represents the unique error code that identifies the type of failure.", "maxLength": 64, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, which may include the field API name or parameter name associated with the failure.", "type": "object" }, "message": { "description": "Represents the error message describing the reason for the failure.", "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the response status. Possible values:\n**error** - The request resulted in an error.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "ErrorResponse" }, "RecordCriteriaSchema": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/FilterCriterionRequest" }, { "description": "To remove criteria from an existing rule entry, set criteria as null in update request.", "type": "null", "x-zs-$id": "RuleEntryCriteriaNullUpdateRequestFormat" } ], "description": "Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators." }, "RecordDeleteAuthorizationFailedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete authorization failed error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteEmptyDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteAuthorizationFailedError" }, "RecordDeleteBadRequestResponse": { "anyOf": [ { "$ref": "#/components/schemas/RecordDeleteFlatError" }, { "$ref": "#/components/schemas/RecordDeleteLockedError" }, { "$ref": "#/components/schemas/RecordDeleteNotApprovedError" }, { "$ref": "#/components/schemas/RecordDeleteInvalidDataError" } ], "description": "Represents the response schema for the record delete bad request operation.", "x-zs-$id": "RecordDeleteBadRequestResponse" }, "RecordDeleteByIdAuthorizationFailedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete by ID authorization failed error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteEmptyDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteByIdAuthorizationFailedError" }, "RecordDeleteByIdDetails": { "additionalProperties": false, "description": "Details object returned when a delete-by-ID request fails due to an invalid record ID.", "properties": { "id": { "description": "ID of the record that caused the error.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "RecordDeleteByIdDetails" }, "RecordDeleteByIdErrorResponse": { "anyOf": [ { "$ref": "#/components/schemas/RecordDeleteByIdFlatError" }, { "$ref": "#/components/schemas/RecordDeleteByIdLockedError" }, { "$ref": "#/components/schemas/RecordDeleteByIdNotApprovedError" } ], "description": "Represents the error response returned when the operation fails due to a record delete by ID response error.", "x-zs-$id": "RecordDeleteByIdErrorResponse" }, "RecordDeleteByIdFlatError": { "anyOf": [ { "$ref": "#/components/schemas/RecordDeleteByIdInvalidDataError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/RecordDeleteByIdInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordDeleteByIdAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDeleteByIdRequiredParamMissingError" } ], "description": "Represents the error response returned when the operation fails due to a record delete by ID flat error.", "x-zs-$id": "RecordDeleteByIdFlatError" }, "RecordDeleteByIdInternalServerErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete by ID internal server response error.", "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteByIdInternalServerErrorResponse array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "type": "object" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteByIdInternalServerErrorResponse" }, "RecordDeleteByIdInvalidDataError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete by ID invalid data error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteByIdResourcePathDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteByIdInvalidDataError" }, "RecordDeleteByIdInvalidRequestMethodError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete by ID invalid request method error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteEmptyDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteByIdInvalidRequestMethodError" }, "RecordDeleteByIdInvalidUrlPatternResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete by ID invalid URL pattern operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteByIdInvalidUrlPatternResponse" }, "RecordDeleteByIdLockedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete by ID locked error.", "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteByIdLockedError array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "action": { "description": "Represents the data value.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the data value.", "format": "int64", "type": "string" } }, "required": [ "action", "id" ], "type": "object" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteByIdLockedError" }, "RecordDeleteByIdNoPermissionResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete by ID no permission operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "permissions": { "description": "Contains additional context about the error.", "items": { "description": "Represents a single item in the RecordDeleteByIdNoPermissionResponse array.", "maxLength": 255, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteByIdNoPermissionResponse" }, "RecordDeleteByIdNotApprovedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete by ID not approved error.", "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteByIdNotApprovedError array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "NOT_APPROVED" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteByIdDetails" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteByIdNotApprovedError" }, "RecordDeleteByIdRequiredParamMissingError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete by ID required parameter missing error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteRequiredParamDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteByIdRequiredParamMissingError" }, "RecordDeleteByIdResourcePathDetails": { "additionalProperties": false, "description": "Contains the contextual details for the record delete by ID resource path error.", "properties": { "resource_path_index": { "description": "Represents the zero-based index indicating which resource in the path caused the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "RecordDeleteByIdResourcePathDetails" }, "RecordDeleteByIdSuccessResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete by ID success operation.", "examples": [ { "data": [ { "code": "SUCCESS", "details": { "id": "5843104000000624046" }, "message": "record deleted", "status": "success" } ] } ], "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteByIdSuccessResponse array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteByIdSuccessResponse" }, "RecordDeleteByIdUnauthorizedResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete by ID unauthorized operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteByIdUnauthorizedResponse" }, "RecordDeleteEmptyDetails": { "additionalProperties": false, "description": "Contains the contextual details for the record delete empty error.", "examples": [ {} ], "maxProperties": 0, "type": "object", "x-zs-$id": "RecordDeleteEmptyDetails" }, "RecordDeleteFlatError": { "anyOf": [ { "$ref": "#/components/schemas/RecordDeleteRequiredParamMissingError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/RecordDeleteInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordDeleteAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDeleteUnableToParseDataTypeError" } ], "description": "Represents the error response returned when the operation fails due to a record delete flat error.", "x-zs-$id": "RecordDeleteFlatError" }, "RecordDeleteInternalErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete internal response error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteInternalErrorResponse" }, "RecordDeleteInvalidDataError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete invalid data error.", "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteInvalidDataError array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteInvalidDataError" }, "RecordDeleteInvalidDataItem": { "additionalProperties": false, "description": "Represents a single record delete invalid data result item.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "maxLength": 20, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RecordDeleteInvalidDataItem" }, "RecordDeleteInvalidRequestMethodError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete invalid request method error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteEmptyDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteInvalidRequestMethodError" }, "RecordDeleteInvalidURLResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete invalid URL operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteInvalidURLResponse" }, "RecordDeleteLockedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete locked error.", "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteLockedError array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "action": { "description": "Represents the data value.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the data value.", "format": "int64", "type": "string" } }, "required": [ "action", "id" ], "type": "object" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteLockedError" }, "RecordDeleteMultiStatusResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete multi status operation.", "properties": { "data": { "allOf": [ { "description": "Represents the response schema for the record delete multi status operation." }, { "description": "Represents the response schema for the record delete multi status operation." } ], "description": "Represents the data value.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents the response schema for the record delete multi status operation.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RecordDeleteSuccessItem" }, { "$ref": "#/components/schemas/RecordDeleteInvalidDataItem" }, { "$ref": "#/components/schemas/RecordDeleteRequiredParamMissingItem" } ], "description": "Represents a single item in the RecordDeleteMultiStatusResponse array." }, "maxItems": 100, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteMultiStatusResponse" }, "RecordDeleteNotApprovedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete not approved error.", "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteNotApprovedError array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "NOT_APPROVED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "maxProperties": 0, "type": "object" }, "message": { "description": "Represents the data value.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteNotApprovedError" }, "RecordDeletePermissionResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete permission operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "permissions": { "description": "Contains additional context about the error.", "items": { "description": "Represents a single item in the RecordDeletePermissionResponse array.", "maxLength": 255, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeletePermissionResponse" }, "RecordDeleteRequiredParamDetails": { "additionalProperties": false, "description": "Contains the contextual details for the record delete required parameter error.", "examples": [ { "param_name": "ids" } ], "properties": { "param_name": { "description": "Represents the name of the parameter that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "RecordDeleteRequiredParamDetails" }, "RecordDeleteRequiredParamMissingError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record delete required parameter missing error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteRequiredParamDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteRequiredParamMissingError" }, "RecordDeleteRequiredParamMissingItem": { "additionalProperties": false, "description": "Represents a single record delete required parameter missing result item.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "param_name": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RecordDeleteRequiredParamMissingItem" }, "RecordDeleteSuccessResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete success operation.", "examples": [ { "data": [ { "code": "SUCCESS", "details": { "id": "410405000002264040" }, "message": "record deleted", "status": "success" } ] } ], "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordDeleteSuccessResponse array.", "properties": { "code": { "description": "Represents the data value.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the data value.", "enum": [ "record deleted" ], "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordDeleteSuccessResponse" }, "RecordDeleteUnableToParseDataTypeError": { "additionalProperties": false, "description": "Error returned when the DELETE request contains data that cannot be parsed.", "properties": { "code": { "description": "Error code indicating unable to parse data type.", "enum": [ "UNABLE_TO_PARSE_DATA_TYPE" ], "type": "string" }, "details": { "$ref": "#/components/schemas/RecordDeleteEmptyDetails" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteUnableToParseDataTypeError" }, "RecordDeleteUnauthorizedResponse": { "additionalProperties": false, "description": "Represents the response schema for the record delete unauthorized operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordDeleteUnauthorizedResponse" }, "RecordDependentFieldMissingError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a dependent field missing error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DependentFieldMissingError" }, "RecordDependentMismatchError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a dependent mismatch error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" }, "resource_path_index": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DependentMismatchError" }, "RecordDuplicateDataError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a duplicate data error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "duplicate_record": { "additionalProperties": true, "description": "Information about the existing record that has the duplicate value, containing field values from the duplicate record.", "properties": { "Owner": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 101, "type": "string" }, "zuid": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "id" ], "type": "object" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "maxLength": 255, "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" }, "more_records": { "description": "Contains additional context about the error.", "type": "boolean" } }, "required": [ "api_name", "json_path", "duplicate_record", "more_records" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateDataError" }, "RecordForbiddenErrorResponse": { "additionalProperties": false, "description": "Represents the forbidden error response returned when the user does not have the required record-level permissions in the specified module.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "permissions": { "description": "Represents the list of permissions that the user is missing.", "items": { "description": "Each string represents the permission name that the user is missing.", "maxLength": 200, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RecordForbiddenErrorResponse" }, "RecordGETDataItem": { "additionalProperties": true, "description": "Represents a single record GET data result item.", "properties": { "$state": { "description": "This will be as Save or Draft. 'save' indicates the record is not in any active Blueprint", "example": "save", "maxLength": 255, "type": "string" }, "$wizard_connection_path": { "description": "$wizard_connection_path information denoted by comma separated connection ids between wizard screens.", "maxLength": 2000, "readOnly": false, "type": [ "string", "null" ] }, "Created_By": { "additionalProperties": false, "description": "Contains information about the user who originally created the record.", "properties": { "email": { "description": "Contains information about the user who originally created the record.", "maxLength": 255, "type": "string" }, "id": { "description": "Contains information about the user who originally created the record.", "format": "int64", "type": "string" }, "name": { "description": "Contains information about the user who originally created the record.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the timestamp when the record was originally created.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains information about the user who last modified the record.", "properties": { "email": { "description": "Contains information about the user who last modified the record.", "maxLength": 255, "type": "string" }, "id": { "description": "Contains information about the user who last modified the record.", "format": "int64", "type": "string" }, "name": { "description": "Contains information about the user who last modified the record.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Represents the timestamp when the record was last modified.", "format": "date-time", "type": "string" }, "Owner": { "additionalProperties": false, "description": "Represents the owner value.", "properties": { "email": { "description": "Represents the owner value.", "maxLength": 256, "type": "string" }, "id": { "description": "Represents the owner value.", "format": "int64", "type": "string" }, "name": { "description": "Represents the owner value.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Wizard": { "additionalProperties": false, "description": "Represents the wizard value.", "properties": { "id": { "description": "Represents the wizard value.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "id": { "description": "Represents the unique identifier of the RecordGETDataItem record.", "format": "int64", "type": "string", "x-zs-$id": "RecordsId" } }, "type": "object", "x-zs-$id": "RecordGETDataItem" }, "RecordGETSuccessResponse": { "additionalProperties": false, "description": "Represents the response schema for the record GET success operation.", "properties": { "data": { "description": "Represents the data value.", "items": { "$ref": "#/components/schemas/RecordGETDataItem" }, "maxItems": 100, "minItems": 1, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents the info value.", "properties": { "call": { "description": "Represents the info value.", "type": "boolean" }, "count": { "description": "Represents the info value.", "format": "int32", "type": "integer" }, "email": { "description": "Represents the info value.", "type": "boolean" }, "more_records": { "description": "Represents the info value.", "type": "boolean" }, "next_page_token": { "description": "Represents the info value.", "maxLength": 500, "type": [ "string", "null" ] }, "page": { "description": "Represents the info value.", "format": "int32", "type": "integer" }, "page_token_expiry": { "description": "Represents the info value.", "format": "date-time", "type": [ "string", "null" ] }, "per_page": { "description": "Represents the info value.", "format": "int32", "type": "integer" }, "previous_page_token": { "description": "Represents the info value.", "maxLength": 500, "type": [ "string", "null" ] }, "sort_by": { "description": "Represents the info value.", "maxLength": 255, "type": "string" }, "sort_order": { "description": "Represents the info value.", "enum": [ "asc", "desc" ], "type": "string" } }, "required": [ "page", "per_page", "count", "more_records", "sort_by", "sort_order", "next_page_token", "previous_page_token", "page_token_expiry" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "RecordGETSuccessResponse" }, "RecordIDGETSuccessResponse": { "additionalProperties": false, "description": "Represents the response schema for the record ID GET success operation.", "properties": { "data": { "description": "Represents the data value.", "items": { "$ref": "#/components/schemas/RecordGETDataItem" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordIDGETSuccessResponse" }, "RecordInternalErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record internal response error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordInternalErrorResponse" }, "RecordInvalidDataMaxLengthError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to invalid data exceeding the maximum length.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Represents the API name for which the data exceeded the maximum length.", "maxLength": 50, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path for the field that exceeded the maximum length.", "type": "string" }, "maximum_length": { "description": "Represents the maximum length that was exceeded.", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataMaxLengthError" }, "RecordInvalidDataTypeError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid data type error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/InvalidDataTypeMismatchDetails", "description": "Additional information pinpointing exactly what was invalid. The structure varies based on the cause of the error." }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataTypeError" }, "RecordInvalidModuleError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid module error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "resource_path_index": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, "RecordInvalidRequestMethodError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a invalid request method error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "resource_path_index": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, "RecordInvalidURLResponse": { "additionalProperties": false, "description": "Represents the response schema for the record invalid URL operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordInvalidURLResponse" }, "RecordLevelSharingNotSupportedForModuleErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when record-level sharing is not supported for the module specified in the request URL.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "Record Level Sharing is not supported for this module" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RecordLevelSharingNotSupportedForModuleErrorResponse" }, "RecordLimitExceededError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a limit exceeded error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "maximum_length": { "description": "Contains additional context about the error.", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "LimitExceededError" }, "RecordMandatoryNotFoundError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a mandatory not found error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "api_name": { "description": "Contains additional context about the error.", "example": "Last_Name", "maxLength": 50, "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "example": "$.data[0].Last_Name", "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, "RecordNotDeletedError": { "additionalProperties": false, "description": "Error response returned when a service record referenced in a DELETE request could not be deleted.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment that caused the failure.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing that the service record could not be deleted.", "enum": [ "record not deleted" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RecordNotDeletedError" }, "RecordNotFoundError": { "additionalProperties": false, "description": "Represents an error response returned when the specified record does not exist or cannot be found.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "RecordNotFoundError" }, "RecordPermissionResponse": { "additionalProperties": false, "description": "Represents the response schema for the record permission operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "permissions": { "description": "Contains additional context about the error.", "items": { "description": "Represents a single item in the RecordPermissionResponse array.", "maxLength": 255, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordPermissionResponse" }, "RecordPhotoErrorDetailsEmpty": { "additionalProperties": false, "description": "Represents an empty details object returned when no additional error context is available for the error response.", "type": "object", "x-zs-$id": "RecordPhotoErrorDetailsEmpty" }, "RecordPostErrorDataItem": { "anyOf": [ { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/RecordInvalidDataMaxLengthError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/NotAllowedDataValueError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/MultipleOrMultiErrorsError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/DependentServiceError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundLayoutRuleWriteError" }, { "$ref": "#/components/schemas/RecordDependentMismatchError" }, { "$ref": "#/components/schemas/RecordInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDuplicateDataError" } ], "description": "Represents the error response returned when the operation fails due to a record post data item error.", "x-zs-$id": "RecordPostErrorDataItem" }, "RecordPostSuccessDataItem": { "additionalProperties": false, "description": "Represents a single record post success data result item.", "examples": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "5725767000000524157" }, "message": "record added", "status": "success" } ], "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "$approval_state": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" }, "$approved": { "description": "Contains additional context about the error.", "type": "boolean" }, "$has_more": { "additionalProperties": true, "description": "Contains additional context about the error.", "type": "object" }, "$layout_id": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "display_label": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "$locked_for_me": { "description": "Contains additional context about the error.", "type": "boolean" }, "$process_flow": { "description": "Contains additional context about the error.", "type": "boolean" }, "$state": { "description": "Contains additional context about the error.", "example": "save", "maxLength": 255, "type": "string" }, "$status": { "description": "Contains additional context about the error.", "example": "cv_1", "maxLength": 255, "type": "string" }, "$wizard_connection_path": { "description": "$wizard_connection_path information denoted by comma separated connection ids between wizard screens.", "maxLength": 2000, "readOnly": false, "type": [ "string", "null" ] }, "Created_By": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Contains additional context about the error.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Contains additional context about the error.", "format": "date-time", "type": "string" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string", "x-zs-$id": "RecordDetailsId" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordPostSuccessDataItem" }, "RecordProcessingSummary": { "additionalProperties": false, "description": "Represents the summary of record-level impact for the job, including total records evaluated, successfully processed, and failed.", "properties": { "failed": { "description": "Represents the failed records.", "format": "int32", "type": "integer" }, "processed": { "description": "Represents the processed records.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the total records.", "format": "int32", "type": "integer" } }, "required": [ "failed", "processed", "total" ], "title": "Record Processing Summary", "type": "object" }, "RecordPutErrorDataItem": { "anyOf": [ { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/MultipleOrMultiErrorsError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/DependentServiceError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/RecordDependentMismatchError" }, { "$ref": "#/components/schemas/RecordInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDuplicateDataError" }, { "$ref": "#/components/schemas/RecordRecordLockedError" }, { "$ref": "#/components/schemas/NotApprovedError" }, { "$ref": "#/components/schemas/NotReviewedError" } ], "description": "Represents the error response returned when the operation fails due to a record put data item error.", "x-zs-$id": "RecordPutErrorDataItem" }, "RecordPutWriteDataItem": { "additionalProperties": true, "description": "Represents a single record put write data result item.", "properties": { "$append_values": { "description": "Represents the $append values value.", "examples": [ "true" ], "maxLength": 10, "type": "string" }, "Layout": { "additionalProperties": false, "description": "Represents the layout value. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID.", "properties": { "id": { "description": "Represents the layout value.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" } ], "resource": "layouts" } } }, "required": [ "id" ], "type": "object" }, "id": { "description": "Represents the unique identifier of the RecordPutWriteDataItem record. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecord", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "id" ], "type": "object", "x-zs-$id": "RecordPutWriteDataItem" }, "RecordRecordLockedError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a record locked error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "action": { "description": "The specific action that was attempted on the locked record, such as record_locking.", "maxLength": 50, "type": "string" }, "api_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "api_name", "json_path", "action" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RecordLockedError" }, "RecordSinglePutWriteDataItem": { "additionalProperties": true, "description": "Represents a single record single put write data result item.", "properties": { "$append_values": { "description": "Represents the $append values value.", "examples": [ "true" ], "maxLength": 10, "type": "string" }, "Layout": { "additionalProperties": false, "description": "Represents the layout value. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID.", "properties": { "id": { "description": "Represents the layout value.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" } ], "resource": "layouts" } } }, "required": [ "id" ], "type": "object" } }, "type": "object", "x-zs-$id": "RecordSinglePutWriteDataItem" }, "RecordSuccessResponse": { "additionalProperties": false, "description": "Represents the response schema for the recordsuccess operation.", "examples": [ { "data": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "5725767000000524157" }, "message": "record added", "status": "success" } ] } ], "properties": { "data": { "description": "Represents the data value.", "items": { "$ref": "#/components/schemas/RecordPostSuccessDataItem" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordSuccessResponse" }, "RecordUnauthorizedResponse": { "additionalProperties": false, "description": "Represents the response schema for the record unauthorized operation.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordUnauthorizedResponse" }, "RecordUpsertErrorDataItem": { "anyOf": [ { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/MultipleOrMultiErrorsError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/RecordDependentMismatchError" }, { "$ref": "#/components/schemas/RecordInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDuplicateDataError" } ], "description": "Represents the error response returned when the operation fails due to a record upsert data item error.", "x-zs-$id": "RecordUpsertErrorDataItem" }, "RecordUpsertSuccessDataItem": { "additionalProperties": false, "description": "Represents a single record upsert success data result item.", "examples": [ { "action": "insert", "code": "SUCCESS", "details": { "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "111112000000142001" }, "duplicate_field": "Email", "message": "record added", "status": "success" } ], "properties": { "action": { "description": "Represents the action that triggered the record lock.", "enum": [ "insert", "update" ], "type": "string" }, "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "$approval_state": { "description": "Contains additional context about the error.", "maxLength": 255, "type": "string" }, "Created_By": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Contains additional context about the error.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" }, "name": { "description": "Contains additional context about the error.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Contains additional context about the error.", "format": "date-time", "type": "string" }, "id": { "description": "Contains additional context about the error.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "duplicate_field": { "description": "Represents the duplicate field value.", "example": "Email", "maxLength": 255, "type": [ "string", "null" ] }, "message": { "description": "Represents the error message describing why the operation failed.", "example": "Record successfully upserted.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "duplicate_field", "action", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordUpsertSuccessDataItem" }, "RecordUpsertSuccessResponse": { "additionalProperties": false, "description": "Represents the response schema for the record upsert success operation.", "examples": [ { "data": [ { "action": "insert", "code": "SUCCESS", "details": { "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "111112000000142001" }, "duplicate_field": "Email", "message": "record added", "status": "success" } ] } ], "properties": { "data": { "description": "Represents the data value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordUpsertSuccessResponse array.", "properties": { "action": { "description": "Represents the data value.", "enum": [ "insert", "update" ], "type": "string" }, "code": { "description": "Represents the data value.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "$approval_state": { "description": "Represents the data value.", "maxLength": 255, "type": "string" }, "Created_By": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" }, "name": { "description": "Represents the data value.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the data value.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the data value.", "properties": { "id": { "description": "Represents the data value.", "format": "int64", "type": "string" }, "name": { "description": "Represents the data value.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Represents the data value.", "format": "date-time", "type": "string" }, "id": { "description": "Represents the data value.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "duplicate_field": { "description": "Represents the data value.", "example": "Email", "maxLength": 255, "type": [ "string", "null" ] }, "message": { "description": "Represents the data value.", "example": "Record successfully upserted.", "type": "string" }, "status": { "description": "Represents the data value.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "duplicate_field", "action", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordUpsertSuccessResponse" }, "RecordWriteDataItem": { "additionalProperties": true, "description": "Represents a single record write data result item.", "properties": { "Layout": { "additionalProperties": false, "description": "Represents the layout value. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve the Layout ID.", "properties": { "id": { "description": "Represents the layout value.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" } ], "resource": "layouts" } } }, "required": [ "id" ], "type": "object" }, "Wizard": { "additionalProperties": false, "description": "Represents the wizard value. Use the [Get Wizards API](wizards.yaml#$.paths./settings/wizards.get) to retrieve the Wizard ID.", "properties": { "id": { "description": "Represents the wizard value.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getAllWizards", "propertyId": "WizardId" } ], "resource": "wizards" } } }, "required": [ "id" ], "type": "object" } }, "type": "object", "x-zs-$id": "RecordWriteDataItem" }, "RecordsDataPostErrorResponse": { "additionalProperties": false, "description": "Standard error response schema returned when one or more record operations fail.", "properties": { "data": { "description": "List of error objects describing failures encountered while processing record operation requests.", "items": { "$ref": "#/components/schemas/RecordPostErrorDataItem" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "x-zs-$id": "RecordsDataPostErrorResponse" }, "RecordsDataPutErrorResponse": { "additionalProperties": false, "description": "Standard error response schema returned when one or more record operations fail.", "properties": { "data": { "description": "List of error objects describing failures encountered while processing record operation requests.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/MultipleOrMultiErrorsError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundLayoutRuleWriteError" }, { "$ref": "#/components/schemas/RecordDependentMismatchError" }, { "$ref": "#/components/schemas/RecordInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDuplicateDataError" }, { "$ref": "#/components/schemas/RecordRecordLockedError" }, { "$ref": "#/components/schemas/NotApprovedError" }, { "$ref": "#/components/schemas/NotReviewedError" }, { "$ref": "#/components/schemas/RecordLimitExceededError" }, { "$ref": "#/components/schemas/DuplicateLinkingDataError" }, { "$ref": "#/components/schemas/DependentServiceError" }, { "$ref": "#/components/schemas/NotAllowedDataValueError" } ], "description": "Error object that can be one of multiple error types based on the error code." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordsDataPutErrorResponse" }, "RecordsDataUpsertErrorResponse": { "additionalProperties": false, "description": "Standard error response schema returned when one or more record operations fail.", "properties": { "data": { "description": "List of error objects describing failures encountered while processing record operation requests.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/MultipleOrMultiErrorsError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/DependentServiceError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundLayoutRuleWriteError" }, { "$ref": "#/components/schemas/MandatoryNotFoundLayoutRuleError" }, { "$ref": "#/components/schemas/MandatoryNotFoundRecordIdError" }, { "$ref": "#/components/schemas/RecordDependentMismatchError" }, { "$ref": "#/components/schemas/RecordInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDuplicateDataError" } ], "description": "Error object that can be one of multiple error types based on the error code." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "x-zs-$id": "RecordsDataUpsertErrorResponse" }, "RecordsIDDataPutErrorResponse": { "additionalProperties": false, "description": "Standard error response schema returned when a single-record operation fails.", "properties": { "data": { "description": "List of error objects describing failures encountered while processing record operation requests.", "items": { "anyOf": [ { "$ref": "#/components/schemas/NotAllowedDataValueError" }, { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/RecordDeleteByIdInvalidDataError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/MultipleOrMultiErrorsError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundLayoutRuleWriteError" }, { "$ref": "#/components/schemas/RecordDependentMismatchError" }, { "$ref": "#/components/schemas/RecordInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDuplicateDataError" }, { "$ref": "#/components/schemas/RecordRecordLockedError" }, { "$ref": "#/components/schemas/NotReviewedError" }, { "$ref": "#/components/schemas/RecordLimitExceededError" } ], "description": "Error object that can be one of multiple error types based on the error code." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "x-zs-$id": "RecordsIDDataPutErrorResponse" }, "RecordsIDPutErrorResponse": { "anyOf": [ { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/NotApprovedError" }, { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/RecordDeleteByIdInvalidDataError" }, { "$ref": "#/components/schemas/RecordsIDDataPutErrorResponse" } ], "x-zs-$id": "RecordsIDPutErrorResponse" }, "RecordsIdPostErrorResponse": { "additionalProperties": false, "description": "Standard error response schema returned when a single-record operation fails.", "properties": { "data": { "description": "List of error objects describing failures encountered while processing record operation requests.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/RecordDeleteByIdInvalidDataError" }, { "$ref": "#/components/schemas/RecordInvalidModuleError" }, { "$ref": "#/components/schemas/MultipleOrMultiErrorsError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundLayoutRuleWriteError" }, { "$ref": "#/components/schemas/RecordInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RecordAuthorizationFailedError" }, { "$ref": "#/components/schemas/RecordDuplicateDataError" }, { "$ref": "#/components/schemas/DependentServiceError" } ], "description": "Error object that can be one of multiple error types based on the error code." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordsIdPostErrorResponse" }, "RecordsInputSchema": { "additionalProperties": false, "description": "Represents the RecordsInputSchema data structure.", "examples": [ { "apply_feature_execution": [ { "name": "layout_rules" } ], "data": [ { "Company": "ABC", "Email": "p.daly@zylker.com", "First_Name": "Paul", "Last_Name": "Daly", "Layout": { "id": "554023000002734009" }, "Lead_Source": "Employee Referral", "State": "Texas" } ], "skip_feature_execution": [ { "name": "cadences" } ], "trigger": [ "approval", "workflow", "blueprint", "pathfinder", "orchestration" ] } ], "properties": { "apply_feature_execution": { "description": "Use the \"apply_feature_execution\" array to trigger supported CRM features when creating or updating a record through the API. Specify \"layout_rules\" to apply layout rules or \"criteria_validation_rule\" to trigger validation rules. For \"layout_rules\", ensure the request includes all fields required by the layout rule criteria; otherwise, the API returns an error. For \"criteria_validation_rule\", all applicable validation rules are evaluated, and the API returns \"MULTIPLE_OR_MULTI_ERRORS\" if multiple rules fail.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordsInputSchema array.", "properties": { "name": { "description": "Represents the apply feature execution value.", "enum": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "data": { "description": "Represents the data value.", "items": { "$ref": "#/components/schemas/RecordWriteDataItem" }, "maxItems": 100, "minItems": 1, "type": "array" }, "skip_feature_execution": { "description": "Use the \"skip_feature_execution\" array to skip Cadences execution when creating a record through the API. Specify \"cadences\" as the value of the \"name\" key and include this key alongside \"data\" in the request.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordsInputSchema array.", "properties": { "name": { "description": "Represents the skip feature execution value.", "enum": [ "assignment_rules", "cadences", "connected_workflows" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "trigger": { "description": "Specifies the CRM features to execute for the API request. Supported values are \"workflow\", \"approval\", and \"blueprint\". If the \"trigger\" parameter is not specified, workflows, approvals, and blueprints related to the API are executed. Specify an empty array [] to prevent these features from executing.", "items": { "description": "Represents a single item in the RecordsInputSchema array.", "enum": [ "approval", "workflow", "blueprint", "pathfinder", "orchestration" ], "type": "string" }, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordWriteRequest" }, "RecordsPostErrorResponse": { "anyOf": [ { "$ref": "#/components/schemas/NotApprovedError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidDataTypeSupportedValuesError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/RecordsDataPostErrorResponse" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/InvalidMaxLengthError" } ], "description": "Standard error response schema returned when record operations fail.", "x-zs-$id": "RecordsPostErrorResponse" }, "RecordsPutErrorResponse": { "anyOf": [ { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/InvalidDataValueError" }, { "$ref": "#/components/schemas/RecordsDataPutErrorResponse" }, { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidDataTypeSupportedValuesError" } ], "description": "Standard error response schema returned when record operations fail.", "x-zs-$id": "RecordsPutErrorResponse" }, "RecordsPutInputSchema": { "additionalProperties": false, "description": "Represents the RecordsPutInputSchema data structure.", "properties": { "apply_feature_execution": { "description": "Represents the apply feature execution value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordsPutInputSchema array.", "properties": { "name": { "description": "Represents the apply feature execution value.", "enum": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "data": { "description": "Represents the data value.", "items": { "$ref": "#/components/schemas/RecordPutWriteDataItem" }, "maxItems": 100, "minItems": 1, "type": "array" }, "skip_feature_execution": { "description": "Represents the skip feature execution value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordsPutInputSchema array.", "properties": { "name": { "description": "Represents the skip feature execution value.", "enum": [ "assignment_rules", "cadences", "connected_workflows" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "trigger": { "description": "Represents the trigger value.", "items": { "description": "Represents a single item in the RecordsPutInputSchema array.", "enum": [ "approval", "workflow", "blueprint", "pathfinder", "orchestration" ], "type": "string" }, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordPutWriteRequest" }, "RecordsSinglePutInputSchema": { "additionalProperties": false, "description": "Represents the RecordsSinglePutInputSchema data structure.", "properties": { "apply_feature_execution": { "description": "Use the \"apply_feature_execution\" array to trigger supported CRM features when creating or updating a record through the API. Specify \"layout_rules\" to apply layout rules or \"criteria_validation_rule\" to trigger validation rules. For \"layout_rules\", ensure the request includes all fields required by the layout rule criteria; otherwise, the API returns an error. For \"criteria_validation_rule\", all applicable validation rules are evaluated, and the API returns \"MULTIPLE_OR_MULTI_ERRORS\" if multiple rules fail.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordsSinglePutInputSchema array.", "properties": { "name": { "description": "Represents the apply feature execution value.", "enum": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "data": { "description": "Represents the data value.", "items": { "$ref": "#/components/schemas/RecordSinglePutWriteDataItem" }, "maxItems": 100, "minItems": 1, "type": "array" }, "skip_feature_execution": { "description": "Represents the skip feature execution value.", "items": { "additionalProperties": false, "description": "Represents a single item in the RecordsSinglePutInputSchema array.", "properties": { "name": { "description": "Represents the skip feature execution value.", "enum": [ "assignment_rules", "cadences", "connected_workflows" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "type": "array" }, "trigger": { "description": "Represents the trigger value.", "items": { "description": "Represents a single item in the RecordsSinglePutInputSchema array.", "enum": [ "approval", "workflow", "blueprint", "pathfinder", "orchestration" ], "type": "string" }, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordsSinglePutInputSchema" }, "RecordsUpsertErrorResponse": { "anyOf": [ { "$ref": "#/components/schemas/InvalidMaxLengthError" }, { "$ref": "#/components/schemas/NotApprovedError" }, { "$ref": "#/components/schemas/RecordInvalidDataTypeError" }, { "$ref": "#/components/schemas/RecordMandatoryNotFoundError" }, { "$ref": "#/components/schemas/InvalidSupportedValuesError" }, { "$ref": "#/components/schemas/RecordsDataUpsertErrorResponse" }, { "$ref": "#/components/schemas/RecordDependentFieldMissingError" } ], "x-zs-$id": "RecordsUpsertErrorResponse" }, "RecordsUpsertSchema": { "additionalProperties": false, "description": "Request body schema for upsert operations, allowing creation or update of records based on duplicate fields.", "properties": { "data": { "description": "List of records to be created or updated using the upsert operation.", "items": { "$ref": "#/components/schemas/RecordSinglePutWriteDataItem" }, "maxItems": 100, "minItems": 1, "type": "array" }, "duplicate_check_fields": { "description": "Specifies the fields used to check for duplicate records during an Upsert operation. Duplicate check fields can be system-defined unique fields or user-defined unique fields. \nThe following are the system-defined duplicate check fields for the respective modules: Leads - \"Email\"; Accounts - \"Account_Name\"; Contacts - \"Email\"; Deals - \"Deal_Name\"; Campaigns - \"Campaign_Name\"; Cases - \"Subject\"; Solutions - \"Solution_Title\"; Products - \"Product_Name\"; Vendors - \"Vendor_Name\"; PriceBooks - \"Price_Book_Name\"; Quotes - \"Subject\"; SalesOrders - \"Subject\"; PurchaseOrders - \"Subject\"; Invoices - \"Subject\"; Custom Modules - \"Name\".\nIf a matching record is found based on these fields, the record is updated; otherwise, a new record is inserted.", "items": { "description": "API name of the field used for duplicate record verification.", "maxLength": 100, "type": "string" }, "type": "array" }, "lar_id": { "description": "The unique ID of the assignment rule to trigger while inserting a record. Use the Get Assignment Rules API to retrieve valid values. This key must be provided parallel to the data key. Supported for all modules where assignment rules are applicable, such as Leads, Contacts, Deals, Accounts, Tasks, Cases, and Custom.", "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getAssignmentRules", "propertyId": "AssignmentRuleId" } ], "resource": "assignment_rules" } }, "trigger": { "description": "Specifies the CRM features to execute for the API request. Supported values are \"workflow\", \"approval\", and \"blueprint\". If the \"trigger\" parameter is not specified, workflows, approvals, and blueprints related to the API are executed. Specify an empty array [] to prevent these features from executing.", "items": { "description": "Represents a single item in the RecordsInputSchema array.", "enum": [ "approval", "workflow", "blueprint", "pathfinder", "orchestration" ], "type": "string" }, "type": "array" }, "wf_trigger": { "description": "Workflow trigger identifier to be executed as part of the upsert operation.", "maxLength": 50, "type": [ "string", "null" ] } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordsUpsertSchema" }, "RecycleBinErrorResponse": { "additionalProperties": false, "description": "Error payload returned when a recycle-bin request fails, including the error code, the error message, and context-specific details.", "properties": { "code": { "description": "Error code identifying why the request failed. Possible values: **INVALID_DATA**, **EXPECTED_FIELD_MISSING**, **EXPECTED_PARAM_MISSING**, **AMBIGUITY_DURING_PROCESSING**, **AUTHORIZATION_FAILED**.", "enum": [ "INVALID_DATA", "EXPECTED_FIELD_MISSING", "EXPECTED_PARAM_MISSING", "AMBIGUITY_DURING_PROCESSING", "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Provides additional context about the error, such as the offending parameter, field, JSON path, expected data type, or record ID. The populated keys depend on the **code** value.", "properties": { "ambiguity_due_to": { "description": "List of factors that caused ambiguity when the error is **AMBIGUITY_DURING_PROCESSING**, typically because two or more mutually exclusive restoration modes were supplied.", "items": { "additionalProperties": false, "description": "Represents a single ambiguity factor, identified by its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the ambiguity factor.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the ambiguity factor within the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 2, "type": "array" }, "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the offending field when the error is due to an invalid data type. Possible values: **jsonarray**, **jsonobject**, **string**.", "enum": [ "jsonarray", "jsonobject", "string" ], "type": "string" }, "expected_fields": { "description": "List of fields that are expected in the request body when the error is **EXPECTED_FIELD_MISSING**.", "items": { "additionalProperties": false, "description": "Represents a single expected field, identified by its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the expected field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the expected field within the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 3, "type": "array" }, "id": { "description": "Represents the record identifier associated with the error.", "format": "int64", "type": "string" }, "json_path": { "description": "Represents the JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Represents the name of the request parameter that caused the error. Possible values: **filters**, **ids**.", "enum": [ "filters", "ids" ], "type": "string" }, "param_names": { "description": "List of request parameter names that are expected but missing when the error is **EXPECTED_PARAM_MISSING**.", "items": { "description": "Name of an expected request parameter that was not supplied. Possible values: **filters**, **ids**, **restore_all_records**.", "enum": [ "filters", "ids", "restore_all_records" ], "type": "string" }, "maxItems": 2, "type": "array" }, "resource_path_index": { "description": "Represents the zero-based index of the resource path segment that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Message that describes the cause of the error.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates that the API request failed. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ErrorResponse" }, "RecycleBinSuccessResponse": { "additionalProperties": false, "description": "Per-item result returned when a single recycle-bin record is processed successfully.", "properties": { "code": { "description": "Result code for the per-item operation. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the per-item operation, including the affected record ID.", "properties": { "id": { "description": "Represents the unique identifier of the recycle-bin record that the per-item result refers to.", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the per-item operation.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates that the per-item operation succeeded. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SuccessResponse" }, "ReferencedScoreField": { "additionalProperties": true, "description": "Represents the referenced score field linked to a custom field in a Scoring Rule.", "properties": { "api_name": { "description": "Specifies the API name of the referenced score field. Required when creating a Scoring Rule.", "enum": [ "Positive_Score", "Negative_Score", "Touch_Point_Positive_Score", "Touch_Point_Negative_Score", "Touch_Point_Score", "Score" ], "type": "string" }, "id": { "description": "Represents the unique ID of the referenced score field.", "maxLength": 25, "type": "string" } }, "title": "Referenced Score Field Information", "type": "object" }, "RelatedDetailsNestedSchema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the email notification related details, including best-time delivery configuration.", "properties": { "best_time": { "description": "Indicates whether to send the email notification at the best time for the recipient. When set to true, the platform determines the optimal send time.", "type": "boolean" } }, "type": "object", "x-zs-$id": "RelatedDetailsBestTimeSchema" }, { "additionalProperties": false, "description": "Represents the task related details, including followup task configuration.", "properties": { "followup_details": { "additionalProperties": false, "description": "Represents the followup task configuration, including the trigger condition and delay settings.", "properties": { "condition": { "description": "Represents the task status condition that triggers the followup task, such as **Completed** or **Not Started**.", "maxLength": 255, "type": "string" }, "period": { "description": "Represents the time period label for the delay before creating the followup task, such as **days**, **hours**, or **minutes**.", "maxLength": 50, "type": "string" }, "unit": { "description": "Represents the numeric time value for the delay before creating the followup task.", "format": "int32", "type": "integer" } }, "type": "object" } }, "type": "object", "x-zs-$id": "RelatedDetailsFollowupSchema" }, { "additionalProperties": false, "description": "Represents the field update related details, including the lookup field for cross-module updates.", "properties": { "lookup_field": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The lookup field linking the rule module to the target module (e.g., Account_Name on Contacts). Provide the field's id and api_name. When the field update targets the same module, related_details is null." } }, "type": "object", "x-zs-$id": "RelatedDetailsLookupFieldSchema" }, { "description": "Represents a null value indicating no related details are configured for this action.", "type": "null", "x-zs-$id": "RelatedDetailsNullSchema" } ], "description": "Represents the optional action-specific configuration attached to an associate action, such as best-time delivery settings for email notifications or lookup field references for field updates.", "x-zs-llm-description": "Discriminator (oneOf) for action-specific supplementary configuration. Only three action types support related_details: email_notifications (best_time delivery), tasks (followup_details), and field_updates (lookup_field for cross-module targeting). Other action types do not use related_details." }, "RelatedList": { "anyOf": [ { "$ref": "#/components/schemas/RelatedListMultiselectLookup" }, { "$ref": "#/components/schemas/RelatedListNonMultiselectLookup" } ], "description": "Represents the base configuration metadata for a related list panel in a CRM module.", "x-zs-$id": "RelatedList" }, "RelatedListField": { "additionalProperties": false, "description": "Represents a field configured as a column in a related list view.", "properties": { "api_name": { "description": "API name of the field.", "maxLength": 100, "minLength": 1, "pattern": "^!?[A-Za-z0-9_.]+$", "type": "string" }, "decimal_place": { "description": "Number of decimal places configured for numeric fields.", "format": "int32", "type": [ "integer", "null" ] }, "enable_colour_code": { "description": "Indicates whether color coding is enabled for this field. Possible values: **true**, **false**.", "type": "boolean" }, "field_label": { "description": "Display label of the field.", "maxLength": 100, "minLength": 1, "type": "string" }, "formula": { "additionalProperties": false, "description": "Formula configuration for the field. Empty object if the field is not a formula field. Returned when include_inner_details contains fields.formula.", "properties": { "return_type": { "description": "The return type of the formula (e.g., text, number).", "maxLength": 50, "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier of the field.", "format": "int64", "type": "string" }, "lookup": { "additionalProperties": false, "description": "Lookup configuration for the field. Empty object if the field is not a lookup. Returned when include_inner_details contains fields.lookup.", "properties": { "api_name": { "description": "API name of the lookup related list.", "maxLength": 100, "type": "string" }, "display_label": { "description": "Display label of the lookup related list.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique identifier of the lookup field.", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Module details for the lookup field.", "properties": { "api_name": { "description": "API name of the lookup target module.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique identifier of the lookup target module.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "query_details": { "additionalProperties": false, "description": "Query details for the lookup field.", "properties": { "system_query_id": { "description": "System query ID for the lookup field.", "format": "int64", "type": [ "string", "null" ] } }, "required": [ "system_query_id" ], "type": "object" }, "revalidate_filter_during_edit": { "description": "Indicates if the filter should be revalidated during edit.", "type": "boolean" } }, "type": "object" }, "mask_details": { "additionalProperties": false, "description": "Masking configuration for the field. Returned when include_inner_details contains fields.mask_details.", "properties": {}, "type": "object" }, "pick_list_values": { "description": "List of picklist values for picklist-type fields in the related list.", "items": { "$ref": "#/components/schemas/PickListValue" }, "maxItems": 500, "type": "array" }, "refer_from_field": { "additionalProperties": false, "description": "Reference field configuration. Returned when include_inner_details contains fields.refer_from_field.", "properties": {}, "type": "object" }, "rollup_summary": { "additionalProperties": false, "description": "Rollup summary configuration for the field. Empty object if the field is not a rollup summary. Returned when include_inner_details contains fields.rollup_summary.", "properties": { "return_type": { "description": "The return type of the rollup summary (e.g., integer, number).", "maxLength": 50, "type": "string" } }, "type": "object" }, "separator": { "description": "Indicates whether a separator is displayed after this field. Possible values: **true**, **false**.", "type": "boolean" }, "sequence_number": { "description": "Display order position of the field within the related list.", "format": "int32", "type": "integer" }, "ui_type": { "description": "UI type identifier that determines how the field is rendered.", "format": "int32", "type": "integer" } }, "required": [ "sequence_number", "id", "api_name" ], "type": "object", "x-zs-$id": "RelatedListField" }, "RelatedListLayoutSpecificProperty": { "additionalProperties": false, "description": "Represents layout-specific configuration overrides for a related list, including per-layout sequence and visibility.", "properties": { "layout": { "additionalProperties": false, "description": "Layout information for which this property override applies.", "properties": { "id": { "description": "Unique identifier of the layout.", "format": "int64", "type": "string" }, "name": { "description": "Display name of the layout.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "sequence_number": { "description": "Display sequence position of this related list in the specified layout.", "format": "int32", "type": "string" }, "status": { "description": "Visibility status of the related list in the specified layout. Possible values: **visible**, **user_hidden**, **scheduled_for_deletion**. ", "enum": [ "visible", "user_hidden", "scheduled_for_deletion" ], "type": "string" } }, "required": [ "sequence_number", "layout", "status" ], "type": "object" }, "RelatedListModule": { "additionalProperties": false, "description": "Represents the module associated with a related list, including its API name and unique identifier.", "properties": { "api_name": { "description": "API name of the module associated with the related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "id": { "description": "Unique identifier of the module.", "format": "int64", "type": "string" }, "plural_label": { "description": "Plural display label of the module.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "RelatedListModule" }, "RelatedListMultiselectLookup": { "additionalProperties": false, "description": "Configuration metadata for a related list of type multiselectlookup.", "properties": { "_layout_specific_properties": { "description": "Layout-specific configuration overrides for this related list, such as per-layout sequence and visibility.", "items": { "$ref": "#/components/schemas/RelatedListLayoutSpecificProperty" }, "maxItems": 25, "minItems": 0, "type": [ "array", "null" ] }, "action": { "description": "Action type supported for adding records to the related list.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "api_name": { "description": "API name identifier for the related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-zs-$id": "RelatedListsMultiselectApiName" }, "connectedlookupApiName": { "description": "API name of the connected lookup field for this multiselectlookup related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "connectedmodule": { "description": "API name of the connected module for this multiselectlookup relationship.", "maxLength": 250, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "customize_display_label": { "description": "Indicates whether the display label of this related list can be customized. Possible values: **true**, **false**. ", "type": "boolean" }, "customize_fields": { "description": "Indicates whether the field selection for this related list can be customized. Possible values: **true**, **false**. ", "type": "boolean" }, "customize_sort": { "description": "Indicates whether the sort configuration for this related list can be customized. Possible values: **true**, **false**. ", "type": "boolean" }, "display_label": { "description": "User-visible label displayed for the related list panel.", "maxLength": 50, "minLength": 1, "type": "string" }, "field_enabled": { "description": "Indicates whether the multiselectlookup field is enabled. Possible values: **true**, **false**.", "type": "boolean" }, "fields": { "description": "List of fields configured as columns in the related list view.", "items": { "$ref": "#/components/schemas/RelatedListField" }, "maxItems": 50, "minItems": 0, "type": [ "array", "null" ] }, "href": { "description": "Relative URL template for navigating to the related list records.", "maxLength": 200, "minLength": 1, "type": [ "string", "null" ] }, "id": { "description": "Specifies the unique identifier of the related list configuration.", "format": "int64", "type": "string", "x-zs-$id": "RelatedListsMultiselectId" }, "linkingmodule": { "description": "API name of the linking module that connects the two entities in the multiselectlookup relationship.", "maxLength": 250, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "module": { "anyOf": [ { "$ref": "#/components/schemas/RelatedListModule" }, { "description": "Represents the null state when no module is associated with this related list.", "type": "null", "x-zs-$id": "RelatedListMultiselectModuleNull" } ], "description": "Module information for the related list. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for details." }, "multiselectlookup": { "$ref": "#/components/schemas/MultiselectLookupConfig" }, "name": { "description": "Internal name of the related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_ \\-]+$", "type": "string" }, "parent_related_lists": { "description": "List of parent related list references that this related list depends on for contextual display.", "items": { "$ref": "#/components/schemas/RelatedListParentReference" }, "maxItems": 4, "minItems": 0, "type": [ "array", "null" ] }, "personality_name": { "description": "Internal personality identifier associated with this related list configuration.", "maxLength": 100, "minLength": 1, "type": "string" }, "record_operations": { "$ref": "#/components/schemas/RelatedListRecordOperations" }, "sequence_number": { "description": "Specifies the display sequence position of the related list in the layout.", "format": "int32", "type": "string" }, "sort_by": { "anyOf": [ { "$ref": "#/components/schemas/RelatedListMultiselectSortField" }, { "description": "Represents the null state when no sort field is configured for this related list.", "type": "null", "x-zs-$id": "RelatedListMultiselectSortFieldNull" } ], "description": "Field by which records in this related list are sorted." }, "sort_order": { "description": "Sort direction for records in this related list. Possible values: **asc**, **desc**.", "enum": [ "asc", "desc", null ], "type": [ "string", "null" ] }, "status": { "description": "Visibility status of the related list. Possible values: **visible**, **user_hidden**, **scheduled_for_deletion**. ", "enum": [ "visible", "user_hidden", "scheduled_for_deletion" ], "type": "string" }, "type": { "description": "Relationship type of the related list.", "enum": [ "multiselectlookup" ], "type": "string", "x-zs-llm-description": "Related list types: 'default', 'custom', 'custom_lookup', 'custom_related_list', 'queries', 'grouped', 'combined_view', 'slyteui', 'multiselectlookup'." }, "visibility": { "description": "Numeric visibility flag for the related list.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "id", "sequence_number", "display_label", "api_name", "module", "name", "action", "href", "type", "customize_sort", "customize_fields", "customize_display_label", "status" ], "type": "object", "x-zs-$id": "RelatedListMultiselectLookup" }, "RelatedListMultiselectSortField": { "additionalProperties": false, "description": "Field metadata used for sorting a multiselectlookup related list. The api_name follows the format ModuleName.FieldApiName (e.g., \"Leads.Company\") where the left part is the connected module api_name and the right part is the field api_name.", "properties": { "api_name": { "description": "API name of the field used for sorting. For multiselectlookup related lists, this is in the format ModuleName.FieldApiName (e.g., \"Leads.Company\").", "maxLength": 200, "minLength": 1, "pattern": "^[A-Za-z0-9_]+(\\.[A-Za-z0-9_]+)?$", "type": "string" }, "id": { "description": "Unique identifier of the sort field.", "format": "int64", "type": "string" } }, "required": [ "id", "api_name" ], "type": "object", "x-zs-$id": "RelatedListMultiselectSortField" }, "RelatedListNonMultiselectLookup": { "additionalProperties": false, "description": "Configuration metadata for a standard (non-multiselectlookup) related list.", "properties": { "_layout_specific_properties": { "description": "Layout-specific configuration overrides for this related list.", "items": { "$ref": "#/components/schemas/RelatedListLayoutSpecificProperty" }, "maxItems": 25, "minItems": 0, "type": [ "array", "null" ] }, "action": { "description": "Action type supported for adding records to the related list.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "api_name": { "description": "API name identifier for the related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-zs-$id": "RelatedListsNonMultiselectApiName" }, "connectedlookupApiName": { "description": "API name of the connected lookup field for this related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "connectedmodule": { "description": "API name of the connected module for this lookup relationship.", "maxLength": 250, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "customize_display_label": { "description": "Indicates whether the display label of this related list can be customized. Possible values: **true**, **false**. ", "type": "boolean" }, "customize_fields": { "description": "Indicates whether the field selection for this related list can be customized. Possible values: **true**, **false**. ", "type": "boolean" }, "customize_sort": { "description": "Indicates whether the sort configuration for this related list can be customized. Possible values: **true**, **false**. ", "type": "boolean" }, "display_label": { "description": "User-visible label displayed for the related list panel.", "maxLength": 50, "minLength": 1, "type": "string" }, "fields": { "description": "Fields displayed in the related list (null if not configured).", "items": { "$ref": "#/components/schemas/RelatedListField" }, "maxItems": 50, "minItems": 0, "type": [ "array", "null" ] }, "href": { "description": "Relative URL template for navigating to the related list records.", "maxLength": 200, "minLength": 1, "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the related list configuration.", "format": "int64", "type": "string", "x-zs-$id": "RelatedListsNonMultiselectId" }, "linkingmodule": { "description": "API name of the linking module for this relationship.", "maxLength": 250, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "module": { "anyOf": [ { "$ref": "#/components/schemas/RelatedListModule" }, { "description": "Represents the null state when no module is associated with this related list.", "type": "null", "x-zs-$id": "RelatedListNonMultiselectModuleNull" } ], "description": "Module information for the related list. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for details." }, "name": { "description": "Internal name of the related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_ \\-]+$", "type": "string" }, "parent_related_lists": { "description": "List of parent related list references that this related list depends on.", "items": { "$ref": "#/components/schemas/RelatedListParentReference" }, "maxItems": 4, "minItems": 0, "type": [ "array", "null" ] }, "personality_name": { "description": "Internal personality identifier associated with this related list configuration.", "maxLength": 100, "minLength": 1, "type": "string" }, "record_operations": { "$ref": "#/components/schemas/RelatedListRecordOperations" }, "sequence_number": { "description": "Display sequence position of the related list in the layout.", "format": "int32", "type": "string" }, "sort_by": { "anyOf": [ { "$ref": "#/components/schemas/RelatedListSortField" }, { "description": "No sorting is applied.", "type": "null", "x-zs-$id": "RelatedListNonMultiselectSortFieldNull" } ], "description": "Field used for sorting the related list (null if no sorting configured)." }, "sort_order": { "description": "Sort direction applied to the related list (null if no sorting configured).", "enum": [ "asc", "desc", null ], "type": [ "string", "null" ] }, "status": { "description": "Visibility status of the related list. Possible values: **visible**, **user_hidden**, **scheduled_for_deletion**. ", "enum": [ "visible", "user_hidden", "scheduled_for_deletion" ], "type": "string" }, "type": { "description": "Relationship type of the related list.", "enum": [ "default", "custom", "custom_lookup", "custom_related_list", "queries", "grouped", "combined_view", "slyteui" ], "type": "string", "x-zs-llm-description": "Related list types: 'default', 'custom', 'custom_lookup', 'custom_related_list', 'queries', 'grouped', 'combined_view', 'slyteui', 'multiselectlookup'." }, "visibility": { "description": "Numeric visibility flag for the related list.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "id", "sequence_number", "display_label", "api_name", "module", "name", "action", "href", "type", "customize_sort", "customize_fields", "customize_display_label", "status" ], "type": "object", "x-zs-$id": "RelatedListNonMultiselectLookup" }, "RelatedListParentReference": { "additionalProperties": false, "description": "Represents a reference to a parent related list that this related list depends on for contextual display.", "properties": { "api_name": { "description": "API name of the parent related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "id": { "description": "Unique identifier of the parent related list.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "RelatedListRecordOperations": { "additionalProperties": false, "description": "Represents the set of record operations permitted for a related list.", "properties": { "assign": { "description": "Indicates whether the assign operation is allowed on records in the related list. Possible values: **true**, **false**. ", "type": "boolean" }, "bulk_edit": { "description": "Indicates whether the bulk edit operation is allowed on records in the related list. Possible values: **true**, **false**. ", "type": "boolean" }, "create": { "description": "Indicates whether the create operation is allowed on records in the related list. Possible values: **true**, **false**. ", "type": "boolean" }, "delete": { "description": "Indicates whether the delete operation is allowed on records in the related list. Possible values: **true**, **false**. ", "type": "boolean" }, "disassociate": { "description": "Indicates whether records can be disassociated from the related list. Possible values: **true**, **false**. ", "type": "boolean" }, "edit": { "description": "Indicates whether the edit operation is allowed on records in the related list. Possible values: **true**, **false**. ", "type": "boolean" } }, "required": [ "edit", "create", "bulk_edit", "delete", "disassociate", "assign" ], "type": "object" }, "RelatedListReference": { "additionalProperties": false, "description": "Represents a related list identified by its API name and unique ID. Used in both the request to specify the target related list and in the response to echo the queried related list.", "properties": { "api_name": { "description": "Represents the API name of the related list.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRelatedLists", "propertyId": "RelatedListsMultiselectApiName" } ], "resource": "related_lists" } }, "id": { "description": "Represents the unique ID of the related list. Use the [Get Related Records API](related_records.yaml#$.paths./{parentRecordModule}/{parentRecord}/{relatedList}.get) to get the ID of the related list in the key ID.", "format": "int64", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRelatedLists", "propertyId": "RelatedListsMultiselectId" } ], "resource": "related_lists" } } }, "required": [ "api_name", "id" ], "type": "object" }, "RelatedListSortField": { "additionalProperties": false, "description": "Represents the field used to sort records in a related list.", "properties": { "api_name": { "description": "API name of the field used for sorting.", "maxLength": 100, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": "string" }, "id": { "description": "Unique identifier of the field used for sorting.", "format": "int64", "type": "string" } }, "required": [ "id", "api_name" ], "type": "object", "x-zs-$id": "RelatedListSortField" }, "RelatedListsAuthenticationFailureError": { "additionalProperties": false, "description": "Error response returned when the OAuth2 access token is missing, expired, or invalid.", "properties": { "code": { "description": "Error code indicating the type of authentication failure. Possible values: **INVALID_TOKEN**. ", "enum": [ "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the authentication error.", "type": "object" }, "message": { "description": "Error message describing the authentication failure. Possible values: **invalid OAuth token**. ", "enum": [ "invalid oauth token" ], "type": "string" }, "status": { "description": "Response status indicating an error occurred. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AuthenticationFailureError" }, "RelatedListsInvalidDataError": { "additionalProperties": false, "description": "Error response returned when a field or parameter value fails validation in a related list operation.", "properties": { "code": { "description": "Error code indicating invalid data was provided. Possible values: **INVALID_DATA**. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataFieldDetails" }, { "$ref": "#/components/schemas/InvalidDataTypeDetails" }, { "$ref": "#/components/schemas/InvalidDataLengthDetails" }, { "$ref": "#/components/schemas/InvalidDataParameterDetails" }, { "$ref": "#/components/schemas/InvalidDataResourcePathDetails" }, { "$ref": "#/components/schemas/InvalidDataFieldWithSupportedValuesDetails" }, { "$ref": "#/components/schemas/InvalidDataFieldIndexDetails" } ], "description": "Contextual details about the invalid data. The structure varies by error subtype: field-level errors include **api_name** and **json_path**; parameter errors include **param_name**; resource path errors include **resource_path_index**. " }, "message": { "description": "Error message describing the invalid data.", "enum": [ "Invalid value provided for field", "Invalid data type", "Invalid data", "invalid data", "Invalid data type for field", "Field value exceeds maximum allowed length", "The status given is invalid.", "Invalid related list id", "Invalid field configuration", "Invalid sortorder value given", "Invalid field api-name given for sorting", "Invalid field Id given for sorting", "Invalid Layout Id", "Api name is not valid", "Field selected is not in related module", "Field selected is not present in any layouts of related module", "Cannot Update sequence of related List which is not visible", "Field Sequence Given is greater the Number of fields Selected", "Field sequence number must be a positive integer greater than zero", "The provided field sequence is not a valid Integer", "Field for sorting not present in the field list", "the relation id given seems to be invalid" ], "type": "string" }, "status": { "description": "Response status indicating an error occurred. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataError" }, "RelatedListsInvalidModuleError": { "additionalProperties": false, "description": "Error response returned when the specified module is invalid or not recognized in the CRM organization.", "properties": { "code": { "description": "Error code indicating the module is invalid. Possible values: **INVALID_MODULE**. ", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the invalid module error.", "properties": { "param_name": { "description": "Name of the parameter that referenced the invalid module. Possible values: **module**. ", "enum": [ "module" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Error message describing the invalid module.", "enum": [ "the module name given seems to be invalid", "the given module is not supported in api" ], "type": "string" }, "status": { "description": "Response status indicating an error occurred. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, "RelatedListsNotSupportedError": { "additionalProperties": false, "description": "Error response returned when the specified module exists but is not supported by this API.", "properties": { "code": { "description": "Error code indicating the module is not supported by this API. Possible values: **NOT_SUPPORTED**. ", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the unsupported module.", "properties": { "param_name": { "description": "Name of the parameter referencing the unsupported module.", "enum": [ "module" ], "type": "string" } }, "type": "object" }, "message": { "description": "Error message describing the unsupported module.", "enum": [ "the given module is not supported for this api", "this module is not supported" ], "type": "string" }, "status": { "description": "Response status indicating an error occurred. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "NotSupportedError" }, "RelatedListsOAuthScopeMismatchError": { "additionalProperties": false, "description": "Error response returned when the access token does not include the required OAuth scope for this API.", "properties": { "code": { "description": "Error code indicating the OAuth scope does not match the required scope. Possible values: **OAUTH_SCOPE_MISMATCH**. ", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the scope mismatch error.", "type": "object" }, "message": { "description": "Error message describing the scope mismatch. Possible values: **invalid OAuth scope to access this URL**. ", "enum": [ "invalid oauth scope to access this URL" ], "type": "string" }, "status": { "description": "Response status indicating an error occurred. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "OAuthScopeMismatchError" }, "RelatedModuleDetails": { "additionalProperties": false, "description": "Related module metadata for automation contexts that operate on related records. Null when no related module context applies.", "properties": { "api_name": { "description": "CRM related-module API name used in automation configuration (e.g., Notes).", "example": "Notes", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the related CRM module corresponding to api_name.", "example": "3361265000000002391", "maxLength": 255, "type": "string" } }, "title": "Related Module Details", "type": [ "object", "null" ], "x-zs-llm-description": "Nullable related module metadata. Present when the field update operates on a related module's fields. Null otherwise." }, "RelatedModuleNull": { "description": "Null when no related module is associated with the task.", "type": "null", "x-zs-$id": "RelatedModuleNull", "x-zs-llm-description": "Null value indicating no related module is associated with the task. The task operates on the primary module directly." }, "RelatedModuleReference": { "additionalProperties": false, "description": "Represents a reference to a related CRM module linked to the parent module of a webhook. Returns null when no related module is configured. Required when feature_type is kiosk.", "properties": { "api_name": { "description": "Represents the API name of the related CRM module.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the related CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ], "x-zs-llm-description": "Nullable related module reference. Null when no related module is configured. Required when feature_type is 'kiosk'." }, "RelatedNotesCannotPerformActionError": { "additionalProperties": false, "description": "Error response schema returned when the user lacks permission to perform the requested action on a note, such as modifying another user's note.", "properties": { "data": { "description": "Represents the list of error objects for each note in the request.", "items": { "additionalProperties": false, "description": "Represents an individual error indicating that the user cannot perform the requested action on this note.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the cannot-perform-action error.", "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CannotPerformActionError" }, "RelatedNotesCannotPerformActionErrorSingle": { "additionalProperties": false, "description": "Error response schema for single-record operations where the user cannot perform the requested action on the specified note.", "properties": { "data": { "description": "Represents the list of error objects for the note in the request.", "items": { "additionalProperties": false, "description": "Represents an individual error indicating that the user cannot perform the requested action on this note.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the cannot-perform-action error.", "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CannotPerformActionErrorSingle" }, "RelatedNotesDiscretePaginationLimitExceededError": { "additionalProperties": false, "description": "Error response returned when a request exceeds the discrete pagination limit without providing a **page_token**.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DISCRETE_PAGINATION_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the pagination limit.", "properties": { "limit": { "description": "Represents the maximum number of records that can be retrieved without a page_token parameter.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DiscretePaginationLimitExceededError" }, "RelatedNotesExpectedFieldMissingError": { "additionalProperties": false, "description": "Error response schema returned when both Note_Content and Note_Title are absent from the request, violating the at-least-one requirement.", "properties": { "data": { "description": "Represents the list of error objects for each note in the request.", "items": { "additionalProperties": false, "description": "Represents an individual error indicating that at least one of the expected fields is missing.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the list of expected fields that are missing from the request.", "properties": { "expected_fields": { "description": "A list of fields from which at least one must be provided. Returned when none of the required fields are present in the request.", "items": { "additionalProperties": false, "description": "Represents an individual expected field that is missing.", "properties": { "api_name": { "description": "Represents the API name of the missing expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing expected field.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingError" }, "RelatedNotesFileSizeExceedsError": { "additionalProperties": false, "description": "Error response schema returned when the total size of attachments in the request exceeds the 20 MB limit.", "properties": { "data": { "description": "Represents the list of error objects for each note in the request.", "items": { "additionalProperties": false, "description": "Represents an individual error indicating that the attachment file size exceeds the allowed limit.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "FILE_SIZE_EXCEEDS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details identifying the attachment field that exceeded the size limit.", "properties": { "api_name": { "description": "Represents the API name of the attachment field that exceeded the size limit.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the attachment field that exceeded the size limit.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "FileSizeExceedsError" }, "RelatedNotesInvalidDataError": { "additionalProperties": false, "description": "Error response schema returned when a field value fails validation, such as exceeding the maximum length.", "properties": { "data": { "description": "Represents the list of error objects for each note in the request.", "items": { "additionalProperties": false, "description": "Represents an individual error indicating that a field value is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional validation details about the invalid field, including constraint information.", "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "InvalidDataError" }, "RelatedNotesMandatoryNotFoundError": { "additionalProperties": false, "description": "Error response schema returned when a mandatory field, such as `id`, is missing from the request body.", "properties": { "data": { "description": "Represents the list of error objects for each note in the request.", "items": { "additionalProperties": false, "description": "Specifies an individual error indicating that a mandatory field is missing.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details identifying the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Specifies the JSON path to the missing mandatory field.", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, "RelatedNotesNoPermissionError": { "additionalProperties": false, "description": "Error response schema returned when the user does not have the required permission to perform the operation, such as the Crm_Implied_Create_Attachments permission.", "properties": { "data": { "description": "Represents the list of error objects for each note in the request.", "items": { "additionalProperties": false, "description": "Represents an individual error indicating that the user lacks a required permission.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the list of required permissions that the user does not have.", "properties": { "permissions": { "description": "Represents the list of required permissions for this operation.", "items": { "description": "Represents a required permission name.", "maxLength": 255, "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NoPermissionError" }, "RelatedNotesNotAllowedError": { "additionalProperties": false, "description": "Error response schema returned when an operation is not permitted, such as sharing a note with a portal user whose parent record is inaccessible.", "properties": { "data": { "description": "Represents the list of error objects for each note in the request.", "items": { "additionalProperties": false, "description": "Specifies an individual error indicating that the operation is not allowed on this note.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details identifying the field on which the operation is not allowed.", "properties": { "api_name": { "description": "The API name of the field associated with the not-allowed operation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field associated with the not-allowed operation.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotAllowedError" }, "RelatedNotesNotAllowedErrorSingle": { "additionalProperties": false, "description": "Error response schema for single-record update operations where the action is not permitted on the specified note.", "properties": { "data": { "description": "Represents the list of error objects for the note in the request.", "items": { "additionalProperties": false, "description": "Represents an individual error indicating that the operation is not allowed on this note.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details identifying the field on which the operation is not allowed.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the not-allowed operation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field associated with the not-allowed operation.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotAllowedErrorSingle" }, "RelatedNotesRequiredParamMissingError": { "additionalProperties": false, "description": "Error response schema for requests where a required query parameter is absent.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the missing parameter.", "properties": { "param_name": { "description": "Represents the name of the required parameter that is missing from the request.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "RelatedRecordCountItem": { "additionalProperties": false, "description": "Represents a single related list count specification, including the target related list and optional filtering criteria to apply before counting.", "properties": { "params": { "$ref": "#/components/schemas/CountParameters" }, "related_list": { "$ref": "#/components/schemas/RelatedListReference" } }, "required": [ "related_list" ], "type": "object" }, "RelatedRecordCountResult": { "additionalProperties": false, "description": "Represents the count result for a specific related list, including the total number of matching records and the related list identifier.", "properties": { "count": { "description": "Represents the total number of related records matching the specified criteria.", "format": "int32", "minimum": 0, "type": "integer" }, "related_list": { "$ref": "#/components/schemas/RelatedListReference" } }, "required": [ "count", "related_list" ], "type": "object", "x-zs-$id": "RelatedRecordCountResult" }, "RelatedRecordModule": { "additionalProperties": false, "description": "Identifies a related module whose open records' ownership should be transferred alongside the parent record when the Owner field is updated. Available modules depend on the parent module context.", "properties": { "api_name": { "description": "API name of the related module. Events, Calls, Tasks - open activity records, available for all modules. Contacts - available only when the parent module is Accounts. Deals - available when the parent module is Accounts or Contacts.", "enum": [ "Events", "Calls", "Tasks", "Contacts", "Deals" ], "example": "Events", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the related module. This is the module ID corresponding to the api_name.", "example": "3361265000000000145", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "title": "Related Record Module", "type": "object", "x-zs-llm-description": "Identifies a related module whose records' ownership transfers alongside the parent when the Owner field is updated." }, "RelatedRecordsAuthorizationFailedError": { "additionalProperties": false, "description": "Represents an error response returned when the access token does not have sufficient privileges for the requested operation.", "properties": { "code": { "description": "Error code.", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "AuthorizationFailedError" }, "RelatedRecordsInternalError": { "additionalProperties": false, "description": "Represents an error response returned when an unexpected internal server error occurs.", "properties": { "code": { "description": "Error code.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "InternalError" }, "RelatedRecordsInvalidDataError": { "additionalProperties": false, "description": "Represents an error response returned when the request contains invalid data, such as an invalid record ID, invalid related list name, or invalid input format.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details. Can be empty depending on the error.", "properties": { "api_name": { "description": "API name of the field/module/related list involved (if applicable).", "maxLength": 100, "type": "string" }, "id": { "description": "Record/related record ID involved in the error (if applicable).", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string" }, "resource_path_index": { "description": "Index/position in the request resource path or payload where the error occurred (if applicable).", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "InvalidDataError" }, "RelatedRecordsInvalidModuleError": { "additionalProperties": false, "description": "Represents an error response returned when the module name in the request is not a valid Zoho CRM module API name.", "properties": { "code": { "description": "Error code indicating the type of error.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "properties": { "resource_path_index": { "description": "Index of the path parameter that caused the error (0-based).", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Detailed error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, "RelatedRecordsInvalidRequestMethodError": { "additionalProperties": false, "description": "Represents an error response returned when the HTTP request method is not valid for this endpoint.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, "RelatedRecordsInvalidTokenError": { "additionalProperties": false, "description": "Represents an error response returned when the access token in the request is invalid or expired.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "InvalidTokenError" }, "RelatedRecordsInvalidUrlPatternError": { "additionalProperties": false, "description": "Represents an error response returned when the request URL does not match a valid API endpoint pattern.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "InvalidUrlPatternError" }, "RelatedRecordsLimitExceededError": { "additionalProperties": false, "description": "Represents an error response returned when the number of items in the request exceeds the allowed limit.", "properties": { "code": { "description": "Error code.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details including limit information.", "properties": { "limit": { "description": "Maximum allowed limit value.", "maxLength": 10, "type": "string" }, "param_name": { "description": "Name of the parameter that exceeded the limit.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "LimitExceededError" }, "RelatedRecordsMandatoryNotFoundError": { "additionalProperties": false, "description": "Represents an error response returned when a required field is missing from the request.", "properties": { "code": { "description": "Error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "properties": { "api_name": { "description": "API name of the missing mandatory field (if applicable).", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSONPath to the missing field in request payload (if applicable).", "maxLength": 500, "type": "string" }, "param_name": { "description": "Name of the missing mandatory parameter (if applicable).", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, "RelatedRecordsNoPermissionError": { "additionalProperties": false, "description": "Represents an error response returned when the authenticated user does not have the required module-level permission for the requested operation.", "properties": { "code": { "description": "Error code.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "properties": { "permissions": { "description": "Missing/required permissions for the requested operation.", "items": { "description": "Permission identifier string.", "maxLength": 200, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "NoPermissionError" }, "RelatedRecordsNotSupportedError": { "additionalProperties": false, "description": "Represents an error response returned when the specified module is not supported by this API.", "properties": { "code": { "description": "Error code indicating the type of error.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "properties": { "resource_path_index": { "description": "Index of the path parameter that caused the error (0-based).", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Detailed error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "NotSupportedError" }, "RelatedRecordsOAuthScopeMismatchError": { "additionalProperties": false, "description": "Represents an error response returned when the access token does not include the required OAuth scope for the requested operation.", "properties": { "code": { "description": "Error code.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "OAuthScopeMismatchError" }, "RelatedRecordsRequiredParamMissingError": { "additionalProperties": false, "description": "Represents an error response returned when a required request parameter is missing.", "properties": { "code": { "description": "Error code.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "properties": { "param_name": { "description": "Name of the missing required parameter.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "RelatedRecordsUnableToParseDataTypeError": { "additionalProperties": false, "description": "Represents an error response returned when the request body or a parameter contains a value that cannot be parsed to the expected data type.", "properties": { "code": { "description": "Error code.", "enum": [ "UNABLE_TO_PARSE_DATA_TYPE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UnableToParseDataTypeError" }, "RelationNotFoundBulkError": { "additionalProperties": false, "description": "Represents an error response returned in bulk operations when the relationship between the parent record and the related record cannot be found, with the result wrapped in a **data** array.", "properties": { "data": { "description": "Array of error results.", "items": { "additionalProperties": false, "description": "Individual error result.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Error details with field information.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 100, "type": "string" }, "id": { "description": "ID of the record for which relation was not found.", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string" }, "json_path": { "description": "JSONPath to the field in request payload.", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RelationNotFoundBulkError" }, "RemoveTagsActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that removes one or more tags from the triggering record when the workflow rule condition is met.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationRemoveTagsDetails", "description": "Configuration for remove_tags actions. The tags array is required and must contain between 1 and 10 entries, each specifying both the tag identifier and name. Tags must already exist in the system before they can be removed. The module reference is optional but when provided, its API name and identifier must match the trigger module. The over_write field is accepted for type compatibility but its value is ignored for remove_tags operations.\n\nThis action is invalid when the same rule contains an add_tags action with over_write set to true. It cannot be used alongside a convert action on Leads modules, as this combination triggers an AMBIGUITY_DURING_PROCESSING error. The remove_tags action is not supported for Visits, Users, or LinkingModules.\n\nExample configuration: {\"tags\": [{\"id\": \"111111000000050001\", \"name\": \"Hot Lead\"}], \"module\": {\"api_name\": \"Leads\", \"id\": \"111111000000000175\"}}\n" }, "id": { "description": "Represents the unique ID of the RemoveTags action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the RemoveTags action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. For remove_tags, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only)." }, "type": { "const": "remove_tags", "description": "Represents the action type discriminator that identifies this as a RemoveTags action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "RemoveTagsActionSchema", "x-zs-llm-description": "Inline action type='remove_tags'. Removes specified tags from the triggering record. Requires details.tags (1-10 entries, each {id, name}). Cannot coexist with convert on Leads. Invalid if same rule has add_tags with over_write=true. Tags must already exist on the record." }, "ReorderWorkflowRulesRequestSchema": { "additionalProperties": false, "description": "Represents the request body for reordering workflow rules, containing the new position assignments for each rule.", "properties": { "reorder": { "additionalProperties": false, "description": "Represents the reorder payload containing the list of workflow rules and their updated execution order.", "properties": { "workflow_rules": { "description": "Represents the array of workflow rule objects for which you want to update the execution order.", "items": { "additionalProperties": false, "description": "Represents a single workflow rule entry in the reorder request, specifying the rule ID and its new module-specific sequence number.", "properties": { "id": { "description": "Specify the ID of the workflow rule for which you want to update the execution order.", "maxLength": 20, "type": "string" }, "module_specific_sequence": { "description": "Specify the new execution order for this workflow rule within the module. The index must start from one.", "format": "int32", "type": "integer" } }, "required": [ "id", "module_specific_sequence" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "type": "object" } }, "required": [ "reorder" ], "title": "Reorder Workflow Rules Request V2", "type": "object", "x-zs-llm-description": "Request body for reorderWorkflowRules. Contains reorder array with rule IDs in the desired execution sequence. All active rules for the target module must be included." }, "ReplaceBlockedOptionInUseErrorResponse": { "additionalProperties": false, "description": "Returned when a replace operation is blocked because the option is used by other features. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "_associations": { "description": "Detail field: _associations", "items": { "additionalProperties": false, "description": "Detail Field: _associations", "properties": { "resources": { "description": "Nested detail field: resources", "items": { "additionalProperties": false, "description": "Detail Field: resources", "properties": { "_details": { "additionalProperties": true, "description": "Nested detail field: _details", "type": [ "object", "null" ] }, "id": { "description": "Nested detail field: id", "maxLength": 255, "type": "string" }, "name": { "description": "Nested detail field: name", "maxLength": 255, "type": "string" } }, "required": [ "_details", "id", "name" ], "type": "object" }, "maxItems": 25, "type": "array" }, "type": { "description": "Nested detail field: type", "maxLength": 255, "type": "string" } }, "required": [ "resources", "type" ], "type": "object" }, "maxItems": 25, "type": "array" }, "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "_associations", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "The picklist option is used in features" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Replace Blocked: Option In Use Error Response", "type": "object", "x-zs-$id": "ReplaceBlockedOptionInUseErrorResponse" }, "RequestBodyEmptyArray": { "additionalProperties": false, "description": "Error returned when the request body contains an empty array where data is expected.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the empty array error.", "properties": { "api_name": { "description": "API name of the field that is empty", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path of the field that is empty", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the empty array issue.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequestBodyEmptyArray" }, "RequestBodyNotFoundError": { "additionalProperties": false, "description": "Error returned when the request body is missing or not found in the request.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the missing request body error.", "properties": { "api_name": { "description": "The API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the missing field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing request body.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Request Body Not Found Error", "type": "object", "x-zs-$id": "RequestBodyNotFoundError" }, "RequestBodySchemaForActionClone": { "additionalProperties": false, "description": "Request body for cloning Assignment Rule.", "properties": { "assignment_rules": { "description": "Array of Assignment Rule objects to be created.", "items": { "additionalProperties": false, "description": "Specify each Assignment Rules entry in the Assignment Rule request.", "properties": { "name": { "description": "Specify the name to be displayed for the Assignment Rule.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "assignment_rules" ], "title": "Clone Assignment Rule Request", "type": "object" }, "RequestBodySchemaForActionCloneEntries": { "additionalProperties": false, "description": "Specifies the request structure for cloning rule entries in an Assignment Rule.", "properties": { "assignment_rules": { "description": "Specify the **assignment_rules** array that contains the rule entries to clone into the target Assignment Rule.", "items": { "additionalProperties": false, "description": "Specify each Assignment Rule object that contains the rule entries to clone.", "properties": { "rule_entries": { "description": "Specify the list of rule entries to clone while retaining their order and configuration in the target Assignment Rule.", "items": { "$ref": "#/components/schemas/RuleEntryUpdateRequestObject" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "rule_entries" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "assignment_rules" ], "title": "Clone entry of an assignment rule request body object", "type": "object" }, "RequestBodySchemaForActionReorderEntries": { "additionalProperties": false, "description": "Request body for reordering entries of an Assignment Rule.", "properties": { "assignment_rules": { "description": "Array of Assignment Rule objects to be created.", "items": { "additionalProperties": false, "description": "Specify each Assignment Rules entry in the Assignment Rule request.", "properties": { "rule_entries": { "description": "Specify the list of rule entries with updated sequence number for reordering.", "items": { "$ref": "#/components/schemas/RuleEntryReorderRequestObject" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "rule_entries" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "assignment_rules" ], "title": "Reorder entries of an assignment rule request body object", "type": "object" }, "RequestBodySchemaForCreate": { "additionalProperties": false, "description": "Request body for creating Assignment Rule.", "properties": { "assignment_rules": { "description": "Array of Assignment Rule objects to be created.", "items": { "additionalProperties": false, "description": "Specify each Assignment Rules entry in the Assignment Rule request.", "properties": { "api_name": { "description": "Specify the aPI name of the rule.", "maxLength": 100, "minLength": 1, "type": "string" }, "default_assignee": { "$ref": "#/components/schemas/DefaultAssigneeRequestObject" }, "description": { "description": "Purpose of the Assignment Rule.", "maxLength": 250, "type": "string" }, "name": { "description": "Specify the name to be displayed for the Assignment Rule.", "maxLength": 100, "minLength": 1, "type": "string" }, "rule_entries": { "description": "Specify the list of rule entries for creation.", "items": { "$ref": "#/components/schemas/RuleEntryCreateRequestObject" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "name", "rule_entries" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "assignment_rules" ], "title": "Create Assignment Rules Request", "type": "object" }, "RequestBodySchemaForUpdate": { "additionalProperties": false, "description": "Request body for creating Assignment Rule.", "properties": { "assignment_rules": { "description": "Array of Assignment Rule objects to be created.", "items": { "additionalProperties": false, "description": "Specify each Assignment Rules entry in the Assignment Rule request.", "properties": { "api_name": { "description": "Specify the aPI name of the rule.", "maxLength": 100, "minLength": 1, "type": "string" }, "default_assignee": { "$ref": "#/components/schemas/DefaultAssigneeRequestObject" }, "description": { "description": "Purpose of the Assignment Rule.", "maxLength": 250, "type": "string" }, "name": { "description": "Specify the name to be displayed for the Assignment Rule.", "maxLength": 100, "minLength": 1, "type": "string" }, "rule_entries": { "description": "Specify the list of rule entries for creation, update or deletion. To delete an existing rule entry, provide the ID of the rule entry to be deleted and set _delete field as null in the request body. To update an existing rule entry, provide the ID of the rule entry to be updated along with the fields to be updated in the request body. To create a new rule entry, do not provide ID field and provide details of the new rule entry in the request body.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RuleEntryDeleteRequestObject" }, { "$ref": "#/components/schemas/RuleEntryUpdateRequestObject" }, { "$ref": "#/components/schemas/RuleEntryCreateRequestObject" } ], "description": "Specify each rule entries entry in the Assignment Rule request." }, "maxItems": 200, "minItems": 1, "type": "array" } }, "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "assignment_rules" ], "title": "Create Assignment Rules Request", "type": "object" }, "RequiredDataNotFoundSchema": { "additionalProperties": false, "description": "Represents the error response returned when required data referenced in the request, such as a module, field, or action entity, cannot be found in the system.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "REQUIRED_DATA_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "api_name": { "description": "Represents the API name of the field with missing required data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with missing required data.", "maxLength": 1000, "type": "string" }, "value": { "description": "Represents the specific required value that was not found in the request.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "Kindly provide values for the required fields", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleRequiredDataNotFoundErrorResponse", "x-zs-llm-description": "Error code: REQUIRED_DATA_NOT_FOUND. Returned when mandatory body data is completely missing. Common: field_mappings values required for action details (create_record, add_meeting, schedule_call) but not provided, or mandatory module fields not included in field_mappings array. Fix: include all mandatory fields in the request." }, "RequiredFieldDependencyError": { "additionalProperties": false, "description": "Error returned when a dependent field is missing. For example, custom_location_url is required when page_type is custom.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the missing required dependent field.", "properties": { "api_name": { "description": "The API name of the missing dependent field", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The field that depends on the missing field", "properties": { "api_name": { "description": "The API name of the dependee field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the dependee field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "The JSON path of the missing dependent field", "maxLength": 1000, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing dependent field.", "enum": [ "Dependent field is missing" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Required Field Dependency Error", "type": "object", "x-zs-$id": "RequiredFieldDependencyError" }, "RequiredFieldMissingError": { "additionalProperties": false, "description": "Represents an error response returned when a required field is absent from the request body.", "properties": { "code": { "description": "Represents the error code **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing validation information.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing required field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing required field.", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredFieldMissingError" }, "RequiredFieldNotFoundError": { "additionalProperties": false, "description": "Error response returned when a required service field cannot be located in the request payload.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that a required field was not found in the request.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredFieldNotFoundError" }, "RequiredIdParamError": { "additionalProperties": false, "description": "Represents an error response returned when the required **ID** parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code **REQUIRED_PARAM_MISSING**.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing the missing parameter information.", "properties": { "param_name": { "description": "Represents the name of the missing required parameter.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message indicating the ID parameter is missing.", "enum": [ "One of the expected param is missing" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredIdParamError" }, "RequiredModuleParamError": { "additionalProperties": false, "description": "Represents an error response returned when the required **module** query parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code **REQUIRED_PARAM_MISSING**.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing the missing parameter information.", "properties": { "param": { "description": "Represents the name of the missing required parameter.", "maxLength": 255, "type": "string" } }, "required": [ "param" ], "type": "object" }, "message": { "description": "Represents the error message indicating the module parameter is missing.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredModuleParamError" }, "RequiredModuleParameterMissingErrorResponse": { "additionalProperties": false, "description": "Returned when the required module parameter is missing. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "Detail field: param_name", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Required Module Parameter Missing Error Response", "type": "object", "x-zs-$id": "RequiredModuleParameterMissingErrorResponse" }, "RequiredParamMissing": { "additionalProperties": false, "description": "Represents the error response when a required query or path parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **REQUIRED_PARAM_MISSING**.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the name of the missing required parameter.", "properties": { "param_name": { "description": "Represents the name of the required parameter that is missing from the request. Possible values: **ids**.", "enum": [ "ids" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message returned when a required parameter is missing. Possible values: **mandatory param missing**.", "enum": [ "mandatory param missing" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "RequiredParamMissing" }, "RequiredParamMissingForDeleteError": { "additionalProperties": false, "description": "Error response returned when the ids query parameter is missing from a service DELETE request.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "param": { "description": "Represents the name of the missing query parameter.", "maxLength": 255, "type": "string" } }, "required": [ "param" ], "type": "object" }, "message": { "description": "Represents the error message describing that a required parameter is missing from the DELETE request.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredParamMissingForDeleteError" }, "RequiredParamMissingGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a required parameter missing GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "param_name": { "description": "Contains additional context about the error.", "maxLength": 50, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingGETError" }, "RequiredParamMissingIdsError": { "additionalProperties": false, "description": "Represents the error returned when the required ids query parameter is absent from a bulk DELETE request.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**REQUIRED_PARAM_MISSING** - The required ids parameter is missing from the request.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the name of the missing required parameter.", "properties": { "param_name": { "description": "Represents the name of the missing required parameter.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**One of the expected parameter is missing** - The ids parameter, which is required for this operation, is not present in the request.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingIdsError", "x-zs-llm-description": "The required 'ids' query parameter is missing for bulk delete. Supply comma-separated webhook IDs." }, "RequiredParamMissingResponse": { "additionalProperties": false, "description": "Returned when the required **id** query parameter is not present in the request URL.", "properties": { "code": { "description": "Represents the error code returned by the API.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error, including the name of the missing parameter.", "properties": { "param_name": { "description": "Represents the name of the required parameter that is missing from the request.", "enum": [ "id" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the overall result status of the API request. Possible values: **error** - The request failed due to a validation or processing issue.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RequiredParamMissingResponse" }, "RequiredParameterMissingError": { "additionalProperties": false, "description": "Represents the error response returned when a mandatory request parameter is missing.", "properties": { "code": { "description": "Represents the error code for the missing required parameter error.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required parameter error, including the parameter name.", "properties": { "param_name": { "description": "Represents the name of the required parameter that is missing from the request.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message indicating a required parameter is missing.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the response status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Required Parameter Missing Error", "type": "object", "x-zs-$id": "RequiredParameterMissingError" }, "RequiredParameterMissingResponse": { "additionalProperties": false, "description": "Represents the error response returned when a required query parameter is absent from the request.", "properties": { "code": { "description": "Represents the error code for the missing required parameter.\nPossible values:\n**REQUIRED_PARAM_MISSING** - A required query parameter is absent from the request.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing parameter.", "properties": { "param_name": { "description": "Represents the name of the missing required parameter.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing parameter.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RequiredParameterMissingResponse" }, "ResourcePathIndex": { "additionalProperties": false, "description": "Represents error details containing the resource path index where the validation error occurred.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path where the validation error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "ResourcePathIndex" }, "ResourcePathIndexError": { "additionalProperties": false, "description": "Represents the error details indicating which segment of the resource path or URL is invalid.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid segment in the resource path.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "ResourcePathIndexError" }, "ResourcePathIndexErrorResponse": { "additionalProperties": false, "description": "Represents the complete error response returned when a segment in the resource path or URL is invalid.", "properties": { "code": { "description": "Represents the error code for the invalid resource path.\nPossible values:\n**INVALID_DATA** - A segment in the resource path is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "$ref": "#/components/schemas/ResourcePathIndexError" }, "message": { "description": "Represents the error message describing the invalid resource path segment.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ResourcePathIndexErrorResponse" }, "ResourceResponseObject": { "additionalProperties": true, "description": "Resource details.", "properties": { "_details": { "$ref": "#/components/schemas/DetailsSchema" }, "api_name": { "description": "Represents the API name of the resource.", "maxLength": 255, "type": "string" }, "id": { "$ref": "#/components/schemas/IdSchema", "description": "Id of the resource" }, "name": { "description": "Represents the display name of the resource. ", "maxLength": 255, "type": "string" }, "zuid": { "description": "Zuid of the user resource", "format": "int32", "maxLength": 19, "type": "string" } }, "required": [ "id", "name" ], "title": "Resource Response Object", "type": "object", "x-zs-$id": "ResourceResponseObject" }, "RestrictedPicklistOptionDeletionErrorResponse": { "additionalProperties": false, "description": "Returned when attempting to delete a restricted picklist option. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "Detail field: resource_path_index", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Restricted Option cannot be deleted" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Restricted Picklist Option Deletion Error Response", "type": "object", "x-zs-$id": "RestrictedPicklistOptionDeletionErrorResponse" }, "RestrictedPicklistOptionReplaceErrorResponse": { "additionalProperties": false, "description": "Returned when attempting to replace a restricted picklist option. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Restricted Option cannot be replaced" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Restricted Picklist Option Replace Error Response", "type": "object", "x-zs-$id": "RestrictedPicklistOptionReplaceErrorResponse" }, "ResultList": { "additionalProperties": false, "description": "Wrapper that returns the per-item results of a recycle-bin operation under the **recycle_bin** array.", "properties": { "recycle_bin": { "description": "List of per-item results for the operation. Each entry is either a success result or a scheduled-job result.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecycleBinSuccessResponse" }, { "$ref": "#/components/schemas/ScheduledResponse" } ] }, "maxItems": 200, "type": "array" } }, "required": [ "recycle_bin" ], "type": "object", "x-zs-$id": "ResultList" }, "RetrieveUnsubscribeLinksResponse": { "additionalProperties": false, "description": "Response payload containing the unsubscribe link records returned by the GET by ID endpoint.", "properties": { "unsubscribe_links": { "description": "Array containing the requested unsubscribe link details", "items": { "$ref": "#/components/schemas/UnsubscribeLinkDetailRecord" }, "maxItems": 1, "type": "array" } }, "required": [ "unsubscribe_links" ], "title": "Retrieve Unsubscribe Links Response", "type": "object", "x-zs-$id": "RetrieveUnsubscribeLinksResponse" }, "RoleGroupProfileTypeAssignToResponseObject": { "additionalProperties": false, "description": "Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.", "properties": { "resource": { "$ref": "#/components/schemas/ResourceResponseObject", "description": "Defines the details user category such as role, group, profile" }, "type": { "description": "Defines which set of users should be considered for assignment.\nPossible values:\n**role** - Represents role.\n**group** - Represents group.\n**profile** - Represents profile. ", "enum": [ "role", "group", "profile" ], "type": "string" } }, "required": [ "type", "resource" ], "title": "Role, group or profile type assign to response object", "type": "object", "x-zs-$id": "RoleGroupProfileTypeAssignToResponseObject" }, "RoleResourceRequestObject": { "additionalProperties": false, "description": "Role resource reference for Assignment Rule entry.", "properties": { "id": { "description": "Specify the iD of the role. Refer to the [Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" }, { "operationId": "createRoles", "propertyId": "RoleResultId" } ], "resource": "roles" } } }, "required": [ "id" ], "title": "Role Resource Request Object", "type": "object" }, "RoleTypeAssignToRequestObject": { "additionalProperties": false, "description": "Assigns ownership to a role. All users under the specified role are eligible for assignment.", "properties": { "resource": { "$ref": "#/components/schemas/RoleResourceRequestObject", "description": "Details of the role to assign" }, "type": { "description": "Assign to type IDentifier. Must be 'role'.\nPossible values:\n**role** - Represents role.", "enum": [ "role" ], "type": "string" } }, "required": [ "type", "resource" ], "title": "Role type assign to request object", "type": "object", "x-zs-$id": "RoleTypeAssignToRequestObject" }, "RuleEntryCreateRequestObject": { "additionalProperties": false, "description": "Defines entries with matching and assignment logic for record processing.", "properties": { "assign_to": { "$ref": "#/components/schemas/AssignToRequestObject", "description": "This field defines the set of users to whom the records that enter the current rule entry must be assigned. (Required)" }, "criteria": { "$ref": "#/components/schemas/RecordCriteriaSchema", "description": "Defines the record criteria based on which records will be filtered and assignment logic defined for current rule entry will be applied. If criteria is not provided or is null, all records entering current rule entry will be assigned based on current rule entry's assignment logic." }, "followup_actions": { "description": "Defines the list of different actions to be executed after owner assignment.", "items": { "$ref": "#/components/schemas/FollowupActionsRequestObject" }, "maxItems": 1, "minItems": 1, "type": [ "array", "null" ] }, "user_availability_based_on": { "description": "Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions.", "items": { "description": "Specify each user availability based on entry in the Assignment Rule request.\nPossible values:\n**online_status** - Represents online status.\n**shift_timing** - Represents shift timing.", "enum": [ "online_status", "shift_timing" ], "type": "string" }, "maxItems": 2, "type": [ "array", "null" ] } }, "required": [ "assign_to" ], "title": "Rule Entry Definition", "type": "object", "x-zs-$id": "RuleEntryCreateRequestObject" }, "RuleEntryDeleteRequestObject": { "additionalProperties": false, "description": "Rule entry request object to delete.", "properties": { "_delete": { "description": "To delete an existing rule entry, provide the ID of the rule entry to be deleted and set _delete field as null in the request body.", "type": "null" }, "id": { "$ref": "#/components/schemas/IdSchema" } }, "required": [ "id", "_delete" ], "type": "object", "x-zs-$id": "RuleEntryDeleteRequestObject" }, "RuleEntryReorderRequestObject": { "additionalProperties": false, "description": "Rule entry request object to delete.", "properties": { "id": { "$ref": "#/components/schemas/IdSchema" }, "sequence_number": { "description": "Entry order of the rule entry. This property can be updated only using reorder_entries API.", "format": "int32", "type": "integer" } }, "required": [ "id", "sequence_number" ], "type": "object" }, "RuleEntryResponseObject": { "additionalProperties": false, "description": "Defines entries with matching and assignment logic for record processing.", "properties": { "allow_agent_user": { "description": "Indicates whether Digital Employee (agent) users are eligible for assignment in this rule entry.", "type": "boolean" }, "assign_to": { "$ref": "#/components/schemas/AssignToResponseObject" }, "criteria": { "additionalProperties": true, "description": "Defines the record criteria based on which records is filtered and assignment logic defined for current rule entry is applied. If criteria is not provided or is null, all records entering current rule entry is assigned based on current rule entry's assignment logic. ", "type": [ "object", "null" ] }, "followup_actions": { "description": "Defines the list of different actions to be executed after owner assignment. ", "items": { "$ref": "#/components/schemas/FollowupActionsResponseObject" }, "maxItems": 1, "minItems": 1, "type": [ "array", "null" ] }, "id": { "$ref": "#/components/schemas/IdSchema" }, "sequence_number": { "description": "Represents the sequence number returned for the Assignment Rule operation. ", "format": "int32", "type": "integer" }, "user_availability_based_on": { "description": "Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions. ", "items": { "description": "Represents each user availability based on entry returned for the Assignment Rule operation.\nPossible values:\n**online_status** - Represents online status.\n**shift_timing** - Represents shift timing.", "enum": [ "online_status", "shift_timing" ], "type": "string" }, "maxItems": 2, "type": [ "array", "null" ] } }, "required": [ "id", "sequence_number", "criteria", "assign_to", "user_availability_based_on", "followup_actions" ], "title": "Rule Entry Object", "type": "object", "x-zs-$id": "RuleEntryResponseObject" }, "RuleEntryUpdateRequestObject": { "additionalProperties": false, "description": "Rule entry request object to update.", "properties": { "allow_agent_user": { "description": "Indicates whether Digital Employee (agent) users are eligible for assignment in this rule entry.", "type": "boolean" }, "assign_to": { "$ref": "#/components/schemas/AssignToRequestObject", "description": "This field defines the set of users to whom the records that enter the current rule entry must be assigned. (Required)" }, "criteria": { "$ref": "#/components/schemas/RecordCriteriaSchema", "description": "Defines the record criteria based on which records will be filtered and assignment logic defined for current rule entry will be applied. If criteria is not provided or is null, all records entering current rule entry will be assigned based on current rule entry's assignment logic." }, "followup_actions": { "description": "Defines the list of different actions to be executed after owner assignment.", "items": { "$ref": "#/components/schemas/FollowupActionsRequestObject" }, "maxItems": 1, "minItems": 1, "type": [ "array", "null" ] }, "id": { "$ref": "#/components/schemas/IdSchema" }, "user_availability_based_on": { "description": "Defines additional availability checks to be performed before choosing a user as owner. A user is assigned as owner only if it satisfies the mentioned availability conditions.", "items": { "description": "Specify each user availability based on entry in the Assignment Rule request.\nPossible values:\n**online_status** - Represents online status.\n**shift_timing** - Represents shift timing.", "enum": [ "online_status", "shift_timing" ], "type": "string" }, "maxItems": 2, "type": [ "array", "null" ] } }, "required": [ "id" ], "title": "Rule Entry Definition", "type": "object", "x-zs-$id": "RuleEntryUpdateRequestObject" }, "RunRulesAlreadyScheduled": { "additionalProperties": false, "description": "Represents the error response when territory rules execution is already scheduled.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **ALREADY_SCHEDULED**.", "enum": [ "ALREADY_SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the job ID of the already scheduled run-rules task.", "properties": { "job_id": { "description": "Represents the unique identifier of the already scheduled run-rules job.", "format": "int64", "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the error message returned when a run-rules task is already scheduled. Possible values: **Previously scheduled Run Rules Action was not yet Completed. Please try again once it is completed**.", "enum": [ "Previously scheduled Run Rules Action was not yet Completed. Please try again once it's completed" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RunRulesAlreadyScheduled" }, "RunRulesDealModuleNotEnabled": { "additionalProperties": false, "description": "Represents the error response when the territory deal rule is not enabled.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the error details for the run-rules operation when the territory deal rule is not enabled.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **FEATURE_NOT_ENABLED**.", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when the territory deal rule is not enabled. Possible values: **Territory Deal Rule Disabled**.", "enum": [ "Territory Deal Rule Disabled" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "type": "object", "x-zs-$id": "RunRulesDealModuleNotEnabled" }, "RunRulesDependentFieldMissing": { "additionalProperties": false, "description": "Error response when a dependent field (e.g., criteria or custom_view) is missing based on the based_on value provided in the territory run rules request.", "properties": { "run_rules": { "additionalProperties": false, "description": "Details of the run rules dependent field missing error.", "properties": { "code": { "description": "Error or status code representing the outcome of the request.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional contextual information about the error or status.", "properties": { "api_name": { "description": "The API field name associated with the validation error.", "enum": [ "criteria", "custom_view" ], "type": "string" }, "dependee": { "additionalProperties": false, "description": "Dependency information related to the error.", "properties": { "api_name": { "description": "The API field name of the dependee.", "enum": [ "based_on" ], "type": "string" }, "json_path": { "description": "JSON path pointing to the field that caused the issue.", "enum": [ "$.run_rules.based_on" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path pointing to the field that caused the issue.", "enum": [ "$.run_rules.criteria", "$.run_rules.custom_view" ], "type": "string" } }, "required": [ "api_name", "json_path", "dependee" ], "type": "object" }, "message": { "description": "Detailed error message to help fix the validation issue.", "enum": [ "Dependent Field missing" ], "type": "string" }, "status": { "description": "Indicates whether the operation failed or succeeded.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "RunRulesDependentFieldMissing" }, "RunRulesExpectedFieldMissing": { "additionalProperties": false, "description": "Represents the error response when an expected field is missing from a territory run rules request.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the error details for the run-rules operation when an expected field is missing.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **EXPECTED_FIELD_MISSING**.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the list of expected fields that are missing.", "properties": { "expected_fields": { "description": "Represents the list of expected fields that are missing from the request.", "items": { "additionalProperties": false, "description": "Represents a single expected field that is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the expected field that is missing.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the expected field that is missing from the request body.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "minItems": 2, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message returned when an expected field is missing. Possible values: **one of the expected field is missing**.", "enum": [ "one of the expected field is missing" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "RunRulesExpectedFieldMissing" }, "RunRulesInvalidData": { "additionalProperties": false, "description": "Represents the error response when invalid data is provided in a territory run rules request.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the error details for the run-rules operation when invalid data is provided.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name, JSON path, and regex pattern for valid values.", "properties": { "api_name": { "description": "Represents the API name of the field that contains an invalid value.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field in the request body that contains an invalid value.", "maxLength": 250, "minLength": 1, "type": "string" }, "regex": { "description": "Represents the regular expression pattern that describes the valid values for the field.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when invalid data is provided. Possible values: **the given value is invalid**, **the given filter value is invalid**, **invalid data**.", "enum": [ "the given value is invalid", "the given filter value is invalid", "invalid data" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "RunRulesInvalidData" }, "RunRulesInvalidIncludeChild": { "additionalProperties": false, "description": "Represents the error response when the include_child parameter has an invalid value.", "properties": { "run_rules": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataType" }, { "$ref": "#/components/schemas/FieldComparatorValueMissing" }, { "$ref": "#/components/schemas/FieldComparatorMismatch" }, { "$ref": "#/components/schemas/FieldValueMismatch" }, { "$ref": "#/components/schemas/ComparatorValueMismatch" }, { "$ref": "#/components/schemas/InvalidComparator" }, { "$ref": "#/components/schemas/LookupLimitExceeded" }, { "$ref": "#/components/schemas/NotSupportedApiName" } ], "description": "Represents the error details for the run-rules operation when an invalid value is provided for the include_child parameter." } }, "required": [ "run_rules" ], "title": "Territory Run Rules Invalid Include Child Error", "type": "object", "x-zs-$id": "RunRulesInvalidIncludeChild" }, "RunRulesLeadModuleNotEnabled": { "additionalProperties": false, "description": "Represents the error response when the territory lead rule is not enabled.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the error details for the run-rules operation when the territory lead rule is not enabled.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **FEATURE_NOT_ENABLED**.", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when the territory lead rule is not enabled. Possible values: **Territory Lead Rule Disabled**.", "enum": [ "Territory Lead Rule Disabled" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "type": "object", "x-zs-$id": "RunRulesLeadModuleNotEnabled" }, "RunRulesMandatoryNotFound": { "additionalProperties": false, "description": "Represents the error response when a mandatory field is missing from a territory run rules request.", "properties": { "run_rules": { "$ref": "#/components/schemas/TerritoriesMandatoryNotFound", "description": "Details of each territory error." } }, "required": [ "run_rules" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "RunRulesMandatoryNotFound" }, "RunRulesModuleNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user does not have permission for the specified module in a territory run rules request.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the error details for the run-rules operation when the user lacks permission for the specified module.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission for the module. Possible values: **You do not have permission for the module.**", "enum": [ "You don't have permission for the module." ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "type": "object", "x-zs-$id": "RunRulesModuleNoPermission" }, "RunRulesNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user does not have permission to run territory rules.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the error details for the run-rules operation when the user lacks permission.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission to run rules. Possible values: **You do not have permission to run rules based on criteria filter.**", "enum": [ "You don't have permission to run rules based on criteria filter." ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "type": "object", "x-zs-$id": "RunRulesNoPermission" }, "SamlInvitationFieldNotAllowedError": { "additionalProperties": false, "description": "Returned when a create or update request specifies a phone field as the invitation field while SAML authentication is active. SAML-based portals require an email field as the invitation field.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An object containing additional detail fields that identify the specific request body field responsible for the error.", "properties": { "api_name": { "description": "The API name of the request body field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the request body field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "The error message that Zoho CRM returned, describing what went wrong.", "enum": [ "SAML configured for portal so phone field was not allowed for user types" ], "type": "string" }, "status": { "description": "The result status of the API call. The value is `error` for all error responses.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "SamlInvitationFieldNotAllowedError" }, "SchedularAlreadyRunningErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when a share operation cannot be processed because a previous share operation on the record is still in progress.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "CANNOT_PROCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "Scheduler is running" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SchedularAlreadyRunningErrorResponse" }, "ScheduleCallActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that schedules a call activity on the triggering record when the workflow rule condition is met.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationScheduleCallDetails", "description": "Configuration for the schedule_call action. Requires the Calls module, a layout, and field mappings that include the call subject. Optionally restricts creation to prevent duplicate records.\n" }, "id": { "description": "Represents the unique ID of the ScheduleCall action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the ScheduleCall action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "related_details": { "$ref": "#/components/schemas/RelatedDetailsNestedSchema", "description": "Optional. For schedule_call, related_details is not typically used. Applicable sub-fields: best_time (for email_notifications only), followup_details (for tasks only), lookup_field (for field_updates only)." }, "type": { "const": "schedule_call", "description": "Represents the action type discriminator that identifies this as a ScheduleCall action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "details" ], "type": "object", "x-zs-$id": "ScheduleCallActionSchema", "x-zs-llm-description": "Inline action type='schedule_call'. Creates a Calls record. Requires module (Calls), layout, and field_mappings (must include Subject). Key fields: Subject, Call_Purpose, Call_Type, Call_Start_Time, Remind_At. Optional: apply_restriction." }, "ScheduleCallTypeFollowupActionRequestObject": { "additionalProperties": false, "description": "Represents the follow-up step configuration for a scheduled call action in a Cadence.", "properties": { "details": { "$ref": "#/components/schemas/AutomationScheduleCallDetails", "description": "Action configuration carrying module+layout+field_mappings for creating the Call record." }, "id": { "description": "Represents the unique identifier of the scheduled call action in the Cadence.", "maxLength": 255, "type": "string" }, "type": { "description": "Represents the action type for this follow-up step.", "enum": [ "schedule_call" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "ScheduleCallTypeFollowupActionRequestObject" }, "ScheduledActionsForWorkflowUsageSchema": { "description": "Represents the list of scheduled action groups for a workflow rule, each group containing the actions and their execution usage metrics.", "items": { "additionalProperties": false, "description": "Represents a scheduled action group configured for the workflow rule, including its execute-after delay and the list of actions within the group.", "properties": { "actions": { "description": "Represents the list of action execution records within this scheduled action group.", "items": { "additionalProperties": false, "description": "Represents the usage details for a single action within the scheduled action group.", "properties": { "associated_time": { "description": "Represents the ISO 8601 timestamp when this action was last executed or associated.", "format": "date-time", "type": "string" }, "failure_count": { "description": "Represents the number of failed executions for this action within the date range.", "format": "int32", "type": "integer" }, "id": { "description": "Represents the unique ID of the executed action.", "format": "string", "type": "string" }, "name": { "description": "Represents the name of the executed action.", "format": "string", "type": "string" }, "queue_count": { "description": "Represents the number of execution instances currently in queue for this action.", "format": "int32", "type": "integer" }, "related_details": { "additionalProperties": true, "description": "Represents additional information related to the action execution, such as email notification performance metrics.", "properties": {}, "type": "object" }, "success_count": { "description": "Represents the number of successful executions for this action within the date range.", "format": "int32", "type": "integer" }, "type": { "description": "Represents the type of action executed, such as **email_notifications**.", "format": "string", "type": "string" } }, "required": [ "id", "name", "type", "queue_count", "success_count", "failure_count", "associated_time" ], "type": "object" }, "maxItems": 5, "type": "array" }, "id": { "description": "Represents unique identifier for the scheduled action.", "format": "string", "type": "string" } }, "required": [ "id", "actions" ], "type": "object" }, "maxItems": 5, "type": "array", "x-zs-llm-description": "Container for scheduled action usage groups in the rule usage response. Lists action groups by their scheduled delay." }, "ScheduledActionsNestedSchema": { "description": "Represents the container for scheduled actions that execute after a configured delay from the time the workflow rule condition is triggered.", "items": { "additionalProperties": false, "description": "Specify when the scheduled actions should be executed", "properties": { "actions": { "description": "Represents the array of action objects for this scheduled group. Uses the same associate and non-associate action structure as instant actions, but only action types that support scheduled execution are allowed. Per-type limits apply independently to instant and scheduled actions.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/NonAssociateActionsNestedSchema" }, { "$ref": "#/components/schemas/AssociateActionsNestedSchema" } ] }, "maxItems": 50, "type": "array" }, "execute_after": { "additionalProperties": false, "description": "Defines the delay before the scheduled actions execute. Required. Cannot be an empty object.", "properties": { "period": { "description": "Represents the type of time interval. Required. Must be one of the allowed period values (invalid_schedule_actions_period if invalid). business_hours and business_days are only available when org business hours are configured. The API returns available periods from getWorkflowConfigurations.", "enum": [ "minutes", "hours", "days", "weeks", "months", "years", "business_hours", "business_days" ], "type": "string" }, "unit": { "description": "Represents the numeric delay value. Required. Allowed ranges per period (unit_not_allowed_for_period if out of range): minutes: 5-180 (2-180 if 1-min repetition feature is enabled), hours: 0-99, days: 0-2000, weeks: 0-100, months: 0-24, years: 0-10, business_hours: 0-99, business_days: 0-2000. All values must be non-negative (no pre-event offsets for scheduled actions).", "format": "int32", "type": "integer" } }, "required": [ "period", "unit" ], "type": "object" }, "id": { "description": "Represents unique Id of the scheduled action", "maxLength": 20, "type": "string" } }, "required": [ "actions" ], "type": [ "object", "null" ] }, "maxItems": 5, "type": [ "array", "null" ], "x-zs-$id": "ScheduledActionsNestedSchema", "x-zs-llm-description": "Container for delayed action groups. Each group has execute_after ({period, unit}) defining the delay and an actions array. Not supported when: trigger has repeat=true, convert action present in instant_actions, or trigger doesn't support scheduling (DEPENDENT_MISMATCH). Max groups governed by getWorkflowRulesCount scheduled_actions_per_rule_limit." }, "ScheduledActionsUsageGroupSchema": { "additionalProperties": false, "description": "Represents a single scheduled action group within a workflow rule, containing the group ID and usage metrics for each action in the group.", "properties": { "actions": { "description": "Represents the array of action usage detail objects within this scheduled action group.", "items": { "$ref": "#/components/schemas/QueuedActionUsageMetricsSchema" }, "maxItems": 5, "type": "array" }, "id": { "description": "Represents the unique ID of the ScheduledActionsUsageGroup within the workflow rule.", "maxLength": 255, "type": "string" } }, "required": [ "actions", "id" ], "title": "Scheduled Actions Usage Group", "type": "object", "x-zs-llm-description": "A scheduled action group in usage. Contains group id and actions array with per-action execution metrics." }, "ScheduledDataNested": { "additionalProperties": false, "description": "Represents the status marker returned with HTTP 202 when the enrollment or unenrollment request is queued for background processing.", "properties": { "code": { "description": "Represents the processing status code. For 202 responses, this is always **SCHEDULED**.", "enum": [ "SCHEDULED" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the scheduled operation. This object is currently empty and reserved for future use.", "type": "object" }, "message": { "description": "Represents the message describing the current processing state of the enrollment request.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the scheduled operation. For 202 responses, this is always **success**.", "enum": [ "success" ], "maxLength": 255, "type": "string" } }, "type": "object" }, "ScheduledJobImpactDetails": { "additionalProperties": false, "description": "Represents the aggregated impact metrics for the scheduled job across records, workflow rules, field dependencies, and dashboard criteria affected by the picklist option change.", "properties": { "dashboard_criteria": { "$ref": "#/components/schemas/DashboardCriteriaProcessingSummary" }, "field_dependency": { "$ref": "#/components/schemas/FieldDependencyProcessingSummary" }, "records": { "$ref": "#/components/schemas/RecordProcessingSummary" }, "workflow_rules": { "$ref": "#/components/schemas/WorkflowRuleProcessingSummary" } }, "required": [ "records" ], "title": "Scheduled Job Impact Details", "type": "object" }, "ScheduledResponse": { "additionalProperties": false, "description": "Result returned when a recycle-bin operation is queued as a background job because it cannot complete synchronously.", "properties": { "code": { "description": "Result code indicating that the operation is scheduled. Possible values: **SCHEDULED**.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the scheduled operation. This is typically an empty object or contains a record ID associated with the scheduled job.", "type": "object" }, "message": { "description": "Represents the message confirming that the operation has been queued as a background job.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates that the request to schedule the operation succeeded. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ScheduledResponse" }, "ScheduledRunRuleJobsRequiredParamMissing": { "additionalProperties": false, "description": "Represents the error response when the required job_id query parameter is missing or null in the Get Scheduled Run Rule Jobs request.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **REQUIRED_PARAM_MISSING**.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the name of the missing required parameter.", "properties": { "param_name": { "description": "Represents the name of the required parameter that is missing from the request. Possible values: **job_id**.", "enum": [ "job_id" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message returned when a required parameter is missing. Possible values: **mandatory param missing**, **One of the expected parameter is missing**.", "enum": [ "mandatory param missing", "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Required Param Missing - job_id", "type": "object", "x-zs-$id": "ScheduledRunRuleJobsRequiredParamMissing" }, "ScheduledServiceStatusRestrictionError": { "additionalProperties": false, "description": "Error response returned when a scheduled service is being marked as Not In Use or Temporarily Unavailable, which is not permitted.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the service status cannot be changed because the service has a scheduled appointment.", "enum": [ "Service status cannot be marked as Not In Use or Temporarily Unavailable for scheduled services.", "Starting date of service availability falls after the current Date, so service cannot be marked as Available or Temporarily Unavailable or Not In Use" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Scheduled Service Status Restriction", "type": "object", "x-zs-$id": "ScheduledServiceStatusRestrictionError" }, "ScheduledStatusPastStartDateError": { "additionalProperties": false, "description": "Error response returned when the service Status is Scheduled but Available_From is earlier than the current date.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the service cannot be set to Scheduled status because the start date has already passed.", "enum": [ "Starting date of service availability falls before the current Date, so service cannot be marked as Scheduled" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Scheduled Status Requires Future Start Date", "type": "object", "x-zs-$id": "ScheduledStatusPastStartDateError" }, "ScopedVariableUpdateItem": { "additionalProperties": false, "description": "Object used to update a variable's value within a scoped resource context; accepts id and the new value.", "properties": { "id": { "description": "Id of variables", "format": "int64", "maxLength": 19, "type": "string" }, "value": { "description": "describes value for the variables", "maxLength": 3000, "type": [ "string", "null" ] } }, "required": [ "id", "value" ], "title": "Scoped Variable Update Item", "type": "object" }, "ScoringRuleActivateSuccessResponse": { "additionalProperties": false, "description": "Scoring rule successfully activated", "properties": { "scoring_rules": { "description": "Activation result for the scoring rule, containing the status and details of the activated rule.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 1, "type": "array" } }, "title": "Activate Scoring Rule Success Response", "type": "object", "x-zs-$id": "ScoringRuleActivateSuccessResponse" }, "ScoringRuleActiveInput": { "description": "It defined the status (active or inactive) of the rule.", "title": "Scoring Rule Active Status", "type": "boolean" }, "ScoringRuleCloneSuccessResponse": { "additionalProperties": false, "description": "successful cloning of a rule", "properties": { "scoring_rules": { "description": "Clone result for the scoring rule, containing the status and ID of the newly cloned rule.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 1, "type": "array" } }, "title": "Clone Scoring Rule Success Response", "type": "object", "x-zs-$id": "ScoringRuleCloneSuccessResponse" }, "ScoringRuleDeleteSuccessResponse": { "additionalProperties": false, "description": "successful deletion of a rule", "properties": { "scoring_rules": { "description": "Deletion result for the scoring rule, containing the status and ID of the deleted rule.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 1, "type": "array" } }, "title": "Delete Scoring Rule By Id Success Response", "type": "object", "x-zs-$id": "ScoringRuleDeleteSuccessResponse" }, "ScoringRuleDescriptionInput": { "description": "Rule configuration info can be added here.", "maxLength": 500, "title": "Scoring Rule Description", "type": [ "string", "null" ] }, "ScoringRuleGET": { "additionalProperties": false, "description": "Represents the root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.", "properties": { "active": { "description": "Indicates whether the Scoring Rule is active (`true`) or inactive (`false`).", "type": "boolean" }, "created_by": { "$ref": "#/components/schemas/CreatedBySchema" }, "created_time": { "description": "Scoring rule created time", "maxLength": 255, "type": "string" }, "custom_fields": { "description": "Represents the custom fields configured for this Scoring Rule to hold referenced scores.", "items": { "$ref": "#/components/schemas/CustomFieldConfiguration" }, "maxItems": 6, "type": [ "array", "null" ] }, "description": { "description": "Represents the optional description of the Scoring Rule. This field is nullable.", "maxLength": 500, "type": [ "string", "null" ] }, "field_rules": { "description": "Module field based score configuration can be added here", "items": { "$ref": "#/components/schemas/FieldScoreConfigurationResponse" }, "maxItems": 50, "type": "array" }, "has_signal_rules": { "description": "It defines whether the production scoring rule has any signal rules or not. Applicable only for Leads and Contacts modules rules in Sandbox environment.", "type": "boolean" }, "id": { "description": "Represents the unique ID of the Scoring Rule.", "maxLength": 255, "type": "string", "x-zs-$id": "ScoringRuleId" }, "layout": { "$ref": "#/components/schemas/LayoutDetails", "description": "Layout info. If the rule should be created for all layouts, this field can be skipped or set value as null." }, "modified_by": { "$ref": "#/components/schemas/ModifiedBySchema", "description": "Scoring rule modified by" }, "modified_time": { "description": "Represents the date and time when the Scoring Rule was last modified, in ISO 8601 format. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "module": { "$ref": "#/components/schemas/ScoringRulesModuleDetails", "description": "module info (Required)" }, "name": { "description": "Represents the unique name of the Scoring Rule.", "maxLength": 25, "type": "string" }, "signal_rules": { "description": "Touch points based score configurations; applicable only for Leads and Contacts modules", "items": { "$ref": "#/components/schemas/TouchPointScoreConfiguration" }, "maxItems": 250, "type": [ "array", "null" ] } }, "required": [ "module", "name" ], "title": "Scoring Rule GET", "type": "object" }, "ScoringRuleLayoutInput": { "additionalProperties": false, "description": "The layout this scoring rule applies to. Omit or pass null to apply the rule to all layouts. When provided as an object, id and api_name are required.", "properties": { "api_name": { "description": "Layout api name", "example": "Lead_Owner", "maxLength": 255, "minLength": 1, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutApiName" } ], "resource": "layouts" } }, "display_label": { "description": "layout display name", "maxLength": 255, "type": "string" }, "id": { "description": "Layout id", "example": "4832675000000850800", "format": "int64", "maxLength": 25, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" } ], "resource": "layouts" } } }, "title": "Layout Information", "type": [ "object", "null" ] }, "ScoringRuleModuleInput": { "additionalProperties": false, "description": "Provides details of a module, including API name and module ID.", "properties": { "api_name": { "description": "Api name of the module", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Represents the module id", "format": "int64", "maxLength": 25, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } } }, "title": "Module Information", "type": "object" }, "ScoringRuleNameInput": { "description": "Scoring rule name. Must be unique within the organization. It cannot contain special characters: ` ~ # % ^ & * ( ) + = \" ; < > [ ] { } | \\", "maxLength": 25, "title": "Scoring Rule Name", "type": "string" }, "ScoringRulePOST": { "additionalProperties": false, "description": "Root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.", "properties": { "active": { "$ref": "#/components/schemas/ScoringRuleActiveInput" }, "custom_fields": { "description": "Custom fields can be configured for scoring rule. These fields will hold the referred scores.", "items": { "$ref": "#/components/schemas/CustomFieldConfiguration" }, "maxItems": 6, "type": [ "array", "null" ] }, "description": { "$ref": "#/components/schemas/ScoringRuleDescriptionInput" }, "field_rules": { "description": "Specifies an array of field-based score configurations that define criteria and associated scores.", "items": { "$ref": "#/components/schemas/FieldScoreConfigurationRequest" }, "maxItems": 50, "type": "array" }, "layout": { "$ref": "#/components/schemas/ScoringRuleLayoutInput" }, "module": { "$ref": "#/components/schemas/ScoringRuleModuleInput" }, "name": { "$ref": "#/components/schemas/ScoringRuleNameInput" }, "signal_rules": { "description": "Represents the touch points based score configurations and is applicable only for Leads and Contacts modules", "items": { "$ref": "#/components/schemas/TouchPointScoreConfigurationPOST" }, "maxItems": 250, "type": [ "array", "null" ] } }, "required": [ "module", "name" ], "title": "Scoring Rule POST", "type": "object" }, "ScoringRulePUT": { "additionalProperties": true, "description": "Represents the root element for defining a scoring rule, including layout, fields, custom fields, and scoring configurations.", "properties": { "active": { "$ref": "#/components/schemas/ScoringRuleActiveInput" }, "custom_fields": { "description": "Represents the custom fields can be configured for scoring rule. These fields will hold the referred scores.", "items": { "$ref": "#/components/schemas/CustomFieldConfigurationPUT" }, "maxItems": 6, "type": [ "array", "null" ] }, "description": { "$ref": "#/components/schemas/ScoringRuleDescriptionInput" }, "field_rules": { "description": "Specifies an array of touch point score configurations, available for Leads and Contacts modules.", "items": { "$ref": "#/components/schemas/FieldScoreConfigurationRequest" }, "maxItems": 50, "type": "array" }, "id": { "description": "Represents the Scoring rule id", "maxLength": 255, "type": "string" }, "name": { "$ref": "#/components/schemas/ScoringRuleNameInput" }, "signal_rules": { "description": "Represents the touch points based score configurations and is applicable only for Leads and Contacts modules", "items": { "$ref": "#/components/schemas/TouchPointScoreConfiguration" }, "maxItems": 250, "type": [ "array", "null" ] } }, "title": "Scoring Rule PUT", "type": "object" }, "ScoringRulePaginationInfo": { "additionalProperties": false, "description": "Nested schema for info", "properties": { "count": { "description": "Total number of scoring rules returned in the current response page.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional scoring rules are available beyond the current page.", "type": "boolean" }, "page": { "description": "Current page number in the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "no of rules need to be fetched per_page", "format": "int32", "type": "integer" } }, "title": "Pagination Info", "type": "object" }, "ScoringRulePutSuccessResponse": { "additionalProperties": false, "description": "Rule successfully updated", "properties": { "scoring_rules": { "description": "Update result for the scoring rule, containing the status and ID of the updated rule.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 1, "type": "array" } }, "title": "Put Scoring Rule By Id Success Response", "type": "object", "x-zs-$id": "ScoringRulePutSuccessResponse" }, "ScoringRuleResponseDetails": { "additionalProperties": false, "description": "Represents the per-item operation result for a Scoring Rule action, including status, code, and message.", "properties": { "code": { "description": "Represents the result code for this per-item Scoring Rule operation.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/SuccessResponseDetails" }, "message": { "description": "Response message for the scoring rule operation", "maxLength": 255, "type": "string" }, "status": { "description": "Response status for the scoring rule operation", "maxLength": 255, "type": "string" } }, "title": "Scoring Rule Response Details", "type": "object" }, "ScoringRulesDeactivateSuccessResponse": { "additionalProperties": false, "description": "Successful deactivation of a rule", "properties": { "scoring_rules": { "description": "Deactivation result for the scoring rule, containing the status and details of the deactivated rule.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 1, "type": "array" } }, "title": "Deactivate Scoring Rule Success Response", "type": "object", "x-zs-$id": "ScoringRulesDeactivateSuccessResponse" }, "ScoringRulesDelete207Response": { "additionalProperties": false, "description": "few ids are invalid and others rules are deleted.", "properties": { "scoring_rules": { "description": "Mixed deletion results - includes success entries for deleted rules and error entries for invalid IDs.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 20, "type": "array" } }, "title": "Delete Scoring Rules Partial Success Response", "type": "object", "x-zs-$id": "ScoringRulesDelete207Response" }, "ScoringRulesDeleteAllResponse": { "additionalProperties": false, "description": "All rules are deleted successfully", "properties": { "scoring_rules": { "description": "Deletion results for all requested scoring rules.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 20, "type": "array" } }, "title": "Delete Scoring Rules Success Response", "type": "object", "x-zs-$id": "ScoringRulesDeleteAllResponse" }, "ScoringRulesModuleDetails": { "additionalProperties": false, "description": "Represents the module associated with a Scoring Rule, including the module API name and unique ID.", "properties": { "api_name": { "description": "Represents the API name of the module associated with the Scoring Rule.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the module associated with the Scoring Rule.", "maxLength": 25, "type": "string" } }, "title": "Module Information", "type": "object" }, "ScoringRulesPartialSuccessResponse": { "additionalProperties": false, "description": "Represents the multi-status response body for the create Scoring Rules operation when some items succeed and others fail.", "properties": { "scoring_rules": { "description": "Represents an array of per-item operation statuses for the partial success response.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 20, "type": "array" } }, "title": "Partial Success Response", "type": "object", "x-zs-$id": "PartialSuccessResponse" }, "ScoringRulesPutSuccessResponse": { "additionalProperties": false, "description": "Rules updated successfully", "properties": { "scoring_rules": { "description": "Update results for all requested scoring rules.", "items": { "$ref": "#/components/schemas/ScoringRuleResponseDetails" }, "maxItems": 20, "type": "array" } }, "title": "Put Scoring Rules Success Response", "type": "object", "x-zs-$id": "ScoringRulesPutSuccessResponse" }, "SectionProperties": { "additionalProperties": false, "description": "Represents the additional configuration properties for subform sections, including row-level interaction settings, tooltip configuration, and conditional display preferences.", "properties": { "bulk_addition": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active bulk addition configuration for a subform section, enabling users to add multiple rows simultaneously to the subform.", "properties": { "lookup_field": { "additionalProperties": false, "description": "The lookup field used for bulk addition", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "name": { "description": "Display name of the lookup field", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id", "name" ], "type": "object" }, "subform_fields": { "anyOf": [ { "description": "List of subform fields available for bulk addition", "items": { "additionalProperties": false, "description": "A subform field available for bulk addition", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName" }, "id": { "$ref": "#/components/schemas/LayoutsId" }, "name": { "description": "Display name of the subform field", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id", "name" ], "type": "object" }, "maxItems": 50, "type": "array", "x-zs-$id": "SubformFieldsArray" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] } }, "required": [ "lookup_field", "subform_fields" ], "type": "object", "x-zs-$id": "BulkAdditionObject" }, { "additionalProperties": false, "description": "Empty object when bulk addition is not configured", "maxProperties": 0, "type": "object", "x-zs-$id": "BulkAdditionEmpty" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] }, "maximum_rows": { "description": "Indicates the maximum number of rows that can be added to the subform section, controlling how many related records can be embedded in a single parent record's layout.", "format": "int32", "minimum": 1, "type": "number" }, "preference": { "description": "Contains the conditional display criteria for the section, defining the field conditions that must be satisfied for the section to be shown or for certain section behaviors to be applied.", "items": { "additionalProperties": false, "description": "Represents a single conditional display criterion for the section, specifying the field, comparison operator, value type, and comparison value used to evaluate whether the condition is met.", "properties": { "comparator": { "description": "Represents the comparison operator applied when evaluating the section preference criterion, such as equals, contains, or is not null.", "example": "not_equal", "maxLength": 50, "type": "string" }, "field": { "additionalProperties": false, "description": "Identifies the field whose value is evaluated against the comparator and preference value to determine whether the section's conditional display condition is met.", "properties": { "api_name": { "$ref": "#/components/schemas/LayoutsApiName", "description": "API name of the field used in the criteria." }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the field used in the criteria." } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Indicates whether the comparison value in the preference criterion is a static literal or a dynamic contextual reference resolved at runtime.", "example": "value", "maxLength": 50, "type": "string" }, "value": { "anyOf": [ { "description": "Represents a string value used as the comparison operand in the section preference criterion.", "example": "${EMPTY}", "maxLength": 255, "type": "string", "x-zs-$id": "PreferenceValueString" }, { "description": "Represents a numeric value used as the comparison operand in the section preference criterion.", "example": 100, "type": "number", "x-zs-$id": "PreferenceValueNumber" }, { "description": "Represents a Boolean value used as the comparison operand in the section preference criterion.", "example": true, "type": "boolean", "x-zs-$id": "PreferenceValueBoolean" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ], "description": "Represents the value compared against the selected field when evaluating the section preference criterion, which may be a string, number, or Boolean depending on the field type." } }, "required": [ "comparator", "field", "type", "value" ], "type": "object" }, "maxItems": 50, "type": "array" }, "reorder_rows": { "description": "Indicates whether users are permitted to reorder existing rows within the subform section by dragging them to a new position. Possible values: `true` — row reordering is allowed; `false` — rows cannot be reordered.", "type": "boolean" }, "tooltip": { "anyOf": [ { "additionalProperties": false, "description": "Represents the active tooltip configuration for this section, specifying the help text and display mechanism shown to users when they hover over the section header.", "properties": { "name": { "description": "Indicates the delivery mechanism for the section tooltip, such as whether it is rendered as a static label or as a modal help popup.", "example": "info_icon", "maxLength": 255, "type": "string" }, "value": { "description": "Contains the help text displayed in the section tooltip, providing contextual guidance about the purpose or use of the section.", "example": "Enter subform data", "maxLength": 255, "type": "string" } }, "required": [ "name", "value" ], "type": "object", "x-zs-$id": "SectionTooltipStructure" }, { "$ref": "#/components/schemas/LayoutsTypeNull" } ] } }, "type": "object", "x-zs-$id": "SectionPropertiesStructure" }, "SectionUpdateObject": { "additionalProperties": true, "description": "Represents a section operation object used in layout update requests to create, modify, or delete a section within the layout, including its label, field assignments, column count, and sequence.", "minProperties": 1, "properties": { "_delete": { "$ref": "#/components/schemas/DeleteObject", "description": "Delete configuration for removing the section. When provided, the section identified by id will be deleted." }, "column_count": { "description": "Indicates the number of columns in which fields are arranged within this section when the layout is rendered on record forms.", "example": 1, "format": "int32", "maximum": 2, "minimum": 1, "type": "integer" }, "display_label": { "description": "Represents the heading label of the section as displayed in the CRM interface. Required when creating a new section.", "examples": [ "Custom Section 2", "Address Information" ], "maxLength": 255, "minLength": 1, "type": "string" }, "fields": { "description": "Contains the array of field operations to perform within this section, including adding, updating, creating, or removing field entries.", "items": { "$ref": "#/components/schemas/FieldUpdateObject" }, "maxItems": 25, "minItems": 1, "type": "array" }, "id": { "$ref": "#/components/schemas/LayoutsId", "description": "Unique identifier of the section. Required for updating or deleting existing sections. Omit when creating a new section." }, "name": { "description": "Represents the internal API name of the section. Required when creating a new section through a layout update.", "examples": [ "Custom Section 2", "Address_Information" ], "maxLength": 255, "minLength": 1, "type": "string" }, "sequence_number": { "description": "Indicates the one-based ordinal position of the section within the layout, controlling the order in which sections are rendered.", "examples": [ 1, 6 ], "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" }, "tab_traversal": { "description": "Specifies the tab key navigation direction within the section. Defines how focus moves between fields when users press Tab. Possible values: `left_to_right` — focus moves horizontally across columns first. `top_to_bottom` — focus moves vertically down each column first.", "enum": [ "left_to_right", "top_to_bottom" ], "examples": [ "left_to_right", "top_to_bottom" ], "type": "string" } }, "type": "object" }, "SendMailMergeNested": { "additionalProperties": false, "description": "Represents the request payload for a send mail merge operation, including the template, recipient addresses, subject, message body, and optional attachment settings.", "properties": { "attachment_name": { "description": "Represents the name of the attachment to include in the mail merge email.", "maxLength": 255, "type": "string" }, "bcc_email": { "description": "Represents the list of email addresses to include in the BCC field of the mail merge email.", "items": { "$ref": "#/components/schemas/BccEmailNested" }, "maxItems": 1, "type": "array" }, "cc_email": { "description": "Represents the list of email addresses to include in the CC field of the mail merge email.", "items": { "$ref": "#/components/schemas/CcEmailNested" }, "maxItems": 1, "type": "array" }, "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." }, "mail_merge_template": { "$ref": "#/components/schemas/MailMergeTemplateNested", "description": "Mailmerge Object to pass Template details (Required)" }, "message": { "description": "Represents the body or content of the email you want to send. It can include up to **100,000 characters**.\n\n", "maxLength": 100000, "type": "string" }, "subject": { "description": "Represents the subject line of the mail merge email.", "maxLength": 255, "type": "string" }, "to_address": { "description": "Represents the list of email addresses to send the mail merge email to.", "items": { "$ref": "#/components/schemas/ToAddressNested" }, "maxItems": 2, "type": "array" }, "type": { "description": "Represents the attachment type for the mail merge email.\nPossible values:\n**inline** - Includes the mail merge document as an inline image in the email.\n**attachment** - Attaches the mail merge document as a separate file in the email.\n", "enum": [ "inline", "attachment" ], "maxLength": 10, "type": "string" } }, "required": [ "mail_merge_template" ], "type": "object" }, "SendMailMergeNested1": { "additionalProperties": false, "description": "Represents the response payload for a send mail merge operation.", "properties": { "code": { "description": "Represents the response code indicating the result of the send mail merge operation.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/MailMergeDetailsNested" }, "message": { "description": "Represents the message describing the result of the send mail merge operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the send mail merge operation.\nPossible values:\n**success** - The mail merge email was initiated successfully.\n**error** - The mail merge email failed to initiate.\n", "enum": [ "success", "error" ], "maxLength": 255, "type": "string" } }, "type": "object" }, "SendMailRequest": { "additionalProperties": false, "description": "Represents the top-level request body for the Send Mail API, containing the email configuration objects.", "properties": { "data": { "description": "Contains the list of email configuration objects to send.", "items": { "additionalProperties": false, "description": "Represents the email configuration for a single send-mail request.", "properties": { "attachments": { "description": "Represents the list of files to attach to the email, referenced by their Zoho File System (ZFS) IDs.", "items": { "additionalProperties": false, "description": "Represents a file attachment referenced by its Zoho File System (ZFS) ID.", "properties": { "id": { "description": "Represents the unique identifier of the file in the Zoho File System (ZFS).", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" }, "bcc": { "description": "Represents the list of BCC (blind carbon copy) recipients for the email.", "items": { "$ref": "#/components/schemas/EmailUser" }, "maxItems": 50, "type": "array" }, "cc": { "description": "Represents the list of CC (carbon copy) recipients for the email.", "items": { "$ref": "#/components/schemas/EmailUser" }, "maxItems": 50, "type": "array" }, "consent_email": { "description": "Indicates whether the email is a GDPR consent email. Possible values: **true** - The email is a GDPR consent request. **false** - The email is not a GDPR consent request.", "type": "boolean" }, "content": { "description": "Represents the body content of the email.", "maxLength": 100000, "type": "string" }, "data_subject_request": { "additionalProperties": false, "description": "Represents the GDPR data subject request associated with the email.", "properties": { "id": { "description": "Represents the unique identifier of the GDPR data subject request.", "maxLength": 100, "type": "string" }, "type": { "description": "Represents the type of GDPR data subject request. Possible values: **access** - A data access request. **rectify** - A data rectification request. **export** - A data export request.", "enum": [ "access", "rectify", "export" ], "type": "string" } }, "type": "object" }, "from": { "$ref": "#/components/schemas/EmailUser" }, "inventory_details": { "additionalProperties": false, "description": "Represents the inventory template details to attach to the email.", "properties": { "inventory_template": { "additionalProperties": false, "description": "Represents the inventory template to attach to the email. Refer to the [Get Inventory Templates](inventory_templates.yaml#$.paths./settings/inventory_templates.get) resource for valid values.", "properties": { "id": { "description": "Represents the unique identifier of the inventory template. Refer to the [Get Inventory Templates](inventory_templates.yaml#$.paths./settings/inventory_templates.get) resource for valid values.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the name of the inventory template.", "maxLength": 100, "type": "string" } }, "type": "object" }, "paper_type": { "description": "Represents the paper size for the inventory template attachment. Possible values: **default** - Uses the default paper size. **A4** - A4 paper size. **us_letter** - US Letter paper size.", "enum": [ "default", "A4", "us_letter" ], "type": "string" }, "view_type": { "description": "Represents the page orientation for the inventory template attachment. Possible values: **portrait** - Portrait orientation. **landscape** - Landscape orientation.", "enum": [ "portrait", "landscape" ], "type": "string" } }, "type": "object" }, "mail_format": { "description": "Represents the format of the email body. Possible values: **html** - HTML-formatted email. **text** - Plain text email.", "enum": [ "html", "text" ], "type": "string" }, "org_email": { "description": "Indicates whether to send the email using the organization email address instead of the sender individual email address. Possible values: **true** - Sends the email using the organization email address. **false** - Sends the email using the sender individual email address.", "type": "boolean" }, "reply_to": { "$ref": "#/components/schemas/EmailUser" }, "scheduled_time": { "description": "Represents the scheduled date and time to send the email, in ISO 8601 date-time format.", "format": "date-time", "type": "string" }, "subject": { "description": "Represents the subject line of the email.", "maxLength": 1000, "type": "string" }, "template": { "additionalProperties": false, "description": "Represents the Email Template to use for the email. Refer to the [Get Email Templates](email_templates.yaml#$.paths./settings/email_templates.get) resource for valid values.", "properties": { "id": { "description": "Represents the unique identifier of the Email Template. Refer to the [Get Email Templates](email_templates.yaml#$.paths./settings/email_templates.get) resource for valid values.", "maxLength": 100, "type": "string" } }, "type": "object" }, "to": { "description": "Represents the list of primary recipients of the email.", "items": { "$ref": "#/components/schemas/EmailUser" }, "maxItems": 50, "type": "array" } }, "required": [ "from", "to" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "SendMailRequest" }, "SendMailSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned after the email sends successfully.", "properties": { "data": { "description": "Represents the list of mail-send results, one item per email request.", "items": { "additionalProperties": false, "description": "Represents the result status for a single email send attempt.", "properties": { "code": { "description": "Represents the status code for the send operation. Possible values: **SUCCESS** - The email was sent successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional metadata returned for the send operation, including the message identifier.", "properties": { "message_id": { "description": "Represents the unique message identifier assigned to the sent email.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the status message for the send operation.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the email send operation. Possible values: **success** - The email was sent successfully.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" } }, "type": "object", "x-zs-$id": "SuccessResponse" }, "ServiceAvailabilityInvalidStatusChangeError": { "additionalProperties": false, "description": "Error response returned when the requested Status change is rejected because the service availability configuration is not valid.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the requested service status change is not allowed.", "enum": [ "As service availability is not valid, status cannot be changed" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ServiceAvailabilityInvalidStatusChangeError" }, "ServiceNameNested": { "additionalProperties": false, "description": "Represents the service for which the appointment is created, including the service ID and name.", "properties": { "id": { "description": "Represents the unique ID of the service.", "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Represents the name of the service for which the appointment is created.", "maxLength": 100, "type": [ "string", "null" ] } }, "type": "object" }, "ServiceTimeNotInBusinessTimingError": { "additionalProperties": false, "description": "Error response returned when the service availability timing falls outside the configured business hours.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the specified service time falls outside the configured business hours.", "enum": [ "Service available time does not satisfy the business timing" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ServiceTimeNotInBusinessTimingError" }, "ServiceUnavailableTillFutureError": { "additionalProperties": false, "description": "Error response returned when Unavailable_Till is not greater than the current time during a service update.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the Unavailable Till date must be in the future.", "enum": [ "Unavailable Till must be greater than current Time.", "When the service status is available, unavailable till must be lesser that current date" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Unavailable Till Must Be in the Future", "type": "object", "x-zs-$id": "ServiceUnavailableTillFutureError" }, "ServicesCreatedByNested": { "additionalProperties": false, "description": "Represents the user who created the service record, identified by name and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "properties": { "id": { "description": "Represents the unique ID of the user who created the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who created the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" } }, "type": "object" }, "ServicesDataNested": { "additionalProperties": false, "description": "Represents a service object in the create request payload, including its name, duration, price, location, members, availability configuration, layout reference, and Zia owner assignment.", "properties": { "$zia_owner_assignment": { "description": "Specify the Zia owner-assignment recommendation behavior for the service record.", "maxLength": 32, "type": [ "string", "null" ] }, "Availability_Type": { "description": "Specify how the service availability is defined. \n\n\n**Possible values**: \n\n- Every Business Days - service is available on every business day.\n\n- Specific Date Range - service is available within an\nAvailable_From and Available_Till range.\n\n- Specific Date(s) - service is available on the dates listed in\nAvailable_Dates.\n\n- Specific Day(s) - service is available on the weekdays listed in\nAvailable_Days.\n", "enum": [ "Specific Day(s)", "Specific Date Range", "Every Business Days", "Specific Date(s)" ], "maxLength": 100, "type": "string" }, "Available_Dates": { "description": "Specify the list of dates on which the service is available, in YYYY-MM-DD format. This key is mandatory when Availability_Type is Specific Date(s).", "items": { "description": "Each string specifies one date on which the service is available, in YYYY-MM-DD format.", "maxLength": 255, "type": "string" }, "maxItems": 20, "type": [ "array", "null" ] }, "Available_Days": { "description": "Specify the list of business days on which the service is available. This key is mandatory when Availability_Type is Specific Day(s).", "items": { "description": "Each string specifies a business day on which the service is available.", "maxLength": 225, "type": "string" }, "maxItems": 7, "type": [ "array", "null" ] }, "Available_From": { "description": "Specify the date from which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range.", "format": "date", "maxLength": 100, "type": [ "string", "null" ] }, "Available_Till": { "description": "Specify the date until which the service is available, in YYYY-MM-DD format. The key is mandatory when Availability_Type is Specific Date Range.", "format": "date", "maxLength": 100, "type": [ "string", "null" ] }, "Available_Timings": { "description": "Specify the available time windows for the service on each available day or date. The total available time must be at least equal to the service Duration. If not mentioned, the configured business hours are used.", "items": { "$ref": "#/components/schemas/AvailableTimingsNested" }, "maxItems": 4, "type": [ "array", "null" ] }, "Description": { "description": "Specify a description of the service.", "maxLength": 32000, "type": [ "string", "null" ] }, "Duration": { "description": "Specify the duration of the service, in minutes. Must be greater than 5 minutes and less than 24 hours.", "format": "int32", "type": "integer" }, "Job_Sheet_Required": { "description": "Specify whether a job sheet is required for the service. **Possible values**: Yes, No.\n", "enum": [ "Yes", "No" ], "maxLength": 3, "type": [ "string", "null" ] }, "Layout": { "$ref": "#/components/schemas/LayoutNested", "description": "Layout id" }, "Location": { "description": "Specify where the service is delivered. \n\n\n**Possible values**: Client Address, Business Address, Business\nAddress and Client Address.\n", "enum": [ "Business Address", "Business Address and Client Address", "Client Address" ], "maxLength": 100, "type": "string" }, "Members": { "description": "Specify the users who deliver the service. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "items": { "$ref": "#/components/schemas/MembersNested" }, "maxItems": 5, "type": "array" }, "Owner": { "$ref": "#/components/schemas/ServicesOwnerNested", "description": "owner of the service" }, "Price": { "description": "Specify the price charged for the service in the organization currency, with up to 16 digits and 2 decimal places.", "format": "int32", "type": "integer" }, "Service_Name": { "description": "Specify the name of the service. The key accepts alphanumeric characters.", "maxLength": 120, "type": "string" }, "Tax": { "description": "Specify the taxes applied to the service cost. Each entry carries a tax ID and the tax value label.", "items": { "$ref": "#/components/schemas/TaxNested" }, "maxItems": 2, "type": [ "array", "null" ] }, "zia_suggested_users": { "additionalProperties": false, "description": "Specify the Zia-suggested users payload associated with the service record.", "type": [ "object", "null" ] } }, "required": [ "Availability_Type", "Duration", "Location", "Members", "Price", "Service_Name" ], "type": "object" }, "ServicesDataNested1": { "additionalProperties": false, "description": "Represents a per-record status item in a response. Carries the operation code, message, status, and details (such as audit metadata and the affected_data block) for one service record.", "properties": { "code": { "description": "Represents the operation result code for the service record. ", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/ServicesDetailsNested" }, "message": { "description": "Represents the result message for the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation. ", "maxLength": 255, "type": "string" } }, "type": "object" }, "ServicesDependentFieldMissingError": { "additionalProperties": false, "description": "Error response returned when a dependent service field required for the current Status or Availability_Type is missing.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that a dependent field required by the submitted field is missing from the request.", "enum": [ "Dependent Field missing" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "DependentFieldMissingError" }, "ServicesDetailsNested": { "additionalProperties": true, "description": "Represents the details as a per-record status item. Carries audit metadata (Modified_Time, Modified_By, Created_Time, Created_By) and the persisted record ID.", "properties": { "Created_By": { "$ref": "#/components/schemas/ServicesCreatedByNested" }, "Created_Time": { "description": "Represents the timestamp when the service record was first saved to the organization.", "maxLength": 255, "type": "string" }, "Modified_By": { "$ref": "#/components/schemas/ServicesModifiedByNested" }, "Modified_Time": { "description": "Represents the timestamp when the service record was last modified.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the affected service record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "ServicesDuplicateDataError": { "additionalProperties": false, "description": "Error response returned when a service field is set to a value that duplicates an existing record.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "duplicate_record": { "description": "Represents the existing record that duplicates the requested value." }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" }, "more_records": { "description": "Indicates whether additional duplicate records exist beyond the one reported." } }, "type": "object" }, "message": { "description": "Represents the error message describing that the request contains duplicate data for an existing record.", "enum": [ "Data is duplicate", "duplicate data" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "DuplicateDataError" }, "ServicesGETCreatedByNested": { "additionalProperties": false, "description": "Represents the user who created the returned service record, identified by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "email": { "description": "Represents the email address of the user.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" } }, "required": [ "email", "id", "name" ], "type": "object" }, "ServicesGETDataNested": { "additionalProperties": true, "description": "Represents a single service record returned by a GET request, including identity, status, availability configuration, members, owner, pricing, tax, audit timestamps, and sharing metadata.", "properties": { "$currency_symbol": { "description": "Represents the currency symbol used to format monetary fields on the service record.", "maxLength": 255, "type": "string" }, "$data_source_details": { "$ref": "#/components/schemas/GETDataSourceDetailsNested" }, "$editable": { "description": "Indicates whether the current user can edit the service record.", "type": "boolean" }, "$field_states": { "description": "Represents the field-state metadata for the service record.", "type": "null" }, "$has_more": { "$ref": "#/components/schemas/GETHasMoreNested" }, "$photo_id": { "description": "Represents the photo ID associated with the service record.", "type": "null" }, "$sharing_permission": { "description": "Represents the sharing permission level of the current user on the service record.", "maxLength": 255, "type": "string" }, "$status": { "description": "Represents the internal status identifier of the service record.", "maxLength": 255, "type": "string" }, "Availability_Type": { "description": "Represents how the service availability is defined. \n\n\n**Possible values**: Specific Day(s), Specific Date Range, Every\nBusiness Days, Specific Date(s).\n", "maxLength": 255, "type": "string" }, "Available_Dates": { "description": "Represents the list of dates on which the service is available.", "items": { "description": "Each string represents a date in the service availability list, in YYYY-MM-DD format." }, "maxItems": 20, "type": "array" }, "Available_Days": { "description": "Represents the list of business days on which the service is available.", "items": { "description": "Each string represents a business day in the service availability list." }, "maxItems": 7, "type": "array" }, "Available_From": { "description": "Represents the date from which the service is available.", "maxLength": 255, "type": "string" }, "Available_Till": { "description": "Represents the date until which the service is available.", "maxLength": 255, "type": [ "string", "null" ] }, "Available_Timings": { "description": "Represents the available time windows configured for the service.", "items": { "$ref": "#/components/schemas/GETAvailableTimingsNested" }, "maxItems": 3, "type": [ "array", "null" ] }, "Created_By": { "$ref": "#/components/schemas/ServicesGETCreatedByNested" }, "Created_Time": { "description": "Represents the timestamp when the service record was first saved to the organization.", "maxLength": 255, "type": "string" }, "Description": { "description": "Represents the description of the service.", "maxLength": 32000, "type": [ "string", "null" ] }, "Duration": { "description": "Represents the duration of the service, in minutes.", "format": "int32", "type": "integer" }, "Job_Sheet_Required": { "description": "Represents whether a job sheet is required for the service. **Possible values**: Yes, No.\n", "enum": [ "Yes", "No" ], "maxLength": 255, "type": "string" }, "Job_Sheet_Section__s": { "description": "Represents the job sheet section associated with the service.", "type": "null" }, "Last_Activity_Time": { "description": "Represents the timestamp of the most recent activity on the service record.", "maxLength": 255, "type": "string" }, "Location": { "description": "Represents where the service is delivered.\n\n\n**Possible values**: Client Address, Business Address, Business\nAddress and Client Address.\n", "maxLength": 255, "type": "string" }, "Members": { "description": "Represents the users who deliver the service. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "items": { "$ref": "#/components/schemas/GETMembersNested1" }, "maxItems": 2, "type": "array" }, "Modified_By": { "$ref": "#/components/schemas/ServicesGETModifiedByNested" }, "Modified_Time": { "description": "Represents the timestamp when the service record was last modified.", "maxLength": 255, "type": "string" }, "Owner": { "$ref": "#/components/schemas/ServicesGETOwnerNested" }, "Price": { "description": "Represents the price charged for the service in the organization currency.", "format": "int32", "type": "integer" }, "Record_Image": { "description": "Represents the record image associated with the service.", "type": "null" }, "Record_Status__s": { "description": "Represents the system-derived record status of the service.", "maxLength": 255, "type": "string" }, "Service_Name": { "description": "Represents the name of the service.", "maxLength": 120, "type": "string" }, "Status": { "description": "Represents the operational status of the service. \n\n\n**Possible values**: Available, Not in Use, Scheduled, Temporarily\nUnavailable.\n", "enum": [ "Available", "Temporarily Unavailable", "Not in Use", "Scheduled" ], "maxLength": 255, "type": "string" }, "Tag": { "description": "Represents the tags associated with the service record. Refer to the [Get tags](tags.yaml#$.paths./settings/tags.get) endpoint for details.", "items": { "description": "Each string represents a tag name associated with the service record.", "maxLength": 2000, "type": "string" }, "maxItems": 100, "type": [ "array", "null" ] }, "Tax": { "description": "Represents the taxes applied to the service cost.", "items": { "description": "Each string represents a tax entry applied to the service cost." }, "maxItems": 100, "type": "array" }, "Unavailable_From": { "description": "Represents the date and time from which the service is unavailable.", "maxLength": 255, "type": [ "string", "null" ] }, "Unavailable_Till": { "description": "Represents the date and time until which the service remains unavailable.", "type": "null" }, "id": { "description": "Represents the unique ID of the service record.", "maxLength": 255, "type": "string" } }, "required": [ "$editable", "$field_states", "$has_more", "$photo_id", "$sharing_permission", "$status", "Availability_Type", "Available_Dates", "Available_Days", "Available_From", "Available_Till", "Available_Timings", "Created_By", "Created_Time", "Description", "Duration", "Job_Sheet_Required", "Job_Sheet_Section__s", "Last_Activity_Time", "Location", "Members", "Modified_By", "Modified_Time", "Owner", "Price", "Record_Image", "Service_Name", "Status", "Tag", "Tax", "Unavailable_From", "Unavailable_Till", "id" ], "type": "object" }, "ServicesGETModifiedByNested": { "additionalProperties": false, "description": "Represents the user who last modified the returned service record, identified by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "email": { "description": "Represents the email address of the user.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" } }, "required": [ "email", "id", "name" ], "type": "object" }, "ServicesGETOwnerNested": { "additionalProperties": false, "description": "Represents the owner of the returned service record, identified by name, ID, and email. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "email": { "description": "Represents the email address of the user.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" } }, "required": [ "email", "id", "name" ], "type": "object" }, "ServicesInvalidDataGenericError": { "additionalProperties": false, "description": "Error response returned when a service field carries data that does not pass validation.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the invalid field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataGenericError" }, "ServicesInvalidModuleNameError": { "additionalProperties": false, "description": "Error response returned when the module name in the request URL does not match any module in the Zoho CRM organization.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment that caused the failure.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidModuleNameError" }, "ServicesMandatoryFieldMissingError": { "additionalProperties": false, "description": "Error response returned when a required service field is missing from the request payload.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that a mandatory field is missing from the request.", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MandatoryFieldMissingError" }, "ServicesModifiedByNested": { "additionalProperties": false, "description": "Represents the user who last modified the service record, identified by name and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "properties": { "id": { "description": "Represents the unique ID of the user who modified the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who modified the service record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 255, "type": "string" } }, "type": "object" }, "ServicesOwnerNested": { "additionalProperties": false, "description": "Represents the owner of the service. Identifies the user who owns the service record by name, full name, and ID. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "properties": { "full_name": { "description": "Specify the full name of the user who owns the service record.", "maxLength": 120, "type": [ "string", "null" ] }, "id": { "description": "Specify the unique ID of the user who owns the service record. Refer to the [Get users](users.yaml#$.paths./users.get) resource for valid values.", "maxLength": 18, "type": [ "string", "null" ] }, "name": { "description": "Specify the display name of the user who owns the service record.", "maxLength": 120, "type": [ "string", "null" ] } }, "type": "object" }, "ServicesPost207multistatusResponse207": { "additionalProperties": false, "description": "Represents a success item in a multi-status response. Carries the success code, message, status, and details for the corresponding service record in the request.", "properties": { "code": { "description": "Represents the operation result code for the service record. ", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/ServicesDetailsNested" }, "message": { "description": "Represents the result message for the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation. ", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "Post207multistatusResponse207" }, "ServicesRecordLockedError": { "additionalProperties": false, "description": "Error response returned when the requested service record is locked and cannot be updated.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details block providing validation context for the error.", "properties": { "action": { "description": "Represents the action that was attempted on the locked record.", "maxLength": 255, "type": "string" }, "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "action", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the service record is locked and cannot be modified.", "enum": [ "Sorry, you cannot perform this operation as the record is locked." ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Record Locked Error", "type": "object", "x-zs-$id": "RecordLockedError" }, "ServicesRequiredParamMissingError": { "additionalProperties": false, "description": "Error response returned when a required query parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "param_name": { "description": "Represents the name of the missing query parameter.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing that a required query parameter is missing from the request.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "SetFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a filter criterion for the in and not_in comparators. The value must be an array of primitive values. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text-based types, and SimpleFilterCriterionValueNumber for integer, currency, or double fields.", "properties": { "comparator": { "description": "Represents the set membership comparison operator applied to the criterion.\nPossible values:\nin - Matches records where the field value is in the specified set of values.\nnot_in - Matches records where the field value is not in the specified set of values.", "enum": [ "in", "not_in" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the set filter criterion.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the set filter criterion is applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "description": "Contains an array of primitive filter values used in the set comparison.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" } ], "x-zs-$id": "SetFilterCriterionRequestValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "SetFilterCriterionRequestValueArray" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "SetFilterCriterionRequest" }, "SetFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the response for a filter criterion using the in and not_in comparators. The value is an array of primitive values.", "properties": { "$disrupted": { "description": "Indicates whether the set filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.", "type": "boolean" }, "comparator": { "description": "Represents the set membership comparison operator returned for the criterion.\nPossible values:\nin - Matches records where the field value is in the specified set of values.\nnot_in - Matches records where the field value is not in the specified set of values.", "enum": [ "in", "not_in" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the set filter criterion response.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the set filter criterion was applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "description": "Contains an array of primitive filter values returned for the set comparison.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" } ], "x-zs-$id": "SetFilterCriterionResponseValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "SetFilterCriterionResponseValueArray" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "SetFilterCriterionResponse" }, "ShareLimitExceedErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the share entry exceeds the per-record sharing limit for the recipient type.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "enum": [ "type" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" }, "limit": { "description": "Represents the maximum number of share records allowed for the entity type.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ShareLimitExceedErrorResponse" }, "ShareRecordsMandatoryNotFound": { "additionalProperties": false, "description": "Represents the error response returned when a mandatory field is missing from the share entry.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API. ", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFound" }, "ShareRecordsMaximumLengthErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the `share` array in the request exceeds the maximum allowed length.", "properties": { "code": { "description": "Represents the response code returned by the API. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response. ", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error. ", "enum": [ "share" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the parameter that caused the error.", "enum": [ "$.share" ], "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the parameter.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MaximumLengthErrorResponse" }, "SharedTo": { "description": "Represents the list of users, roles, groups, or territories the Custom View is shared with.", "items": { "additionalProperties": false, "description": "Shared To Object", "properties": { "id": { "description": "ID of the user/group", "format": "int64", "maxLength": 25, "type": "string" }, "name": { "description": "Name of the user/group", "maxLength": 255, "type": "string" }, "subordinates": { "description": "Specify true if subordinates are included, false otherwise", "type": [ "boolean", "null" ] }, "type": { "description": "Represents the type of the shared-to entity.\nPossible values:\n**territories** - The view is shared with a territory.\n**roles** - The view is shared with a role.\n**groups** - The view is shared with a group.\n**users** - The view is shared with a specific user.", "enum": [ "territories", "roles", "groups", "users" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "maxItems": 250, "type": [ "array", "null" ] }, "SharedToReference": { "additionalProperties": false, "description": "Represents a reference to a user/group for sharing a Custom View", "properties": { "id": { "description": "ID of the user/group", "format": "int64", "maxLength": 25, "type": "string" }, "name": { "description": "Name of the user/group", "maxLength": 255, "type": "string" }, "subordinates": { "description": "Specify true if subordinates are included, false otherwise", "type": [ "boolean", "null" ] }, "type": { "description": "Type of share", "enum": [ "territories", "roles", "groups", "users" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object", "x-zs-$id": "SharedToReference" }, "SharingSharedRecordErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when a record that was already shared with the current user cannot be shared again with other users.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "Shared record cannot be shared to other users" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SharingSharedRecordErrorResponse" }, "ShiftHoursSuccessResponse": { "additionalProperties": false, "description": "Represents the response body that contains the shift hour configurations and the aggregate count of shifts with assigned users.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations in the request or response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code of the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "id": { "description": "Represents the unique identifier of the shift hour affected by the operation.", "maxLength": 100, "type": "string", "x-zs-$id": "ShiftHoursDetailsId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "shift_hours" ], "type": "object", "x-zs-$id": "ShiftHoursSuccessResponse" }, "SignMailMergeNested": { "additionalProperties": false, "description": "Represents the request payload for a sign mail merge operation, including the template reference, file name, signing order, and the list of signers.", "properties": { "file_name": { "description": "Represents the name of the file to send for signing or approval.", "maxLength": 255, "type": "string" }, "mail_merge_template": { "$ref": "#/components/schemas/MailMergeTemplateNested", "description": "To pass Template details (Required)" }, "sign_in_order": { "description": "Indicates whether recipients must act on the document in a specified sequence.\nPossible values:\n**true** - The document first goes for approval, then for signing in the defined order.\n**false** - Zoho Sign sends the document to all recipients simultaneously.\n", "type": "boolean" }, "signers": { "description": "The details of the users you want to sign the document.\n- recipient_name **string, mandatory** - the name of the user who has to sign or approve the document.\n- **action_type** string, mandatory - 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.\n- **recipient** JSON object, mandatory\n - **value** string, mandatory - the email ID of the user who has to sign or approve the document.\n\n> **Note**\n> The values for the fields **recipient_name** and **recipient.value** will be taken from the mail merge template. If you want to override the values in the template, you must specify the values of these fields in the input body.", "items": { "$ref": "#/components/schemas/SignersNested" }, "maxItems": 3, "type": "array" } }, "required": [ "file_name", "mail_merge_template" ], "type": "object" }, "SignMailMergeNested1": { "additionalProperties": false, "description": "Represents the response payload for a sign mail merge operation.", "properties": { "code": { "description": "Represents the response code indicating the result of the sign mail merge operation.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/DetailsNested1" }, "message": { "description": "Represents the message describing the result of the sign mail merge operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the sign mail merge operation.\nPossible values:\n**success** - The sign mail merge document was sent successfully.\n**error** - The sign mail merge document failed to send.\n", "enum": [ "success", "error" ], "maxLength": 255, "type": "string" } }, "type": "object" }, "SignalInformation": { "additionalProperties": false, "description": "Details about touch point signals used in scoring, including signal namespace and ID.", "properties": { "id": { "description": "Signal id", "maxLength": 25, "type": "string" }, "namespace": { "description": "Signal namespace", "maxLength": 255, "type": "string" } }, "title": "Touch Point Signal Information", "type": "object" }, "SignersNested": { "additionalProperties": false, "description": "Represents a signer entry for a sign mail merge operation, including the recipient details, the recipient name, and the required action type.", "properties": { "action_type": { "description": "Represents the action the recipient must perform on the mail merge document.\nPossible values:\n**sign** - The recipient must sign the document.\n**approve** - The recipient must approve the document.\n", "enum": [ "sign", "approve" ], "maxLength": 7, "type": "string" }, "recipient": { "$ref": "#/components/schemas/RecipientNested", "description": "Recipient Object (Required)" }, "recipient_name": { "description": "Represents the name of the recipient who must sign or approve the document.", "maxLength": 255, "type": "string" } }, "required": [ "action_type", "recipient", "recipient_name" ], "type": "object" }, "SimpleAssociateActionSchema": { "additionalProperties": false, "description": "Represents an associate action that references a pre-configured action entity by its unique ID, applicable to action types such as webhooks, functions, and notifications.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "additionalProperties": false, "description": "Represents the read-only details of the associated action entity. Returned in GET responses and not required in POST or PUT requests.", "properties": { "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module this action applies to." } }, "type": "object" }, "id": { "description": "Represents the unique ID of the pre-configured action entity. Required to associate an existing action with the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the SimpleAssociate action. Returned in GET responses and derived from the referenced action configuration.", "maxLength": 500, "type": "string" }, "type": { "description": "Represents the type of associate action.\nPossible values:\nwebhooks - HTTP callback to an external URL.\nfunctions - Custom function execution.\nemail_notifications - Automated email notification.\ntasks - Task creation action.", "enum": [ "webhooks", "functions", "sms", "whatsapp" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "SimpleAssociateActionSchema", "x-zs-llm-description": "References a pre-configured action entity (webhooks, functions, sms, whatsapp) by type and ID. No related_details supported. Create entities via: webhooks->createWebhooks, functions->Create_Functions, sms/whatsapp->postMessageNotifications. Entity must target the correct module based on module_selection context." }, "SimpleFieldError": { "additionalProperties": false, "description": "Represents the error details for an invalid or missing field, including the API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the invalid field in the request.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "SimpleFieldError" }, "SimpleFilterCriterionRequest": { "anyOf": [ { "$ref": "#/components/schemas/EqualityFilterCriterionRequest" }, { "$ref": "#/components/schemas/TextFilterCriterionRequest" }, { "$ref": "#/components/schemas/OrderingFilterCriterionRequest" }, { "$ref": "#/components/schemas/BetweenFilterCriterionRequest" }, { "$ref": "#/components/schemas/SetFilterCriterionRequest" }, { "$ref": "#/components/schemas/MultiSelectLookupFilterCriterionRequest" } ], "description": "Represents a simple field-based filter criterion that dispatches to the appropriate comparator-specific schema. The equal and not_equal comparators support scalar or array values; text comparators support scalar or array strings; ordering comparators require a scalar; between and not_between comparators require a two-element array; in and not_in comparators require an array of primitives; and include_all, include_any, exclude_all, and exclude_any comparators require an array of lookup objects and apply only when the field's data_type is multiuserlookup or multiselectlookup.", "x-zs-$id": "SimpleFilterCriterionRequest" }, "SimpleFilterCriterionResponse": { "anyOf": [ { "$ref": "#/components/schemas/EqualityFilterCriterionResponse" }, { "$ref": "#/components/schemas/TextFilterCriterionResponse" }, { "$ref": "#/components/schemas/OrderingFilterCriterionResponse" }, { "$ref": "#/components/schemas/BetweenFilterCriterionResponse" }, { "$ref": "#/components/schemas/SetFilterCriterionResponse" }, { "$ref": "#/components/schemas/MultiSelectLookupFilterCriterionResponse" } ], "description": "Represents the response for a simple field-based filter criterion, dispatching to the appropriate comparator-specific response schema.", "x-zs-$id": "SimpleFilterCriterionResponse" }, "SimpleFilterCriterionValueAgeDuePredefined": { "description": "Represents a predefined age or due-in-days placeholder value applicable only when the field's data_type is date or datetime. Follows the pattern ${AGEINDAYS}+ for records where the date field was exactly n days in the past, or ${DUEINDAYS}+ for records where the date field is exactly n days in the future. Supported comparators are equal, not_equal, less_than, greater_than, less_equal, and greater_equal.", "maxLength": 255, "pattern": "^\\$\\{(AGEINDAYS|DUEINDAYS)\\}\\+[0-9]+$", "type": "string", "x-zs-$id": "SimpleFilterCriterionValueAgeDuePredefined" }, "SimpleFilterCriterionValueBoolean": { "description": "Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field).", "type": "boolean", "x-zs-$id": "SimpleFilterCriterionValueBoolean" }, "SimpleFilterCriterionValueDateTimePredefined": { "description": "Represents a predefined placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator.", "enum": [ "${TODAY}", "${TOMORROW}", "${TOMORROWPLUS}", "${YESTERDAY}", "${YESTERDAYMINUS}", "${LASTMONTH}", "${THISMONTH}", "${NEXTMONTH}", "${LASTWEEK}", "${THISWEEK}", "${NEXTWEEK}", "${THISYEAR}", "${THISFY}", "${THISFQ}", "${LASTYEAR}", "${PREVFY}", "${PREVFQ}", "${NEXTYEAR}", "${NEXTFY}", "${NEXTFQ}", "${EMPTY}", "${NOTEMPTY}" ], "type": "string", "x-enumDescriptions": { "${EMPTY}": "Matches records where the date field has no value set.", "${LASTMONTH}": "Matches records where the date field falls within the entire previous calendar month.", "${LASTWEEK}": "Matches records where the date field falls within the previous calendar week (Monday–Sunday).", "${LASTYEAR}": "Matches records where the date field falls within the previous calendar year.", "${NEXTFQ}": "Matches records where the date field falls within the next fiscal quarter.", "${NEXTFY}": "Matches records where the date field falls within the next fiscal year.", "${NEXTMONTH}": "Matches records where the date field falls within the next calendar month.", "${NEXTWEEK}": "Matches records where the date field falls within the next calendar week.", "${NEXTYEAR}": "Matches records where the date field falls within the next calendar year.", "${NOTEMPTY}": "Matches records where the date field has a value set.", "${PREVFQ}": "Matches records where the date field falls within the previous fiscal quarter.", "${PREVFY}": "Matches records where the date field falls within the previous fiscal year.", "${THISFQ}": "Matches records where the date field falls within the current fiscal quarter.", "${THISFY}": "Matches records where the date field falls within the current fiscal year.", "${THISMONTH}": "Matches records where the date field falls within the current calendar month.", "${THISWEEK}": "Matches records where the date field falls within the current calendar week.", "${THISYEAR}": "Matches records where the date field falls within the current calendar year.", "${TODAY}": "Matches records where the date field falls on the current calendar day.", "${TOMORROWPLUS}": "Matches records where the date field is on tomorrow or any later date (tomorrow onwards).", "${TOMORROW}": "Matches records where the date field falls on the next calendar day.", "${YESTERDAYMINUS}": "Matches records where the date field is on yesterday or any earlier date (up to and including yesterday).", "${YESTERDAY}": "Matches records where the date field falls on the previous calendar day." }, "x-zs-$id": "SimpleFilterCriterionValueDateTimePredefined" }, "SimpleFilterCriterionValueGeneralPredefined": { "description": "Represents a predefined placeholder value applicable to any field data_type with the equal comparator.\nPossible values:\n${EMPTY} - Matches records where the field has no value.\n${NOTEMPTY} - Matches records where the field has any non-empty value.", "enum": [ "${EMPTY}", "${NOTEMPTY}" ], "type": "string", "x-enumDescriptions": { "${EMPTY}": "Matches records where the field has no value (null or empty string).", "${NOTEMPTY}": "Matches records where the field has any non-empty value." }, "x-zs-$id": "SimpleFilterCriterionValueGeneralPredefined" }, "SimpleFilterCriterionValueNDaysPredefined": { "description": "Represents a predefined N-period range placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. Follows the pattern ${NEXT_N_:} or ${LAST_N_:}, where PERIOD is DAYS, WEEKS, MONTHS, or YEARS and n is a positive integer. The current period is always excluded from the range.", "maxLength": 255, "pattern": "^\\$\\{(LAST_N_|NEXT_N_)(DAYS|WEEKS|MONTHS|YEARS):([0-9]+)\\}$", "type": "string", "x-zs-$id": "SimpleFilterCriterionValueNDaysPredefined" }, "SimpleFilterCriterionValueNumber": { "description": "Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double.", "type": "number", "x-zs-$id": "SimpleFilterCriterionValueNumber" }, "SimpleFilterCriterionValueObjectBase": { "additionalProperties": true, "description": "Represents the base minified record structure of a lookup module, containing the record's unique identifier and display name.", "properties": { "id": { "description": "Represents the unique ID of the lookup module record.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the lookup module record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "SimpleFilterCriterionValueObjectPredefined": { "anyOf": [ { "additionalProperties": false, "description": "Represents the predefined object form for the currently logged-in user, in which only the name property carries the predefined value ${CURRENTUSER} and no ID property is included.", "properties": { "name": { "description": "Represents the predefined placeholder for the currently logged-in user.\nPossible values:\n${CURRENTUSER} - Represents the currently logged-in user.", "enum": [ "${CURRENTUSER}" ], "type": "string" } }, "required": [ "name" ], "type": "object", "x-zs-$id": "SimpleFilterCriterionValueObjectPredefinedCurrentUser" }, { "additionalProperties": true, "description": "Represents the predefined object form for the currently logged-in user's role, in which the ID property carries the predefined value ${CURRENTUSERROLE} and the name property is an optional display label.", "properties": { "id": { "description": "Represents the predefined placeholder for the logged-in user's role record ID.\nPossible values:\n${CURRENTUSERROLE} - Represents the role of the currently logged-in user.", "enum": [ "${CURRENTUSERROLE}" ], "type": "string" }, "name": { "description": "Represents an optional display label for the predefined role, such as Logged in User Role.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "SimpleFilterCriterionValueObjectPredefinedCurrentUserRole" } ], "description": "Represents a predefined placeholder object filter criterion value for lookup fields, applicable with equal or not_equal comparators when the field's data_type is ownerlookup or userlookup. Two forms are supported: (1) the currently logged-in user, represented by passing only the name property with the predefined value ${CURRENTUSER} and no ID property; and (2) the logged-in user's role, represented by passing the ID property with the predefined value ${CURRENTUSERROLE} and an optional display label in the name property. For specific real users or roles that are not predefined, use SimpleFilterCriterionValueObjectRequest, which requires the ID property.", "x-zs-$id": "SimpleFilterCriterionValueObjectPredefined" }, "SimpleFilterCriterionValueObjectRequest": { "allOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectBase" }, { "additionalProperties": true, "description": "Represents the constraint that the ID property is required for the lookup object filter criterion value in request bodies.", "properties": { "id": {} }, "required": [ "id" ], "type": "object" } ], "description": "Represents a lookup object filter criterion value for request bodies, applicable when the field's data_type is lookup, ownerlookup, or userlookup. The ID property is required.", "x-zs-$id": "SimpleFilterCriterionValueObjectRequest" }, "SimpleFilterCriterionValueObjectResponse": { "allOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectBase" }, { "additionalProperties": true, "description": "Represents the constraint that both the ID and name properties are required for the lookup object filter criterion value in response bodies.", "properties": { "id": {}, "name": {} }, "required": [ "id", "name" ], "type": "object" } ], "description": "Represents a lookup object filter criterion value for response bodies, applicable when the field's data_type is lookup, ownerlookup, or userlookup. Both the ID and name properties are included.", "x-zs-$id": "SimpleFilterCriterionValueObjectResponse" }, "SimpleFilterCriterionValueString": { "description": "Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas.", "maxLength": 255, "type": "string", "x-zs-$id": "SimpleFilterCriterionValueString" }, "SinglePipelineGetResponse": { "additionalProperties": false, "description": "Root response object containing an array of pipeline configurations from Zoho CRM.", "properties": { "pipeline": { "description": "Array of pipeline configuration items.", "items": { "additionalProperties": false, "description": "Picklist option representing a pipeline configuration with associated stage mappings.", "properties": { "actual_value": { "description": "Internal API value for the picklist option.", "example": "Standard (Standard)", "format": "string", "type": "string" }, "default": { "description": "Indicates if this is the default picklist value.", "example": true, "type": "boolean" }, "display_value": { "description": "Display name of the picklist value as shown to users.", "example": "Standard (Standard)", "format": "string", "type": "string" }, "id": { "description": "Unique identifier for this picklist value.", "example": "2766660000054211007", "format": "int64", "type": "string" }, "maps": { "description": "Array of stage mappings for this picklist value.", "items": { "additionalProperties": false, "description": "Mapping between a picklist value and a specific pipeline stage, including its position and forecasting details.", "properties": { "actual_value": { "description": "Internal system value/API name for the stage.", "example": "Needs Analysis", "format": "string", "type": "string" }, "colour_code": { "description": "Hexadecimal color code associated with the stage for UI representation.", "example": "#FF5733", "format": "string", "type": "string" }, "display_value": { "description": "User-facing display name of the pipeline stage.", "example": "Needs Analysis", "format": "string", "type": "string" }, "forecast_category": { "additionalProperties": false, "description": "Represents a forecast category used in sales pipeline stages for revenue forecasting and reporting.", "properties": { "id": { "description": "Unique system identifier for the forecast category.", "example": "2766660000000007092", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the forecast category (e.g., 'Pipeline', 'Closed', 'Omitted').", "example": "Pipeline", "format": "string", "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "forecast_type": { "description": "Forecast type indicating stage status (e.g., 'Open', 'Closed Won', 'Closed Lost').", "example": "Open", "format": "string", "type": "string" }, "id": { "description": "Unique identifier for this stage mapping.", "example": "2766660000000007106", "format": "int64", "type": "string" }, "sequence_number": { "description": "Position of this stage in the pipeline sequence (1-based indexing).", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "display_value", "sequence_number", "forecast_category", "actual_value", "id", "forecast_type" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "display_value", "maps", "actual_value", "id" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "pipeline" ], "type": "object", "x-zs-$id": "SinglePipelineGetResponse" }, "SocialActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that publishes a post to a social network such as Facebook or Twitter when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationSocialDetails", "description": "Configuration for the social action, containing the message content with merge field support. Required for commenting or replying actions, and not needed for like or retweet actions.\n" }, "id": { "description": "Represents the unique ID of the Social action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the Social action as it appears within the workflow rule configuration.", "maxLength": 100, "type": "string" }, "type": { "description": "Represents the social action type. Facebook actions require Facebook-specific triggers, and Twitter actions require Twitter-specific triggers.", "enum": [ "comment_to_post", "reply_to_comment", "like_to_comment", "reply_to_message", "retweet", "reply_to_tweet" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "SocialActionSchema", "x-zs-llm-description": "Inline social action for Facebook (comment_to_post, reply_to_comment, like_to_comment, reply_to_message) or Twitter (retweet, reply_to_tweet). Available only with matching social triggers (fb_* or tw_*). Limit 1 per type per rule. details.content required for comment/reply types, not needed for like/retweet." }, "SourceOptionAmbiguityErrorResponse": { "additionalProperties": false, "description": "Returned when ambiguity occurs while processing old_value (source option). Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "ambiguity_due_to": { "description": "Detail field: ambiguity_due_to", "items": { "additionalProperties": false, "description": "Detail Field: ambiguity_due_to", "properties": { "api_name": { "description": "Nested detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "ambiguity while processing the old_value" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Source Option Ambiguity Error Response", "type": "object", "x-zs-$id": "SourceOptionAmbiguityErrorResponse" }, "SourceOptionMandatoryErrorResponse": { "additionalProperties": false, "description": "Returned when old_value is missing in the replace request. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "old_value is mandatory" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Source Option Mandatory Error Response", "type": "object", "x-zs-$id": "SourceOptionMandatoryErrorResponse" }, "SpecialCharacterNotAllowed": { "additionalProperties": false, "description": "Represents the error details returned when a field value in the request contains special characters that are not allowed.", "properties": { "code": { "description": "Represents the error code for the special character error.\nPossible values:\n**INVALID_DATAS** - The request contains special characters that are not allowed.", "enum": [ "INVALID_DATAS" ], "type": "string" }, "details": { "$ref": "#/components/schemas/SimpleFieldError" }, "message": { "description": "Represents the error message indicating that special characters are not allowed.\nPossible values:\n**Special Characters are not allowed** - The field value contains invalid special characters.", "enum": [ "Special Characters are not allowed" ], "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SpecialCharacterNotAllowed" }, "SsrfUrlError": { "additionalProperties": false, "description": "Represents the error returned when the URL provided fails SSRF validation. Internal network addresses and private host ranges are not permitted.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The webhook URL is blocked due to SSRF protection. It resolves to an internal or private host address.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the field with the insecure URL.", "properties": { "api_name": { "description": "Represents the API name of the URL field that contains the insecure address.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the URL field that contains the insecure address.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**URL you've configured is not secure** - The webhook URL resolves to an internal or private host address that is blocked by SSRF protection.", "enum": [ "Url you've configured is not secure" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SsrfUrlError", "x-zs-llm-description": "The URL failed SSRF validation. Internal/private network URLs are not allowed." }, "StandardErrorResponse": { "additionalProperties": false, "description": "Represents a standard error response that wraps one or more error detail objects in a data array.", "properties": { "data": { "description": "Represents the list of error details returned for the failed request. Always returned in the response.", "items": { "$ref": "#/components/schemas/ErrorDetail" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "StandardErrorResponse" }, "StandardFiscalYearUpdate": { "additionalProperties": false, "description": "Represents the request payload to update standard fiscal year settings. When `display_based_on` is set to `end_month`, the `start_month` cannot be `JANUARY`.", "properties": { "display_based_on": { "$ref": "#/components/schemas/FiscalYearDisplayBasedOn" }, "start_month": { "$ref": "#/components/schemas/FiscalYearStartMonth" } }, "required": [ "start_month" ], "type": "object", "x-zs-$id": "StandardFiscalYearUpdate" }, "StaticArrayValue": { "description": "Represents an array of string values used as the static value for multiselectpicklist fields, where each element corresponds to an available picklist option. Valid option labels are retrievable from the GET /settings/fields endpoint filtered by data_type=multiselectpicklist.", "items": { "description": "A single picklist option string to include in the multi-select field value. Each entry corresponds to one selectable option as defined for the target field in Zoho CRM.", "example": "Option1", "maxLength": 255, "type": "string" }, "maxItems": 50, "minItems": 1, "type": "array", "x-zs-$id": "StaticArrayValue", "x-zs-llm-description": "Array value for type=static on multiselect_picklist fields. Each element must match an available picklist option. Discover valid options from getFields for the target module. Invalid options return INVALID_DATA." }, "StaticFieldMapping": { "additionalProperties": false, "description": "Represents a static-type mapping that assigns a literal value directly to the target field at execution time. The value shape varies by field data type: a plain string for text, picklist, phone, email, URL, number, decimal, currency, and percentage fields (numeric values expressed as strings); an array of strings for multiselectpicklist fields; and an object containing ID and name for ownerlookup fields. Date, datetime, and ALARM fields do not support this type — use execution_time instead, as static on those fields produces a DEPENDENT_MISMATCH error. Fields marked unique in the module settings also require merge_field rather than static for create_record actions.", "properties": { "display_value": { "description": "The server-computed representation of the mapped value, included in GET responses. Omitted from create and update requests.", "maxLength": 500, "type": "string" }, "field": { "$ref": "#/components/schemas/AutomationFieldAttributes", "description": "Target field to populate when the automation executes. api_name is required. If id is also provided, both must refer to the same field; otherwise the API returns AMBIGUITY_DURING_PROCESSING." }, "type": { "const": "static", "description": "Identifies the mapping strategy for this field assignment. The value must be `static`, which instructs the automation engine to assign a fixed, literal value to the target field at execution time rather than resolving it dynamically.", "type": "string" }, "value": { "anyOf": [ { "$ref": "#/components/schemas/StaticStringValue" }, { "$ref": "#/components/schemas/StaticArrayValue" }, { "$ref": "#/components/schemas/StaticObjectValue" } ], "description": "The literal value assigned to the target field at automation execution time. The expected shape is determined by the target field data_type, discoverable via GET /settings/fields?module={module}. For most field types, supply a string (for example, \"High\", \"Not Started\", \"1234\"). For multi-select picklist fields (data_type: multiselectpicklist), supply an array of option strings. For fields that reference an entity such as an owner or layout (data_type: ownerlookup), supply an object with at minimum the entity ID." } }, "required": [ "field", "type", "value" ], "title": "Static Field Mapping", "type": "object", "x-zs-$id": "StaticFieldMapping", "x-zs-llm-description": "type='static' mapping. Value is used as-is without runtime resolution. NOT for Date/DateTime/ALARM fields (use execution_time static returns DEPENDENT_MISMATCH). NOT for unique fields or formula fields. Value structure depends on field data_type: string for most fields, array for multiselect_picklist, object for ownerlookup/layout." }, "StaticObjectValue": { "additionalProperties": true, "description": "Represents an object value used as the static value for ownerlookup and layout fields, containing an ID that identifies the target user or layout and an optional name that the server resolves from the ID when not supplied. Typically used to assign record ownership by providing the user ID.", "properties": { "id": { "description": "The system identifier of the referenced entity, such as a user or layout record. This value drives entity resolution by the automation engine and must be provided when the target field references an entity.", "example": "111113000000059916", "maxLength": 255, "type": "string" }, "name": { "description": "The display name of the referenced entity, such as a user full name or a layout label. When omitted from a request payload, the server resolves and populates this property from the supplied ID. The property is present in all GET responses.", "example": "John Doe", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "title": "Static Object Value", "type": "object", "x-zs-$id": "StaticObjectValue", "x-zs-llm-description": "Object value for type=static on ownerlookup and layout fields. id is mandatory (user ID or layout ID). name is optional server resolves from id. Use getUsers for owner IDs, getLayouts for layout IDs." }, "StaticStringValue": { "description": "Represents a plain string value used as the static value for text, picklist, phone, email, URL, number, decimal, currency, and percentage fields. Numeric values are expressed as strings rather than numeric literals. Picklist values must exactly match one of the options defined for the field.", "example": "High", "maxLength": 1000, "type": "string", "x-zs-$id": "StaticStringValue", "x-zs-llm-description": "String value for type=static mappings. Applies to: text, picklist, phone, email, URL, number, decimal, currency, percentage fields. Numbers must be sent as strings (e.g., '100' not 100). Picklist values must match available options invalid values return INVALID_DATA." }, "SuccessDataNested": { "additionalProperties": false, "description": "Represents a successful per-record operation result.", "properties": { "code": { "description": "Represents the result code for the record operation.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/CadencesExecutionDetailsNested" }, "message": { "description": "Represents the message indicating the outcome of the record operation.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the record operation.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "SuccessDataNested" }, "SuccessObject": { "additionalProperties": false, "description": "Details of successfully created/cloned/deleted/updated Assignment Rules, including code, message, and status.", "properties": { "code": { "description": "Represents the status code that identifies the result of the Assignment Rule operation.\nPossible values:\n**SUCCESS** - Represents success.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the Assignment Rule operation result.", "properties": { "id": { "$ref": "#/components/schemas/IdSchema", "x-zs-$id": "AssignmentRuleResultId" }, "rule_entries": { "description": "Represents the rule entries returned for the Assignment Rule operation.", "items": { "additionalProperties": false, "description": "Represents each rule entries entry returned for the Assignment Rule operation.", "properties": { "id": { "$ref": "#/components/schemas/IdSchema" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message that describes the result of the Assignment Rule operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the Assignment Rule operation.\nPossible values:\n**success** - Represents success.", "enum": [ "success" ], "type": "string" } }, "title": "Assignment Rule Success Details", "type": "object", "x-zs-$id": "SuccessObject" }, "SuccessResponse200": { "additionalProperties": false, "description": "Represents the success response returned after a Cadence operation is completed successfully.", "properties": { "cadences": { "description": "Represents the list of Cadences with their result status from the operation.", "items": { "$ref": "#/components/schemas/CadencesItemNested" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "SuccessResponse200" }, "SuccessResponseAssociations": { "additionalProperties": false, "description": "Contains the response structure for Assignment Rule association details.", "properties": { "associations": { "description": "Contains the CRM features associated with the Assignment Rule.", "items": { "$ref": "#/components/schemas/AssociationSchema" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "title": "Generated Schema", "type": "object", "x-zs-$id": "SuccessResponseAssociations" }, "SuccessResponseDetails": { "additionalProperties": true, "description": "Represents the details returned in a successful Scoring Rule operation, including the affected rule ID and any unsaved custom fields.", "properties": { "id": { "description": "Represents the unique ID of the Scoring Rule affected by the operation.", "maxLength": 25, "type": "string" }, "unsaved_custom_fields": { "description": "Represents an array of custom fields that could not be saved during the operation.", "items": { "$ref": "#/components/schemas/UnsavedCustomFieldDetails" }, "maxItems": 6, "type": "array" } }, "title": "Success response Details", "type": "object" }, "SuccessResponseDetailsSchema": { "additionalProperties": false, "description": "Represents the details object within a success response, containing the unique ID of the created or updated resource.", "properties": { "id": { "description": "Represents the unique ID of the SuccessResponseDetails within the workflow rule.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-llm-description": "Details object within a success response item. Contains id of the created or updated workflow rule resource." }, "SuccessResponseGETById": { "additionalProperties": false, "description": "Scoring rule details", "properties": { "scoring_rules": { "description": "Represents an array containing the Scoring Rule details returned for the get by ID operation.", "items": { "$ref": "#/components/schemas/ScoringRuleGET" }, "maxItems": 1, "type": "array" } }, "title": "Get Scoring Rule By Id Success Response", "type": "object", "x-zs-$id": "SuccessResponseGETById" }, "SuccessResponseNestedSchema": { "additionalProperties": false, "description": "Represents a single item in a multi-status response array, including a response code, status indicator, message, and optionally the resource details.", "properties": { "code": { "description": "Represents the API response code indicating the operation result, such as **SUCCESS** or **INVALID_DATA**.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/SuccessResponseDetailsSchema" }, "message": { "description": "Represents the message describing the operation result or error.", "enum": [ "workflow created", "workflow updated", "workflow deleted", "WorkFlow Rule deleted successfully", "rules reordered successfully", "Workflow cloned successfully" ], "type": "string" }, "status": { "description": "Represents the response status indicator, such as **success** or **error**.", "maxLength": 7, "type": "string" } }, "type": "object", "x-zs-$id": "SuccessResponseNestedSchema", "x-zs-llm-description": "Individual success/error status object within a bulk operation response. Contains code (status code string), details (object with created/updated resource id), message (human-readable), and status ('success' or 'error')." }, "SurplusWeekNested": { "anyOf": [ { "description": "Clears any existing surplus week configuration for the custom fiscal year.", "type": "null", "x-zs-$id": "SurplusWeekNullValue" }, { "$ref": "#/components/schemas/SurplusWeekValue" } ], "description": "Represents the surplus week configuration to apply for a custom fiscal year. Send `null` to clear the configured surplus week, or send a complete object with the quarter, period, and year to set a new surplus week." }, "SurplusWeekValue": { "additionalProperties": false, "description": "Represents the surplus week configuration values, including the quarter, period, and year in which the surplus week is placed.", "properties": { "period": { "description": "Specify the fiscal period within the quarter that contains the surplus week.", "format": "int32", "type": "integer" }, "quarter": { "description": "Specify the fiscal quarter that contains the surplus week.", "format": "int32", "type": "integer" }, "year": { "description": "Specify the year in which the surplus week is configured. You can configure this only for the current year and the following year.", "format": "int32", "type": "integer" } }, "required": [ "period", "quarter", "year" ], "type": "object", "x-zs-$id": "SurplusWeekValue" }, "SwitchToCustomFiscalYearUpdate": { "additionalProperties": false, "description": "Represents the request payload to switch the organization from a standard fiscal year to a custom fiscal year. When `start_month` is provided alongside `start_date`, its value must match the month component of `start_date`.", "properties": { "calendar_type": { "description": "Specify the calendar type used to switch to a custom fiscal year. Possible values: `custom`.", "enum": [ "custom" ], "maxLength": 10, "type": "string" }, "display_based_on": { "$ref": "#/components/schemas/FiscalYearDisplayBasedOnForCustom" }, "interval_display_option": { "$ref": "#/components/schemas/FiscalYearIntervalDisplayOption" }, "start_date": { "$ref": "#/components/schemas/FiscalYearStartDate" }, "start_month": { "$ref": "#/components/schemas/FiscalYearStartMonth", "description": "Specify the start month of the fiscal year. This field is optional. When provided, its value must match the month component of the configured start_date." }, "structure": { "$ref": "#/components/schemas/FiscalYearStructure" }, "surplus_week": { "$ref": "#/components/schemas/SurplusWeekNested", "description": "Specify the surplus week configuration for the custom fiscal year. Send `null` to clear the configured surplus week." } }, "required": [ "calendar_type", "interval_display_option", "start_date", "structure" ], "type": "object", "x-zs-$id": "SwitchToCustomFiscalYearUpdate" }, "SwitchToStandardFiscalYearUpdate": { "additionalProperties": false, "description": "Represents the request payload to switch the organization from a custom fiscal year to a standard fiscal year.", "properties": { "calendar_type": { "description": "Specify the calendar type used to switch to a standard fiscal year. Possible values: `gregorian`.", "enum": [ "gregorian" ], "maxLength": 10, "type": "string" }, "display_based_on": { "$ref": "#/components/schemas/FiscalYearDisplayBasedOn" }, "start_month": { "$ref": "#/components/schemas/FiscalYearStartMonth" } }, "required": [ "calendar_type" ], "type": "object", "x-zs-$id": "SwitchToStandardFiscalYearUpdate" }, "SystemVariableGroupActionNotAllowedError": { "additionalProperties": false, "description": "Represents an error response returned when an update operation targets a system-defined variable group that does not support modification.", "properties": { "code": { "description": "Represents the error code **CANNOT_PERFORM_ACTION**.", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the system-defined variable group that does not support the operation.", "properties": { "api_name": { "description": "Represents the API name of the system-defined variable group that does not support the operation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field referencing the system-defined variable group.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the operation is not supported for system-defined variable groups.", "enum": [ "the given operation is not supported for system defined variable group" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "System Variable Group Action Not Allowed Error", "type": "object", "x-zs-$id": "ErrorResponseCore2122751318" }, "TagErrorItemResponse": { "additionalProperties": false, "description": "Error object for individual tag failures.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details", "type": "object" }, "message": { "description": "Error message", "enum": [ "Invalid data", "Invalid data type", "invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "TagErrorItemResponse" }, "TagFieldInvalidDataTypeError": { "additionalProperties": false, "description": "Error indicating that a tag field has an invalid data type.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field with invalid data type", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data type", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagFieldInvalidDataTypeError" }, "TagInvalidDataError": { "additionalProperties": false, "description": "Represents an error response returned when a field value is invalid.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing validation information.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with the invalid value.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagInvalidDataError" }, "TagInvalidDataTypeError": { "additionalProperties": false, "description": "Error indicating that a tag field has an invalid data type.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data", "invalid tag id" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagInvalidDataTypeError" }, "TagNotFoundError": { "additionalProperties": false, "description": "Represents an error response returned when the specified tag ID does not exist.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object.", "properties": { "id": { "description": "Represents the ID of the tag that was not found.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message indicating the tag was not found.", "enum": [ "tags not found" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagNotFoundError" }, "TaggedActionUsageMetricsSchema": { "additionalProperties": false, "description": "Represents usage metrics for a single tagged workflow action, including its identifier, tag ID, action type, and success and failure counts.", "properties": { "associated_time": { "description": "Represents the ISO 8601 timestamp indicating when this tagged action was last associated with or modified on a workflow rule.", "maxLength": 255, "type": "string" }, "failure_count": { "description": "Represents the total number of failed executions recorded for this tagged action within the queried date range.", "format": "int32", "type": "integer" }, "id": { "description": "Represents the unique ID of the TaggedActionUsageMetrics within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the workflow rule or its associated tagged action.", "maxLength": 255, "type": "string" }, "success_count": { "description": "Represents the total number of successful executions recorded for this tagged action within the queried date range.", "format": "int32", "type": "integer" }, "tag_id": { "description": "Represents the unique ID of the tag associated with this action.", "maxLength": 20, "type": "string" }, "type": { "description": "Represents the category of tagged workflow action executed by the rule.", "maxLength": 255, "type": "string" } }, "required": [ "associated_time", "failure_count", "id", "name", "success_count", "tag_id", "type" ], "title": "Tagged Action Usage Metrics", "type": "object", "x-zs-llm-description": "Individual action usage entry with tag association. Contains name, type, id, tag_id, success_count, failure_count, and associated_time." }, "TagsActionsCreatedByNested": { "additionalProperties": false, "description": "Nested schema for created_by user details.", "properties": { "id": { "description": "Unique identifier of the user", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the user who created the resource", "maxLength": 255, "type": "string" } }, "type": "object" }, "TagsActionsDataNested": { "additionalProperties": false, "description": "Nested schema for data in operation responses.", "properties": { "code": { "description": "Status code of the operation", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/TagsActionsDetailsNested" }, "message": { "description": "Human-readable message about the operation result", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation (e.g., success, error)", "maxLength": 255, "type": "string" } }, "type": "object" }, "TagsActionsDetailsNested": { "additionalProperties": false, "description": "Nested schema for operation details in responses.", "properties": { "affected_data": { "description": "Affected data in the operation", "type": "null" }, "id": { "description": "Unique identifier of the record", "maxLength": 255, "type": "string" }, "modifiedTime": { "description": "Last modified time of the record", "maxLength": 255, "type": "string" }, "not_added_tags": { "description": "Tags that were not added to the record", "items": { "$ref": "#/components/schemas/TagsActionsTagsNested1" }, "maxItems": 10, "type": "array" }, "tags": { "description": "Tags associated with the record", "items": { "$ref": "#/components/schemas/TagsActionsTagsNested1" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "TagsActionsInvalidModuleNameError": { "additionalProperties": false, "description": "Error indicating that the specified module name is invalid.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": {}, "type": "object" }, "message": { "description": "Error message", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidModuleNameError" }, "TagsActionsInvalidRequestMethodError": { "additionalProperties": false, "description": "Error indicating that the HTTP request method is invalid.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": {}, "type": "object" }, "message": { "description": "Error message", "enum": [ "The http request method type is not a valid one" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, "TagsActionsModifiedByNested": { "additionalProperties": false, "description": "Nested schema for modified_by user details.", "properties": { "id": { "description": "Unique identifier of the user", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the user who last modified the resource", "maxLength": 255, "type": "string" } }, "type": "object" }, "TagsActionsModuleTagsNotSupportedError": { "additionalProperties": false, "description": "Error indicating that the specified module does not support tags.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": {}, "type": "object" }, "message": { "description": "Error message", "enum": [ "the given module is not supported for this api" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ModuleTagsNotSupportedError" }, "TagsActionsNoPermissionError": { "additionalProperties": false, "description": "Error indicating that the user does not have permission to perform the operation.", "properties": { "code": { "description": "Error code", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "permissions": { "description": "List of required permissions", "items": { "description": "Permission required to access the resource", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "NoPermissionError" }, "TagsActionsRecordLockedError": { "additionalProperties": false, "description": "Error indicating that the record is locked and cannot be modified.", "properties": { "code": { "description": "Error code", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "action": { "description": "Action that was attempted on the locked record", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the locked record", "maxLength": 255, "type": "string" } }, "required": [ "action", "id" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Sorry, you cannot perform this operation as the record is locked." ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RecordLockedError" }, "TagsActionsRequiredParamMissingError": { "additionalProperties": false, "description": "Error indicating that a required parameter is missing.", "properties": { "code": { "description": "Error code", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "Name of the missing parameter", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "One of the expected param is missing" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "TagsActionsTagFieldMaxLengthError": { "additionalProperties": false, "description": "Error indicating that a tag field exceeds the maximum allowed length.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field exceeding max length", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field exceeding max length", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Maximum allowed length for the field", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagFieldMaxLengthError" }, "TagsActionsTagsNested": { "additionalProperties": false, "description": "Nested schema for tag details in requests.", "properties": { "color_code": { "description": "Color code of the tag", "maxLength": 7, "type": [ "string", "null" ] }, "conflict_id": { "description": "ID of the tag to be merged into the master tag", "maxLength": 19, "type": [ "string", "null" ] }, "modified_time": { "description": "Last modification timestamp of the tag", "format": "date-time", "maxLength": 25, "type": [ "string", "null" ] }, "name": { "description": "Tag name", "maxLength": 25, "type": [ "string", "null" ] } }, "type": "object" }, "TagsActionsTagsNested1": { "additionalProperties": false, "description": "Nested schema for tag details in responses.", "properties": { "color_code": { "description": "Color code of the tag", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the tag", "maxLength": 255, "type": "string" }, "name": { "description": "Tag name", "maxLength": 255, "type": "string" }, "rid": { "description": "Resource ID", "format": "uuid", "type": "string" } }, "type": "object" }, "TagsCreatedByNested": { "additionalProperties": false, "description": "Represents the user who created the tag.", "properties": { "id": { "description": "Represents the unique ID of the user who created the tag.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who created the tag.", "maxLength": 255, "type": "string" } }, "type": "object" }, "TagsDetailsNested": { "additionalProperties": false, "description": "Represents the detailed metadata of the tag, including timestamps, the tag name, color code, and the users who created and last modified it.", "properties": { "color_code": { "description": "Represents the hex color code assigned to the tag, such as **#FF0000**. The value is null when no color is assigned.", "maxLength": 255, "type": [ "string", "null" ] }, "created_by": { "$ref": "#/components/schemas/TagsCreatedByNested" }, "created_time": { "description": "Represents the creation date and time of the tag.", "format": "date-time", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the tag.", "maxLength": 255, "type": "string" }, "modified_by": { "$ref": "#/components/schemas/TagsModifiedByNested" }, "modified_time": { "description": "Represents the last modification date and time of the tag.", "format": "date-time", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the tag.", "maxLength": 255, "type": "string" } }, "type": "object" }, "TagsGETCreatedByNested": { "additionalProperties": false, "description": "Represents the user who created the tag in the GET response.", "properties": { "id": { "description": "Represents the unique ID of the user who created the tag.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who created the tag.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "TagsGETModifiedByNested": { "additionalProperties": false, "description": "Represents the user who last modified the tag in the GET response.", "properties": { "id": { "description": "Represents the unique ID of the user who last modified the tag.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who last modified the tag.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "TagsInvalidDataError": { "additionalProperties": false, "description": "Error indicating invalid data type for the tags field.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Maximum allowed length for the field", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagsInvalidDataError" }, "TagsInvalidDataTypeError": { "additionalProperties": false, "description": "Represents an error response returned when a field value has an invalid data type.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing validation information.", "properties": { "api_name": { "description": "Represents the API name of the field with the invalid data type.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field with the invalid data type.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid data type.", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidDataTypeError" }, "TagsInvalidModuleError": { "additionalProperties": false, "description": "Represents an error response returned when the specified module name is invalid.", "properties": { "code": { "description": "Represents the error code **INVALID_MODULE**.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the invalid module name.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidModuleError" }, "TagsInvalidRequestMethodError": { "additionalProperties": false, "description": "Represents an error response returned when the HTTP request method is not valid for this endpoint.", "properties": { "code": { "description": "Represents the error code **INVALID_REQUEST_METHOD**.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message indicating the HTTP method is not valid for this endpoint.", "enum": [ "The http request method type is not a valid one" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, "TagsInvalidUrlPatternError": { "additionalProperties": false, "description": "Represents an error response returned when the URL pattern does not match any known endpoint.", "properties": { "code": { "description": "Represents the error code **INVALID_URL_PATTERN**.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message indicating the URL does not match a known pattern.", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "InvalidUrlPatternError" }, "TagsLicenseLimitExceededError": { "additionalProperties": false, "description": "Represents an error response returned when the tag creation limit for the module has been reached on the current plan.", "properties": { "code": { "description": "Represents the error code **LICENSE_LIMIT_EXCEEDED**.", "enum": [ "LICENSE_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message indicating the tag limit for the plan has been reached.", "enum": [ "tags edition limit exceeded" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagsLicenseLimitExceededError" }, "TagsMandatoryFieldNotFoundError": { "additionalProperties": false, "description": "Represents an error response returned when a required field is missing from the request body.", "properties": { "code": { "description": "Represents the error code **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing validation information.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing mandatory field.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing mandatory field.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "MandatoryFieldNotFoundError" }, "TagsModifiedByNested": { "additionalProperties": false, "description": "Represents the user who last modified the tag.", "properties": { "id": { "description": "Represents the unique ID of the user who last modified the tag.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the user who last modified the tag.", "maxLength": 255, "type": "string" } }, "type": "object" }, "TagsModuleTagsNotSupportedError": { "additionalProperties": false, "description": "Represents an error response returned when the specified module does not support tags.", "properties": { "code": { "description": "Represents the error code **INVALID_MODULE**.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message indicating the module does not support tags.", "enum": [ "the given module is not supported for this api" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ModuleTagsNotSupportedError" }, "TagsNested2": { "additionalProperties": false, "description": "Nested schema for tag details in merge response.", "properties": { "code": { "description": "Status code of the merge operation", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/DetailsNested2" }, "message": { "description": "Human-readable message about the merge result", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the merge operation", "maxLength": 255, "type": "string" } }, "type": "object" }, "TagsPost207multistatusResponse207": { "additionalProperties": false, "description": "Represents a single tag operation result item in a multi-status response.", "properties": { "code": { "description": "Represents the operation result code for the tag item.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/TagsDetailsNested" }, "message": { "description": "Represents the operation result message for the tag item.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the operation result status for the tag item.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "Post207multistatusResponse207" }, "TagsTagFieldMaxLengthError": { "additionalProperties": false, "description": "Represents an error response returned when a field value exceeds the allowed maximum length.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details object containing validation information.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeds the maximum length.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that exceeds the maximum length.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message describing the maximum length violation.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "TagFieldMaxLengthError" }, "TagsTagsNested": { "additionalProperties": true, "description": "Represents the request body schema for creating or updating a tag.", "properties": { "color_code": { "description": "Specify the hex color code for the tag, such as **#FF0000**. Set to null to remove the assigned color.", "maxLength": 7, "type": [ "string", "null" ] }, "name": { "description": "Specify the name of the tag. The maximum allowed length is 26 characters.", "maxLength": 26, "type": "string" } }, "required": [ "name" ], "type": "object" }, "TagsTagsNested1": { "additionalProperties": false, "description": "Represents a tag operation result object returned in the response.", "properties": { "code": { "description": "Represents the operation result code for the tag.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/TagsDetailsNested" }, "message": { "description": "Represents the operation result message for the tag.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the tag operation.", "maxLength": 255, "type": "string" } }, "type": "object" }, "TargetOptionAmbiguityErrorResponse": { "additionalProperties": false, "description": "Returned when ambiguity occurs while processing new_value (target option). Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "ambiguity_due_to": { "description": "Detail field: ambiguity_due_to", "items": { "additionalProperties": false, "description": "Detail Field: ambiguity_due_to", "properties": { "api_name": { "description": "Nested detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "ambiguity while processing the new_value" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Target Option Ambiguity Error Response", "type": "object", "x-zs-$id": "TargetOptionAmbiguityErrorResponse" }, "TargetOptionExpectedFieldMissingErrorResponse": { "additionalProperties": false, "description": "Returned when required fields for new_value are not provided. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "expected_fields": { "description": "Detail field: expected_fields", "items": { "additionalProperties": false, "description": "Detail Field: expected_fields", "properties": { "api_name": { "description": "Nested detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "specify atleast one field" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Target Option Expected Field Missing Error Response", "type": "object", "x-zs-$id": "TargetOptionExpectedFieldMissingErrorResponse" }, "TargetOptionMandatoryErrorResponse": { "additionalProperties": false, "description": "Returned when new_value is missing in the replace request. Includes error code, message, status, and details.", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "new_value is mandatory" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Target Option Mandatory Error Response", "type": "object", "x-zs-$id": "TargetOptionMandatoryErrorResponse" }, "TaskActionResult": { "additionalProperties": false, "description": "Result of a task create, update, or delete operation.", "properties": { "code": { "description": "Operation result code (e.g., SUCCESS).", "example": "SUCCESS", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/TaskActionResultDetails" }, "message": { "description": "Result message describing the outcome of the task action.", "example": "task deleted successfully", "maxLength": 255, "type": "string" }, "status": { "description": "Operation result status (e.g., success).", "example": "success", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task Action Result", "type": "object", "x-zs-llm-description": "Generic action result for create/update/delete operations. Check status and code fields." }, "TaskActionResultDetails": { "additionalProperties": false, "description": "Details returned with a task action result, including the created or affected resource ID.", "properties": { "id": { "description": "Unique ID of the created or affected automation task.", "example": "111111000000195072", "maxLength": 20, "type": "string", "x-zs-$id": "WorkflowTaskResultId" }, "resource_path_index": { "description": "Index of the resource in the request payload array.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "title": "Task Action Result Details", "type": "object", "x-zs-llm-description": "Contains the resource_path_index and id of the affected task. Use id for subsequent GET/PUT/DELETE calls." }, "TaskAssociateActionSchema": { "additionalProperties": false, "description": "Represents an associate action that creates a task based on a pre-configured task template when the workflow rule condition is triggered.", "properties": { "_delete": { "description": "Indicates that this action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "additionalProperties": false, "description": "Represents the read-only details of the associated task action. Returned in GET responses and not required in POST or PUT requests.", "properties": { "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module this action applies to." } }, "type": "object" }, "id": { "description": "Represents the unique ID of the task action. Required to associate a pre-configured task with the workflow rule.", "maxLength": 20, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getWorkflowTasks", "propertyId": "WorkflowTaskId" } ], "resource": "workflow_tasks" } }, "name": { "description": "Represents the display name of the TaskAssociate action. Returned in GET responses and derived from the referenced action configuration.", "maxLength": 500, "type": "string" }, "related_details": { "$ref": "#/components/schemas/TaskRelatedDetailsSchema", "description": "Configures a followup task that is automatically created after the original task, based on a status condition and time delay. Null when no followup is configured." }, "type": { "const": "tasks", "description": "Represents the action type discriminator that identifies this as a TaskAssociate action within the workflow rule. The value is fixed for this action type and must be supported by the target module and trigger event.", "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "TaskAssociateActionSchema", "x-zs-llm-description": "References a pre-configured task action entity by ID. Create the entity first via createWorkflowTasks, then use its ID here. Supports related_details.followup_details for auto-creating follow-up tasks on status change. Entity must be created for the correct module context." }, "TaskCreateOrUpdateInput": { "additionalProperties": false, "description": "PURPOSE: Writable task fields for create or update. PREREQUISITES: (1) Call GET /settings/layouts?module=Tasks - fields with required: true in the field info are mandatory in field_mappings. (2) Call GET /settings/modules to discover valid module api_names. Read-only fields (id, created_time, modified_time, created_by, modified_by, lock_status, associated, deletable) are excluded.", "properties": { "feature_type": { "default": "workflow", "description": "The automation feature this task definition belongs to. Defaults to \"workflow\" if omitted. A task can only be associated with the feature it was created for - a task with feature_type=\"workflow\" can only be attached to workflow rules, not to blueprints or kiosks. Supported values are defined in the enum.", "enum": [ "workflow", "approval_process", "blueprint", "blueprint_transition", "blueprint_state", "review_process", "orchestration", "assignment_rules", "kiosks", "pathfinder", "connected_workflows", "commandcenter_service", "cadences", "scoring_rule", "case_escalation_rule" ], "maxLength": 255, "type": "string" }, "field_mappings": { "description": "REQUIRED. Field mappings for task fields. Mandatory mappings: Subject (static or merge_field), Due_Date (execution_time), Status (static: Not Started, Deferred, In Progress, Completed, Waiting on someone else), Priority (static: Highest, High, Normal, Low, Lowest). Optional: Description, Owner, Remind_At (execution_time). Each entry requires field ({api_name, id}), type, and value. Types: static (literal values), merge_field (${!Module.Field} tokens), execution_time (for Date/DateTime/ALARM - requires period, unit, trigger_field, sign). Workflow tasks support period: days, business_days only. Max 20 entries.", "items": { "$ref": "#/components/schemas/AutomationFieldMappings" }, "maxItems": 20, "minItems": 1, "type": "array" }, "module": { "$ref": "#/components/schemas/TaskCreateOrUpdateModuleRef" }, "name": { "description": "Display name for this task definition. Must be identical to the value provided in the Subject field_mapping entry. If they do not match, the API returns INVALID_DATA. For merge_field type Subject mappings, set name to the same token string (e.g., \"${!Leads.Last_Name}\").", "maxLength": 255, "type": "string" }, "notify": { "default": false, "description": "Whether notification should be sent to the task owner when this automation task executes.", "type": "boolean" } }, "required": [ "name", "module", "field_mappings" ], "title": "Task Create Or Update Input", "type": "object", "x-zs-llm-description": "Describes the editable fields for a task definition. Before submitting: (1) GET /settings/layouts?module=Tasks fields where required: true must appear in field_mappings; (2) GET /settings/modules to confirm valid module api_names. System-managed fields (id, created_time, modified_time, created_by, modified_by, lock_status, associated, deletable) must not be included." }, "TaskCreateOrUpdateModuleRef": { "additionalProperties": false, "description": "PURPOSE: The CRM module this task definition belongs to. Specifies which module's records will trigger task creation - not the Tasks module itself. PREREQUISITES: Call GET /settings/modules to discover available module api_names and IDs. api_name is required, id is optional.", "properties": { "api_name": { "description": "REQUIRED. API name of the CRM module whose records trigger this task creation (e.g., Leads, Contacts, Deals). Use GET /settings/modules to discover available modules.", "maxLength": 255, "type": "string" }, "id": { "description": "Optional module ID. If provided alongside api_name, both must refer to the same module.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "title": "Task Create Or Update Module Ref", "type": "object", "x-zs-llm-description": "Identifies the CRM module whose records trigger task creation this is the source module, not the Tasks module itself. api_name is required; id is optional. Use GET /settings/modules to discover valid module api_names and IDs." }, "TaskCreateOrUpdateRequest": { "additionalProperties": false, "description": "PURPOSE: Request body wrapper for creating or updating an automation task definition. MUST contain a tasks array with exactly 1 task object.", "properties": { "tasks": { "description": "REQUIRED. Array containing exactly 1 automation task object. Multiple tasks per request are not supported.", "items": { "$ref": "#/components/schemas/TaskCreateOrUpdateInput" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "tasks" ], "title": "Task Create Or Update Request", "type": "object", "x-zs-llm-description": "Top-level request envelope for creating or updating an automation task definition; must include a tasks array containing exactly one task object." }, "TaskDependentMismatchSchema": { "additionalProperties": false, "description": "Returned when a field_mapping value conflicts with a dependent field constraint - such as a mismatched dependee field or an invalid dependent value.", "properties": { "code": { "description": "Error code indicating a dependent field mismatch.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the dependent field conflict.", "properties": { "api_name": { "description": "API name of the field that caused the mismatch.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The field that the mismatched field depends on.", "properties": { "api_name": { "description": "API name of the dependee field (e.g., type, field.id).", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the dependee field in the request payload.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "JSON path pointing to the mismatched value.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Maximum allowed length for the dependent value.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message describing the dependent field mismatch.", "example": "the value does not match with the dependent field", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task Dependent Mismatch Schema", "type": "object", "x-zs-$id": "TaskDependentMismatchSchema", "x-zs-llm-description": "A field_mapping value conflicts with a dependent field constraint mismatched dependee/dependent values. Verify field dependencies via module field metadata." }, "TaskDetails": { "additionalProperties": false, "description": "Automation task details returned by the API, including ownership, module context, and field mappings.", "properties": { "associated": { "description": "Whether this task is associated with workflow/Blueprint/approval configuration.", "type": "boolean" }, "created_by": { "$ref": "#/components/schemas/CreatorDetails" }, "created_time": { "description": "Timestamp when the automation task was created.", "example": "2025-10-27T15:35:49+00:00", "maxLength": 255, "type": "string" }, "deletable": { "description": "Indicates whether this task can be deleted.", "type": "boolean" }, "editable": { "description": "Indicates whether this task can be edited by the current user/context.", "type": "boolean" }, "feature_type": { "description": "Specify the automation feature category that uses this task. Values: \"workflow\" (workflow rule), \"approval_process\" (Approval Process), \"Blueprint\" (Blueprint transition), \"kiosks\" (kiosk/process flow), \"scoring_rule\" (Scoring Rule), \"case_escalation_rule\" (case escalation rule).", "enum": [ "workflow", "approval_process", "blueprint", "blueprint_transition", "blueprint_state", "review_process", "orchestration", "assignment_rules", "kiosks", "pathfinder", "connected_workflows", "commandcenter_service", "cadences", "scoring_rule", "case_escalation_rule" ], "maxLength": 255, "type": "string" }, "field_mappings": { "description": "Specify the field mappings configured for the task. When an automation task is created, the fields should be mapped to tasks modules. Use this JSON array to map the fields of Automation Tasks fields to create tasks automatically when an automation is triggered. ", "items": { "$ref": "#/components/schemas/AutomationFieldMappings" }, "maxItems": 20, "type": "array" }, "id": { "description": "Unique ID of the automation task.", "maxLength": 255, "type": "string", "x-zs-$id": "WorkflowTaskId" }, "lock_status": { "$ref": "#/components/schemas/WorkflowTasksLockStatus" }, "modified_by": { "$ref": "#/components/schemas/ModifierDetails" }, "modified_time": { "description": "Timestamp when the task definition was last modified.", "example": "2025-10-27T15:35:49+00:00", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/WorkflowTasksModuleDetails" }, "name": { "description": "Specify the name of the automation task.", "maxLength": 255, "type": "string" }, "notify": { "description": "Whether owner notification is enabled for this task.", "type": "boolean" }, "related_module": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowTasksModuleDetails" }, { "$ref": "#/components/schemas/RelatedModuleNull" } ], "description": "Related module metadata when the task is tied to a secondary module; otherwise null. Specify the api_name and id of the related module." }, "source": { "description": "Source system that created or owns this task (for example: crm).", "example": "crm", "maxLength": 255, "type": "string" } }, "required": [ "field_mappings", "module", "name", "id", "created_time", "modified_time", "feature_type" ], "title": "Task Details", "type": "object", "x-zs-llm-description": "Full automation task object from GET responses. Contains field_map, module, related_module, lock_status, owner, and audit timestamps." }, "TaskDuplicateDataSchema": { "additionalProperties": false, "description": "Returned when the request contains duplicate field mappings - such as specifying the same field more than once in field_mappings.", "properties": { "code": { "description": "Error code indicating duplicate data.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the duplicated field.", "properties": { "api_name": { "description": "API name of the duplicated field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path pointing to the duplicate entry in the request payload.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Error message describing the duplicate data condition.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task Duplicate Data Schema", "type": "object", "x-zs-$id": "TaskDuplicateDataSchema", "x-zs-llm-description": "Duplicate field mapping detected. The same field appears more than once in field_map. Remove the duplicate entry." }, "TaskInvalidDataSchema": { "additionalProperties": false, "description": "Returned when the request contains invalid data - such as an unrecognized field, wrong data type, value exceeding maximum length, unsupported parameter value, or invalid resource ID.", "properties": { "code": { "description": "Error code indicating invalid data.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with contextual validation information.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path pointing to the invalid value in the request payload.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Maximum allowed length or count for the field value.", "format": "int32", "type": "integer" }, "param_name": { "description": "Name of the query parameter that caused the error.", "maxLength": 255, "type": "string" }, "resource_path_index": { "description": "Index of the resource in the request array that caused the error.", "format": "int32", "type": "integer" }, "supported_values": { "description": "List of accepted values for this field.", "items": { "description": "Accepted value for this field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Error message describing the invalid data condition.", "example": "Invalid data", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task Invalid Data Schema", "type": "object", "x-zs-$id": "TaskInvalidDataSchema", "x-zs-llm-description": "Request contains invalid data unrecognized field name, wrong data type, or value exceeding limits. Check details.api_name and details.json_path for the problematic field." }, "TaskInvalidModuleSchema": { "additionalProperties": false, "description": "Returned when the specified module API name, ID, or query parameter value does not match any valid CRM module.", "properties": { "code": { "description": "Error code indicating an invalid module.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the invalid module reference.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path pointing to the invalid module reference.", "maxLength": 1000, "type": "string" }, "param_name": { "description": "Name of the query parameter with the invalid module value.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Error message describing the invalid module.", "example": "the module name given seems to be invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task Invalid Module Schema", "type": "object", "x-zs-$id": "TaskInvalidModuleSchema", "x-zs-llm-description": "The module api_name or ID does not match any valid CRM module. Verify via GET /settings/modules." }, "TaskMandatoryNotFoundSchema": { "additionalProperties": false, "description": "Returned when a required field or parameter is missing from the request payload.", "properties": { "code": { "description": "Error code indicating a mandatory field is missing.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the missing field.", "properties": { "api_name": { "description": "API name of the missing required field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path pointing to where the missing field is expected.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Error message describing which mandatory field is missing.", "example": "Required field is missing", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task Mandatory Not Found Schema", "type": "object", "x-zs-$id": "TaskMandatoryNotFoundSchema", "x-zs-llm-description": "A required field or parameter is missing from the request. Check details for the missing field name." }, "TaskNoPermissionSchema": { "additionalProperties": false, "description": "Returned when the caller does not have the required permissions to perform this operation or access this feature.", "properties": { "code": { "description": "Error code indicating insufficient permissions.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Permission details required for this operation.", "properties": { "permissions": { "description": "Contains a list of required permissions for this operation.", "items": { "description": "Required permission name.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Error message describing the permission issue.", "example": "permission denied", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task No Permission Schema", "type": "object", "x-zs-$id": "TaskNoPermissionSchema", "x-zs-llm-description": "Caller lacks the required permission. Check that the user's profile allows automation management." }, "TaskNotAllowedSchema": { "additionalProperties": false, "description": "Returned when the requested operation is not allowed - such as deleting a task associated with an Approval Process, Workflow Rule, or Blueprint, or modifying a read-only system-managed task.", "properties": { "code": { "description": "Error code indicating operation not allowed.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the resource.", "properties": { "resource_path_index": { "description": "Index of the resource in the request array that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message describing why the operation is not allowed.", "example": "Task is associated with at least one of Approval Process/Workflow Rules/Blueprint", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Task Not Allowed Schema", "type": "object", "x-zs-$id": "TaskNotAllowedSchema", "x-zs-llm-description": "Operation not allowed the task is associated with an Approval Process, Workflow Rule, or Blueprint. Remove the association before delete/modify." }, "TaskRelatedDetailsSchema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the followup task configuration that defines the status condition and delay for automatically creating a followup task.", "properties": { "followup_details": { "additionalProperties": false, "description": "Represents the followup task configuration, including the trigger condition and delay settings.", "properties": { "condition": { "description": "Represents the task status condition that triggers the followup task, such as **Completed** or **Not Started**.", "maxLength": 255, "type": "string" }, "period": { "description": "Represents the time period label for the delay before creating the followup task, such as **days**, **hours**, or **minutes**.", "maxLength": 50, "type": "string" }, "unit": { "description": "Represents the numeric time value for the delay before creating the followup task.", "format": "int32", "type": "integer" } }, "type": "object" } }, "type": "object", "x-zs-$id": "TaskRelatedDetailsFollowupSchema" }, { "description": "Represents a null value indicating no followup task is configured for this task action.", "type": "null", "x-zs-$id": "TaskRelatedDetailsNullSchema" } ], "description": "Represents the optional related configuration details for task actions, specifying whether and how a followup task should be created.", "x-zs-llm-description": "Supplementary config for tasks associate action. Configures automatic followup task creation based on condition/unit/period - creates a new followup task after the original task's status changes." }, "TaskResourceRequestObject": { "additionalProperties": false, "description": "Task resource reference for followup action.", "properties": { "id": { "description": "Specify the iD of the task.", "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getWorkflowTasks", "propertyId": "WorkflowTaskId" }, { "operationId": "createWorkflowTasks", "propertyId": "WorkflowTaskResultId" } ], "resource": "workflow_tasks" } } }, "required": [ "id" ], "title": "Task Resource Request Object", "type": "object" }, "TaxNested": { "additionalProperties": false, "description": "Represents a tax entry applied to the service cost, identified by its tax ID and value label.", "properties": { "id": { "description": "Specify the unique ID of the tax applied to the service cost.", "type": "null" }, "value": { "description": "Specify the display label of the tax applied to the service cost.", "maxLength": 100, "type": [ "string", "null" ] } }, "type": "object" }, "TerritoriesDependentFieldMissingError": { "additionalProperties": false, "description": "Represents the error response when a required dependent field is missing from the territory request.", "properties": { "territories": { "description": "Represents the list of territory objects with their error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory in the transfer-and-delete response.", "properties": { "code": { "description": "Represents the error code indicating the type of error for the territory operation.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the API name and JSON path of the problematic field.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 100, "minLength": 1, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field that is required but missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the dependent field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the dependent field.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the reason for this failure.", "enum": [ "This territory has its child. Please Give the transfer_to_id field value" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "DependentFieldMissingError" }, "TerritoriesDuplicateDataError": { "additionalProperties": false, "description": "Represents the error response when the request contains duplicate data for a territory field.", "properties": { "territories": { "description": "Represents the list of territory objects with their error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code indicating the type of error for the territory operation.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "api_name": { "description": "Represents the API name of the field that contains duplicate data.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains duplicate data.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the reason for this failure.", "enum": [ "Given Territory name already exists", "Duplicate Territory Name Found" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "DuplicateDataError" }, "TerritoriesInvalidDataWithId": { "additionalProperties": false, "description": "Represents the error response when an invalid territory ID is provided in the request.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the invalid territory ID.", "properties": { "id": { "description": "Represents the territory ID that was provided but found to be invalid.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message returned when an invalid territory ID is provided. Possible values: **the id given seems to be invalid**, **Invalid Territory Id**.", "enum": [ "the id given seems to be invalid", "Invalid Territory Id" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "InvalidDataWithId" }, "TerritoriesInvalidDataWithSupportedValues": { "additionalProperties": false, "description": "Represents the error response when a field value is not valid, including the list of accepted values.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name, JSON path, and list of accepted values.", "properties": { "api_name": { "description": "Represents the API name of the field that contains an unsupported value.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field in the request body that contains an invalid value.", "maxLength": 250, "minLength": 1, "type": "string" }, "supported_values": { "description": "Represents the list of accepted values for the field.", "items": { "description": "Represents a single accepted value for the field.", "maxLength": 100, "type": "string" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message returned when a field value is not among the accepted values. Possible values: **the given value is invalid**, **Given Permission_type value is invalid**.", "enum": [ "the given value is invalid", "Given Permission_type value is invalid" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "InvalidDataWithSupportedValues" }, "TerritoriesInvalidRequestError": { "additionalProperties": false, "description": "Represents the error response when the request is invalid, such as when the ids parameter exceeds the maximum allowed limit.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_REQUEST**.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional contextual information about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when the request cannot be processed. Possible values: **unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.**", "enum": [ "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values." ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Request Error", "type": "object", "x-zs-$id": "InvalidRequestError" }, "TerritoriesMandatoryNotFound": { "additionalProperties": false, "description": "Error schema returned when a mandatory criterion field is absent from the request. The error code MANDATORY_NOT_FOUND is issued, and the details object identifies the missing field via its api_name and json_path properties.", "properties": { "code": { "description": "Error code identifying the category of error.\n\nPossible values:\nMANDATORY_NOT_FOUND - Indicates that a required criterion field was absent from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object identifying the mandatory criterion field that is absent from the request. Contains the api_name of the missing field and the json_path indicating its expected location in the request body.", "properties": { "api_name": { "description": "API name of the criterion field that is required but was not found in the request.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path to the location in the request body where the mandatory criterion field was expected but not found.", "maxLength": 512, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message describing the mandatory field not found condition returned in the response envelope.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the error response.\n\nPossible values:\nerror - Indicates that the request failed because a mandatory criterion field was not found.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFound" }, "TerritoriesMandatoryNotFoundError": { "additionalProperties": false, "description": "Represents the error response when a mandatory field is missing from the territory request.", "properties": { "territories": { "description": "Represents the list of territory objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory.", "properties": { "code": { "description": "Represents the error code for the territory error. Possible values: **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field name and JSON path of the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field that is missing from the request.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the mandatory field that is missing from the request body.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when a required field is absent. Possible values: **required field not found**.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, "TerritoryAssignAlreadyUsed": { "additionalProperties": false, "description": "Represents the error response when a territory is already assigned to the specified record.", "properties": { "data": { "description": "Represents the list of territory assignment objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory assignment.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **ALREADY_USED**.", "enum": [ "ALREADY_USED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field and path that caused it.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 100, "minLength": 1, "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Represents the location where the duplicate value already exists in the request.", "properties": { "json_path": { "description": "Represents the JSON path pointing to the existing duplicate value.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "exists_in", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when a duplicate territory ID is found. Possible values: **duplicate territory id found**.", "enum": [ "duplicate territory id found" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignAlreadyUsed" }, "TerritoryAssignDuplicateData": { "additionalProperties": false, "description": "Represents the error response when duplicate territory entries are found in the assignment request.", "properties": { "data": { "description": "Represents the list of assignment objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory assignment.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **DUPLICATE_DATA**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field and path that contains duplicate data.", "properties": { "api_name": { "description": "Represents the API name of the field that contains duplicate data.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains duplicate data.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when a duplicate territory is found. Possible values: **Given Territory id already exists for that record**, **Given Territory already exists for that record**.", "enum": [ "Given Territory id already exists for that record", "Given Territory already exists for that record" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignDuplicateData" }, "TerritoryAssignInvalidDataMaxLen": { "additionalProperties": false, "description": "Represents the error response when a territory assignment field value exceeds the maximum allowed length.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeds the maximum length.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that exceeds the maximum length.", "maxLength": 250, "minLength": 1, "type": "string" }, "maximum_length": { "description": "Represents the maximum number of characters allowed for the field.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message returned when invalid data is submitted. Possible values: **invalid data**.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignInvalidDataMaxLen" }, "TerritoryAssignInvalidDataOnURL": { "additionalProperties": false, "description": "Represents the error response when an invalid value is found in the URL path of a territory assignment request.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the resource path index where the issue occurred.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the invalid data was detected.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message returned when an invalid ID is provided in the URL. Possible values: **the id given seems to be invalid**, **The record Id given seems to be invalid**.", "enum": [ "the id given seems to be invalid", "The record Id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignInvalidDataOnURL" }, "TerritoryAssignInvalidDataTerritoryId": { "additionalProperties": false, "description": "Represents the error response when an invalid territory ID is provided in a territory assignment request.", "properties": { "data": { "description": "Represents the list of assignment objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory assignment.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field and path associated with the invalid territory ID.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the invalid territory ID.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains the invalid territory ID.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when an invalid territory ID is provided. Possible values: **the id given seems to be invalid**, **The record Id given seems to be invalid**.", "enum": [ "the id given seems to be invalid", "The record Id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignInvalidDataTerritoryId" }, "TerritoryAssignMandatoryNotFound": { "additionalProperties": false, "description": "Represents the error response when a mandatory field is missing from a territory assignment request.", "properties": { "data": { "description": "Represents the list of assignment objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory assignment.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing mandatory field.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when a mandatory field is absent. Possible values: **One of the expected parameter is missing**, **required field not found**.", "enum": [ "One of the expected parameter is missing", "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignMandatoryNotFound" }, "TerritoryAssignNoPermission": { "additionalProperties": false, "description": "Represents the error response when the authenticated user does not have permission to assign territories to the specified record.", "properties": { "data": { "description": "Represents the list of assignment objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory assignment.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "api_name": { "description": "Represents the API name of the field related to the permission error.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field related to the permission error.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when a user lacks permission for the territory operation. Possible values: **User has no permission to add / remove the Territories**, **User has no permission to update the record**, **User has no permission to assign/remove this territory**.", "enum": [ "User has no permission to add / remove the Territories", "User has no permission to update the record", "User has no permission to assign/remove this territory" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignNoPermission" }, "TerritoryAssignNotSupported": { "additionalProperties": false, "description": "Represents the error response when the territory assignment operation is not supported for the specified module.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NOT_SUPPORTED**.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the resource path index where the issue occurred.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the unsupported operation was detected.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Detailed error message to help fix the validation issue.", "enum": [ "the api is not supported for this module" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignNotSupported" }, "TerritoryAssignRecordLocked": { "additionalProperties": false, "description": "Represents the error response when the target record is locked and cannot be assigned a territory.", "properties": { "data": { "description": "Represents the list of assignment objects with error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory assignment.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **RECORD_LOCKED**.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the locked record identifier.", "properties": { "action": { "description": "Represents the action that triggered the record lock error. Possible values: **record_locking**.", "enum": [ "record_locking" ], "type": "string" }, "id": { "description": "Represents the unique identifier of the locked record.", "format": "int64", "type": "string" } }, "required": [ "id", "action" ], "type": "object" }, "message": { "description": "Represents the error message returned when a record is locked. Possible values: **Sorry, you cannot perform this operation as the record is locked.**.", "enum": [ "Sorry, you cannot perform this operation as the record is locked." ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignRecordLocked" }, "TerritoryAssignRecordLockedInURL": { "additionalProperties": false, "description": "Represents the error response when the target record in the URL path is locked and cannot be modified.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **RECORD_LOCKED**.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the resource path index of the locked record.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the locked record was supplied.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message returned when a record is locked. Possible values: **Sorry, you cannot perform this operation as the record is locked.**.", "enum": [ "Sorry, you cannot perform this operation as the record is locked." ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryAssignRecordLockedInURL" }, "TerritoryAssignRecordScheduledResponse": { "additionalProperties": false, "description": "Represents the response returned when a single-record territory assignment job has been scheduled.", "properties": { "data": { "description": "Represents the list of record-territory association objects.", "items": { "additionalProperties": false, "description": "Represents the details of a single territory assignment operation.", "properties": { "code": { "description": "Represents the code for the scheduled territory assignment. Possible values: **SCHEDULED**.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduled territory assignment, including the record and job identifiers.", "properties": { "id": { "description": "Represents the unique identifier of the record.", "format": "int64", "type": "string" }, "job_id": { "description": "Represents the unique identifier of the scheduled job.", "format": "int64", "type": "string" } }, "required": [ "id", "job_id" ], "type": "object" }, "message": { "description": "Represents the message returned when the territory assignment is scheduled. Possible values: **Territory assignment process scheduled successfully**.", "enum": [ "Territory assignment process scheduled successfully" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryAssignRecordScheduledResponse" }, "TerritoryAssignRecordSuccessResponse": { "additionalProperties": false, "description": "Successful response returned when territories are assigned to a record.", "properties": { "data": { "description": "Array containing the result of the territory assignment.", "items": { "additionalProperties": false, "description": "Details of the territory assignment operation.", "properties": { "code": { "description": "Status code indicating the territory assignment was successful.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional information about the territory assignment.", "properties": { "id": { "description": "Unique identifier of the record.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Success message confirming that the territory data was updated.", "enum": [ "the territories data updated successfully", "the territories data removed successfully" ], "type": "string" }, "status": { "description": "Indicates whether the operation succeeded or failed.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryAssignRecordSuccessResponse" }, "TerritoryAssignScheduledResponse": { "additionalProperties": false, "description": "Represents the response returned when a territory assignment job has been scheduled.", "properties": { "data": { "description": "Represents the list of record-territory association objects.", "items": { "additionalProperties": false, "description": "Represents the details of a single territory assignment operation.", "properties": { "code": { "description": "Represents the code for the scheduled territory assignment. Possible values: **SCHEDULED**.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduled territory assignment, including the record and job identifiers.", "properties": { "id": { "description": "Represents the unique identifier of the record.", "format": "int64", "type": "string" }, "job_id": { "description": "Represents the unique identifier of the scheduled job.", "format": "int64", "type": "string" } }, "required": [ "id", "job_id" ], "type": "object" }, "message": { "description": "Represents the message returned when the territory assignment is scheduled. Possible values: **Territory assignment process scheduled successfully**.", "enum": [ "Territory assignment process scheduled successfully" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryAssignScheduledResponse" }, "TerritoryAssignSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned when territories are successfully assigned to records.", "properties": { "data": { "description": "Represents the list of territory assignment result objects.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory assignment operation.", "properties": { "code": { "description": "Represents the result code for the territory assignment. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the territory assignment, including the record identifier.", "properties": { "id": { "description": "Represents the unique identifier of the record to which territories were assigned.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message returned for the territory assignment. Possible values: **the territories data updated successfully**.", "enum": [ "the territories data updated successfully" ], "type": "string" }, "status": { "description": "Represents the status of the territory assignment operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryAssignSuccessResponse" }, "TerritoryAssociatedUsersCountResponse": { "additionalProperties": false, "description": "Represents the response containing the count of users associated with each territory.", "properties": { "associated_users_count": { "description": "Represents the list of objects containing the count of users associated with each territory.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory with its associated user count.", "properties": { "count": { "description": "Represents the total number of users associated with the territory.", "format": "int32", "minimum": 0, "type": "integer" }, "territory": { "additionalProperties": false, "description": "Represents the territory object associated with the user count.", "properties": { "id": { "description": "Represents the unique identifier of the territory.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the territory.", "maxLength": 50, "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "required": [ "count", "territory" ], "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents the pagination metadata for the response.", "properties": { "count": { "description": "Represents the total number of records available in the current response.", "format": "int32", "minimum": 0, "type": "integer" }, "more_records": { "description": "Represents whether additional records are available beyond the current page.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.", "format": "int32", "minimum": 1, "type": "integer" }, "per_page": { "description": "Represents the number of records returned per page.", "format": "int32", "maximum": 2000, "minimum": 1, "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "associated_users_count", "info" ], "type": "object", "x-zs-$id": "TerritoryAssociatedUsersCountResponse" }, "TerritoryByIdNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user does not have permission to access the specified territory by ID.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **PERMISSION_DENIED**.", "enum": [ "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission error, including the resource path index.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the permission error occurred.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission to access the territory. Possible values: **User does not have update/delete permission for the territory**, **User does not have permission to view/access the Territory**.", "enum": [ "User does not have update/delete permission for the territory", "User does not have permission to view/access the Territory" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "TerritoryByIdNoPermission" }, "TerritoryChildListResponse": { "additionalProperties": false, "description": "Represents the response containing child territories with pagination details.", "properties": { "info": { "$ref": "#/components/schemas/InfoSchema", "description": "Pagination metadata for the response.", "x-zs-$id": "InfoGETChildTerritories" }, "territories": { "description": "Represents the list of child territory objects.", "items": { "$ref": "#/components/schemas/TerritoryGETSchema", "description": "Individual territory object." }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "territories", "info" ], "type": "object", "x-zs-$id": "TerritoryChildListResponse" }, "TerritoryCreateSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned when one or more territories are successfully created.", "properties": { "territories": { "description": "Represents the list of territory objects created by the request.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory creation operation.", "properties": { "code": { "description": "Represents the result code for the territory creation. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the created territory, including its unique identifier.", "properties": { "id": { "description": "Represents the unique identifier of the created territory.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message returned for the territory creation. Possible values: **Territory Created Successfully**.", "enum": [ "Territory Created Successfully" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the territory creation operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Create Success Response", "type": "object", "x-zs-$id": "TerritoryCreateSuccessResponse" }, "TerritoryCriteriaError": { "additionalProperties": false, "description": "Represents the error response for criteria validation errors in territory operations, containing a territories array with criteria error items.", "properties": { "territories": { "description": "Represents the list of territory objects with criteria validation error details.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataType" }, { "$ref": "#/components/schemas/FieldComparatorValueMissing" }, { "$ref": "#/components/schemas/FieldComparatorMismatch" }, { "$ref": "#/components/schemas/FieldValueMismatch" }, { "$ref": "#/components/schemas/ComparatorValueMismatch" }, { "$ref": "#/components/schemas/InvalidComparator" }, { "$ref": "#/components/schemas/LookupLimitExceeded" }, { "$ref": "#/components/schemas/NotSupportedApiName" }, { "additionalProperties": false, "description": "Represents a territory-specific comparator error for criteria validation.", "properties": { "code": { "const": "INVALID_DATA", "description": "Represents the error code for the request.", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field API name, JSON path, and supported values.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the field with invalid data.", "maxLength": 512, "type": "string" }, "supported_values": { "description": "Represents the list of valid values supported for the field.", "items": { "description": "Represents a single supported value for the field.", "maxLength": 100, "type": "string" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when the criteria data is invalid. Possible values: **the given value is invalid**, **the given filter value is invalid**, **invalid data**, **The given api_name seems to be invalid**, **The given comparator seems to be invalid**, **Please give a valid comparator**.", "enum": [ "the given value is invalid", "the given filter value is invalid", "invalid data", "The given api_name seems to be invalid", "The given comparator seems to be invalid", "Please give a valid comparator" ], "type": "string" }, "status": { "const": "error", "description": "Represents the status of the operation. Possible values: **error**.", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryInvalidComparator" }, { "$ref": "#/components/schemas/FieldNotSupportedInCriteria" } ] }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Criteria Validation Error", "type": "object", "x-zs-$id": "TerritoryCriteriaError" }, "TerritoryDeleteSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned when one or more territories are successfully deleted.", "properties": { "territories": { "description": "Represents the list of territory objects deleted by the request.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory delete operation.", "properties": { "code": { "description": "Represents the result code for the territory deletion. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the deleted territory, including its unique identifier.", "properties": { "id": { "description": "Represents the unique identifier of the deleted territory.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message returned for the territory deletion. Possible values: **Territory Deleted Successfully**, **Given Territory Removed Successfully**.", "enum": [ "Territory Deleted Successfully", "Given Territory Removed Successfully" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the territory deletion operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Delete Success Response", "type": "object", "x-zs-$id": "TerritoryDeleteSuccessResponse" }, "TerritoryErrorPermissionDenied": { "additionalProperties": false, "description": "Represents the error response when access to a territory resource is denied or the territory feature is disabled or not yet enabled.", "properties": { "code": { "description": "Represents the error code indicating why territory access was denied. Possible values: **PERMISSION_DENIED**, **FEATURE_NOT_ENABLED**, **TERRITORY_DISABLED**, **TERRITORY_NOT_ENABLED**.", "enum": [ "PERMISSION_DENIED", "FEATURE_NOT_ENABLED", "TERRITORY_DISABLED", "TERRITORY_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission denied error, returned as an empty object.", "type": "object" }, "message": { "description": "Represents the human-readable description of why the territory access was denied.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryErrorPermissionDenied" }, "TerritoryFeatureNotEnabledError": { "additionalProperties": false, "description": "Represents the error response when the territory feature is not enabled for the organization.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **FEATURE_NOT_ENABLED**.", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when the territory feature is not enabled for the organization. Possible values: **Territory Management is disabled**, **Territory Management is not enabled**, **Territory Management Disabled**, **the territory feature is not enabled for Leads Module**, **Territory Management is not enabled for Leads Module**.", "enum": [ "Territory Management is disabled", "Territory Management is not enabled", "Territory Management Disabled", "the territory feature is not enabled for Leads Module", "Territory Management is not enabled for Leads Module" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryFeatureNotEnabledError" }, "TerritoryGETSchema": { "additionalProperties": false, "description": "Represents a single territory record returned by the API.", "properties": { "account_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionResponse" }, { "$ref": "#/components/schemas/GroupedFilterCriterionResponse" }, { "const": null, "description": "Represents the absence of an account rule criteria for the territory.", "type": "null", "x-zs-$id": "AccountRuleCriteriaNullGET" } ], "description": "Represents the criteria used to auto-assign accounts to the territory." }, "api_name": { "description": "Represents the unique API name of the territory used in API requests.", "maxLength": 100, "type": "string", "x-zs-$id": "TerritoriesApiName" }, "created_by": { "additionalProperties": false, "description": "Represents the user who created the territory.", "properties": { "id": { "description": "Represents the unique identifier of the user who created the territory.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the user who created the territory.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the date and time the territory record took effect, in ISO 8601 format.", "format": "date-time", "type": "string" }, "deal_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionResponse" }, { "$ref": "#/components/schemas/GroupedFilterCriterionResponse" }, { "const": null, "description": "Represents the absence of a deal rule criteria for the territory.", "type": "null", "x-zs-$id": "DealRuleCriteriaNullGET" } ], "description": "Represents the criteria used to auto-assign deals to the territory." }, "description": { "anyOf": [ { "const": null, "description": "Represents the absence of a description for the territory.", "type": "null", "x-zs-$id": "DescriptionNull" }, { "description": "Represents the description of the territory.", "maxLength": 250, "type": "string", "x-zs-$id": "Description" } ] }, "id": { "description": "Represents the unique identifier of the territory.", "format": "int64", "type": "string", "x-zs-$id": "TerritoriesId" }, "lead_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionResponse" }, { "$ref": "#/components/schemas/GroupedFilterCriterionResponse" }, { "const": null, "description": "Represents the absence of a lead rule criteria for the territory.", "type": "null", "x-zs-$id": "LeadRuleCriteriaNullGET" } ], "description": "Represents the criteria used to auto-assign leads to the territory." }, "manager": { "anyOf": [ { "additionalProperties": false, "description": "Represents a territory manager identified by user ID.", "properties": { "id": { "description": "Represents the unique identifier of the territory manager.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the territory manager.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the current status of the territory manager. Possible values: **deleted**, **rejected**, **active**, **closed**, **disabled**.", "enum": [ "deleted", "rejected", "active", "closed", "disabled" ], "type": "string" }, "zuid": { "description": "Represents the Zoho User ID (ZUID) of the territory manager.", "format": "int32", "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ManagerGET" }, { "const": null, "description": "Represents the absence of a territory manager.", "type": "null", "x-zs-$id": "ManagerNullGET" } ] }, "modified_by": { "additionalProperties": false, "description": "Represents the user who last modified the territory.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified the territory.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the user who last modified the territory.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "modified_time": { "description": "Represents the date and time when the territory was last modified, in ISO 8601 format.", "format": "date-time", "type": "string" }, "name": { "description": "Represents the display name of the territory.", "maxLength": 50, "type": "string" }, "permission_type": { "description": "Represents the access permission for users in this territory. Possible values: **read_write_delete**, **read_only**.", "enum": [ "read_write_delete", "read_only" ], "type": "string" }, "reporting_to": { "anyOf": [ { "additionalProperties": false, "description": "Represents the parent territory to which this territory reports in the hierarchy.", "properties": { "id": { "description": "Represents the unique identifier of the parent territory.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the parent territory.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ReportingToObjectGET" }, { "const": null, "description": "Represents the absence of a parent territory for this territory.", "type": "null", "x-zs-$id": "ReportingToNullGET" } ] } }, "required": [ "created_time", "modified_time", "manager", "reporting_to", "permission_type", "modified_by", "description", "id", "created_by", "name", "api_name" ], "type": "object", "x-zs-$id": "TerritoryGETSchema" }, "TerritoryGetByIdResponse": { "additionalProperties": false, "description": "Represents the response returned when retrieving a territory by its unique ID.", "properties": { "territories": { "description": "Represents the list of territory objects returned for the specified ID.", "items": { "$ref": "#/components/schemas/TerritoryGETSchema", "description": "Individual territory object." }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "TerritoryGetByIdResponse" }, "TerritoryGetResponse": { "additionalProperties": false, "description": "Represents the response containing territories assigned to a user and pagination details.", "properties": { "info": { "additionalProperties": false, "description": "Represents the pagination details for the response.", "properties": { "count": { "description": "Represents the number of territory records returned in the current page. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether more territory records are available beyond the current page. Possible values: true - More records are available. false - No more records are available.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the maximum number of records returned per page.", "format": "int32", "type": "integer" } }, "required": [ "count", "page", "per_page", "more_records" ], "type": "object" }, "territories": { "description": "The JSON array representing the list of territories assigned to the user.", "items": { "additionalProperties": false, "description": "Represents the details of a single territory assigned to the user.", "properties": { "Manager": { "additionalProperties": false, "description": "Represents the manager of the territory. Valid user IDs and names can be retrieved using the [Get Users](users.json#$.paths./{users}.get) API.", "properties": { "Name": { "description": "Represents the full name of the territory manager.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the territory manager.", "format": "int64", "type": "string" } }, "type": "object" }, "Name": { "description": "Represents the name of the territory.", "maxLength": 255, "type": "string" }, "Reporting_To": { "additionalProperties": false, "description": "Represents the parent territory that this territory reports to in the hierarchy.", "properties": { "Name": { "description": "Represents the name of the parent territory or reporting entity.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the parent territory or reporting entity.", "format": "int64", "type": "string" } }, "required": [ "Name", "id" ], "type": "object" }, "id": { "description": "Represents the unique ID of the territory.", "format": "int64", "type": "string" } }, "required": [ "id", "Manager", "Reporting_To", "Name" ], "type": "object" }, "maxItems": 200, "minItems": 0, "type": "array", "uniqueItems": true } }, "required": [ "territories", "info" ], "type": "object", "x-zs-$id": "TerritoryGetResponse" }, "TerritoryInternalServerErrorSchema": { "additionalProperties": false, "description": "Represents the error response when an internal server error occurs during a territory operation.", "properties": { "code": { "description": "Represents the error code for an internal server error. Possible values: **INTERNAL_SERVER_ERROR**.", "enum": [ "INTERNAL_SERVER_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the internal server error, returned as an empty object.", "type": "object" }, "message": { "description": "Represents the human-readable description of the internal server error.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryInternalServerErrorSchema" }, "TerritoryInvalidUrlPathErrorSchema": { "additionalProperties": false, "description": "Represents the error response when an invalid value is provided in the URL path of a territory request.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the index of the invalid URL path segment.", "properties": { "resource_path_index": { "description": "Represents the index of the URL path segment where the invalid value was found.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message returned when an invalid value is provided in the URL path. Possible values: **The given territory id is invalid**, **the id given seems to be invalid**, **The record Id given seems to be invalid**, **Invalid Territory Id**.", "enum": [ "The given territory id is invalid", "the id given seems to be invalid", "The record Id given seems to be invalid", "Invalid Territory Id" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryInvalidUrlPathErrorSchema" }, "TerritoryLimitExceededError": { "additionalProperties": false, "description": "Represents the error response when a territory-related limit is exceeded.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **LIMIT_EXCEEDED**.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the limit information.", "properties": { "limit": { "description": "Represents the maximum allowed limit that was exceeded.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message returned when the territory limit is exceeded. Possible values: **Maximum limit of territories for that record exceeds**.", "enum": [ "Maximum limit of territories for that record exceeds" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryLimitExceededError" }, "TerritoryLimitExceededErrorWithField": { "additionalProperties": false, "description": "Represents the error response when a territory-related limit is exceeded, with field-level context.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **LIMIT_EXCEEDED**.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field-level context and limit information.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the limit exceeded error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the field that caused the limit exceeded error.", "maxLength": 100, "type": "string" }, "limit": { "description": "Represents the maximum allowed limit that was exceeded.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "api_name", "json_path", "limit" ], "type": "object" }, "message": { "description": "Represents the error message returned when the territory limit is exceeded. Possible values: **Maximum limit of territories for that record exceeds**.", "enum": [ "Maximum limit of territories for that record exceeds" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryLimitExceededErrorWithField" }, "TerritoryListResponse": { "anyOf": [ { "additionalProperties": false, "description": "Represents the paginated response containing a list of territories with pagination details.", "properties": { "info": { "$ref": "#/components/schemas/InfoSchema", "description": "Pagination metadata for the response.", "x-zs-$id": "InfoGET" }, "territories": { "description": "Represents the list of territory objects returned in the paginated response.", "items": { "$ref": "#/components/schemas/TerritoryGETSchema", "description": "Individual territory object containing detailed information about the territory." }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "territories", "info" ], "type": "object", "x-zs-$id": "TerritoryListResponseSchema" }, { "additionalProperties": false, "description": "Represents the response containing territories filtered by the specified IDs.", "properties": { "territories": { "description": "Represents the list of territory objects filtered by the specified IDs.", "items": { "$ref": "#/components/schemas/TerritoryGETSchema", "description": "Individual territory object." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "GetAllTerritoriesWithIdsParam" } ], "description": "Represents the response for the GET /settings/territories endpoint. Returns either a paginated list of territories with an info object, or a filtered list of territories when the ids parameter is provided.", "x-zs-$id": "TerritoryListResponse" }, "TerritoryMaxLimitExceededErrorSchema": { "additionalProperties": false, "description": "Represents the error response when the number of territories in the request exceeds the allowed maximum.", "properties": { "territories": { "description": "Represents the list of territory objects with limit exceeded error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory that exceeded the allowed limit.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **LIMIT_EXCEEDED**.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the maximum allowed limit.", "properties": { "limit": { "description": "Represents the maximum number of territories allowed per request.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "limit" ], "type": "object", "x-zs-$id": "MaxLimitExceededDetailsObject" }, "message": { "description": "Represents the error message returned when the territory limit is exceeded. Possible values: **Territory Limit reached**.", "enum": [ "Territory Limit reached" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "TerritoryMaxLimitExceededErrorSchema" }, "TerritoryMaxLimitExceededErrorSchemaForCriteria": { "additionalProperties": false, "description": "Represents the error response when the number of criteria conditions in the request exceeds the allowed maximum.", "properties": { "territories": { "description": "Represents the list of territory objects with criteria limit error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory that exceeded the criteria limit.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **LIMIT_EXCEEDED**.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the maximum criteria limit and the fields that exceeded it.", "properties": { "limit": { "description": "Represents the maximum number of criteria conditions allowed.", "format": "int32", "minimum": 1, "type": "integer" }, "limit_due_to": { "description": "Represents the list of criteria fields that caused the limit to be exceeded.", "items": { "additionalProperties": false, "description": "Represents the error details for a single criteria field that contributed to the limit being exceeded.", "properties": { "api_name": { "description": "Represents the API name of the criteria field that caused the limit to be exceeded.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path of the criteria field that caused the limit to be exceeded.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "limit", "limit_due_to" ], "type": "object", "x-zs-$id": "MaxLimitExceededDetailsObjectForCriteria" }, "message": { "description": "Represents the error message returned when the territory criteria limit is exceeded. Possible values: **Maximum Territory Criteria Limit reached**.", "enum": [ "Maximum Territory Criteria Limit reached" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "TerritoryMaxLimitExceededErrorSchemaForCriteria" }, "TerritoryNotEnabledError": { "additionalProperties": false, "description": "Represents the error response when territory management has never been enabled for the organization.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **TERRITORY_NOT_ENABLED**.", "enum": [ "TERRITORY_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message returned when territory management has never been enabled. Possible values: **the territory feature is not enabled for Leads Module**, **Territory Management is not enabled**.", "enum": [ "the territory feature is not enabled for Leads Module", "Territory Management is not enabled" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryNotEnabledError" }, "TerritoryOrgNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user does not have update or delete permission for the specified territory.", "properties": { "territories": { "description": "Represents the list of territory objects with organization permission error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory when the user lacks permission to delete the organization territory.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **PERMISSION_DENIED**.", "enum": [ "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission error.", "properties": { "id": { "description": "Represents the unique identifier related to the permission error context.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission for the organization territory. Possible values: **User does not have update/delete permission for the territory**, **You do not have the necessary permissions to access this territory.**.", "enum": [ "User does not have update/delete permission for the territory", "You do not have the necessary permissions to access this territory." ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "TerritoryOrgNoPermission" }, "TerritoryParentNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user does not have permission to use the specified territory as a parent.", "properties": { "territories": { "description": "Represents the list of territory objects with permission error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory with a parent permission error.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **PERMISSION_DENIED**.", "enum": [ "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission error.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission to use the selected parent territory. Possible values: **Doesn't have a permission to choose that territory as a Parent Id**.", "enum": [ "Doesn't have a permission to choose that territory as a Parent Id" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "TerritoryParentNoPermission" }, "TerritoryParentNoPermissionDetailed": { "additionalProperties": false, "description": "Represents the error response when the user does not have permission to use the specified territory as a parent, with detailed field-level context.", "properties": { "territories": { "description": "Represents the list of territory objects with detailed permission error information.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory with a parent permission error.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **PERMISSION_DENIED**.", "enum": [ "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the permission error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the field that caused the permission error.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission for the territory. Possible values: **Doesn't have a permission to choose that territory as a Parent Id**, **User does not have update/delete permission for the territory**, **User does not have permission to view/access the Territory**.", "enum": [ "Doesn't have a permission to choose that territory as a Parent Id", "User does not have update/delete permission for the territory", "User does not have permission to view/access the Territory" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "TerritoryParentNoPermissionDetailed" }, "TerritoryRecordNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user lacks permission to update the record.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission error, including the resource path index.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the permission error occurred.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission to update the record. Possible values: **User has no permission to update the record**.", "enum": [ "User has no permission to update the record" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryRecordNoPermission" }, "TerritoryRecordUpdateNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user lacks permission to update the record for a territory assign or remove operation.", "properties": { "data": { "description": "Represents the list of error details for the records that could not be processed.", "items": { "additionalProperties": false, "description": "Represents the error details for a single record that could not be processed.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the permission error.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the field that caused the permission error.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks permission to update the record. Possible values: **User has no permission to update the record**.", "enum": [ "User has no permission to update the record" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory No Permission Error Response", "type": "object", "x-zs-$id": "TerritoryRecordUpdateNoPermission" }, "TerritoryRemoveRecordScheduledResponse": { "additionalProperties": false, "description": "Represents the response returned when a single-record territory removal job has been scheduled.", "properties": { "data": { "description": "Represents the list of scheduled territory removal results.", "items": { "additionalProperties": false, "description": "Represents the error details for a single scheduled territory removal operation.", "properties": { "code": { "description": "Represents the result code for the scheduled territory removal. Possible values: **SCHEDULED**.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduled territory removal, including the record and job identifiers.", "properties": { "id": { "description": "Represents the unique identifier of the record for which territory removal was scheduled.", "format": "int64", "type": "string" }, "job_id": { "description": "Represents the unique identifier of the scheduled territory removal job.", "format": "int64", "type": "string" } }, "required": [ "id", "job_id" ], "type": "object" }, "message": { "description": "Represents the success message returned when the territory removal is scheduled. Possible values: **Territory removal process scheduled successfully**.", "enum": [ "Territory removal process scheduled successfully" ], "type": "string" }, "status": { "description": "Represents the status of the scheduled territory removal operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryRemoveRecordScheduledResponse" }, "TerritoryRemoveRecordSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned when territories are successfully removed from a record.", "properties": { "data": { "description": "Represents the list of territory removal results for the records.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory removal operation.", "properties": { "code": { "description": "Represents the result code for the territory removal. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the territory removal, including the record identifier.", "properties": { "id": { "description": "Represents the unique identifier of the record from which territories were removed.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message returned for the territory removal. Possible values: **the territories data removed successfully**.", "enum": [ "the territories data removed successfully" ], "type": "string" }, "status": { "description": "Represents the status of the territory removal operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryRemoveRecordSuccessResponse" }, "TerritoryRemoveScheduledResponse": { "additionalProperties": false, "description": "Represents the response returned when a territory removal job has been scheduled.", "properties": { "data": { "description": "Represents the list of scheduled territory removal results.", "items": { "additionalProperties": false, "description": "Represents the error details for a single scheduled territory removal operation.", "properties": { "code": { "description": "Represents the result code for the scheduled territory removal. Possible values: **SCHEDULED**.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduled territory removal, including the record and job identifiers.", "properties": { "id": { "description": "Represents the unique identifier of the record for which territory removal was scheduled.", "format": "int64", "type": "string" }, "job_id": { "description": "Represents the unique identifier of the scheduled territory removal job.", "format": "int64", "type": "string" } }, "required": [ "id", "job_id" ], "type": "object" }, "message": { "description": "Represents the success message returned when the territory removal is scheduled. Possible values: **Territory removal process scheduled successfully**.", "enum": [ "Territory removal process scheduled successfully" ], "type": "string" }, "status": { "description": "Represents the status of the scheduled territory removal operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryRemoveScheduledResponse" }, "TerritoryRemoveSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned when territories are successfully removed from records.", "properties": { "data": { "description": "Represents the list of territory removal results.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory removal operation.", "properties": { "code": { "description": "Represents the result code for the territory removal. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the territory removal, including the record identifier.", "properties": { "id": { "description": "Represents the unique identifier of the record from which territories were removed.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message returned for the territory removal. Possible values: **the territories data removed successfully**.", "enum": [ "the territories data removed successfully" ], "type": "string" }, "status": { "description": "Represents the status of the territory removal operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "TerritoryRemoveSuccessResponse" }, "TerritoryRemoveSystemAssignedNotAllowed": { "additionalProperties": false, "description": "Represents the error response when attempting to remove a system-assigned territory from a record.", "properties": { "data": { "description": "Represents the list of error details for the territory removal operations that are not allowed.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory removal that is not allowed.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error. Possible values: **id**.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the invalid territory ID in the request.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when attempting to remove a system-assigned territory. Possible values: **Territory id which you are trying to remove was system assigned**, **The territory id which you are trying to remove was system assigned**.", "enum": [ "Territory id which you are trying to remove was system assigned", "The territory id which you are trying to remove was system assigned" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "title": "Record - Territory Error Response", "type": "object", "x-zs-$id": "TerritoryRemoveSystemAssignedNotAllowed" }, "TerritoryReportingToChildError": { "additionalProperties": false, "description": "Represents the error response when the reporting_to territory ID is a child of the territory being updated, which would create a circular hierarchy.", "properties": { "territories": { "description": "Represents the list of territory objects with child hierarchy error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory with a child hierarchy error.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the hierarchy error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the hierarchy validation error.", "maxLength": 100, "minLength": 1, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the field that caused the hierarchy error.", "maxLength": 250, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when the reporting_to territory is a child of the territory being updated. Possible values: **Reporting_to id should not be the child of given territory. Chosse another territory as Reporing_to**, **Org Territory cannot be deleted.**, **Territory can't be deleted as it's having child**.", "enum": [ "Reporting_to id should not be the child of given territory. Chosse another territory as Reporing_to", "Org Territory cannot be deleted.", "Territory can't be deleted as it's having child" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "TerritoryReportingToChildError" }, "TerritoryRuleModuleReference": { "additionalProperties": false, "anyOf": [ { "description": "Represents the module identified by its unique ID.", "required": [ "id" ], "x-zs-$id": "TerritoryRuleModuleById" }, { "description": "Represents the module identified by its API name.", "required": [ "api_name" ], "x-zs-$id": "TerritoryRuleModuleByApiName" } ], "description": "Represents the CRM module associated with the territory rule, identified by either its unique ID or API name.", "properties": { "api_name": { "description": "Represents the API name of the module associated with the territory rule.", "maxLength": 50, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Represents the unique identifier of the module associated with the territory rule.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } } }, "type": "object", "x-zs-$id": "TerritoryRuleModuleReference" }, "TerritoryRunRulesScheduledResponse": { "additionalProperties": false, "description": "Represents the response returned when territory rules execution has been scheduled.", "properties": { "run_rules": { "additionalProperties": false, "description": "Represents the result of the scheduled territory rules execution.", "properties": { "code": { "description": "Represents the result code for the scheduled territory rules execution. Possible values: **SCHEDULED**.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduled execution, including the job identifier.", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled territory rules execution job.", "format": "int64", "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the success message returned when territory rules execution is scheduled. Possible values: **Territory rules scheduled successfully.Once done, completion email is sent.**, **Territory rules Scheduled successfully.Once done Completion email will sent**.", "enum": [ "Territory rules scheduled successfully.Once done, completion email will be sent.", "Territory rules Scheduled successfully.Once done Completion email will sent" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the scheduled territory rules execution. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "run_rules" ], "type": "object", "x-zs-$id": "TerritoryRunRulesScheduledResponse" }, "TerritoryScheduledRunRuleJobsResponse": { "additionalProperties": false, "description": "Represents the response containing the status and details of scheduled territory run rule jobs.", "properties": { "scheduled_run_rule_jobs": { "additionalProperties": false, "description": "Represents the status and details of the scheduled territory rule execution job.", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled run rule job.", "format": "int64", "type": "string" }, "scheduled_by": { "additionalProperties": false, "description": "Represents the user who scheduled the run rule job.", "properties": { "id": { "description": "Represents the unique identifier of the user who scheduled the run rule job.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who scheduled the run rule job.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "scheduled_time": { "description": "Represents the date and time when the run rule job was scheduled, in ISO 8601 format.", "format": "date-time", "type": "string" }, "status": { "description": "Represents the current status of the scheduled run rule job. Possible values: **COMPLETED**, **IN_PROGRESS**, **FAILED**, **SCHEDULED**.", "enum": [ "COMPLETED", "IN_PROGRESS", "FAILED", "SCHEDULED" ], "type": "string" } }, "required": [ "status", "job_id", "scheduled_by", "scheduled_time" ], "type": "object" } }, "required": [ "scheduled_run_rule_jobs" ], "type": "object", "x-zs-$id": "TerritoryScheduledRunRuleJobsResponse" }, "TerritoryTransferAndDeleteSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned when a territory is successfully transferred and deleted.", "properties": { "territories": { "description": "Represents the list of territory objects transferred and deleted by the request.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory transfer and delete operation.", "properties": { "code": { "description": "Represents the result code for the territory transfer and deletion. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the transferred and deleted territory, including its unique identifier.", "properties": { "id": { "description": "Represents the unique identifier of the transferred and deleted territory.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message returned for the territory transfer and deletion. Possible values: **Territory Transferred And Deleted Successfully**, **Given Territory Removed Successfully and its child Territories moved to the another territory**.", "enum": [ "Territory Transferred And Deleted Successfully", "Given Territory Removed Successfully and its child Territories moved to the another territory" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the territory transfer and delete operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Transfer And Delete Success Response", "type": "object", "x-zs-$id": "TerritoryTransferAndDeleteSuccessResponse" }, "TerritoryUpdateDeleteNoPermission": { "additionalProperties": false, "description": "Represents the error response when the user does not have update or delete permission for the specified territory.", "properties": { "territories": { "description": "Represents the list of territory objects with update or delete permission error details.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory with an update or delete permission error.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permission error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the permission error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the field that caused the permission error.", "maxLength": 250, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message returned when the user lacks update or delete permission for the territory. Possible values: **User does not have update/delete permission for the territory**.", "enum": [ "User does not have update/delete permission for the territory" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Update/Delete No Permission Error", "type": "object", "x-zs-$id": "TerritoryUpdateDeleteNoPermission" }, "TerritoryUpdateSuccessResponse": { "additionalProperties": false, "description": "Represents the response returned when one or more territories are successfully updated.", "properties": { "territories": { "description": "Represents the list of territory objects updated by the request.", "items": { "additionalProperties": false, "description": "Represents the error details for a single territory update operation.", "properties": { "code": { "description": "Represents the result code for the territory update. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the updated territory, including its unique identifier.", "properties": { "id": { "description": "Represents the unique identifier of the updated territory.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message returned for the territory update. Possible values: **Territory Updated Successfully**.", "enum": [ "Territory Updated Successfully" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the territory update operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "title": "Territory Update Success Response", "type": "object", "x-zs-$id": "TerritoryUpdateSuccessResponse" }, "TerritoryUsersLimitExceededErrorSchema": { "additionalProperties": false, "description": "Represents the error response returned when the number of users to be associated exceeds the territory user limit.", "properties": { "code": { "description": "Represents the error code for the territory user limit exceeded error.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents a single error detail object for the limit exceeded error.", "properties": { "limit": { "description": "Represents the maximum number of users allowed in the territory.", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object", "x-zs-$id": "TerritoryuserslimitexceedederrorschemaLimitObject" }, { "additionalProperties": false, "description": "Represents a null value indicating no additional error details are available.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 100, "type": "string" }, "limit": { "description": "Represents the maximum number of users permitted in the territory.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "limit" ], "type": "object", "x-zs-$id": "TerritoryuserslimitexceedederrorschemaApinameObject" } ], "description": "Represents additional details about the territory user limit exceeded error." }, "message": { "description": "Represents the error message describing the territory user limit exceeded error.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the territory user limit exceeded error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TerritoryUsersLimitExceededErrorSchema" }, "TextFilterCriterionRequest": { "additionalProperties": false, "description": "Represents a filter criterion for the like, not_like, starts_with, ends_with, contains, and not_contains comparators. The value must be a string scalar or array; use SimpleFilterCriterionValueString for text-based field types. Object and Boolean values are not supported. Resolve the data_type from the field's FieldSchema.", "properties": { "comparator": { "description": "Represents the text comparison operator applied to the criterion.\nPossible values:\nlike - Matches records where the field value contains the specified pattern.\nnot_like - Matches records where the field value does not contain the specified pattern.\nstarts_with - Matches records where the field value begins with the specified string.\nends_with - Matches records where the field value ends with the specified string.\ncontains - Matches records where the field value contains the specified string.\nnot_contains - Matches records where the field value does not contain the specified string.", "enum": [ "like", "not_like", "starts_with", "ends_with", "contains", "not_contains" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the text filter criterion.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the text filter criterion is applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Contains an array of primitive string values for the text filter comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" } ], "x-zs-$id": "TextFilterCriterionRequestValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "TextFilterCriterionRequestValueArray" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" } ], "description": "Represents the string filter value used in the text comparator. Accepts a scalar string or an array of string values." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "TextFilterCriterionRequest" }, "TextFilterCriterionResponse": { "additionalProperties": false, "description": "Represents the response for a filter criterion using the like, not_like, starts_with, ends_with, contains, and not_contains comparators. The value is a string scalar or array; SimpleFilterCriterionValueString applies to text-based field types.", "properties": { "$disrupted": { "description": "Indicates whether the text filter criterion is in a disrupted state, typically due to an invalid or unresolvable field or value reference.", "type": "boolean" }, "comparator": { "description": "Represents the text comparison operator returned for the criterion.\nPossible values:\nlike - Matches records where the field value contains the specified pattern.\nnot_like - Matches records where the field value does not contain the specified pattern.\nstarts_with - Matches records where the field value begins with the specified string.\nends_with - Matches records where the field value ends with the specified string.\ncontains - Matches records where the field value contains the specified string.\nnot_contains - Matches records where the field value does not contain the specified string.", "enum": [ "like", "not_like", "starts_with", "ends_with", "contains", "not_contains" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents the field reference constraint that requires the api_name property to be present for the text filter criterion response.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the target field definition to which the text filter criterion was applied, conforming to the base field structure." }, "type": { "default": "value", "description": "Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference.\nPossible values:\nvalue - The value is a direct literal.\nmerge_field - The value is a merge field reference.\npre_defined - The value is a predefined system variable placeholder.\nfield - The value references another field.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Contains an array of primitive string values returned for the text filter comparator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" } ], "x-zs-$id": "TextFilterCriterionResponseValueArrayItems" }, "maxItems": 500, "minItems": 1, "type": "array", "x-zs-$id": "TextFilterCriterionResponseValueArray" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" } ], "description": "Represents the string filter value returned for the text comparator. Contains a scalar string or an array of string values." } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "TextFilterCriterionResponse" }, "TimeObjectSchema": { "description": "Represents a time offset specification combining a period label and a numeric magnitude, used in time-based workflow trigger configurations.", "format": "date-time", "maxLength": 255, "type": [ "string", "null" ], "x-zs-llm-description": "Timestamp object used in GET responses for created_time, modified_time, and last_executed_time fields." }, "Timestamp": { "description": "ISO 8601 datetime string with timezone offset representing when the profile action was performed (for example, `2024-05-17T09:15:56+05:30`).", "example": "2024-05-17T09:15:56+05:30", "format": "date-time", "type": "string", "x-zs-$id": "Timestamp" }, "ToAddressNested": { "additionalProperties": false, "description": "Represents a recipient address entry for a mail merge email, containing the address type and email value.", "properties": { "type": { "description": "Represents the type of the address.\nPossible values:\n**email** - Indicates the value is an email address.\n", "enum": [ "email" ], "maxLength": 5, "type": "string" }, "value": { "description": "Represents the recipient email address for the mail merge email.", "format": "email", "maxLength": 255, "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "ToValueMustBeGreaterThanFromError": { "additionalProperties": false, "description": "Error response returned when an Available_Till date is not greater than the corresponding Available_From date.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the To value must be greater than the From value.", "enum": [ "To value must be Greater than From value" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "ToValueMustBeGreaterThanFromError" }, "TokenBoundDataMismatchGETError": { "additionalProperties": false, "description": "Represents the error response returned when the operation fails due to a token bound data mismatch GET error.", "properties": { "code": { "description": "Represents the error code identifying the type of failure.", "enum": [ "TOKEN_BOUND_DATA_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error.", "properties": { "param_name": { "description": "Contains additional context about the error.", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation failed.", "type": "string" }, "status": { "description": "Indicates the overall result status of the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TokenBoundDataMismatchGETError" }, "TouchPointScoreConfiguration": { "additionalProperties": false, "description": "Configuration for applying scores based on touch points for Leads and Contacts modules.", "properties": { "_delete": { "description": "used to delete the signal rule", "type": "null" }, "id": { "description": "Signal rule primary key", "maxLength": 25, "type": "string" }, "score": { "description": "Points that should be added for the signal (Required for CREATE)", "format": "int32", "type": "integer" }, "signal": { "$ref": "#/components/schemas/SignalInformation", "description": "Touch point signal info (Required for CREATE)" } }, "title": "Touch Point Score Configuration", "type": "object" }, "TouchPointScoreConfigurationPOST": { "additionalProperties": false, "description": "Configuration for applying scores based on touch points for Leads and Contacts modules. The '_delete' key is not supported in POST.", "properties": { "id": { "description": "Signal rule primary key", "maxLength": 25, "type": "string" }, "score": { "description": "Points that should be added for the signal (Required)", "format": "int32", "type": "integer" }, "signal": { "$ref": "#/components/schemas/SignalInformation", "description": "Touch point signal info (Required)" } }, "title": "Touch Point Score Configuration POST", "type": "object" }, "TransferToIdNotFoundError": { "additionalProperties": false, "description": "Error body returned when the `transfer_to` query parameter is required but missing.", "properties": { "code": { "description": "Error code indicating a missing mandatory parameter. Possible values: `MANDATORY_NOT_FOUND`.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the missing parameter.", "properties": { "param": { "description": "Name of the missing required query parameter. Possible values: `transfer_to`.", "enum": [ "transfer_to" ], "type": "string" } }, "required": [ "param" ], "type": "object" }, "message": { "description": "Human-readable description of the missing parameter error.", "maxLength": 1000, "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TransferToIdNotFoundError" }, "UnauthorizedError": { "additionalProperties": false, "description": "Represents the error response when authentication fails for the request.", "properties": { "code": { "description": "Represents the error code for the request. Possible values: **AUTHENTICATION_FAILURE**.", "enum": [ "AUTHENTICATION_FAILURE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the authentication error.", "type": "object" }, "message": { "description": "Represents the error message returned when authentication fails. Possible values: **Authentication failed**.", "enum": [ "Authentication failed" ], "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UnauthorizedError" }, "UnauthorizedResponse": { "additionalProperties": false, "description": "Represents the error response returned when the request is unauthorized due to an OAuth scope mismatch.", "properties": { "code": { "description": "Represents the error code for the OAuth scope mismatch.\nPossible values:\n**OAUTH_SCOPE_MISMATCH** - The access token does not include the required scope for this operation.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details for this error. An empty object indicates no additional details are available.", "maxProperties": 0, "type": "object", "x-zs-$id": "UnauthorizedResponseDetail" }, "message": { "description": "Represents the error message indicating the request is unauthorized due to an OAuth scope mismatch.", "maxLength": 1024, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an authorization error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UnauthorizedResponse" }, "UnavailableFromTimeOutsideAvailabilityError": { "additionalProperties": false, "description": "Error response returned when Unavailable_From does not fall within the service availability window.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing that the Unavailable From time falls outside the service availability window.", "enum": [ "Unavailable From time does not fall within service availability" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "UnavailableFromTimeOutsideAvailabilityError" }, "UnavailableTillTimeOutsideAvailabilityError": { "additionalProperties": false, "description": "Error response returned when Unavailable_Till does not fall within the service availability window.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "Unavailable Till time does not fall within service availability" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "UnavailableTillTimeOutsideAvailabilityError" }, "UnavailableWindowOrderError": { "additionalProperties": false, "description": "Error response returned when Unavailable_Till is not earlier than Unavailable_From.", "properties": { "code": { "description": "Represents the error code returned for the failed request.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details providing validation context for the error.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field whose value causes the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "dependee", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the failure.", "enum": [ "Unavailable Till must be lesser than Unavailable From" ], "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Unavailable Window Order Error", "type": "object", "x-zs-$id": "UnavailableWindowOrderError" }, "UnenrollPropertiesNested": { "additionalProperties": false, "description": "Represents the unenrollment condition configuration for a Cadence.", "properties": { "details": { "description": "Represents the additional details for the unenrollment condition.", "type": [ "object", "null" ] }, "type": { "description": "Represents the type of unenrollment condition for the Cadence.\nPossible values:\nautomatic_unenroll - Unenroll records automatically based on the configured condition.\nend_date - Unenroll records when the specified end date is reached.\ncriteria - Unenroll records that meet the specified criteria.\nfollowup_criteria - Unenroll records based on follow-up criteria.", "enum": [ "automatic_unenroll", "end_date", "criteria", "followup_criteria" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "UnsavedCustomFieldDetails": { "additionalProperties": false, "description": "Represents the details of a custom field that could not be saved during the operation.", "properties": { "field_label": { "description": "Represents the display name of the custom field that could not be saved.", "maxLength": 100, "type": "string" } }, "title": "Unsaved Custom Field Details", "type": "object" }, "UnsubscribeLinkActionStatus": { "additionalProperties": false, "description": "Status of an unsubscribe link operation, including the outcome code, message, status, and the affected entity reference.", "properties": { "code": { "description": "The result code (SUCCESS or error code)", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/ActionEntityReference" }, "message": { "description": "Represents the message describing the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the operation (success or error)", "maxLength": 255, "type": "string" } }, "title": "Unsubscribe Link Action Status", "type": "object" }, "UnsubscribeLinkAssociatedPlace": { "additionalProperties": false, "description": "A place where the unsubscribe link is associated, including the linked resource, module details, and association type.", "properties": { "details": { "$ref": "#/components/schemas/UnsubscribeLinkAssociationDetails" }, "resource": { "$ref": "#/components/schemas/UnsubscribeLinkAssociationResource" }, "type": { "description": "The type of associated place (e.g., email_templates)", "maxLength": 255, "type": "string" } }, "required": [ "details", "resource", "type" ], "title": "Unsubscribe Link Associated Place", "type": "object" }, "UnsubscribeLinkAssociationDetails": { "additionalProperties": false, "description": "Additional details for an unsubscribe link association, including the associated module context.", "properties": { "module": { "$ref": "#/components/schemas/UnsubscribeLinkAssociationResourceModule" } }, "required": [ "module" ], "title": "Unsubscribe Link Association Details", "type": "object" }, "UnsubscribeLinkAssociationRecord": { "additionalProperties": false, "description": "Association record that groups the associated places under a specific unsubscribe link ID.", "properties": { "associated_places": { "description": "List of places where this unsubscribe link is being used", "items": { "$ref": "#/components/schemas/UnsubscribeLinkAssociatedPlace" }, "maxItems": 1, "type": "array" }, "id": { "$ref": "#/components/schemas/UnsubscribeLinkId", "description": "The unique identifier of the unsubscribe link" } }, "required": [ "associated_places", "id" ], "title": "Unsubscribe Link Association Record", "type": "object" }, "UnsubscribeLinkAssociationResource": { "additionalProperties": false, "description": "Represents the resource associated with an unsubscribe link, including its name and unique identifier.", "properties": { "id": { "description": "The unique identifier of the associated resource", "maxLength": 19, "type": "string", "x-zs-$id": "UnsubscribeLinkAssociationResourceId" }, "name": { "description": "The name of the associated resource", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "title": "Unsubscribe Link Association Resource", "type": "object" }, "UnsubscribeLinkAssociationResourceModule": { "additionalProperties": false, "description": "Represents the module information associated with an unsubscribe link, including the module API name and ID.", "properties": { "api_name": { "description": "Represents the API name of the CRM module associated with the unsubscribe link.", "maxLength": 255, "type": "string", "x-zs-$id": "UnsubscribeLinkAssociationResourceModuleApiName" }, "id": { "description": "Represents the unique identifier of the CRM module associated with the unsubscribe link.", "maxLength": 19, "type": "string", "x-zs-$id": "UnsubscribeLinkAssociationResourceModuleId" } }, "required": [ "api_name", "id" ], "title": "Unsubscribe Link Association Module", "type": "object" }, "UnsubscribeLinkBaseFields": { "additionalProperties": true, "description": "Represents the base fields for unsubscribe link configuration", "properties": { "custom_location_url": { "description": "Represents the custom webpage URL for hosting the unsubscribe link. Required when page_type is custom. Required when page_type is custom. Required when page_type is custom.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the unsubscribe link", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUnsubscribeLinkById", "propertyId": "UnsubscribeLinkId" } ], "resource": "unsubscribe_links" } }, "name": { "description": "Represents the unique name for the unsubscribe link", "maxLength": 255, "type": "string" }, "page_type": { "description": "Specifies where the unsubscribe page is hosted: standard (Zoho CRM page) or custom (your own webpage)", "maxLength": 255, "type": "string" }, "standard_page_message": { "description": "The message displayed on the standard unsubscribe page. Can be rich text (HTML) or plain text.", "maxLength": 2000, "type": "string" }, "submission_action_type": { "description": "The action after unsubscribe: display_message (show a message) or redirect (redirect to a URL)", "maxLength": 255, "type": "string" }, "submission_message": { "description": "Represents the message displayed when the user clicks the unsubscribe button. Required when submission_action_type is display_message. unsubscribe button. Required when submission_action_type is display_message.", "maxLength": 2000, "type": "string" }, "submission_redirect_url": { "description": "Represents the URL to redirect users to after unsubscribing. Required when submission_action_type is redirect. Required when submission_action_type is redirect.", "maxLength": 255, "type": "string" } }, "title": "Unsubscribe Link Base Fields", "type": "object" }, "UnsubscribeLinkBulkUpdateItem": { "allOf": [ { "$ref": "#/components/schemas/UnsubscribeLinkBaseFields" }, { "additionalProperties": true, "description": "Required fields for bulk update operation. The id field is mandatory to identify which link to update.", "required": [ "id" ], "type": "object" } ], "description": "Represents the fields required for a bulk update of unsubscribe links. The **id** field is mandatory for each update entry.", "title": "Unsubscribe Link Bulk Update Item" }, "UnsubscribeLinkCreateItem": { "allOf": [ { "$ref": "#/components/schemas/UnsubscribeLinkBaseFields" }, { "additionalProperties": true, "description": "Required fields for creating an unsubscribe link", "required": [ "name", "page_type", "submission_action_type" ], "type": "object" } ], "description": "Represents the fields required to create an unsubscribe link. The **name**, **page_type**, and **submission_action_type** fields are mandatory.", "title": "Unsubscribe Link Create Item" }, "UnsubscribeLinkCreatedByUser": { "additionalProperties": false, "description": "User who created the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "id": { "description": "Represents the unique identifier of the user who created the unsubscribe link unsubscribe link", "maxLength": 19, "type": "string", "x-zs-$id": "UnsubscribeLinksCreatedById" }, "name": { "description": "Represents the name of the user who created the unsubscribe link", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "title": "Unsubscribe Link Created By User", "type": [ "object", "null" ] }, "UnsubscribeLinkDetailRecord": { "additionalProperties": false, "description": "Full unsubscribe link configuration including display messages, submission behavior, audit information, and creator or modifier details.", "properties": { "created_by": { "$ref": "#/components/schemas/UnsubscribeLinkCreatedByUser" }, "created_time": { "description": "The date and time when the unsubscribe link was created", "maxLength": 255, "type": "string" }, "custom_location_url": { "description": "The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard.", "type": "null" }, "id": { "$ref": "#/components/schemas/UnsubscribeLinkId", "description": "The unique identifier of the unsubscribe link" }, "modified_by": { "$ref": "#/components/schemas/UnsubscribeLinkModifiedByUser" }, "modified_time": { "description": "The date and time when the unsubscribe link was last modified", "maxLength": 255, "type": "string" }, "name": { "description": "The unique name of the unsubscribe link", "maxLength": 255, "type": "string" }, "page_type": { "description": "Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom)", "maxLength": 255, "type": "string" }, "standard_page_message": { "description": "The message displayed on the standard unsubscribe page", "maxLength": 2000, "type": "string" }, "submission_action_type": { "description": "The action performed after unsubscribe: display_message (show a message) or redirect (redirect to a URL)", "maxLength": 255, "type": "string" }, "submission_message": { "description": "The message displayed when the user clicks the unsubscribe button (for display_message action type)", "maxLength": 2000, "type": "string" }, "submission_redirect_url": { "description": "The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured.", "type": "null" } }, "required": [ "created_by", "created_time", "custom_location_url", "id", "modified_by", "modified_time", "name", "page_type", "standard_page_message", "submission_action_type", "submission_message", "submission_redirect_url" ], "title": "Unsubscribe Link Detail Record", "type": "object" }, "UnsubscribeLinkId": { "description": "Represents the unique identifier for an unsubscribe link.", "maxLength": 19, "type": "string", "x-zs-$id": "UnsubscribeLinkId" }, "UnsubscribeLinkModificationByIdRequest": { "additionalProperties": false, "description": "Request payload to update an unsubscribe link identified by its ID.", "properties": { "unsubscribe_links": { "description": "Array containing the unsubscribe link configuration to update (required)", "items": { "$ref": "#/components/schemas/UnsubscribeLinkSingleUpdateItem" }, "maxItems": 1, "type": "array" } }, "required": [ "unsubscribe_links" ], "title": "Unsubscribe Link Modification By Id Request", "type": "object" }, "UnsubscribeLinkModificationResultList": { "additionalProperties": false, "description": "Collection of action status objects produced after modifying unsubscribe links via PUT requests.", "properties": { "unsubscribe_links": { "description": "Array containing the status of the modification operation for each link", "items": { "$ref": "#/components/schemas/UnsubscribeLinkActionStatus" }, "maxItems": 1, "type": "array" } }, "title": "Unsubscribe Link Modification Result List", "type": "object", "x-zs-$id": "PutunsubscribelinksResponse200" }, "UnsubscribeLinkModifiedByUser": { "additionalProperties": false, "description": "User who last modified the unsubscribe link, including the user name and ID. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified the unsubscribe link unsubscribe link", "maxLength": 19, "type": "string", "x-zs-$id": "UnsubscribeLinksModifiedById" }, "name": { "description": "Represents the name of the user who last modified the unsubscribe link link", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "title": "Unsubscribe Link Modified By User", "type": [ "object", "null" ] }, "UnsubscribeLinkRemovalResultList": { "additionalProperties": false, "description": "Collection of action status objects produced after deleting unsubscribe links via DELETE requests.", "properties": { "unsubscribe_links": { "description": "Array containing the status of the delete operation for each link", "items": { "$ref": "#/components/schemas/UnsubscribeLinkActionStatus" }, "maxItems": 1, "type": "array" } }, "title": "Unsubscribe Link Removal Result List", "type": "object", "x-zs-$id": "Delete111111000000115722Response200" }, "UnsubscribeLinkSingleUpdateItem": { "allOf": [ { "$ref": "#/components/schemas/UnsubscribeLinkBaseFields" }, { "additionalProperties": true, "description": "Required fields for updating a single unsubscribe link. The id field is mandatory to identify which link to update.", "required": [ "id" ], "type": "object" } ], "description": "Represents the fields required to update a single unsubscribe link. The **id** field in the request body must match the ID in the path.", "title": "Unsubscribe Link Single Update Item" }, "UnsubscribeLinkSummaryRecord": { "additionalProperties": false, "description": "Summarized unsubscribe link configuration with timestamps, page settings, submission behavior, and creator or modifier references as returned by the listing endpoint.", "properties": { "created_by": { "$ref": "#/components/schemas/UnsubscribeLinkCreatedByUser" }, "created_time": { "description": "The date and time when the unsubscribe link was created", "maxLength": 255, "type": "string" }, "custom_location_url": { "description": "The custom webpage URL where the unsubscribe link is hosted. Null if page_type is standard.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "$ref": "#/components/schemas/UnsubscribeLinkId", "description": "The unique identifier of the unsubscribe link" }, "modified_by": { "$ref": "#/components/schemas/UnsubscribeLinkModifiedByUser" }, "modified_time": { "description": "The date and time when the unsubscribe link was last modified", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the unique name of the unsubscribe link", "maxLength": 255, "type": "string" }, "page_type": { "description": "Indicates whether the unsubscribe page is hosted on Zoho's standard page (standard) or a custom webpage (custom)", "maxLength": 255, "type": [ "string", "null" ] }, "standard_page_message": { "description": "Represents the message displayed on the standard unsubscribe page. Null if page_type is custom. Null if page_type is custom.", "maxLength": 2000, "type": [ "string", "null" ] }, "submission_action_type": { "description": "Represents the action performed after unsubscribe display_message (show a message) or redirect (redirect to a URL) a message) or redirect (redirect to a URL) a message) or redirect (redirect to a URL)\"", "maxLength": 255, "type": "string" }, "submission_message": { "description": "The message displayed when the user clicks the unsubscribe button (for display_message action type). Null if not configured.", "maxLength": 2000, "type": [ "string", "null" ] }, "submission_redirect_url": { "description": "The URL to which the user is redirected after unsubscribing (for redirect action type). Null if not configured.", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "created_by", "created_time", "custom_location_url", "id", "modified_by", "modified_time", "name", "page_type", "standard_page_message", "submission_action_type", "submission_message", "submission_redirect_url" ], "title": "Unsubscribe Link Summary Record", "type": "object" }, "UnsubscribeLinksDependentFieldMissingError": { "additionalProperties": false, "description": "Error returned when a required dependent field is missing. For example, custom_location_url is required when page_type is custom, or submission_redirect_url is required when submission_action_type is redirect.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the dependent field error.", "properties": { "api_name": { "description": "The API name of the missing field", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The field that depends on the missing field", "properties": { "api_name": { "description": "The API name of the dependee field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the dependee field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "The JSON path of the missing field", "maxLength": 1000, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing dependency.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Dependent Field Missing Error", "type": "object", "x-zs-$id": "DependentFieldMissingError" }, "UnsubscribeLinksDuplicateDataError": { "additionalProperties": false, "description": "Error returned when attempting to create an unsubscribe link with a name that already exists in your account.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the duplicate data error.", "properties": { "api_name": { "description": "The API name of the field with duplicate data", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the field with duplicate data", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the duplicate data issue.", "enum": [ "Unsubscribe Link name already exists" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Duplicate Data Error", "type": "object", "x-zs-$id": "DuplicateDataError" }, "UnsubscribeLinksInvalidDataTypeError": { "additionalProperties": false, "description": "Error returned when the data type provided for a field does not match the expected type.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the invalid data type error.", "properties": { "api_name": { "description": "The API name of the invalid field", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the invalid field", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "The maximum allowed length for this field", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data type issue.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Type Error", "type": "object", "x-zs-$id": "InvalidDataTypeError" }, "UnsubscribeLinksMandatoryFieldMissingError": { "additionalProperties": false, "description": "Error returned when a required mandatory field is missing from the request.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the missing mandatory field error.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing mandatory field", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing mandatory field.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Mandatory Field Missing Error", "type": "object", "x-zs-$id": "MandatoryFieldMissingError" }, "UnsubscribeLinksPermissionDeniedError": { "additionalProperties": false, "description": "Error returned when the OAuth token does not have the required scope to perform the operation.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the permission denied error.", "properties": { "permissions": { "description": "The list of required permissions", "items": { "description": "Represents a required permission for this operation.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission denied issue.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Permission Denied Error", "type": "object", "x-zs-$id": "PermissionDeniedError" }, "UnsubscribeLinksResponse": { "additionalProperties": false, "description": "Response envelope containing a collection of unsubscribe link records returned by the settings listing endpoint.", "properties": { "unsubscribe_links": { "description": "Array of unsubscribe link summary records", "items": { "$ref": "#/components/schemas/UnsubscribeLinkSummaryRecord" }, "maxItems": 10, "type": "array" } }, "required": [ "unsubscribe_links" ], "title": "Unsubscribe Link List Response", "type": "object", "x-zs-$id": "GetunsubscribelinksResponse200" }, "UnsupportedKeyNotAllowedError": { "additionalProperties": false, "description": "Returned when the request contains keys that are not supported for the selected field update configuration.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "API name of the field that is not supported for this action.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field in the request body.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "This key is not supported for this particular action", "The given module is not supported", "Field cannot be updated" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Unsupported Key Not Allowed Error", "type": "object", "x-zs-$id": "UnsupportedKeyNotAllowedError", "x-zs-llm-description": "The request contains keys not supported for this field update type. Remove unsupported keys based on the selected field type." }, "UnsupportedMergeFieldErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when a merge-field token in the webhook configuration references a field that is not supported for the module or context.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - The request contains an unsupported merge field or a restricted parameter name.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field that contains the unsupported merge field or restricted parameter name.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that triggered the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Unsupported fields are present** - The request contains merge fields that are not supported for this operation.\n**restricted parameter name found** - A parameter name in the request is reserved and cannot be used.", "enum": [ "Unsupported fields are present", "restricted parameter name found" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Unsupported Merge Field Error Response", "type": "object", "x-zs-$id": "UnsupportedMergeFieldErrorResponse", "x-zs-llm-description": "A merge field in the webhook configuration is not supported for this module/field type." }, "UnsupportedModule": { "additionalProperties": false, "description": "Represents the error response returned when the module specified in the request URL is not supported by the share records API.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "resource_path_index": { "description": "Represents the index of the URL path segment that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UnsupportedModule" }, "UnsupportedPageTypeError": { "additionalProperties": false, "description": "Error returned when an unsupported value is provided for the page_type field. Supported values are 'standard' and 'custom'.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional validation information about the unsupported value error.", "properties": { "api_name": { "description": "The API name of the field with the unsupported value", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path of the field with the unsupported value", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "The list of supported values for this field", "items": { "description": "Represents a supported value for the field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported value issue.", "enum": [ "the given module is not supported in create or update" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Unsubscribe Link Page Type Unsupported Error", "type": "object", "x-zs-$id": "ErrorResponseCore1572491218" }, "UpdateFieldUpdateLockedActionPermissionError": { "additionalProperties": false, "description": "Returned when the target field update is locked and the user lacks privilege to modify it.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "resource_path_index": { "description": "Index of the resource path used in the request.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "example": "Insufficient privileges to edit locked action", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Update Field Update Locked Action Permission Error", "type": "object", "x-zs-$id": "UpdateFieldUpdateLockedActionPermissionError", "x-zs-llm-description": "The field update is locked and the user lacks permission to modify it. Unlock via parent automation or use a higher-privilege account." }, "UpdateFieldUpdateMissingPathIdError": { "additionalProperties": false, "description": "Returned when the field update ID path segment is missing in the update request URL.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the missing path segment", "properties": { "resource_path_index": { "description": "Index of the missing resource path segment.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "example": "One of the expected parameter is missing", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Update Field Update Missing Path Id Error", "type": "object", "x-zs-$id": "UpdateFieldUpdateMissingPathIdError", "x-zs-llm-description": "The field update ID is missing from the PUT request URL path. Include /{id} in the URL." }, "UpdateFieldUpdateReadOnlyActionError": { "additionalProperties": false, "description": "Returned when attempting to edit a read-only field update action.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "resource_path_index": { "description": "Index of the resource path used in the request.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "example": "Insufficient privileges to edit action", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Update Field Update Read Only Action Error", "type": "object", "x-zs-$id": "UpdateFieldUpdateReadOnlyActionError", "x-zs-llm-description": "Cannot edit a read-only field update action. These are system-managed." }, "UpdateFieldUpdateSuccessResponse": { "additionalProperties": false, "description": "Success response payload returned after a field update action is modified.", "properties": { "field_updates": { "description": "Array containing the updated field update action. Contains exactly one item.", "items": { "$ref": "#/components/schemas/FieldUpdateActionResult" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateFieldUpdateSuccessResponse", "x-zs-llm-description": "Confirms the PUT update succeeded. Contains the updated field update action ID." }, "UpdateFiscalYearResponse": { "additionalProperties": false, "description": "Represents the response body for a successful fiscal year settings update.", "properties": { "fiscal_year": { "$ref": "#/components/schemas/FiscalYearNested1" } }, "required": [ "fiscal_year" ], "type": "object", "x-zs-$id": "UpdateFiscalYearResponse" }, "UpdateLayoutErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned for layout update operations that fail, containing either a wrapped per-layout error array or a top-level error code and message.", "properties": { "code": { "description": "Represents the error classification code returned for layout update failures that are not wrapped in a layout-specific error array.", "example": "REQUIRED_PARAM_MISSING", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/LayoutsErrorDetails" }, "layouts": { "description": "Contains the array of layout-specific error results for batch layout update operations that encountered failures.", "items": { "$ref": "#/components/schemas/LayoutUpdateErrorResult" }, "maxItems": 1, "minItems": 1, "type": "array" }, "message": { "description": "Contains a descriptive explanation of the layout update error that occurred.", "example": "One of the expected parameter is missing", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the outcome of the layout update operation. Possible values: `error` — the operation did not complete successfully.", "enum": [ "error" ], "example": "error", "type": "string" } }, "type": "object", "x-zs-$id": "UpdateLayoutErrorResponse" }, "UpdateLayoutRequest": { "additionalProperties": false, "description": "Represents the request body for updating a layout, containing exactly one layout object with the configuration changes to apply.", "properties": { "layouts": { "description": "Contains exactly one layout object defining the update operations to be applied, including sections, profiles, and display settings.", "items": { "$ref": "#/components/schemas/LayoutUpdateObject" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object" }, "UpdateLayoutSuccessResponse": { "additionalProperties": false, "description": "Represents the successful response returned when a layout update operation completes, containing the per-layout update results.", "properties": { "layouts": { "description": "Contains the array of result entries for the layout update operation, each reporting the outcome for an individual layout.", "items": { "$ref": "#/components/schemas/LayoutUpdateSuccessResult" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "UpdateLayoutSuccessResponse" }, "UpdateProfileChildPermissionParentDisabledErrorResponse": { "additionalProperties": false, "description": "Error body returned when a child permission is enabled while its parent permission is disabled.", "properties": { "profiles": { "description": "Per-profile INVALID_DATA errors indicating a child-parent permission rule violation.", "items": { "additionalProperties": false, "description": "INVALID_DATA error entry indicating a child permission cannot be enabled because its parent is disabled.", "properties": { "code": { "description": "Error code indicating invalid permission state. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the permission ID that violates the parent-child rule.", "properties": { "api_name": { "description": "API name of the field containing the child permission ID. Possible values: `id`.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "JSONPath to the permission id in the request payload.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable description explaining that the parent permission must be enabled first.", "enum": [ "Child permission can not be enabled, since its parent permission is disabled" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfileChildPermissionParentDisabledErrorResponse" }, "UpdateProfileDuplicateDataErrorResponse": { "additionalProperties": false, "description": "Error body returned when the updated profile name is already in use by another profile.", "properties": { "profiles": { "description": "Per-profile DUPLICATE_DATA errors from the update request.", "items": { "additionalProperties": false, "description": "DUPLICATE_DATA error entry for one profile in the update request.", "properties": { "code": { "description": "Error code indicating duplicate profile name data. Possible values: `DUPLICATE_DATA`.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the duplicated field and the ID of the conflicting profile.", "properties": { "api_name": { "description": "API name of the field that contains duplicate data.", "maxLength": 255, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath to the duplicate field in the request payload.", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable description of the duplicate data error.", "enum": [ "duplicate data" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfileDuplicateDataErrorResponse" }, "UpdateProfileInvalidActionErrorResponse": { "additionalProperties": false, "description": "Error body returned when the action given in the update profile request is invalid.", "properties": { "profiles": { "description": "Per-profile INVALID_DATA errors from the update request.", "items": { "additionalProperties": false, "description": "INVALID_DATA error entry indicating the action is invalid.", "properties": { "code": { "description": "Error code indicating an invalid action. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object returned for the invalid action error.", "maxProperties": 0, "type": "object" }, "message": { "description": "Human-readable description of the invalid action error.", "enum": [ "The action given is invalid" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfileInvalidActionErrorResponse" }, "UpdateProfileInvalidIdErrorResponse": { "additionalProperties": false, "description": "Error body returned when the profile ID in the update request path is invalid or refers to a deleted profile.", "properties": { "code": { "description": "Error code indicating an invalid profile ID. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the path segment containing the invalid ID.", "properties": { "resource_path_index": { "description": "Zero-based index of the URL path segment that contains the invalid profile ID.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable description of the invalid ID error.", "enum": [ "the id given seems to be invalid or already deleted" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateProfileInvalidIdErrorResponse" }, "UpdateProfileInvalidPermissionIdErrorResponse": { "additionalProperties": false, "description": "Error body returned when a permission ID in `profiles[].permissions_details` is not valid.", "properties": { "profiles": { "description": "Per-profile INVALID_DATA errors identifying the invalid permission ID.", "items": { "additionalProperties": false, "description": "INVALID_DATA error entry for an invalid permission ID.", "properties": { "code": { "description": "Error code indicating an invalid permission ID. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the permission ID field that failed validation.", "properties": { "api_name": { "description": "API name of the field containing the invalid permission ID. Possible values: `id`.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "JSONPath to the invalid permission ID in the request payload.", "enum": [ "$.profiles[0].permissions_details[0].id" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable error message. v8 returns \"Invalid permission ID\"; v9 returns \"the id given seems to be invalid or already deleted\".", "enum": [ "the id given seems to be invalid or already deleted", "Invalid permission ID" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfileInvalidPermissionIdErrorResponse" }, "UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse": { "additionalProperties": false, "description": "Error body returned when `permissions_details` in the update request is of an unexpected data type.", "properties": { "profiles": { "description": "Per-profile errors for the update request.", "items": { "additionalProperties": false, "description": "Per-profile INVALID_DATA error indicating permissions_details has an unexpected datatype.", "properties": { "code": { "description": "Error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the datatype mismatch.", "properties": { "api_name": { "description": "API name of the field with datatype mismatch.", "enum": [ "permissions_details" ], "type": "string" }, "expected_data_type": { "description": "Expected datatype for the field.", "enum": [ "jsonobject", "jsonarray" ], "type": "string" }, "json_path": { "description": "JSONPath to the field with datatype mismatch.", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "expected_data_type", "api_name" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse" }, "UpdateProfileInvalidProfileNameSpecialCharsErrorResponse": { "additionalProperties": false, "description": "Error body returned when the profile name in the update request contains disallowed special characters.", "properties": { "profiles": { "description": "Per-profile INVALID_DATA errors pointing to the invalid `name` value in the update request.", "items": { "additionalProperties": false, "description": "INVALID_DATA error entry for an invalid profile name value.", "properties": { "code": { "description": "Error code indicating invalid profile name data. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the invalid `name` field in the update request.", "properties": { "api_name": { "description": "API name of the field that contains an invalid value.", "maxLength": 255, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath to the invalid field in the update request.", "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable description of the invalid profile name characters error.", "enum": [ "Profile name should not contain the following special character(s) : #, %, &, (, ), *, ^" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfileInvalidProfileNameSpecialCharsErrorResponse" }, "UpdateProfilePermissionNotAllowedErrorResponse": { "additionalProperties": false, "description": "Error body returned when a permission ID in `permissions_details` cannot be updated.", "properties": { "profiles": { "description": "Per-permission NOT_ALLOWED errors from the update request.", "items": { "additionalProperties": false, "description": "NOT_ALLOWED error entry indicating a specific permission ID is not updatable.", "properties": { "code": { "description": "Error code indicating the permission cannot be updated. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the permission ID that cannot be updated.", "properties": { "api_name": { "description": "API name of the field containing the non-updatable permission ID. Possible values: `id`.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "JSONPath to the field in the request payload.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable description of why this permission ID cannot be updated.", "enum": [ "This Permissionid cannot be updated" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfilePermissionNotAllowedErrorResponse" }, "UpdateProfilePermissionNotCustomizableErrorResponse": { "additionalProperties": false, "description": "Error body returned when a permission in `permissions_details` cannot be customized.", "properties": { "profiles": { "description": "Per-profile INVALID_DATA errors indicating a non-customizable permission.", "items": { "additionalProperties": false, "description": "INVALID_DATA error entry indicating the permission is not customizable.", "properties": { "code": { "description": "Error code indicating invalid data for a non-customizable permission. Possible values: `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the non-customizable permission ID field.", "properties": { "api_name": { "description": "API name of the field containing the non-customizable permission. Possible values: `id`.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "JSONPath to the permission id in the request payload.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable description of the non-customizable permission error.", "enum": [ "Permission is not customizable" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfilePermissionNotCustomizableErrorResponse" }, "UpdateProfilePrivateProfileNotAllowedErrorResponse": { "additionalProperties": false, "description": "Error body returned when attempting to update a `private_profile`, which is used exclusively for team modules and cannot be updated through this endpoint.", "properties": { "code": { "description": "Error code indicating the update operation is not allowed. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the path segment containing the private profile ID.", "properties": { "resource_path_index": { "description": "Zero-based index of the URL path segment that contains the private profile ID.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable description of why the team module profile cannot be updated.", "enum": [ "Team Module profile cannot be updated" ], "type": "string" }, "status": { "description": "The status of the response.\n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateProfilePrivateProfileNotAllowedErrorResponse" }, "UpdateProfileSystemProfileNotAllowedErrorResponse": { "additionalProperties": false, "description": "Error body returned when attempting to update a built-in system profile, which is not permitted.", "properties": { "code": { "description": "Error code indicating the update operation is not allowed. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object identifying the path segment containing the system profile ID.", "properties": { "resource_path_index": { "description": "Zero-based index of the URL path segment that contains the system profile ID.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable description of why the system profile cannot be updated.", "enum": [ "System profile cannot be updated" ], "type": "string" }, "status": { "description": "The status of the response. \n**Possible values:**\n**error**", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateProfileSystemProfileNotAllowedErrorResponse" }, "UpdateScoringRulesByIDRequestBody": { "additionalProperties": false, "description": "Represents the request body schema for bulk update Scoring Rules operations.", "properties": { "scoring_rules": { "description": "Represents an array of Scoring Rule update objects. Required for PUT operations.", "items": { "$ref": "#/components/schemas/ScoringRulePUT" }, "maxItems": 10, "type": "array" } }, "required": [ "scoring_rules" ], "title": "Update Scoring Rules By ID Request Body", "type": "object", "x-zs-$id": "UpdateScoringRulesByIDRequestBody" }, "UpdateScoringRulesRequestBody": { "additionalProperties": false, "description": "Request body for updating multiple scoring rules.", "properties": { "scoring_rules": { "description": "Array of scoring rule update objects (Required)", "items": { "$ref": "#/components/schemas/ScoringRulePUT" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "scoring_rules" ], "title": "Update Scoring Rules Request Body", "type": "object", "x-zs-$id": "UpdateScoringRulesRequestBody" }, "UpdateTaskSuccessResponse": { "additionalProperties": false, "description": "Success response for updating an automation task. Contains the updated task ID.", "properties": { "tasks": { "description": "Array containing exactly one result for the updated task.", "items": { "$ref": "#/components/schemas/TaskActionResult" }, "maxItems": 1, "type": "array" } }, "required": [ "tasks" ], "title": "Update Task Success Response", "type": "object", "x-zs-$id": "UpdateTaskSuccessResponse", "x-zs-llm-description": "Confirms the PUT update succeeded. Contains the updated task ID in the result details." }, "UpdateUnsubscribeLinksRequest": { "additionalProperties": false, "description": "Request payload for bulk PUT requests to update unsubscribe link configurations.", "properties": { "unsubscribe_links": { "description": "Root key containing the unsubscribe links to update (required)", "items": { "$ref": "#/components/schemas/UnsubscribeLinkBulkUpdateItem" }, "maxItems": 1, "type": "array" } }, "required": [ "unsubscribe_links" ], "title": "Update Unsubscribe Links Request", "type": "object" }, "UpdateUnsubscribeLinksSuccessResponse": { "additionalProperties": false, "description": "Success response for a PUT request that returns the action status of each updated unsubscribe link.", "properties": { "unsubscribe_links": { "description": "Array containing the status of the update operation for each link", "items": { "$ref": "#/components/schemas/UnsubscribeLinkActionStatus" }, "maxItems": 1, "type": "array" } }, "title": "Update Unsubscribe Links Success Response", "type": "object", "x-zs-$id": "UpdateUnsubscribeLinksSuccessResponse" }, "UpdateWebhookRequest": { "additionalProperties": false, "description": "Represents the request body wrapper for updating a webhook. The webhooks array must contain exactly one webhook object.", "properties": { "webhooks": { "description": "Represents the list containing exactly one webhook object with the full replacement configuration.", "items": { "$ref": "#/components/schemas/WebhookUpdateInput" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "UpdateWebhookRequest", "x-zs-llm-description": "Top-level request envelope for updating a webhook by ID; must include a webhooks array holding exactly one webhook object." }, "UpdateWebhookSuccessResponse": { "additionalProperties": false, "description": "Represents the success response for a webhook update operation, including the operation result and the updated webhook ID.", "properties": { "webhooks": { "description": "Represents the list containing the operation result for the updated webhook.", "items": { "$ref": "#/components/schemas/WebhookStatusResponse" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateWebhookSuccessResponse", "x-zs-llm-description": "Confirms the PUT update succeeded. Contains the updated webhook ID." }, "UpdateWorkflowRuleSchema": { "additionalProperties": false, "description": "Represents the request body wrapper for updating an existing workflow rule. Contains a single-element array with the updated rule configuration.", "properties": { "workflow_rules": { "description": "The request body must contain a **workflow_rules** array with one object.", "items": { "$ref": "#/components/schemas/WorkflowRulePutNestedSchema" }, "maxItems": 1, "type": "array" } }, "required": [ "workflow_rules" ], "type": "object", "x-zs-llm-description": "Top-level request body for PUT /settings/automation/workflow_rules (bulk update). Contains workflow_rules array with exactly 1 rule object that must include its id for identification." }, "UpsertRelationsRequest": { "additionalProperties": false, "description": "Represents the request body for adding or updating contact role relations on a deal.", "properties": { "data": { "description": "List of contact role relations to upsert", "items": { "additionalProperties": false, "description": "Contact role relation definition", "properties": { "Contact_Role": { "additionalProperties": false, "description": "Contact role to associate with the relation", "properties": { "id": { "description": "Contact role identifier", "format": "int64", "type": "string" }, "name": { "description": "Contact role display name", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "id": { "description": "Identifier of the contact relation for the deal", "format": "int64", "type": "string" } }, "required": [ "Contact_Role", "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" }, "UpsertRelationsSuccessResponse": { "additionalProperties": false, "description": "Represents the response body of a successfully added after adding or updating contact role relations.", "properties": { "data": { "description": "Status entries for each processed relation", "items": { "additionalProperties": false, "description": "Result for processing a single relation", "properties": { "code": { "const": "SUCCESS", "description": "Operation status code", "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the processed relation", "properties": { "id": { "description": "Identifier of the processed relation", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Result message describing the action performed", "enum": [ "relation updated", "relation added" ], "type": "string" }, "status": { "const": "success", "description": "Operation status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UpsertRelationsSuccessResponse" }, "UrlErrorResponseForCustomView": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewsUnableToParseDataTypeError", "description": "Data type could not be parsed from the request" }, { "$ref": "#/components/schemas/CustomViewsInvalidUrlPatternError", "description": "Request URL does not match any known pattern" }, { "$ref": "#/components/schemas/CustomViewsInvalidModuleError", "description": "The specified module is invalid or does not exist" } ], "description": "Represents the URL-level error responses for Custom View operations, covering data type parse failures, invalid URL patterns, and invalid module errors.", "x-zs-$id": "UrlErrorResponseForCustomView" }, "UrlIdMissingSchema": { "additionalProperties": false, "description": "Represents the error response returned when the workflow rule ID provided in the URL path is invalid or does not match an existing record.", "properties": { "code": { "description": "Represents the error code that identifies the specific error condition.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the failed request.", "properties": { "resource_path_index": { "description": "Represents the **resource_path_index** value from the error detail object.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "the id given seems to be invalid", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for the error, typically **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "WorkflowRuleUrlIdMissingErrorResponses", "x-zs-llm-description": "Error codes: INVALID_DATA or NOT_ALLOWED. Returned for path-parameter validation failures. INVALID_DATA: the ID in the URL path is malformed or does not exist. NOT_ALLOWED: operation not permitted on the specified resource (e.g., deleting a locked rule). Fix: verify the rule ID exists via getWorkflowRules before using it in path." }, "User": { "additionalProperties": false, "description": "Represents a user record in Zoho CRM, including personal details, role, profile, and related information.", "properties": { "$current_shift": { "description": "Represents the user's current shift assignment.", "type": [ "object", "null" ] }, "$next_shift": { "description": "Represents the user's next upcoming shift assignment.", "type": [ "object", "null" ] }, "$shift_effective_from": { "description": "Represents the date from which the user's shift becomes effective.", "type": [ "object", "null" ] }, "Isonline": { "description": "Indicates whether the user is currently online.", "type": "boolean" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified this user record.", "properties": { "id": { "description": "Represents the unique ID of the modifier.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the full name of the modifier.", "maxLength": 200, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Modified_Time": { "description": "Represents the date and time when the user account was last modified.", "format": "date-time", "type": "string" }, "alias": { "description": "Represents the user's alias.", "maxLength": 50, "type": [ "string", "null" ] }, "category": { "description": "Represents the user's category or type.", "enum": [ "regular_user", "sandbox_user", "light_user" ], "type": "string" }, "city": { "description": "Represents the user's city.", "maxLength": 100, "type": [ "string", "null" ] }, "confirm": { "description": "Indicates whether the user has confirmed their account.", "type": "boolean" }, "country": { "description": "Represents the user's country.", "maxLength": 100, "type": [ "string", "null" ] }, "country_locale": { "description": "Represents the user's country locale.", "maxLength": 50, "type": "string" }, "created_by": { "additionalProperties": false, "description": "Represents the user who created this user record.", "properties": { "id": { "description": "Represents the unique ID of the creator.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the full name of the creator.", "maxLength": 200, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "created_time": { "description": "Represents the date and time when the user account was created.", "format": "date-time", "type": "string" }, "customize_info": { "additionalProperties": false, "description": "Represents the user's customization preferences.", "properties": { "bc_view": { "description": "Represents the business card view preference.", "type": [ "object", "null" ] }, "notes_desc": { "description": "Indicates whether the notes description is visible.", "type": [ "object", "null" ] }, "show_detail_view": { "description": "Indicates whether the detail view is visible.", "type": "boolean" }, "show_home": { "description": "Indicates whether the home page is visible.", "type": "boolean" }, "show_left_panel": { "description": "Indicates whether the left panel is visible.", "type": [ "boolean", "null" ] }, "show_right_panel": { "description": "Indicates whether the right panel is visible.", "type": [ "boolean", "null" ] }, "unpin_recent_item": { "description": "Indicates whether recent items are unpinned.", "type": [ "object", "null" ] } }, "type": "object" }, "date_format": { "description": "Represents the user's preferred date format.", "maxLength": 50, "type": "string" }, "decimal_separator": { "description": "Represents the user's preferred decimal separator.", "enum": [ "Comma", "Period" ], "type": "string" }, "default_tab_group": { "description": "Represents the user's default tab group.", "maxLength": 100, "type": "string" }, "dob": { "description": "Represents the user's date of birth.", "format": "date", "type": [ "string", "null" ] }, "fax": { "description": "Represents the user's fax number.", "maxLength": 30, "type": [ "string", "null" ] }, "first_name": { "description": "Represents the user's first name.", "maxLength": 50, "type": "string" }, "full_name": { "description": "Represents the user's full name.", "maxLength": 200, "type": "string" }, "id": { "description": "Represents the unique identifier of the user.", "maxLength": 100, "type": "string" }, "language": { "description": "Represents the user's preferred language.", "maxLength": 50, "type": "string" }, "last_name": { "description": "Represents the user's last name.", "maxLength": 50, "type": [ "string", "null" ] }, "locale": { "description": "Represents the user's locale.", "maxLength": 50, "type": "string" }, "microsoft": { "description": "Indicates whether the user has Microsoft integration enabled.", "type": "boolean" }, "name_format__s": { "description": "Represents the user's preferred name format.", "enum": [ "First Name,Last Name,Salutation", "Salutation,First Name,Last Name", "First Name,Salutation,Last Name", "Last Name,Salutation,First Name", "Salutation,Last Name,First Name", "Last Name,First Name,Salutation" ], "type": "string" }, "number_separator": { "description": "Represents the user's preferred number separator.", "maxLength": 10, "type": "string" }, "offset": { "description": "Represents the time zone offset in milliseconds.", "format": "int32", "type": "integer" }, "personal_account": { "description": "Indicates whether this is a personal account.", "type": "boolean" }, "profile": { "additionalProperties": false, "description": "Represents the user's profile.", "properties": { "id": { "description": "Represents the unique ID of the user's profile.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the name of the user's profile.", "maxLength": 100, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "role": { "additionalProperties": false, "description": "Represents the user's role.", "properties": { "id": { "description": "Represents the unique ID of the user's role.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the name of the user's role.", "maxLength": 100, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "sandboxDeveloper": { "description": "Indicates whether the user is a sandbox developer.", "type": "boolean" }, "signature": { "description": "Represents the user's email signature.", "maxLength": 200, "type": [ "string", "null" ] }, "sort_order_preference__s": { "description": "Represents the user's sort order preference.", "maxLength": 50, "type": "string" }, "state": { "description": "Represents the user's state or province.", "maxLength": 100, "type": [ "string", "null" ] }, "status": { "description": "Represents the user's account status.", "enum": [ "inactive", "deleted", "rejected", "active", "closed", "disabled" ], "type": "string" }, "status_reason__s": { "description": "Represents the reason for the user's current status.", "maxLength": 100, "type": [ "string", "null" ] }, "street": { "description": "Represents the user's street address.", "maxLength": 250, "type": [ "string", "null" ] }, "theme": { "additionalProperties": false, "description": "Represents the user's UI theme preferences.", "properties": { "background": { "description": "Represents the overall background color of the theme.", "maxLength": 7, "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string" }, "new_background": { "description": "Represents the new background color of the theme.", "maxLength": 7, "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": [ "string", "null" ] }, "normal_tab": { "additionalProperties": false, "description": "Represents the normal tab theme settings.", "properties": { "background": { "description": "Represents the background color of the normal tab in hexadecimal format.", "maxLength": 7, "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string" }, "font_color": { "description": "Represents the font color of the normal tab in hexadecimal format.", "maxLength": 7, "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string" } }, "required": [ "font_color", "background" ], "type": "object" }, "screen": { "description": "Represents the screen layout preference.", "enum": [ "stretched", "fixed" ], "type": "string" }, "selected_tab": { "additionalProperties": false, "description": "Represents the selected tab theme settings.", "properties": { "background": { "description": "Represents the background color of the selected tab in hexadecimal format.", "maxLength": 7, "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string" }, "font_color": { "description": "Represents the font color of the selected tab in hexadecimal format.", "maxLength": 7, "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string" } }, "required": [ "font_color", "background" ], "type": "object" }, "type": { "description": "Represents the type of theme applied.", "enum": [ "default", "custom" ], "type": "string" } }, "required": [ "normal_tab", "selected_tab", "background", "screen", "type" ], "type": "object" }, "time_format": { "description": "Represents the user's preferred time format.", "enum": [ "HH:mm", "hh:mm a" ], "type": "string" }, "time_zone": { "description": "Represents the user's time zone.", "maxLength": 50, "type": "string" }, "website": { "description": "Represents the user's website URL.", "maxLength": 250, "pattern": "[a-z0-9]{5}[.]com", "type": [ "string", "null" ] }, "zip": { "description": "Represents the user's postal or zip code.", "maxLength": 30, "type": [ "string", "null" ] }, "zuid": { "description": "Represents the Zoho user ID.", "maxLength": 100, "type": "string" } }, "required": [ "id", "first_name", "full_name", "email", "status", "category", "profile", "role", "created_by", "created_time", "Modified_By", "Modified_Time", "language", "locale", "zuid" ], "type": "object", "x-zs-$id": "User" }, "UserDefinedParameter": { "additionalProperties": false, "description": "Represents the single user-defined key-value parameter included in webhook request payloads.", "properties": { "name": { "description": "Represents the key name of the user-defined parameter.", "maxLength": 255, "type": "string" }, "value": { "description": "Represents the value of the user-defined parameter.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-llm-description": "A single user-defined key-value parameter for webhook configuration." }, "UserDetails": { "additionalProperties": true, "description": "Represents the user details object used to create or update a Zoho CRM user, including personal information, preferences, role, profile, and account settings.", "properties": { "$current_shift": { "anyOf": [ { "additionalProperties": false, "description": "Represents the current shift object with the shift ID and display name to assign to the user.", "properties": { "id": { "description": "Specify the unique ID of the shift to assign as the current shift.", "maxLength": 19, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getShifts", "propertyId": "ShiftsId" } ], "resource": "shift_hours" } }, "name": { "description": "Specify the display name of the shift to assign as the current shift.", "maxLength": 80, "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-zs-$id": "CurrentShiftDetials" }, { "description": "Indicates that no current shift is assigned to the user.", "type": "null", "x-zs-$id": "NoCurrentShiftUpdate" } ], "description": "Specify the current shift assigned to the user. Set to null to clear the assigned shift." }, "$next_shift": { "anyOf": [ { "additionalProperties": false, "description": "Represents the upcoming shift object with the shift ID and display name to assign to the user.", "properties": { "id": { "description": "Specify the unique ID of the shift to assign as the upcoming shift.", "format": "int64", "maxLength": 100, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getShifts", "propertyId": "ShiftsId" } ], "resource": "shift_hours" } }, "name": { "description": "Specify the display name of the shift to assign as the upcoming shift.", "maxLength": 80, "type": "string" } }, "required": [ "id", "name" ], "type": "object", "x-zs-$id": "NextShiftDetails" }, { "description": "Indicates that no upcoming shift is assigned to the user.", "type": "null", "x-zs-$id": "NoNextShiftDetails" } ], "description": "Specify the upcoming shift to be assigned to the user. Set to null to clear the upcoming shift." }, "$shift_effective_from": { "anyOf": [ { "description": "Represents the date on which the upcoming shift assignment becomes effective.", "format": "date", "pattern": "([0-9]{4})-([0-9]{2})-([0-9]{2})", "type": "string", "x-zs-$id": "NextShiftEffectiveFromDateUpdate" }, { "description": "Indicates that no upcoming shift effective date is set.", "type": "null", "x-zs-$id": "NoNextShiftEffectiveFromDateUpdate" } ], "description": "Specify the date on which the upcoming shift assignment becomes effective." }, "Reporting_To": { "anyOf": [ { "additionalProperties": false, "description": "Represents the reporting manager object with the manager user ID and name.", "properties": { "id": { "description": "Specify the unique ID of the user to assign as the reporting manager.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } }, "name": { "description": "Specify the full name of the user to assign as the reporting manager.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ReportingToUser" }, { "description": "Indicates that no reporting manager is assigned to this user.", "type": "null", "x-zs-$id": "NoReportingToUser" } ], "description": "Specify the user to whom this user reports. Set to null to remove the reporting relationship. Refer to the [Get Users](users.yaml#$.paths./users.get) endpoint for valid user IDs." }, "alias": { "anyOf": [ { "description": "Represents the alias or short name to assign to the user.", "maxLength": 50, "type": "string", "x-zs-$id": "UserAliasUpdate" }, { "description": "Indicates that no alias is set for the user.", "type": "null", "x-zs-$id": "NoUserAliasUpdate" } ], "description": "Specify an alias or short name for the user. Set to null to remove an existing alias." }, "city": { "anyOf": [ { "description": "Represents the city value to set for the user.", "maxLength": 100, "type": "string", "x-zs-$id": "UserCityUpdate" }, { "description": "Indicates that the city value should be cleared.", "type": "null", "x-zs-$id": "NoUserCityUpdate" } ], "description": "Specify the city for the user's address. Set to null to clear an existing city value." }, "country": { "anyOf": [ { "description": "Represents the country value to set for the user.", "maxLength": 100, "type": "string", "x-zs-$id": "UserCountryUpdate" }, { "description": "Indicates that the country value should be cleared.", "type": "null", "x-zs-$id": "NoUserCountryUpdate" } ], "description": "Specify the country for the user's address. Set to null to clear an existing country value." }, "country_locale": { "description": "Specify the locale associated with the user's country.", "enum": [ "ps_AF", "sv_AX", "sq_AL", "ar_DZ", "en_AS", "ca_AD", "pt_AO", "en_AI", "en_AQ", "en_AG", "es_AR", "hy_AM", "nl_AW", "en_AU", "de_AT", "az_AZ", "en_BS", "ar_BH", "bn_BD", "en_BB", "be_BY", "nl_BE", "fr_BE", "en_BZ", "fr_BJ", "en_BM", "en_BT", "es_BO", "bs_BA", "en_BW", "no_BV", "pt_BR", "en_IO", "en_VG", "ms_BN", "bg_BG", "fr_BF", "fr_BI", "km_KH", "fr_CM", "en_CA", "fr_CA", "pt_CV", "en_KY", "fr_CF", "ar_TD", "es_CL", "zh_CN", "en_CX", "en_CC", "es_CO", "fr_KM", "en_CK", "es_CR", "hr_HR", "es_CU", "el_CY", "cs_CZ", "fr_CD", "da_DK", "ar_DJ", "en_DM", "es_DO", "es_EC", "ar_EG", "es_SV", "es_GQ", "en_ER", "et_EE", "en_SZ", "am_ET", "en_FK", "fo_FO", "fj_FJ", "fi_FI", "fr_FR", "fr_GF", "fr_PF", "fr_TF", "fr_GA", "en_GM", "ka_GE", "de_DE", "en_GH", "en_GI", "el_GR", "kl_GL", "en_GD", "fr_GP", "en_GU", "es_GT", "fr_GN", "pt_GW", "en_GY", "fr_HT", "en_HM", "es_HN", "zh_HK", "hu_HU", "is_IS", "en_IN", "id_ID", "fa_IR", "ar_IQ", "en_IE", "iw_IL", "it_IT", "en_JM", "ja_JP", "ar_JO", "ru_KZ", "sw_KE", "en_KI", "ar_KW", "uz_KG", "lo_LA", "lv_LV", "ar_LB", "en_LS", "en_LR", "ar_LY", "de_LI", "lt_LT", "fr_LU", "de_LU", "zh_MO", "en_MG", "en_MW", "ms_MY", "dv_MV", "fr_ML", "mt_MT", "en_MH", "fr_MQ", "ar_MR", "en_MU", "fr_YT", "es_MX", "en_FM", "ro_MD", "fr_MC", "mn_MN", "sr_ME", "en_MS", "ar_MA", "pt_MZ", "my_MM", "en_NA", "en_NR", "ne_NP", "nl_NL", "nl_AN", "fr_NC", "en_NZ", "es_NI", "fr_NE", "en_NG", "en_NU", "en_NF", "ko_KP", "mk_MK", "en_MP", "no_NO", "ar_OM", "en_PK", "en_PW", "ar_PS", "es_PA", "en_PG", "es_PY", "es_PE", "en_PH", "en_PN", "pl_PL", "pt_PT", "es_PR", "ar_QA", "fr_CG", "fr_RE", "ro_RO", "ru_RU", "rw_RW", "en_SH", "en_KN", "en_LC", "fr_PM", "en_VC", "en_WS", "it_SM", "pt_ST", "ar_SA", "fr_SN", "sr_RS", "sr_CS", "en_SC", "en_SL", "en_SG", "sk_SK", "sl_SI", "en_SB", "so_SO", "en_ZA", "en_GS", "ko_KR", "es_ES", "si_LK", "ar_SD", "nl_SR", "no_SJ", "sv_SE", "fr_CH", "de_CH", "it_CH", "ar_SY", "zh_TW", "fa_TJ", "sw_TZ", "th_TH", "pt_TL", "fr_TG", "en_TK", "to_TO", "en_TT", "ar_TN", "tr_TR", "tk_TM", "en_TC", "en_TV", "en_UG", "uk_UA", "ar_AE", "en_GB", "en_US", "en_UM", "es_UY", "uz_UZ", "bi_VU", "it_VA", "es_VE", "vi_VN", "en_VI", "fr_WF", "ar_EH", "ar_YE", "en_ZM", "en_ZW", "fr_CI" ], "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported country locales. Use 'actual_value'. (api_name :country_locale ).\n" }, "customize_info": { "additionalProperties": true, "description": "Specify user interface customization preferences for the user's account.", "properties": { "notes_desc": { "description": "Specify whether notes should be displayed in descending order for the user.\\n\\nPossible values:\\ntrue - Notes are displayed in descending order.\\nfalse - Notes are not displayed in descending order.", "type": "boolean" }, "show_detail_view": { "description": "Specify whether the detail view panel is displayed for the user.\\n\\nPossible values:\\ntrue - The detail view panel is displayed.\\nfalse - The detail view panel is not displayed.", "type": "boolean" }, "show_left_panel": { "description": "Specify whether the left panel is displayed in the user interface.\\n\\nPossible values:\\ntrue - The left panel is shown.\\nfalse - The left panel is hidden.", "type": "boolean" } }, "type": "object" }, "date_format": { "description": "Specify the user's preferred date format for displaying date values.", "enum": [ "dd-MM-yyyy", "dd/MM/yyyy", "dd.MM.yyyy", "dd MM yyyy", "dd-MM-yy", "dd/MM/yy", "dd.MM.yy", "d.MM.yy", "d-M-yy", "d/M/yy", "d.M.yy", "d.M.yy.", "d-M-yyyy", "d/M/yyyy", "d.M.yyyy", "d. M. yyyy.", "d. M. yyyy", "d MMM, yyyy", "dd MMM, yyyy", "d. MMMM yyyy", "dd.MM.yyyy.", "dd.MM.yy.", "yyyy-MM-dd", "yyyy/MM/dd", "yyyy.MM.dd", "yyyy MM dd", "yy/MM/dd", "yy-MM-dd", "yy.M.d", "yy-M-d", "yy. M. d", "yyyy/M/d", "yyyy年MM月dd日", "yy年M月d日", "yyyy.MM.dd.", "yyyy. MM. dd", "MM-dd-yyyy", "MM/dd/yyyy", "MM.dd.yyyy", "MM dd yyyy", "MM-dd-yy", "MM/dd/yy", "M/dd/yy", "MMM-dd-yyyy", "MMM dd, yyyy", "MMM d, yyyy", "MMMM d, yyyy", "yyyy.dd.MM", "yy.d.M" ], "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported date formats. Use 'reference_value'. (api_name :date_format ).\n" }, "decimal_separator": { "description": "Specify the user's preferred decimal separator character for displaying numerical values.", "enum": [ "Comma", "Period" ], "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported decimal separator options. Use 'actual_value'. (api_name :decimal_separator ). \n" }, "default_tab_group": { "description": "Specify the default tab group for the user, determining which group of tabs is shown upon login.", "format": "int32", "type": "integer" }, "distance_preference__s": { "description": "Specify the user's preferred unit of measurement for displaying distance values.", "enum": [ "Kilometers", "Miles" ], "type": "string" }, "dob": { "anyOf": [ { "description": "Represents the date of birth value in YYYY-MM-DD format to set for the user.", "format": "date", "type": "string", "x-zs-$id": "UserDOBUpdate" }, { "description": "Indicates that the date of birth should be cleared.", "type": "null", "x-zs-$id": "NoUserDOBUpdate" } ], "description": "Specify the user's date of birth in YYYY-MM-DD format. Set to null to clear an existing date of birth." }, "email": { "description": "Specify the email address for the user's account.", "maxLength": 100, "type": "string" }, "fax": { "anyOf": [ { "description": "Represents the fax number to set for the user.", "maxLength": 30, "type": "string", "x-zs-$id": "UserFaxUpdate" }, { "description": "Indicates that the fax number should be cleared.", "type": "null", "x-zs-$id": "NoUserFaxUpdate" } ], "description": "Specify the user's fax number. Set to null to clear an existing fax number." }, "first_name": { "description": "Specify the user's first name.", "maxLength": 50, "type": "string" }, "full_name": { "description": "Specify the user's full name.", "maxLength": 100, "readOnly": true, "type": "string" }, "id": { "description": "Represents the unique identifier of the user record.", "maxLength": 19, "readOnly": true, "type": "string" }, "image_link": { "description": "Specify the URL of the user's profile image from the Identity and Access Management (IAM) system.", "maxLength": 100, "type": "string" }, "language": { "description": "Specify the preferred language for the user. This value can be updated only by the user themselves.", "enum": [ "af_NA", "af_ZA", "ak_GH", "su_ID", "cy_GB", "de_CH", "de_AT", "en_AU", "en_CA", "en_IE", "en_NZ", "en_SG", "en_ZA", "ee_GH", "ee_TG", "fy_NL", "ga_GB", "ga_IE", "gv_IM", "ki_KE", "gd_GB", "ha_GH", "ha_NG", "ha_NE", "ig_NG", "rn_BI", "jv_ID", "rw_RW", "sw_CD", "sw_KE", "sw_TZ", "sw_UG", "lg_UG", "lb_LU", "mg_MG", "mt_MT", "ms_BN", "ms_ID", "ms_MY", "ms_SG", "nl_BE", "nl_BQ", "om_ET", "om_KE", "ff_GN", "ff_SN", "qu_BO", "qu_EC", "qu_PE", "so_ET", "so_DJ", "so_KE", "so_SO", "sg_CF", "vi_VN", "lu_CD", "tr_CY", "tr_TR", "wo_SN", "az_AZ", "bm_ML", "bs_BA", "br_FR", "ca_AD", "ca_ES", "ca_FR", "ca_IT", "sn_ZW", "da_DK", "da_GL", "se_NO", "se_SE", "se_FI", "et_EE", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_EC", "es_SV", "es_GT", "es_HN", "es_NI", "es_PA", "es_PY", "es_PE", "es_PR", "es_DO", "es_UY", "es_VE", "eu_ES", "fr_BE", "fr_CA", "fr_CH", "fo_DK", "fo_FO", "gl_ES", "hr_BA", "hr_HR", "nd_ZW", "xh_ZA", "zu_ZA", "it_VA", "it_IT", "it_SM", "it_CH", "kl_GL", "kw_GB", "ku_TR", "lv_LV", "to_TO", "lt_LT", "ln_AO", "ln_CG", "ln_CF", "ln_CD", "hu_HU", "nn_NO", "no_NO", "nb_NO", "nb_SJ", "uz_AF", "uz_UZ", "pl_PL", "ro_MD", "ro_RO", "rm_CH", "sq_XK", "sq_MK", "sq_AL", "sk_SK", "sl_SI", "fi_FI", "sv_FI", "sv_SE", "sv_AX", "mi_NZ", "tk_TM", "yo_BJ", "yo_NG", "is_IS", "cs_CZ", "el_GR", "el_CY", "be_BY", "bg_BG", "os_GE", "os_RU", "ky_KG", "mk_MK", "mn_MN", "ce_RU", "sr_BA", "sr_CS", "sr_RS", "sr_ME", "tt_RU", "tg_TJ", "uk_UA", "kk_KZ", "hy_AM", "ug_CN", "ur_IN", "ur_PK", "ar_JO", "ar_AE", "ar_BH", "ar_DZ", "ar_SD", "ar_IQ", "ar_KW", "ar_MA", "ar_SA", "ar_YE", "ar_TN", "ar_SY", "ar_OM", "ar_QA", "ar_LB", "ar_LY", "sd_PK", "sd_IN", "fa_AF", "fa_IR", "ps_AF", "ps_PK", "ks_IN", "ne_NP", "ne_IN", "mr_IN", "sa_IN", "hi_IN", "as_IN", "bn_BD", "bn_IN", "pa_PK", "pa_IN", "gu_IN", "or_IN", "ta_IN", "ta_LK", "ta_SG", "ta_MY", "te_IN", "kn_IN", "ml_IN", "si_LK", "th_TH", "lo_LA", "bo_IN", "bo_CN", "dz_BT", "my_MM", "ka_GE", "ti_ET", "ti_ER", "am_ET", "km_KH", "zh_MO", "zh_HK", "zh_SG", "zh_CN", "zh_TW", "ja_JP", "ii_CN", "ko_KR", "ko_KP" ], "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported languages. Use 'actual_value'. (api_name :language ).\n" }, "last_name": { "anyOf": [ { "description": "Represents the last name to set for the user.", "maxLength": 50, "type": "string", "x-zs-$id": "UserLastNameUpdate" }, { "description": "Indicates that the last name should be cleared.", "type": "null", "x-zs-$id": "NoUserLastNameUpdate" } ], "description": "Specify the user's last name. Set to null if no last name is to be stored." }, "locale": { "description": "Specify the locale for the user.", "enum": [ "in_ID", "zh_CN", "zh_TW", "da_DK", "de_DE", "en_GB", "en_US", "es_ES", "fr_FR", "iw_IL", "hr_HR", "it_IT", "hu_HU", "nl_NL", "pl_PL", "pt_BR", "pt_PT", "sv_SE", "vi_VN", "tr_TR", "cs_CZ", "bg_BG", "ru_RU", "ar_EG", "hi_IN", "th_TH", "ja_JP", "ko_KR" ], "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported locales. Use 'actual_value'. (api_name :locale ).\n" }, "mobile": { "description": "Specify the user's mobile phone number. Set to null to clear an existing mobile number.", "maxLength": 30, "type": [ "string", "null" ] }, "name_format__s": { "description": "Specify the format to use when displaying the user's name.", "enum": [ "Salutation,First Name,Last Name", "Salutation,Last Name,First Name", "First Name,Salutation,Last Name", "First Name,Last Name,Salutation", "Last Name,Salutation,First Name", "Last Name,First Name,Salutation" ], "type": "string" }, "number_separator": { "description": "Specify the character to use as a separator when formatting numbers for the user. This field is case-insensitive.", "enum": [ "Comma", "Period", "Space", "comma", "period", "space" ], "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported number separators. Use 'actual_value'. (api_name :number_separator ).\n" }, "phone": { "description": "Specify the user's phone number. Set to null to clear an existing phone number.", "maxLength": 30, "type": [ "string", "null" ] }, "profile": { "additionalProperties": false, "description": "Specify the profile to assign to the user, including the profile's unique identifier and display name.", "properties": { "id": { "description": "Specify the unique ID of the profile to assign to the user.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } }, "name": { "description": "Specify the display name of the profile to assign to the user.", "maxLength": 50, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "role": { "additionalProperties": false, "description": "Specify the role to assign to the user, including the role's unique identifier and display name.", "properties": { "id": { "description": "Specify the unique ID of the role to assign to the user.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } }, "name": { "description": "Specify the display name of the role to assign to the user.", "maxLength": 200, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "share_among_subordinates": { "description": "Specify whether the user's records should be shared with their subordinates.\\n\\nPossible values:\\ntrue - Records are shared with subordinates.\\nfalse - Records are not shared with subordinates.", "type": "boolean" }, "signature": { "description": "Specify the email signature for the user. Set to null to remove an existing signature.", "maxLength": 200, "type": [ "string", "null" ] }, "sort_order_preference__s": { "description": "Specify the user's preferred sort order for displaying records.", "enum": [ "First Name,Last Name", "Last Name,First Name" ], "type": "string" }, "state": { "anyOf": [ { "description": "Represents the state or province to set for the user.", "maxLength": 100, "type": "string", "x-zs-$id": "UserStateUpdate" }, { "description": "Indicates that the state value should be cleared.", "type": "null", "x-zs-$id": "NoUserStateUpdate" } ], "description": "Specify the state or province for the user's address. Set to null to clear an existing state value." }, "status": { "description": "Specify the status of the user account.", "enum": [ "active", "inactive" ], "type": "string", "x-zs-$id": "UserStatusUpdate", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of available status values. Use 'reference_value'. (api_name :status ).\n" }, "street": { "anyOf": [ { "description": "Represents the street address to set for the user.", "maxLength": 250, "type": "string", "x-zs-$id": "UserStreetUpdate" }, { "description": "Indicates that the street address should be cleared.", "type": "null", "x-zs-$id": "NoUserStreetUpdate" } ], "description": "Specify the street address for the user. Set to null to clear an existing street address." }, "theme": { "additionalProperties": false, "description": "Specify the theme configuration for the user's CRM interface, including color and display settings for the background, screen, header, normal tab, and selected tab elements.", "properties": { "background": { "description": "Specify the background color for the user's theme.", "format": "hex-color", "type": "string" }, "header": { "additionalProperties": false, "description": "Specify the theme settings for the header area of the user's CRM interface, including background color and font color.", "properties": { "background": { "description": "Specify the background color for the header area of the user's theme.", "format": "hex-color", "type": "string" }, "font_color": { "description": "Specify the font color for the header area of the user's theme.", "format": "hex-color", "type": "string" } }, "type": "object" }, "new_background": { "description": "Specify the updated background color for the user's theme.", "format": "hex-color", "type": [ "string", "null" ] }, "normal_tab": { "additionalProperties": false, "description": "Specify the theme settings for the normal (unselected) tab in the user's CRM interface, including background color and font color.", "properties": { "background": { "description": "Specify the background color for the normal tab in the user's theme.", "format": "hex-color", "type": "string" }, "font_color": { "description": "Specify the font color for the normal tab in the user's theme.", "format": "hex-color", "type": "string" } }, "type": "object" }, "screen": { "description": "Specify the screen type or layout for the user's CRM interface.", "enum": [ "fixed" ], "type": "string" }, "selected_tab": { "additionalProperties": false, "description": "Specify the theme settings for the selected tab in the user's CRM interface, including background color and font color.", "properties": { "background": { "description": "Specify the background color for the selected tab in the user's theme.", "format": "hex-color", "type": "string" }, "font_color": { "description": "Specify the font color for the selected tab in the user's theme.", "format": "hex-color", "type": "string" } }, "type": "object" }, "type": { "description": "Specify the type of theme to apply to the user's CRM interface.", "enum": [ "default", "custom" ], "type": "string" } }, "readOnly": true, "type": "object" }, "time_format": { "description": "Specify the time format to use for displaying time values for the user.", "enum": [ "HH:mm", "hh:mm a" ], "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported time formats. Use 'actual_value'. (api_name :time_format ).\n" }, "time_zone": { "description": "Specify the time zone for the user. This value can be updated only by the user themselves.", "maxLength": 150, "type": "string", "x-zs-llm-description": "Valid values are system-defined picklist options available in the Fields Get API (Users module). Call the Fields Get API with module=Users to retrieve the complete set of supported time zones. Use 'actual_value'. (api_name :time_zone ).\n" }, "website": { "anyOf": [ { "description": "Represents the website URL to set for the user.", "maxLength": 250, "type": "string", "x-zs-$id": "UserWebsiteUpdate" }, { "description": "Indicates that the website URL should be cleared.", "type": "null", "x-zs-$id": "NoUserWebsiteUpdate" } ], "description": "Specify the user's website URL. Set to null to clear an existing website URL." }, "zip": { "anyOf": [ { "description": "Represents the postal code or ZIP code to set for the user.", "maxLength": 30, "type": "string", "x-zs-$id": "UserPostalCodeUpdate" }, { "description": "Indicates that the postal code should be cleared.", "type": "null", "x-zs-$id": "NoUserPostalCodeUpdate" } ], "description": "Specify the user's postal code or ZIP code. Set to null to clear an existing postal code." } }, "type": "object" }, "UserInvalidErrorSchemaInURL": { "additionalProperties": false, "description": "Represents the error response when a user or territory ID in the request URL fails validation.", "properties": { "code": { "description": "Represents the error code for the validation failure. Possible values: **INVALID_DATA**, **DUPLICATE_DATA**, **MANDATORY_NOT_FOUND**, **NOT_ALLOWED**, **DEPENDENT_FIELD_MISSING**.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "MANDATORY_NOT_FOUND", "NOT_ALLOWED", "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional contextual information about the URL validation error.", "properties": { "api_name": { "description": "Represents the API field name associated with the URL validation error.", "format": "string", "minLength": 1, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field information related to the URL validation error.", "properties": { "api_name": { "description": "Represents the API field name of the dependent field that caused the URL validation error.", "format": "string", "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependent field that caused the URL validation error.", "format": "string", "minLength": 1, "type": "string" }, "resource_path_index": { "description": "Represents the index in the resource path where the dependent field is located.", "format": "int32", "type": "integer" } }, "type": "object" }, "id": { "description": "Represents the unique identifier of the resource related to the URL validation error.", "format": "string", "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that caused the URL validation error.", "format": "string", "minLength": 1, "type": "string" }, "resource_path_index": { "description": "Represents the index in the resource path where the URL validation error occurred.", "format": "int32", "type": "integer" }, "supported_values": { "description": "Represents the list of supported values for the field associated with the URL validation error.", "items": { "description": "Represents a supported value for the field associated with the URL validation error.", "maxLength": 100, "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [], "type": "object" }, "message": { "description": "Represents the detailed error message describing the URL validation failure.", "format": "string", "type": "string" }, "status": { "description": "Represents the outcome status of the response. Possible values: **error**, **success**, **failure**.", "enum": [ "error", "success", "failure" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "UserInvalidErrorSchemaInURL" }, "UserInvalidErrorSchemaOnRequestBody": { "additionalProperties": false, "description": "Represents the error response when one or more users in the request body fail validation during a territory user operation.", "properties": { "users": { "description": "Represents the list of user entries, each containing the result code, details, status, and message for the corresponding user in the request.", "items": { "additionalProperties": false, "description": "Represents the result for one user entry in the request, including the outcome code, error details, status, and message.", "properties": { "code": { "description": "Represents the error or status code for the user entry. Possible values: **INVALID_DATA**, **DUPLICATE_DATA**, **MANDATORY_NOT_FOUND**, **NOT_ALLOWED**, **DEPENDENT_FIELD_MISSING**.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "MANDATORY_NOT_FOUND", "NOT_ALLOWED", "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional contextual information about the validation error for the user entry.", "properties": { "api_name": { "description": "Represents the API field name associated with the validation error.", "format": "string", "minLength": 1, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependent field information related to the validation error.", "properties": { "api_name": { "description": "Represents the API field name of the dependent field that caused the validation error.", "format": "string", "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependent field that caused the validation error.", "format": "string", "minLength": 1, "type": "string" }, "resource_path_index": { "description": "Represents the index in the resource path where the dependent field is located.", "format": "int32", "type": "integer" } }, "type": "object" }, "id": { "description": "Represents the unique identifier of the resource related to the validation error.", "format": "string", "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that caused the validation error.", "format": "string", "minLength": 1, "type": "string" }, "owner_status": { "description": "Represents the status of the user being added to the territory, indicating why the operation failed.", "format": "string", "type": "string" }, "resource_path_index": { "description": "Represents the index in the resource path where the validation error occurred.", "format": "int32", "type": "integer" }, "supported_values": { "description": "Represents the list of supported values for the field associated with the validation error.", "items": { "description": "Represents a supported value for the field associated with the validation error.", "maxLength": 100, "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [], "type": "object" }, "message": { "description": "Represents the detailed error message describing the validation issue for the user entry.", "format": "string", "type": "string" }, "status": { "description": "Represents the outcome status of the user entry in the response. Possible values: **error**, **success**, **failure**.", "enum": [ "error", "success", "failure" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "title": "Territory Error Response", "type": "object", "x-zs-$id": "UserInvalidErrorSchemaOnRequestBody" }, "UserResourceRequestObject": { "additionalProperties": false, "description": "User resource reference for Assignment Rule entry.", "properties": { "id": { "description": "Specify the iD of the user. Refer to the [Users API](users.yaml#$.paths./users.get) resource for valid values.", "maxLength": 19, "minLength": 1, "pattern": "^[1-9][0-9]{0,18}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" }, { "operationId": "createUser", "propertyId": "UserResultId" } ], "resource": "users" } } }, "required": [ "id" ], "title": "User Resource Request Object", "type": "object", "x-zs-$id": "UserResourceRequestObject" }, "UserTypeDefaultAssigneeRequestObject": { "additionalProperties": false, "description": "Configures a specific user or the currently logged-in user as the default assignee.", "properties": { "resource": { "anyOf": [ { "$ref": "#/components/schemas/UserResourceRequestObject", "description": "Specific user to set as the default assignee" }, { "additionalProperties": false, "description": "Defines the logged-in user as the default assignee.", "properties": { "api_name": { "description": "Set ${CURRENTUSER} to use the logged-in user as the default assignee.\nPossible values:\n**${CURRENTUSER}** - Represents ${currentuser}.", "enum": [ "${CURRENTUSER}" ], "type": "string" } }, "type": "object", "x-zs-$id": "DefaultAssigneeCurrentUserRefRequestFormat" } ], "description": "Specify the resource for the Assignment Rule request." }, "type": { "description": "Default assignee type. Must be 'user'.\nPossible values:\n**user** - Represents user.", "enum": [ "user" ], "type": "string" } }, "required": [ "type", "resource" ], "title": "User type default assignee request object", "type": "object", "x-zs-$id": "UserTypeDefaultAssigneeRequestObject" }, "UserTypeNested": { "additionalProperties": false, "description": "A top-level wrapper object used in create and update request bodies. Contains the `user_type` array that holds one or more portal user type objects.", "properties": { "active": { "description": "Indicates whether the portal user type is active. Set to `true` to allow portal users to access the portal via this user type, or `false` to deactivate it.", "type": [ "boolean", "null" ] }, "deactive_user_count": { "description": "The number of portal users assigned to this user type who are currently deactivated.", "format": "int32", "type": [ "integer", "null" ] }, "id": { "description": "Denotes the unique numeric identifier of the portal user type.", "format": "int64", "maxLength": 18, "readOnly": true, "type": "string" }, "invitation_field": { "$ref": "#/components/schemas/InvitationFieldNested", "description": "The CRM field used as the invitation field for this portal user type. Portal invitations are sent to the contact value stored in this field. Required when creating a user type." }, "modules": { "description": "The list of CRM modules with their access configurations for this portal user type. Required when creating a user type.", "items": { "$ref": "#/components/schemas/ModulesNested" }, "maxItems": 500, "type": "array" }, "name": { "description": "The display name of the portal user type. For example, \"Client Portal\", \"Vendor Portal\", or \"Partner Portal\". Must be alphanumeric with spaces only, maximum 50 characters.", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9 ]+$", "type": "string" }, "personality_module": { "$ref": "#/components/schemas/PersonalityModuleNested", "description": "The personality module for this portal user type. Records in this module serve as portal user identities, and portal invitations are sent to records in this module. Required when creating a user type." } }, "required": [ "invitation_field", "modules", "name", "personality_module" ], "type": "object" }, "UserTypeNested1": { "additionalProperties": false, "description": "Represents the nested object representing a single portal user type within a list operation response, containing summary-level configuration fields.", "properties": { "active": { "description": "Indicates whether the portal user type is currently active and available to portal users.", "type": "boolean" }, "default": { "description": "Indicates whether this is the default portal user type in the organization. The default user type is created automatically when the portal is set up, using Contacts as the personality module.", "type": "boolean" }, "id": { "description": "Indicates the unique identifier of the resource.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$id": "PortalUserTypeDetailsId" }, "invitation_field": { "$ref": "#/components/schemas/InvitationFieldNested" }, "modules": { "description": "Represents the array of modules associated with the user type.", "items": { "$ref": "#/components/schemas/ModulesNested" }, "maxItems": 4, "type": "array" }, "name": { "description": "Represents the name of the resource.", "maxLength": 255, "type": "string" }, "personality_module": { "$ref": "#/components/schemas/PersonalityModuleNested1" } }, "type": "object" }, "UserTypeNested2": { "additionalProperties": false, "description": "A nested object representing a single portal user type within a get-by-ID response, containing the full configuration including module access details.", "properties": { "code": { "description": "The error code that identifies the type of error. For example, `INVALID_DATA` or `MANDATORY_NOT_FOUND`.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/PortalUserTypeDetailsNested" }, "message": { "description": "Represents the error message that Zoho CRM returned, describing what went wrong.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the result status of the API call. The value is `error` for all error responses.", "maxLength": 255, "type": "string" } }, "type": "object" }, "UserTypeNestedV2": { "additionalProperties": false, "description": "A wrapper object used in update request bodies. Contains the `user_type` array that holds the portal user type object with the fields to be updated.", "properties": { "active": { "description": "Set to `true` to activate the portal user type or `false` to deactivate it.", "type": [ "boolean", "null" ] }, "modules": { "description": "Represents the list of modules whose properties you want to update within the portal user type.", "items": { "$ref": "#/components/schemas/ModulesNestedV2" }, "maxItems": 1, "type": [ "array", "null" ] }, "name": { "description": "The updated display name for the portal user type. Must be alphanumeric with spaces only, maximum 50 characters.", "maxLength": 50, "type": [ "string", "null" ] }, "personality_module": { "$ref": "#/components/schemas/PersonalityModuleNested", "description": "The updated personality module for the portal user type. Cannot be changed for the default user type." } }, "type": "object" }, "UsersGetDependentFieldMissingResponse": { "additionalProperties": false, "description": "Represents the error response returned when a required dependent parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code returned when a required dependent parameter is missing from the request.", "enum": [ "DEPENDENT_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the missing dependent parameter, including the names of the dependent and dependee parameters.", "properties": { "dependee": { "additionalProperties": false, "description": "Represents the parameter that depends on the missing parameter and requires it to be present in the request.", "properties": { "param_name": { "description": "Represents the name of the parameter that depends on the missing parameter.", "enum": [ "child_data" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "param_name": { "description": "Represents the name of the missing required parameter in the request.", "enum": [ "query_id" ], "type": "string" } }, "required": [ "dependee", "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing dependent parameter.", "enum": [ "Dependent Param missing" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UsersGetDependentFieldMissingResponse" }, "UsersGetInvalidParamResponse": { "additionalProperties": false, "description": "Represents the error response returned when an invalid parameter value is provided in the request.", "properties": { "code": { "description": "Represents the error code returned when an invalid parameter value is provided in the request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the invalid parameter, including the name of the parameter.", "properties": { "param_name": { "description": "Represents the name of the invalid parameter in the request.", "enum": [ "query_id" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid parameter.", "enum": [ "Invalid queryId" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UsersGetInvalidParamResponse" }, "UsersInfo": { "additionalProperties": false, "description": "Represents the pagination metadata returned with the user list response, including the current page, records per page, total count, and whether additional pages are available.", "properties": { "count": { "description": "Represents the total number of user records returned in the current response.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional records are available beyond the current page.\\n\\nPossible values:\\ntrue - More records are available on subsequent pages.\\nfalse - No more records are available.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of user records returned per page.", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "UsersTerritoriesSuccessResponse": { "additionalProperties": false, "description": "Represents the response containing the per-territory operation results.", "properties": { "territories": { "description": "Represents the list of per-territory operation results.", "items": { "additionalProperties": false, "description": "Represents the result of a single territory operation.", "properties": { "code": { "description": "Represents the result code for the territory operation. Possible values: SUCCESS - The territory operation completed successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details for the operation result.", "properties": { "id": { "description": "Represents the unique ID of the territory on which the operation was performed.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the result of the territory operation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the territory operation. Possible values: success - The operation completed successfully.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "minItems": 0, "type": "array", "uniqueItems": true } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "TerritorySuccessResponse" }, "UsersTypeAssignToRequestObject": { "additionalProperties": false, "description": "Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.", "properties": { "resources": { "description": "Defines the list of users details.", "items": { "$ref": "#/components/schemas/UserResourceRequestObject" }, "maxItems": 50, "minItems": 1, "type": "array" }, "type": { "description": "If assign to type is users.\nPossible values:\n**users** - Represents users.", "enum": [ "users" ], "type": "string" } }, "required": [ "type", "resources" ], "title": "Users type assign to request object", "type": "object", "x-zs-$id": "UsersTypeAssignToRequestObject" }, "UsersTypeAssignToResponseObject": { "additionalProperties": false, "description": "Defines the criteria and list of users eligible for record assignment upon entering the current rule entry.", "properties": { "resources": { "description": "Defines the list of users details. ", "items": { "$ref": "#/components/schemas/ResourceResponseObject" }, "maxItems": 50, "minItems": 1, "type": "array" }, "type": { "description": "If assign to type is users.\nPossible values:\n**users** - Represents users. ", "enum": [ "users" ], "type": "string" } }, "required": [ "type", "resources" ], "title": "Users type assign to response object", "type": "object", "x-zs-$id": "UsersTypeAssignToResponseObject" }, "ValidationError": { "additionalProperties": false, "description": "Validation error details", "properties": { "code": { "description": "Error code identifying the type of validation failure", "enum": [ "MANDATORY_NOT_FOUND", "MAPPING_MISMATCH", "INVALID_DATA", "DUPLICATE_DATA", "CANNOT_PERFORM_ACTION", "NOT_ALLOWED", "NOT_REVIEWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error context and affected field information", "properties": { "api_name": { "description": "API name of the affected field", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath to the affected field in the request", "maxLength": 200, "type": "string" }, "mapped_field": { "description": "Name of the field that has a mapping relationship", "maxLength": 100, "type": "string" }, "maximum_length": { "description": "Maximum allowed length for the field", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Message that explains why the lead conversion request failed validation.", "maxLength": 500, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "ValidationErrorWrapper": { "additionalProperties": false, "description": "Wrapper for validation error responses", "properties": { "data": { "description": "Array of validation errors", "items": { "$ref": "#/components/schemas/ValidationError" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ValidationErrorWrapper" }, "VariableActionResult": { "additionalProperties": false, "description": "Per-item result for a variable operation, providing a code, message, status, and details such as the variable ID.", "properties": { "code": { "description": "The result code of the operation (for example, SUCCESS).", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/VariableOperationDetail" }, "message": { "description": "A human-readable message describing the result of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the operation (for example, success or error).", "maxLength": 255, "type": "string" } }, "title": "Variable Action Result", "type": "object" }, "VariableAssociationGroup": { "additionalProperties": false, "description": "Grouping of variable associations under a named category, including the list of associated resources.", "properties": { "name": { "description": "The name of the association category (for example, email_templates).", "maxLength": 255, "type": "string" }, "resources": { "description": "Array of resources associated with this variable under this category.", "items": { "$ref": "#/components/schemas/VariableAssociationResource" }, "maxItems": 1, "type": "array" } }, "required": [ "name", "resources" ], "title": "Variable Association Group", "type": "object" }, "VariableAssociationResource": { "additionalProperties": false, "description": "A resource associated with variables, including name, id, and nested association details.", "properties": { "details": { "$ref": "#/components/schemas/VariableAssociationResourceDetails" }, "id": { "description": "The unique ID of the associated resource.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$id": "VariableAssociationResourceId" }, "name": { "description": "The name of the associated resource.", "maxLength": 255, "type": "string" } }, "required": [ "details", "id", "name" ], "title": "Variable Association Resource", "type": "object" }, "VariableAssociationResourceDetails": { "additionalProperties": false, "description": "Details about a resource association, including the referenced module.", "properties": { "module": { "$ref": "#/components/schemas/AssociationResourceModuleDetails" } }, "required": [ "module" ], "title": "Variable Association Resource Details", "type": "object" }, "VariableAssociationsResponse": { "additionalProperties": false, "description": "Success response containing an array of variable association groups for the requested context.", "properties": { "variables_associations": { "description": "Array of variable association groups, each containing the association type and related resources.", "items": { "$ref": "#/components/schemas/VariableAssociationGroup" }, "maxItems": 1, "type": "array" } }, "required": [ "variables_associations" ], "title": "Variable Associations Response", "type": "object", "x-zs-$id": "GetassociationsResponse200" }, "VariableCreationItem": { "additionalProperties": false, "description": "Represents a variable to create, including api_name, name, optional description, data type (text, integer, boolean, date, float), initial value, and the target variable_group reference.", "properties": { "api_name": { "description": "Specify the API name of the variables.", "maxLength": 100, "pattern": "^[a-zA-Z]+\\w*[a-zA-Z0-9]*$", "type": "string" }, "description": { "description": "Specify the description of the variables.", "maxLength": 250, "type": [ "string", "null" ] }, "name": { "description": "Specify the name of the variables.", "maxLength": 50, "type": "string" }, "type": { "description": "Specify the type of the variables", "enum": [ "text", "integer", "boolean", "date", "float" ], "maxLength": 7, "type": "string" }, "value": { "description": "Initial value of variable", "format": "int32", "type": [ "integer", "null" ] }, "variable_group": { "$ref": "#/components/schemas/VariableGroupIdentifierInput", "description": "Variable Groups json object (Required)" } }, "required": [ "api_name", "name", "type", "variable_group" ], "title": "Variable Creation Item", "type": "object" }, "VariableGroupAmbiguityError": { "additionalProperties": false, "description": "Error payload indicating ambiguity while processing variable group identifiers, such as conflicting id and api_name references.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "ambiguity_due_to": { "description": "Detail field: ambiguity_due_to", "items": { "additionalProperties": false, "description": "Detail Field: ambiguity_due_to", "properties": { "api_name": { "description": "Nested detail field: api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Nested detail field: json_path", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Ambiguity while processing the request" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variable Group Ambiguity Error", "type": "object", "x-zs-$id": "ErrorResponseCore239977156" }, "VariableGroupApiNameGenerationItemAlt": { "additionalProperties": false, "description": "Represents a single variable group item submitted for API name generation.", "properties": { "name": { "description": "Represents the proposed name of the variable group for which an available API name is generated.", "maxLength": 50, "type": "string" } }, "required": [ "name" ], "title": "Variable Group API Name Generation Item (Alternate)", "type": "object" }, "VariableGroupCollectionResponse": { "additionalProperties": false, "description": "Represents the response body for a successful variable group update operation.", "properties": { "variable_groups": { "description": "Represents an array of per-item operation status objects returned after processing the update request.", "items": { "$ref": "#/components/schemas/VariableGroupOperationStatus" }, "maxItems": 1, "type": "array" } }, "title": "Variable Group Collection Response", "type": "object", "x-zs-$id": "PutvariablegroupsResponse200" }, "VariableGroupDefinitionInputAlt": { "additionalProperties": false, "description": "Represents a single variable group item containing the fields to update when updating a variable group by ID.", "properties": { "api_name": { "description": "Represents the API name for the variable group. The value must comply with the required naming pattern. This field is nullable.", "maxLength": 100, "type": [ "string", "null" ] }, "description": { "description": "Represents the description of the variable group. This field is nullable.", "maxLength": 3000, "type": [ "string", "null" ] }, "name": { "description": "Represents the display name of the variable group. This field is nullable.", "maxLength": 50, "type": [ "string", "null" ] } }, "title": "Variable Group Definition Input (Alternate)", "type": "object" }, "VariableGroupDefinitionRequestAlt": { "additionalProperties": false, "description": "Represents the request body for updating a variable group by ID.", "properties": { "variable_groups": { "description": "Represents an array containing a single variable group definition item for the update by ID operation.", "items": { "$ref": "#/components/schemas/VariableGroupDefinitionInputAlt" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "variable_groups" ], "title": "Variable Group Definition Request (Alternate)", "type": "object" }, "VariableGroupFieldPathDetails": { "additionalProperties": false, "description": "Represents the field path details returned in per-item operation results, providing context about which field the result pertains to.", "properties": { "api_name": { "description": "Represents the API name of the variable group field that the operation result refers to.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the variable group field that the operation result refers to.", "maxLength": 255, "type": "string" } }, "title": "Variable Group Field Path Details", "type": "object" }, "VariableGroupIdentifierInput": { "additionalProperties": false, "description": "Nested object that identifies the variable group when defining a variable. Includes the group's id (required).", "properties": { "id": { "description": "The unique ID of the variable group. Mandatory.", "format": "int64", "type": "string" } }, "required": [ "id" ], "title": "Variable Group Identifier", "type": "object" }, "VariableGroupInvalidIDError": { "additionalProperties": false, "description": "Indicates an invalid variable group identifier in the request path. Includes code INVALID_DATA and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "The name of the parameter that caused the error.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variable Group Invalid ID Error", "type": "object", "x-zs-$id": "ErrorResponseCore1406268584" }, "VariableGroupInvalidReferenceError": { "additionalProperties": false, "description": "Error payload returned when the supplied variable group identifier (id) is invalid during variable processing.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variable Group Invalid Reference Error", "type": "object", "x-zs-$id": "VariableGroupInvalidReferenceError" }, "VariableGroupListResponse": { "additionalProperties": false, "description": "Represents the response body for the list variable groups operation.", "properties": { "variable_groups": { "description": "Represents an array of variable group summary objects returned in the list response.", "items": { "$ref": "#/components/schemas/VariableGroupSummary" }, "maxItems": 100, "type": "array" } }, "required": [ "variable_groups" ], "title": "Variable Group List Response", "type": "object", "x-zs-$id": "GetvariablegroupsResponse200" }, "VariableGroupMultiStatusResponseAlt": { "additionalProperties": false, "description": "Represents the multi-status response body returned when individual variable group items in a bulk update operation have different outcomes.", "properties": { "variable_groups": { "description": "Represents an array of per-item results for the bulk update operation, where each item can be a success or an error response.", "items": { "anyOf": [ { "$ref": "#/components/schemas/VariableGroupOperationStatus" }, { "$ref": "#/components/schemas/ErrorResponseCore1117753881" } ], "description": "Represents a single per-item result in the multi-status response for the bulk update operation." }, "maxItems": 2, "type": "array" } }, "title": "Variable Group Multi-Status Response (Alternate)", "type": "object", "x-zs-$id": "PutvariablegroupsResponse207" }, "VariableGroupOperationResponse": { "additionalProperties": false, "description": "Represents the response body for a successful update variable group by ID operation.", "properties": { "variable_groups": { "description": "Represents an array containing the per-item operation status for the updated variable group.", "items": { "$ref": "#/components/schemas/VariableGroupOperationStatus" }, "maxItems": 1, "type": "array" } }, "title": "Variable Group Operation Response", "type": "object", "x-zs-$id": "Put111111000000117094Response200" }, "VariableGroupOperationStatus": { "additionalProperties": false, "description": "Represents the per-item operation result for a variable group action, including the status code, message, and optional field path details.", "properties": { "code": { "description": "Represents the status code for the individual variable group operation result.", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/VariableGroupFieldPathDetails" }, "message": { "description": "Represents the message describing the result of the individual variable group operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the individual variable group operation result.", "maxLength": 255, "type": "string" } }, "title": "Variable Group Operation Status", "type": "object", "x-zs-$id": "VariableGroupOperationStatus" }, "VariableGroupQueryResponse": { "additionalProperties": false, "description": "Represents the response body for the get variable group by ID operation.", "properties": { "variable_groups": { "description": "Represents an array containing the variable group matching the specified ID.", "items": { "$ref": "#/components/schemas/VariableGroupSummary" }, "maxItems": 1, "type": "array" } }, "required": [ "variable_groups" ], "title": "Variable Group Query Response", "type": "object", "x-zs-$id": "VariableGroupQueryResponse" }, "VariableGroupSchema": { "additionalProperties": true, "description": "Base schema for variable_group", "properties": { "api_name": { "description": "The API name of the variable group.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getVariableGroups", "propertyId": "VariableGroupApiName" } ], "resource": "variable_groups" } }, "id": { "description": "The unique ID of the variable group.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getVariableGroups", "propertyId": "VariableGroupId" } ], "resource": "variable_groups" } }, "name": { "description": "The display name of the variable group.", "maxLength": 50, "type": "string" } }, "title": "Generated Schema", "type": "object" }, "VariableGroupSummary": { "additionalProperties": false, "description": "Represents a summary of a variable group returned in list and retrieval responses.", "properties": { "api_name": { "description": "Represents the API name of the variable group, used to reference the group in API calls.", "maxLength": 100, "type": "string", "x-zs-$id": "VariableGroupApiName" }, "description": { "description": "Represents the description of the variable group. This field is nullable.", "maxLength": 3000, "type": [ "string", "null" ] }, "display_label": { "description": "Represents the display label of the variable group shown in the CRM interface.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique ID of the variable group.", "maxLength": 19, "type": "string", "x-zs-$id": "VariableGroupId" }, "name": { "description": "Represents the internal name of the variable group.", "maxLength": 50, "type": "string" }, "source": { "description": "Represents the source of the variable group, indicating whether it is system-defined or user-defined.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "description", "display_label", "id", "name", "source" ], "title": "Variable Group Summary (Lookup)", "type": "object" }, "VariableGroupUpdateItemAlt": { "additionalProperties": false, "description": "Represents a single variable group item for batch update operations.", "properties": { "api_name": { "description": "Represents the API name to update for the variable group. This field is nullable.", "maxLength": 100, "type": [ "string", "null" ] }, "description": { "description": "Represents the updated description for the variable group. This field is nullable.", "maxLength": 3000, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the variable group to update.", "maxLength": 18, "type": "string" }, "name": { "description": "Represents the updated display name for the variable group. This field is nullable.", "maxLength": 50, "type": [ "string", "null" ] } }, "required": [ "id" ], "title": "Variable Group Update Item (Alternate)", "type": "object" }, "VariableGroupUpdateRequestAlt": { "additionalProperties": false, "description": "Represents the request body for the bulk update variable groups operation.", "properties": { "variable_groups": { "description": "Represents an array of variable group update items for batch processing. The array accepts 1 to 10 items.", "items": { "$ref": "#/components/schemas/VariableGroupUpdateItemAlt" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "variable_groups" ], "title": "Variable Group Update Request (Alternate)", "type": "object" }, "VariableGroupsApiNameGenerationResponse": { "additionalProperties": false, "description": "Represents the response body for a successful generate API name operation.", "properties": { "variable_groups": { "description": "Represents an array of per-item results containing the generated API names for each submitted variable group.", "items": { "$ref": "#/components/schemas/VariableGroupOperationStatus" }, "maxItems": 1, "type": "array" } }, "title": "API Name Generation Response", "type": "object", "x-zs-$id": "GenerateAPINameResponse" }, "VariableGroupsInvalidDataError": { "additionalProperties": false, "description": "Represents an error response returned when the request contains invalid data for a field.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the field that contains invalid data.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains invalid data.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that exceeded the limit.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that the request contains invalid data.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Data Error", "type": "object", "x-zs-$id": "ErrorResponseCore1471813213" }, "VariableGroupsMandatoryFieldMissingError": { "additionalProperties": false, "description": "Represents an error response returned when a required field is missing from the request body.", "properties": { "code": { "description": "Represents the error code **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details for the missing required field.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing required field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that a required field is missing from the request.", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Mandatory Field Missing Error", "type": "object", "x-zs-$id": "ErrorResponseCore579601507" }, "VariableGroupsPermissionDeniedError": { "additionalProperties": false, "description": "Represents an error response returned when the client does not have the required permissions to access the variable group settings.", "properties": { "code": { "description": "Represents the error code **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the validation details containing the list of permissions required to access this resource.", "properties": { "permissions": { "description": "Represents an array of permission names required to perform this operation.", "items": { "description": "Represents a single required permission name.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message indicating that access to the resource is denied.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Permission Denied Error", "type": "object", "x-zs-$id": "ErrorResponseCore637385226" }, "VariableListItem": { "additionalProperties": false, "description": "Representation of a variable within collection responses, including readOnly, apiName, name, description, id, source, type, value, and group brief.", "properties": { "api_name": { "description": "The API name of the CRM variable.", "maxLength": 100, "type": "string", "x-zs-$id": "VariablesApiName" }, "description": { "description": "The description of the variable, if any.", "maxLength": 3000, "type": [ "string", "null" ] }, "id": { "description": "The unique ID of the variable.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$id": "VariablesId" }, "name": { "description": "The display name of the variable.", "maxLength": 50, "type": "string" }, "read_only": { "description": "Indicates whether the variable is read-only.", "type": "boolean" }, "source": { "description": "The source of the variable (for example, crm).", "maxLength": 255, "type": "string" }, "type": { "description": "The data type of the variable (for example, text, integer, percent, decimal, currency, date, datetime, email, phone, url, checkbox, textarea, long).", "maxLength": 255, "type": "string" }, "value": { "description": "The current value of the variable, if any.", "maxLength": 3000, "type": "string" }, "variable_group": { "$ref": "#/components/schemas/VariableGroupSchema" } }, "required": [ "api_name", "description", "id", "name", "source", "type", "variable_group" ], "title": "Variable List Item", "type": "object" }, "VariableOperationDetail": { "additionalProperties": false, "description": "Minimal details about a variable operation, including the server-assigned variable identifier.", "properties": { "api_name": { "description": "The API name of the variable.", "maxLength": 255, "type": "string" }, "id": { "description": "The unique ID of the variable.", "format": "int64", "type": "string" } }, "title": "Variable Operation Detail", "type": "object" }, "VariableOperationResult": { "additionalProperties": false, "description": "Per-item outcome for a variable operation, including code, message, status, and details such as the resulting variable id.", "properties": { "code": { "description": "The result code of the operation (for example, SUCCESS, INVALID_DATA).", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/VariableResultDetails" }, "message": { "description": "A human-readable message describing the result of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the operation (for example, success or error).", "maxLength": 255, "type": "string" } }, "title": "Variable Operation Result", "type": "object" }, "VariableResultDetails": { "additionalProperties": false, "description": "Details of an individual variable operation result, including the id of the affected variable.", "properties": { "api_name": { "description": "The API name of the affected variable.", "maxLength": 100, "type": "string" }, "id": { "description": "The unique ID of the affected variable.", "format": "int64", "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 255, "type": "string" } }, "title": "Variable Result Details", "type": "object" }, "VariableValueInvalidDataError": { "additionalProperties": false, "description": "Indicates invalid data supplied for a variable's value during update. Includes code INVALID_DATA and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA", "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "The expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "invalid data", "Please check whether the input values are correct" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variable Value Invalid Data Error", "type": "object", "x-zs-$id": "VariableValueInvalidDataError" }, "VariablesApiNameGenerationResponse": { "additionalProperties": false, "description": "200 response providing generated API names for the submitted variables.", "properties": { "variables": { "description": "Array of results for the API name generation operation.", "items": { "$ref": "#/components/schemas/VariableActionResult" }, "maxItems": 1, "type": "array" } }, "title": "API Name Generation Response", "type": "object", "x-zs-$id": "PostgenerateapinameResponse200" }, "VariablesBatchInput": { "additionalProperties": false, "description": "Request body wrapper that carries an array of variable definitions to be processed in a single batch.", "properties": { "variables": { "description": "Array of variable definitions to create. Maximum: 25 items.", "items": { "$ref": "#/components/schemas/VariableCreationItem" }, "maxItems": 2, "type": "array" } }, "required": [ "variables" ], "title": "Variables Batch Input", "type": "object" }, "VariablesBatchOperationCreated": { "additionalProperties": false, "description": "Summary response for a batch variables operation where all items are created successfully. Includes an array of per-item results.", "properties": { "variables": { "description": "Array of operation results for each created variable.", "items": { "$ref": "#/components/schemas/VariableOperationResult" }, "maxItems": 5, "type": "array" } }, "title": "Variables Batch Operation (Created)", "type": "object", "x-zs-$id": "PostvariablesResponse201" }, "VariablesBatchOperationMultiStatus": { "additionalProperties": false, "description": "Batch response indicating mixed successes and failures. Contains a variables array with per-item outcomes and related details.", "properties": { "variables": { "description": "Array of per-item operation results indicating success or failure for each variable.", "items": { "$ref": "#/components/schemas/VariableOperationResult" }, "maxItems": 2, "type": "array" } }, "title": "Variables Batch Operation (Multi-Status)", "type": "object", "x-zs-$id": "PostvariablesResponse207" }, "VariablesBatchRemovalMultiStatusResponse": { "additionalProperties": false, "description": "Batch removal response indicating mixed outcomes for multiple variables, with per-item result details.", "properties": { "variables": { "description": "Array of operation results for each deleted variable.", "items": { "$ref": "#/components/schemas/VariableOperationResult" }, "maxItems": 6, "type": "array" } }, "title": "Variables Batch Removal Multi-Status Response", "type": "object", "x-zs-$id": "DeletevariablesResponse207" }, "VariablesBatchUpdateRequestAlt1": { "additionalProperties": false, "description": "Alternate instance of the batch update request wrapper holding an array of variable update items.", "properties": { "variables": { "description": "Array of variable update items to process. Mandatory.", "items": { "$ref": "#/components/schemas/ScopedVariableUpdateItem" }, "maxItems": 25, "type": "array" } }, "required": [ "variables" ], "title": "Variables Batch Update Request (Alternate 1)", "type": "object" }, "VariablesBatchUpdateResponse": { "additionalProperties": false, "description": "Success response summarizing the outcome of a batch update, with an array of per-item operation results.", "properties": { "variables": { "description": "Array of operation results for each updated variable.", "items": { "$ref": "#/components/schemas/VariableOperationResult" }, "maxItems": 1, "type": "array" } }, "title": "Variables Batch Update Response", "type": "object", "x-zs-$id": "PutvariablesResponse200" }, "VariablesDomainNotSupportedError": { "additionalProperties": false, "description": "Returned when the operation is not supported for the selected domain. Includes code INVALID_DATA and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "resource_path_index": { "description": "The index of the invalid resource in the URL path.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "invalid data", "the id given seems to be invalid or already deleted" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Domain Not Supported Error", "type": "object", "x-zs-$id": "ErrorResponseCore1388195419" }, "VariablesDuplicateDataError": { "additionalProperties": false, "description": "Indicates that submitted data duplicates existing records. Includes code DUPLICATE_DATA, details, message, and status.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "duplicate data" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Duplicate Data Error", "type": "object", "x-zs-$id": "ErrorResponseCore789720987" }, "VariablesDuplicateDataExtendedError": { "additionalProperties": false, "description": "Duplicate data error with extended validation details. Includes code DUPLICATE_DATA, detailed context, message, and status.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "duplicate data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Duplicate Data Extended Error", "type": "object", "x-zs-$id": "VariablesDuplicateDataExtendedError" }, "VariablesInvalidDataError": { "additionalProperties": false, "description": "Generic invalid data error for the submitted payload. Includes code INVALID_DATA, details, message, and status.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "The maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data", "invalid data" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Invalid Data Error", "type": "object", "x-zs-$id": "ErrorResponseCore1645526583" }, "VariablesInvalidDataGeneralError": { "additionalProperties": false, "description": "Another form of invalid data error with validation details. Includes code INVALID_DATA and message.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Detail field: supported_values", "items": { "description": "Detail Field: supported_values", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Invalid Data General Error", "type": "object", "x-zs-$id": "ErrorResponseCore679994589" }, "VariablesInvalidDataGenericError": { "additionalProperties": false, "description": "Generic invalid data response with standard error structure. Includes code INVALID_DATA and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" }, "regex": { "description": "The regular expression pattern that the field value must match.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "regex" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Invalid Data Generic Error", "type": "object", "x-zs-$id": "ErrorResponseCore845321816" }, "VariablesInvalidDataTypeError": { "additionalProperties": false, "description": "General invalid data type error with validation details. Includes code INVALID_DATA and a descriptive message.", "properties": { "code": { "description": "Represents the error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "The expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "expected_data_type", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message", "enum": [ "Invalid data type" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Invalid Data Type Error", "type": "object", "x-zs-$id": "ErrorResponseCore1793125962" }, "VariablesInvalidRequestMethodError": { "additionalProperties": false, "description": "Returned when an unsupported HTTP request method is used. Includes code INVALID_REQUEST_METHOD.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "The http request method type is not a valid one" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Request Method Error", "type": "object", "x-zs-$id": "ErrorResponseCore1875045219" }, "VariablesInvalidTypeError": { "additionalProperties": false, "description": "Indicates an invalid data type for the variables field. Includes code INVALID_DATA and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA", "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "The maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "invalid data", "Please check whether the input values are correct", "no data found to update" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Invalid Type Error", "type": "object", "x-zs-$id": "ErrorResponseCore1291593659" }, "VariablesInvalidUrlPatternError": { "additionalProperties": false, "description": "Returned when the requested URL does not match a supported pattern. Includes code INVALID_URL_PATTERN.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid URL Pattern Error", "type": "object", "x-zs-$id": "ErrorResponseCore767063671" }, "VariablesListResponse": { "additionalProperties": false, "description": "Response wrapper containing an array of variables returned by the list operation.", "properties": { "variables": { "description": "Array of variable objects, each containing the variable details such as name, API name, type, value, and variable group.", "items": { "$ref": "#/components/schemas/VariableListItem" }, "maxItems": 200, "type": "array" } }, "required": [ "variables" ], "title": "Variables List Response", "type": "object", "x-zs-$id": "GetvariablesResponse200" }, "VariablesMandatoryFieldMissingError": { "additionalProperties": false, "description": "Error for a missing required field in the payload. Includes code MANDATORY_NOT_FOUND and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Mandatory Field Missing Error", "type": "object", "x-zs-$id": "ErrorResponseCore731875101" }, "VariablesPermissionDeniedError": { "additionalProperties": false, "description": "Returned when the caller lacks permission to access variables. Includes code NO_PERMISSION and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "permissions": { "description": "The list of required permissions.", "items": { "description": "The required permission.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Permission Denied Error", "type": "object", "x-zs-$id": "ErrorResponseCore637385226" }, "VariablesRemovalFailedError": { "additionalProperties": false, "description": "Indicates failure to remove a variable due to an invalid ID or other issues. Includes code INVALID_DATA and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "id": { "description": "Detail field: id", "format": "int64", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "variable not deleted", "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Removal Failed Error", "type": "object", "x-zs-$id": "ErrorResponseCore1243464418" }, "VariablesRequestBodyMissingError": { "additionalProperties": false, "description": "Error returned when the request body is missing. Includes code INVALID_DATA, validation details, message, and error status.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "expected_data_type": { "description": "The expected data type for the field.", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "body" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Request Body Missing Error", "type": "object", "x-zs-$id": "ErrorResponseCore1077889464" }, "VariablesRequiredFieldMissingError": { "additionalProperties": false, "description": "Error returned when the required variables field is not provided. Includes code MANDATORY_NOT_FOUND and validation details.", "properties": { "code": { "description": "Represents the error code.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Variables Required Field Missing Error", "type": "object", "x-zs-$id": "ErrorResponseCore1142616582" }, "VariablesScopedBatchUpdateRequestAlt1": { "additionalProperties": false, "description": "Alternate instance of the scoped batch update request wrapper for variable updates.", "properties": { "variables": { "description": "Array of variable update items to process. Mandatory.", "items": { "$ref": "#/components/schemas/ScopedVariableUpdateItem" }, "maxItems": 1, "type": "array" } }, "required": [ "variables" ], "title": "Variables Batch Update Request (Scoped Alternate 1)", "type": "object" }, "VariablesScopedBatchUpdateResponse": { "additionalProperties": false, "description": "Success response summarizing scoped batch updates with an array of per-item operation results.", "properties": { "variables": { "description": "Array of variable update items to process.", "items": { "$ref": "#/components/schemas/VariableOperationResult" }, "maxItems": 1, "type": "array" } }, "title": "Variables Batch Update Response (Scoped)", "type": "object", "x-zs-$id": "VariablesScopedBatchUpdateResponse" }, "VariablesScopedRemovalResponse": { "additionalProperties": false, "description": "Success response summarizing outcomes of variable removal within a scoped context, with per-item results.", "properties": { "variables": { "description": "Array of operation results for each deleted variable.", "items": { "$ref": "#/components/schemas/VariableOperationResult" }, "maxItems": 1, "type": "array" } }, "title": "Variables Removal Response (Scoped)", "type": "object", "x-zs-$id": "Delete1234567890Response200" }, "VariablesbyGroupResponse": { "additionalProperties": false, "description": "Collection wrapper returning variables associated with the specified group identifier.", "properties": { "variables": { "description": "Array of variable operation results.", "items": { "$ref": "#/components/schemas/VariableListItem" }, "maxItems": 25, "type": "array" } }, "required": [ "variables" ], "title": "Variables by Group Response", "type": "object", "x-zs-$id": "GetVariableByIdResponse200" }, "ViewAndApprovedParamValueErrorResponse": { "additionalProperties": false, "description": "Represents the error response returned when the `view` query parameter is set to an unsupported value.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "enum": [ "view", "approved" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "Please check whether the input values are correct" ], "type": "string" }, "status": { "description": "Represents the status of the API call.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ViewParamWithManageValueErrorResponse" }, "ViewsNested": { "additionalProperties": false, "description": "A nested object representing a list view associated with a portal user type module. Identified by a unique numeric ID, name, display label, and type.", "properties": { "display_label": { "description": "Represents the display label of the list view shown to portal users.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the resource.", "maxLength": 25, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalsMeta", "propertyId": "PortalsMetaViewsId" } ], "resource": "portals_meta" } }, "name": { "description": "Represents the name of the resource.", "maxLength": 255, "type": "string" }, "type": { "description": "The type of the list view. Possible values: `canvas_view` (Canvas View), `custom_view` (Custom List View).", "enum": [ "canvas_view", "custom_view" ], "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "WebhookAssociatedWithRulesError": { "additionalProperties": false, "description": "Represents the error returned when a request attempts to delete a webhook that is associated with at least one active Workflow Rule, Approval Process, or Blueprint.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**NOT_ALLOWED** - The webhook cannot be modified because it is associated with an active automation rule.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the resource path with the associated webhook.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource in the request URL path.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**This webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint** - The webhook cannot be deleted or modified because it is actively linked to one or more automation rules.", "enum": [ "This webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "WebhookAssociatedWithRulesError", "x-zs-llm-description": "Cannot delete the webhook is associated with active Workflow Rules, Approval Processes, or Blueprints." }, "WebhookAuthenticationDetails": { "additionalProperties": false, "description": "Represents the authentication configuration for the webhook endpoint. Use type **general** for endpoints that do not require credentials. Use type **connection** with a valid connection_name for endpoints that require authenticated access via a pre-configured Zoho connection.", "properties": { "connection_name": { "description": "Represents the name of the Zoho connection used for authentication. This field is required only when **type** is **connection**.", "maxLength": 255, "type": [ "string", "null" ] }, "type": { "description": "Specify the authentication method for the webhook endpoint.\nPossible values:\n**general** - No credentials required.\n**connection** - Uses a pre-configured Zoho connection.", "enum": [ "general", "connection" ], "maxLength": 255, "type": "string" } }, "required": [ "type" ], "title": "Webhook Authentication Details", "type": "object", "x-zs-llm-description": "Authentication method for the webhook endpoint. Mandatory for all webhooks. Use type 'general' with no connection for endpoints requiring no auth." }, "WebhookCreateInput": { "additionalProperties": false, "description": "Represents the writable fields for creating a new webhook. Required fields are name, module, url, http_method, authentication, and feature_type. System-managed fields must not be included. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid module API names.", "properties": { "authentication": { "$ref": "#/components/schemas/WebhookAuthenticationDetails", "description": "Authentication configuration. Required for all webhooks, including those without authentication credentials. Use type=general for webhooks that do not require authentication (no connection_name needed). Use type=connection when the webhook endpoint requires authenticated access via a pre-configured connection (connection_name is required)." }, "body": { "$ref": "#/components/schemas/WebhookRequestBody", "description": "Request body configuration. Only allowed when http_method is POST or PUT. type and format are required. When type=form_data: provide form_data_content (object with module_parameters and custom_parameters arrays); When type=raw: provide raw_data_content (string) and format (JSON, XML, Text, or HTML). When type=none: format may be null." }, "date_time_format": { "$ref": "#/components/schemas/DateTimeFormatConfig", "description": "Optional. Only relevant when a date or datetime merge-field is used in any parameter (headers, url_parameters, or body). Use datetime_format + time_zone when a datetime field is referenced (e.g., ${!Leads.Created_Time}). Use date_format when a date field is referenced (e.g., ${!Leads.Date_1}). Ignored if no date/datetime merge-fields are present." }, "description": { "description": "Specify the optional description of the webhook purpose.", "example": "Fires when a new lead is created", "maxLength": 500, "type": [ "string", "null" ] }, "feature_type": { "description": "Specify the automation feature type for this webhook.\nPossible values:\n**workflow** - Workflow Rule.\n**approval_process** - Approval Process.\n**blueprint_transition** - Blueprint transition.\n**blueprint_state** - Blueprint state.\n**assignment_rules** - Assignment Rules.\n**kiosk** - Kiosk feature.\n**commandcenter_service** - CommandCenter service.", "enum": [ "workflow", "approval_process", "blueprint_transition", "blueprint_state", "assignment_rules", "kiosk", "commandcenter_service" ], "example": "workflow", "maxLength": 255, "type": "string" }, "headers": { "$ref": "#/components/schemas/WebhookHeaders", "description": "HTTP headers for the outgoing webhook request. Only allowed when http_method is POST, PUT, or DELETE. Restricted header name: HOST is not allowed. Parameter names must be unique across the collection (DUPLICATE_DATA)." }, "http_method": { "description": "Specify the HTTP method used when the webhook fires. POST and PUT accept headers and body. GET and DELETE accept url_parameters. DELETE also accepts headers.\nPossible values:\n**POST** - Sends a POST request.\n**GET** - Sends a GET request.\n**PUT** - Sends a PUT request.\n**DELETE** - Sends a DELETE request.", "enum": [ "POST", "GET", "PUT", "DELETE" ], "type": "string" }, "module": { "$ref": "#/components/schemas/AutomationModuleDetailsResponse", "description": "The CRM module this webhook is associated with. Provide at least one of api_name or id. Cannot be changed after creation." }, "name": { "description": "Specify the display name of the webhook. The name must not contain the tilde (~) character.", "example": "New Lead Webhook", "maxLength": 250, "type": "string" }, "related_module": { "$ref": "#/components/schemas/RelatedModuleReference", "description": "Related CRM module. Required when feature_type is kiosk. Null otherwise.", "type": [ "object", "null" ] }, "url": { "description": "Specify the destination URL that receives the webhook request when triggered. The URL must begin with http://, https://, www., or a merge-field token (${...}). URLs resolving to internal or private host addresses are rejected by SSRF protection.", "example": "https://webhook.site/example-uuid", "maxLength": 2000, "type": "string" }, "url_parameters": { "$ref": "#/components/schemas/WebhookUrlParameters", "description": "URL query parameters for the outgoing request. Only allowed when http_method is GET or DELETE." } }, "required": [ "name", "module", "url", "http_method", "authentication", "feature_type" ], "type": "object", "x-zs-$id": "WebhookCreateInput", "x-zs-llm-description": "Defines the writable fields when creating a webhook. Before submitting: `getModules` to confirm valid module api_names. Required: name, module, url, http_method, authentication, and feature_type. System-managed fields (id, created_time, modified_time, created_by, modified_by, lock_status, editable, deletable, associated, source, category) must not be included." }, "WebhookCustomParameters": { "additionalProperties": false, "description": "Represents a static key-value parameter for webhook requests. Used in headers, URL query parameters, or form data fields. The value is a fixed literal sent unchanged with every webhook execution.", "properties": { "name": { "description": "Represents the parameter key sent in the webhook request.", "maxLength": 255, "type": "string" }, "value": { "description": "Represents the static literal value sent with every webhook execution.", "maxLength": 255, "type": "string" } }, "title": "Webhook Custom Parameters", "type": "object", "x-zs-llm-description": "A static key-value parameter. Used in headers, URL query parameters, or form data fields." }, "WebhookDetailsResponse": { "additionalProperties": false, "description": "Represents the nested object containing the unique identifier of the webhook returned by a mutation operation.", "properties": { "id": { "description": "Represents the unique identifier of the webhook.", "maxLength": 255, "type": "string" } }, "title": "Webhook Details Response", "type": "object", "x-zs-llm-description": "Nested details containing the webhook's unique identifier." }, "WebhookFailureDetail": { "additionalProperties": false, "description": "Represents the details of a single webhook execution failure, including the triggering CRM record, workflow rule, failure reason, and timestamp.", "properties": { "entity_details": { "$ref": "#/components/schemas/FailureEntityDetails", "description": "Details of the CRM record that triggered the failed webhook execution." }, "failure_reason": { "description": "Represents the reason for the webhook execution failure, such as page_notfound.", "maxLength": 255, "type": "string" }, "failure_time": { "description": "Represents the ISO 8601 timestamp of when the webhook execution failed.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the failure record.", "maxLength": 255, "type": "string" }, "webhook": { "$ref": "#/components/schemas/WebhookReference", "description": "Reference to the webhook that failed (id and name)." }, "workflow_rule": { "$ref": "#/components/schemas/WorkflowRuleReference", "description": "Reference to the workflow rule that triggered the webhook." } }, "type": "object", "x-zs-llm-description": "Single webhook execution failure including triggering entity, workflow rule, failure reason, and timestamp." }, "WebhookFailuresResponse": { "additionalProperties": false, "description": "Represents the paginated response containing webhook execution failure records. Filter by webhook_id, module API name, and date range using query parameters.", "properties": { "info": { "$ref": "#/components/schemas/PaginationInfoResponse", "description": "Pagination metadata for navigating failure records." }, "webhook_failures": { "description": "Represents the list of webhook execution failure detail objects.", "items": { "$ref": "#/components/schemas/WebhookFailureDetail" }, "maxItems": 200, "type": "array" } }, "type": "object", "x-zs-$id": "WebhookFailuresResponse", "x-zs-llm-description": "Paginated response of webhook execution failures. Filter by webhook_id, module, and date range." }, "WebhookHeaders": { "additionalProperties": false, "description": "Represents the HTTP headers configuration for the outgoing webhook request. Supports module merge-field parameters and custom static parameters. The host header name is reserved and cannot be used.", "properties": { "custom_parameters": { "description": "Represents the static key-value pairs sent as HTTP headers with every webhook execution.", "items": { "$ref": "#/components/schemas/WebhookCustomParameters" }, "maxItems": 10, "type": [ "array", "null" ] }, "module_parameters": { "description": "Represents the module merge-field parameters sent as HTTP headers. The key must be present but may be an empty array when only custom parameters are needed.", "items": { "$ref": "#/components/schemas/WebhookModuleParameters" }, "maxItems": 25, "type": [ "array", "null" ] } }, "title": "Webhook Headers", "type": "object", "x-zs-llm-description": "Headers configuration for webhook HTTP requests. HOST and restricted headers are not allowed. Contains module_parameters and custom_parameters arrays." }, "WebhookModuleParameters": { "additionalProperties": false, "description": "Represents a module merge-field parameter for webhook requests. Used in headers, URL query parameters, or form data fields. The value is resolved at runtime from the field of the triggering CRM record.", "properties": { "name": { "description": "Represents the parameter key sent in the webhook request. The name must be unique within the parameter collection.", "maxLength": 255, "type": "string" }, "value": { "description": "Represents the merge-field token resolved at runtime from the triggering CRM record. Use the API field names and not display names (for example, use ${!Leads.Last_Name}, not ${!Leads.Last Name}). Invalid API names return INVALID_DATA.", "maxLength": 255, "type": "string" } }, "title": "Webhook Module Parameters", "type": "object", "x-zs-llm-description": "A merge-field parameter resolved from a record's field value at runtime. Use ${!Module.Field_Name} syntax." }, "WebhookReference": { "additionalProperties": false, "description": "Represents a lightweight reference to a webhook, containing its unique identifier and display name. Used in failure log records.", "properties": { "id": { "description": "Represents the unique identifier of the webhook.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the webhook.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-llm-description": "Reference to a webhook in failure context. Contains id and name." }, "WebhookRequestBody": { "additionalProperties": false, "description": "Represents the request body configuration for the outgoing webhook request. For type **form_data**, provide form_data_content with module_parameters and custom_parameters; format may be null. \n\nFor type **raw**, supply raw_data_content and a format value of JSON, XML, Text, or HTML. For type **none**, the body carries no content and format may be null.", "properties": { "form_data_content": { "$ref": "#/components/schemas/FormDataContent", "description": "Form data content when body type is form_data. Contains module parameters, custom parameters, and an optional user-defined parameter." }, "format": { "description": "Specify the body content format.\nPossible values:\n**JSON** - JSON format.\n**XML** - XML format.\n**Text** - Plain text format.\n**HTML** - HTML format.\n**null** - Valid for form_data and none body types.", "enum": [ "JSON", "XML", "Text", "HTML", null ], "maxLength": 25, "type": [ "string", "null" ] }, "raw_data_content": { "description": "Represents the raw string content sent as the request body. This field is required when the body type is raw.", "maxLength": 500, "type": [ "string", "null" ] }, "type": { "description": "Specify the body type for the webhook request.\nPossible values:\n**form_data** - Sends data as key-value pairs in the request body.\n**raw** - Sends plain text, JSON, HTML, or XML content directly.\n**none** - No body content.", "enum": [ "form_data", "raw", "none" ], "maxLength": 255, "type": "string" } }, "required": [ "type", "format" ], "title": "Webhook Request Body", "type": "object", "x-zs-llm-description": "Configures the webhook request body; type and format are required for all variants. For type=form_data: supply form_data_content with module_parameters and custom_parameters sub-arrays; format may be null. For type=raw: supply raw_data_content (a string) and a format value of JSON, XML, Text, or HTML note the field is raw_data_content, not data, and format, not content_type. For type=none: the body carries no content and format may be null, but the field must still be present. Example form_data: {\"type\":\"form_data\",\"format\":null,\"form_data_content\":{\"module_parameters\":[{\"name\":\"Lead_Source\",\"value\":\"${!Leads.Lead_Source}\"}],\"custom_parameters\":[{\"name\":\"key\",\"value\":\"val\"}]}}. Example (raw): {\"type\":\"raw\",\"format\":\"JSON\",\"raw_data_content\":\"{\\\"lead\\\":\\\"${!Leads.Full_Name}\\\"}\"}." }, "WebhookStatusResponse": { "additionalProperties": false, "description": "Represents the operation result for a webhook create, update, or delete action. On success, code is success, status is success, and details contains the webhook ID.", "properties": { "code": { "description": "Represents the success or error code of the webhook operation.", "example": "SUCCESS", "maxLength": 255, "type": "string" }, "details": { "$ref": "#/components/schemas/WebhookDetailsResponse", "description": "Result details. On success, contains the webhook id." }, "message": { "description": "Represents the description of the operation result.", "example": "webhook created successfully", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the operation status.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Webhook Status Response", "type": "object", "x-zs-llm-description": "Action result for webhook create/update/delete. On success: code=SUCCESS with the webhook ID in details." }, "WebhookUpdateInput": { "additionalProperties": false, "description": "Represents the writable fields for updating an existing webhook. Full-replacement semantics apply all required fields must be present, as omitted fields reset to defaults or null. \n\nThe module field is immutable; providing a different module returns NOT_ALLOWED. System-managed read-only fields must be omitted.", "properties": { "authentication": { "$ref": "#/components/schemas/WebhookAuthenticationDetails", "description": "Authentication configuration." }, "body": { "$ref": "#/components/schemas/WebhookRequestBody", "description": "Request body. Only allowed when http_method is POST or PUT. type and format are required. When type=form_data: provide form_data_content (object with module_parameters and custom_parameters arrays); format may be null. When type=raw: provide raw_data_content (string) and format (JSON, XML, Text, or HTML). When type=none: format may be null." }, "date_time_format": { "$ref": "#/components/schemas/DateTimeFormatConfig", "description": "Optional. Only relevant when a date or datetime merge-field is used in any parameter (headers, url_parameters, or body). Use datetime_format + time_zone for datetime fields, date_format for date fields. Ignored if no date/datetime merge-fields are present." }, "description": { "description": "Specify the optional description of the webhook purpose.", "maxLength": 500, "type": [ "string", "null" ] }, "feature_type": { "description": "Specify the automation feature type for this webhook.\nPossible values:\n**workflow** - Workflow Rule.\n**approval_process** - Approval Process.\n**blueprint_transition** - Blueprint transition.\n**blueprint_state** - Blueprint state.\n**assignment_rules** - Assignment Rules.\n**kiosk** - Kiosk feature.\n**commandcenter_service** - CommandCenter service.", "enum": [ "workflow", "approval_process", "blueprint_transition", "blueprint_state", "assignment_rules", "kiosk", "commandcenter_service" ], "maxLength": 255, "type": "string" }, "headers": { "$ref": "#/components/schemas/WebhookHeaders", "description": "HTTP headers. Only allowed when http_method is POST, PUT, or DELETE. Restricted header name: HOST is not allowed. Parameter names must be unique (DUPLICATE_DATA)." }, "http_method": { "description": "Specify the HTTP method used when the webhook fires.\nPossible values:\n**POST** - Sends a POST request.\n**GET** - Sends a GET request.\n**PUT** - Sends a PUT request.\n**DELETE** - Sends a DELETE request.", "enum": [ "POST", "GET", "PUT", "DELETE" ], "type": "string" }, "id": { "description": "Represents the unique identifier of the webhook to update. The ID is required in the request body when using the bulk update endpoint.", "example": "5725767000007186002", "maxLength": 20, "type": "string" }, "module": { "$ref": "#/components/schemas/AutomationModuleDetailsResponse", "description": "The CRM module. Cannot be changed - providing a different module returns NOT_ALLOWED." }, "name": { "description": "Specify the display name of the webhook. The name must not contain the tilde (~) character. The name cannot be changed for kiosk feature actions.", "maxLength": 250, "type": "string" }, "related_module": { "$ref": "#/components/schemas/RelatedModuleReference", "description": "Related CRM module. Required when feature_type is kiosk.", "type": [ "object", "null" ] }, "url": { "description": "Specify the destination URL that receives the webhook request when triggered. The URL must begin with http://, https://, www., or a merge-field token (${...}). URLs resolving to internal or private host addresses are rejected by SSRF protection.", "maxLength": 2000, "type": "string" }, "url_parameters": { "$ref": "#/components/schemas/WebhookUrlParameters", "description": "URL query parameters. Only allowed when http_method is GET or DELETE." } }, "required": [ "name", "module", "url", "http_method", "authentication", "feature_type" ], "type": "object", "x-zs-$id": "WebhookUpdateInput", "x-zs-llm-description": "Defines the writable fields when updating a webhook. Start by calling `getWebhookById` to read the current state. All required fields (name, module, url, http_method, authentication, feature_type) must be included partial updates are not supported. Module is immutable and returns NOT_ALLOWED if changed. System-managed read-only fields must be omitted." }, "WebhookUrlParameters": { "additionalProperties": false, "description": "Represents the URL query parameters appended to the webhook request URL. Applicable only when http_method is GET or DELETE. Returns null when http_method is POST or PUT.", "properties": { "custom_parameters": { "description": "Represents the static key-value pairs appended as URL query parameters to every webhook request. Each entry must have a unique name.\n\n- name (string, optional)\n\nSpecify a name to the custom header.\n\n\n- value (string, optional)\n\nSpecify a value to the custom header.\n\n\n\"custom_parameters\": [\n {\n \"name\": \"OAuth\",\n \"value\": \"2.0\"\n }\n]. \n\n\nA maximum of 10 entries is allowed.", "items": { "$ref": "#/components/schemas/WebhookCustomParameters" }, "maxItems": 10, "type": "array" }, "module_parameters": { "description": "Represents the module merge-field parameters appended as URL query parameters. Values are resolved at runtime from the triggering CRM record using the merge-field format (for example, ${!Leads.Email}). Use the [Get Fields Metadata](fields.yaml#$.paths./settings/fields.get) resource to retrieve valid field API names.", "items": { "$ref": "#/components/schemas/WebhookModuleParameters" }, "maxItems": 25, "type": "array" }, "user_defined_parameters": { "$ref": "#/components/schemas/UserDefinedParameter", "description": "A single user-defined parameter appended as a URL query parameter. Note: The API uses plural 'user_defined_parameters' here but singular 'user_defined_parameter' in form_data_content - both are single objects, not arrays." } }, "type": [ "object", "null" ], "x-zs-$id": "WebhookUrlParameters", "x-zs-llm-description": "URL parameters for GET/DELETE webhook methods. Null when http_method is POST or PUT." }, "WebhooksDependentFieldMissingError": { "additionalProperties": false, "description": "Represents the error returned when a field that is required by another field's value is absent from the request.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**DEPENDENT_FIELD_MISSING** - A required dependent field is missing from the request.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the missing dependent field and the dependee field that triggered the requirement.", "properties": { "api_name": { "description": "Represents the API name of the missing or conflicting field.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the dependee field whose value triggers the dependency requirement.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependee field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the missing or conflicting field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**raw data content key is mandatory for raw body type** - The raw_data_content field is required when the body type is raw.\n**form data content key is mandatory for form body type** - The form_data_content field is required when the body type is form.\n**Webhook action related module missing for kiosk feature** - A related module is required for kiosk-type webhooks.\n**Dependent Field missing** - A required dependent field was not included in the request.", "enum": [ "raw data content key is mandatory for raw body type", "form data content key is mandatory for form body type", "Webhook action related module missing for kiosk feature", "Dependent Field missing" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DependentFieldMissingError", "x-zs-llm-description": "A dependent field is missing from the request." }, "WebhooksExpectedFieldMissingError": { "additionalProperties": false, "description": "Represents the error returned when a required object is supplied but does not include any of the expected identifying fields.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**EXPECTED_FIELD_MISSING** - One or more expected fields are absent from the request.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details listing the fields of which at least one must be provided.", "properties": { "expected_fields": { "description": "Represents the list of expected fields of which at least one must be provided.", "items": { "additionalProperties": false, "description": "Represents an expected field reference object containing the field API name and its JSON path.", "properties": { "api_name": { "description": "Represents the API name of the expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the expected field.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 5, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Specify atleast one field** - At least one of the expected fields must be provided in the request.\n**Provide the expected field** - A specific required field is absent from the request.", "enum": [ "Specify atleast one field", "Provide the expected field" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingError", "x-zs-llm-description": "A required object was provided but missing all expected identifying fields. Supply at least one identifier." }, "WebhooksFeatureNotSupportedError": { "additionalProperties": false, "description": "Represents the error returned when the current CRM edition does not support the webhook feature.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**FEATURE_NOT_SUPPORTED** - The requested feature is not available in the current edition.", "enum": [ "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing additional context about the unsupported feature.", "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**feature not available in this edition** - The requested webhook feature is not supported by the current CRM edition.", "enum": [ "feature not available in this edition" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FeatureNotSupportedError", "x-zs-llm-description": "The CRM edition does not support webhooks. Upgrade is required." }, "WebhooksInvalidDataMaxLengthError": { "additionalProperties": false, "description": "Represents the error returned when a field value exceeds the maximum allowed character length.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - A field value exceeds the maximum allowed length.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field that exceeds the maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeds the maximum allowed length.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that exceeds the maximum allowed length.", "maxLength": 1000, "type": "string" }, "maximum_length": { "description": "Represents the maximum number of characters allowed for the field.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.", "enum": [ "Invalid data", "invalid data" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataMaxLengthError", "x-zs-llm-description": "A field value exceeds maximum allowed character length. Check details.maximum_length." }, "WebhooksInvalidDataSupportedValuesError": { "additionalProperties": false, "description": "Represents the error returned when a field value is not among the accepted values for that field. The details object includes a supported_values array listing the accepted values.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - A field value is not among the supported values.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field with an unsupported value.", "properties": { "api_name": { "description": "Represents the API name of the field that contains the unsupported value.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contains the unsupported value.", "maxLength": 1000, "type": "string" }, "regex": { "description": "Represents the regex pattern used for validation of the field value.", "maxLength": 1000, "type": "string" }, "supported_values": { "description": "Represents the list of values that are supported for this field.", "items": { "description": "Represents an individual supported value for the field.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\n", "enum": [ "Invalid data", "invalid data" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataSupportedValuesError", "x-zs-llm-description": "A field value is not among the supported values. Check details.supported_values array." }, "WebhooksInvalidDataTypeError": { "additionalProperties": false, "description": "Represents the error returned when a field value has an incorrect data type.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_DATA** - A field value has an incorrect data type.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing information about the field with the incorrect data type.", "properties": { "api_name": { "description": "Represents the API name of the field with the incorrect data type.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the incorrect data type.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Invalid data type** - The field value does not match the expected data type.\n**data type not supported** - The data type provided is not supported for this field.\n**invalid data** - The field value is not valid.", "enum": [ "Invalid data type", "data type not supported", "invalid data" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataTypeError", "x-zs-llm-description": "A field value has an incorrect data type (e.g., string instead of object). Check details." }, "WebhooksInvalidModuleErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the module api_name provided in a query parameter does not match an existing CRM module.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**INVALID_MODULE** - The module API name provided in the request is not recognized.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the name of the parameter with the invalid module.", "properties": { "param_name": { "description": "Represents the name of the parameter that contains the invalid module API name.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**The value provided to the param is Invalid** - The module API name does not match any valid CRM module.", "enum": [ "The value provided to the param is Invalid" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Invalid Module Error Response", "type": "object", "x-zs-$id": "InvalidModuleErrorResponse", "x-zs-llm-description": "The module in the request is invalid. Verify via `getModules`." }, "WebhooksLimitExceededError": { "additionalProperties": false, "description": "Represents the error returned when the number of items in a parameter array exceeds the allowed limit.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**LIMIT_EXCEEDED** - The number of webhooks exceeds the maximum allowed for the organization.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the field name and the enforced limit.", "properties": { "api_name": { "description": "Represents the API name of the field for which the limit is exceeded.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field for which the limit is exceeded.", "maxLength": 1000, "type": "string" }, "limit": { "description": "Represents the maximum number of items allowed for the field.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**can't pass more than the limit** - The submitted value exceeds the allowed limit for this field.", "enum": [ "can't pass more than the limit" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "LimitExceededError", "x-zs-llm-description": "A parameter count exceeds the allowed limit (e.g., too many custom_parameters)." }, "WebhooksMandatoryFieldMissingError": { "additionalProperties": false, "description": "Represents the error returned when a required field is absent from the request body.", "properties": { "code": { "description": "Represents the error code for this failure.\nPossible values:\n**MANDATORY_NOT_FOUND** - A required field is missing from the request body.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details identifying the mandatory field that is missing.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field that is missing.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the mandatory field that is missing.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\nPossible values:\n**Required field is missing** - A mandatory field was not included in the request.", "enum": [ "Required field is missing" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryFieldMissingError", "x-zs-llm-description": "A required field is missing from the request body. Check details for the field name." }, "WebhooksNoPermissionErrorResponse": { "additionalProperties": false, "description": "Represents the error returned when the requesting user does not have the required CRM profile permission to perform the operation.", "properties": { "code": { "description": "The requesting user does not have the required CRM profile permission.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details containing the list of permissions required for this operation.", "properties": { "permissions": { "description": "Represents the list of CRM profile permissions required to perform this operation.", "items": { "description": "Represents an individual CRM profile permission name required to perform this operation.", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.\n\nPossible values:\n**permission denied** - The requesting user lacks the required CRM profile permission for this operation.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the error status.\nPossible values:\n**error** - Indicates the request did not complete successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "No Permission Error Response", "type": "object", "x-zs-$id": "NoPermissionErrorResponse", "x-zs-llm-description": "The user lacks permission to perform this webhook operation. Check profile settings." }, "WhatsappMessageNotificationTypeFollowupActionRequestObject": { "additionalProperties": false, "description": "Represents the follow-up step configuration for a WhatsApp message notification action in a Cadence.", "properties": { "id": { "description": "Represents the unique identifier of the WhatsApp message notification action.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getMessageNotifications", "propertyId": "MessageNotificationId" }, { "operationId": "postMessageNotification", "propertyId": "MessageNotificationResultId" } ], "resource": "message_notifications" } }, "type": { "description": "Represents the action type for this follow-up step.", "enum": [ "whatsapp_message_notification" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "WhatsappMessageNotificationTypeFollowupActionRequestObject" }, "WorkflowActionCountsResponseSchema": { "additionalProperties": false, "description": "Represents the response body containing the action count breakdown for one or more workflow rules, grouped by condition.", "properties": { "workflow_rules": { "description": "Represents the array of workflow rule objects with their action count details.", "items": { "$ref": "#/components/schemas/WorkflowRuleActionCountGroupSchema" }, "maxItems": 10, "type": "array" } }, "required": [ "workflow_rules" ], "title": "Workflow Action Counts Response", "type": "object", "x-zs-$id": "GetactionscountResponse200", "x-zs-llm-description": "Response from getWorkflowRulesActionsCount. Contains workflow_rules array where each entry has rule id and conditions array with per-condition action counts split by instant and scheduled types." }, "WorkflowConditionActionCountSummarySchema": { "additionalProperties": false, "description": "Represents the action count summary for a single workflow rule condition, including the condition ID, sequence number, and counts for instant and scheduled actions.", "properties": { "id": { "description": "Represents the unique ID of the WorkflowConditionActionCountSummary within the workflow rule.", "maxLength": 20, "type": "string" }, "instant_actions": { "anyOf": [ { "$ref": "#/components/schemas/ActionsCountSummarySchema" }, { "description": "Represents a null value indicating no instant actions are configured for this condition.", "type": "null", "x-zs-$id": "LockedByNullSchema2" } ] }, "scheduled_actions": { "description": "Represents the array of scheduled action groups configured for this condition.", "items": { "$ref": "#/components/schemas/ActionsCountSummarySchema" }, "maxItems": 5, "type": [ "array", "null" ] }, "sequence_number": { "description": "Represents the execution order of this condition within the workflow rule, starting from one.", "format": "int32", "type": "integer" } }, "required": [ "id", "instant_actions", "scheduled_actions", "sequence_number" ], "title": "Workflow Condition Action Count Summary", "type": "object", "x-zs-llm-description": "Per-condition action count breakdown. Contains sequence_number, id (condition ID), instant_actions (count by type), and scheduled_actions (count by type). Use to check slot availability." }, "WorkflowConditionUsageSummarySchema": { "additionalProperties": false, "description": "Represents the execution usage summary for a single workflow rule condition, including total execution count and breakdowns for instant and scheduled action groups.", "properties": { "id": { "description": "Represents the unique ID of the WorkflowConditionUsageSummary within the workflow rule.", "maxLength": 20, "type": "string" }, "instant_actions": { "$ref": "#/components/schemas/InstantActionsUsageListSchema" }, "scheduled_actions": { "description": "Represents the array of scheduled action groups configured for this condition.", "items": { "$ref": "#/components/schemas/ScheduledActionsUsageGroupSchema" }, "maxItems": 5, "type": "array" }, "usage_count": { "description": "Represents the total number of times the actions in this condition were executed.", "format": "int32", "type": "integer" } }, "required": [ "id", "instant_actions", "scheduled_actions", "usage_count" ], "title": "Workflow Condition Usage Summary", "type": "object", "x-zs-$id": "WorkflowConditionUsageSummarySchema", "x-zs-llm-description": "Per-condition usage metrics. Contains instant_actions (list of action metrics), scheduled_actions (grouped action metrics), usage_count (total executions), and condition id." }, "WorkflowConditionUsageWithTaggedInstantActionsSchema": { "additionalProperties": false, "description": "Represents the usage summary for a workflow rule condition where instant actions include tag-based metrics, along with scheduled action group data.", "properties": { "id": { "description": "Represents the unique ID of the WorkflowConditionUsageWithTaggedInstantActions within the workflow rule.", "maxLength": 20, "type": "string" }, "instant_actions": { "$ref": "#/components/schemas/InstantActionsUsageWithTagsSchema" }, "scheduled_actions": { "$ref": "#/components/schemas/ScheduledActionsForWorkflowUsageSchema" }, "usage_count": { "description": "Represents the total number of times the actions in this condition were executed.", "format": "int32", "type": "integer" } }, "required": [ "id", "instant_actions", "scheduled_actions", "usage_count" ], "title": "Workflow Condition Usage With Tagged Instant Actions", "type": "object", "x-zs-$id": "WorkflowConditionUsageWithTaggedInstantActionsSchema", "x-zs-llm-description": "Variant of condition usage where instant actions include tag_id for tracking tagged action performance. Same structure as WorkflowConditionUsageSummarySchema but with tag metadata on each action." }, "WorkflowConfigurationsAction": { "additionalProperties": false, "description": "Represents an action type available for the module. Defines an operation that can be performed when a workflow rule triggers. The limit field is the per-type cap that applies independently to instant_actions and scheduled_actions - for instance, if limit=5, you can add up to 5 instances in instant_actions and up to 5 in scheduled_actions of the same rule.", "properties": { "api_name": { "description": "Represents the API identifier of the action type used when creating or modifying workflow rules (for example, field_updates, email_notifications, webhooks, assign_owner, add_tags, remove_tags, create_record, add_meeting, schedule_call, convert, functions, flow).", "maxLength": 255, "type": "string" }, "associate_action": { "description": "Indicates whether this action type is an associate action. Associate actions link or associate records between modules (for example, linking a Contact to a Deal or associating a Product with an Order). Associate actions differ from standard data-write actions such as field_updates or email_notifications.\nPossible values: **true** - This action type is an associate action. **false** - This action type is a standard non-associate action.", "type": "boolean", "x-zs-llm-description": "When true, reference an existing reusable automation entity by ID instead of defining the action inline." }, "is_clickable": { "description": "Indicates whether this action type can be edited directly from the workflow configuration UI page. Not relevant for API usage.", "type": "boolean" }, "limit": { "description": "Maximum number of instances of this action type allowed per workflow rule. Applies independently to instant_actions and scheduled_actions - for instance, if limit=5, you can add up to 5 instances in instant_actions and up to 5 in scheduled_actions. Returns LIMIT_EXCEEDED if exceeded.", "format": "int32", "minimum": 1, "type": "integer", "x-zs-llm-description": "Use this as the maximum number of action instances of this type allowed in instant_actions and separately in scheduled_actions." }, "limit_per_action": { "description": "Represents the maximum number of items within a single action instance. For example, add_tags and remove_tags allow a maximum of 10 tags per action. Returns null if no per-action item limit applies.", "format": "int32", "type": [ "integer", "null" ], "x-zs-llm-description": "Use this as the maximum number of items inside one action instance when the value is not null." }, "name": { "description": "Represents the display name of the action type as shown in the CRM UI.", "maxLength": 255, "type": "string" }, "supported_in_scheduled_action": { "description": "Indicates whether this action type can be used as a scheduled (time-delayed) action in a workflow rule. **Possible values:** true - This action type is supported in scheduled_actions (for example, time-delayed email_notifications or field_updates). false - This action type is only supported in instant_actions.", "type": "boolean", "x-zs-llm-description": "When false, do not place this action type inside scheduled_actions." } }, "title": "Workflow Configurations Action", "type": "object", "x-zs-$id": "WorkflowConfigurationsAction", "x-zs-llm-description": "Use this object to choose an action type and understand whether it is reusable, schedulable, and how many instances are allowed." }, "WorkflowConfigurationsMetadata": { "additionalProperties": false, "description": "Configuration metadata for workflows on a specific module. Contains three sections: triggers (events that fire the rule), actions (operations available when the rule fires with their per-type limits and scheduling support), and related_triggers_details (child/related modules like Notes or Calls whose events can also trigger rules on the parent module).", "properties": { "actions": { "description": "List of available action types for the module. Each action defines an operation that can be performed when the workflow rule fires, along with its per-type limit (applies independently to instant_actions and scheduled_actions), scheduling support, and whether it is an associate action (reusable entity referenced by ID) or non-associate action (defined inline).", "items": { "$ref": "#/components/schemas/WorkflowConfigurationsAction" }, "maxItems": 20, "type": "array", "x-zs-llm-description": "Use this list to validate action types and limits before selecting instant or scheduled actions for a workflow rule." }, "related_triggers_details": { "description": "List of related modules (e.g., Notes, Calls, Activities) whose record events can trigger workflow rules on the parent module. Each entry contains the related module's identity and available trigger types.", "items": { "$ref": "#/components/schemas/WorkflowConfigurationsRelatedTriggerDetail" }, "maxItems": 20, "type": "array", "x-zs-llm-description": "Use this list only when a workflow rule should be triggered by events from a related module rather than the primary module." }, "triggers": { "description": "Represents the list of trigger types available for the module. Each entry defines an event that can initiate a workflow rule, along with the action types supported for that trigger (for example, create, edit, delete, field_update, date_or_datetime).", "items": { "$ref": "#/components/schemas/WorkflowConfigurationsTrigger" }, "maxItems": 20, "type": "array", "x-zs-llm-description": "Use each trigger api_name as the execute_when type when creating or updating workflow rules." } }, "title": "Workflow Configurations Metadata", "type": "object", "x-zs-$id": "WorkflowConfigurationsMetadata", "x-zs-llm-description": "Use this schema to understand which triggers and action types can be used when composing workflow rule requests for the module." }, "WorkflowConfigurationsModuleReference": { "additionalProperties": false, "description": "Represents a CRM module with its identity and display labels, including its API name, singular and plural display labels, unique ID, and internal name.", "properties": { "api_name": { "description": "Represents the API name of the CRM module used in API requests (for example, Leads, Contacts, Deals, Accounts, Tasks, Cases, Products, Quotes, Sales_Orders, Invoices, Campaigns, Vendors).", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the CRM module.", "example": "3361265000000000147", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the internal name of the CRM module.", "maxLength": 255, "type": "string" }, "plural_label": { "description": "Represents the plural display name of the module as shown in the CRM UI (for example, Leads, Contacts, Deals).", "maxLength": 255, "type": "string" }, "singular_label": { "description": "Represents the singular display name of the module as shown in the CRM UI (for example, Lead, Contact, Deal).", "maxLength": 255, "type": "string" } }, "title": "Module Reference", "type": "object", "x-zs-$id": "ModuleReference", "x-zs-llm-description": "Use api_name or id from this object when another workflow API requires a module identifier." }, "WorkflowConfigurationsNoPermissionError": { "additionalProperties": false, "description": "Represents the error response when the user lacks the required Manage Automation Actions privilege or when the workflow feature is unavailable in the current CRM edition.", "properties": { "code": { "description": "Represents the error code indicating the type of permission or feature availability error.\nPossible values:\nNO_PERMISSION - The user's profile lacks the required privilege.\nFEATURE_NOT_SUPPORTED - The workflow feature is unavailable in the current CRM edition.\n ", "enum": [ "NO_PERMISSION", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the object containing details about the missing permission.", "properties": { "permissions": { "description": "Represents the list of required permissions that the user's profile is missing.", "items": { "description": "Represents a required permission identifier string (for example, Crm_Implied_Manage_Workflow).", "maxLength": 255, "type": "string" }, "maxItems": 5, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the permission error message describing the issue.", "example": "feature not available in this edition", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "No Permission Error", "type": "object", "x-zs-$id": "NoPermissionError" }, "WorkflowConfigurationsRelatedTriggerDetail": { "additionalProperties": false, "description": "Represents a related module that can act as a trigger source for the parent module's workflow rules. For example, when a user creates a Note on a Lead record, a workflow rule on the Leads module configured with a Notes-related trigger fires.", "properties": { "api_name": { "description": "Represents the API name of the related module that can act as a trigger source (for example, Notes, Tasks, Events, Attachments). Use this value to identify the related module when creating workflow rules that should fire on related record events.", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/WorkflowConfigurationsModuleReference", "description": "Module identity including api_name, id, and labels." }, "name": { "description": "Represents the display name of the related module.", "maxLength": 255, "type": "string" }, "triggers": { "description": "Represents the list of trigger types available from this related module. These triggers can be used in workflow rules on the parent module via the execute_when.details.trigger_module field.", "items": { "$ref": "#/components/schemas/WorkflowConfigurationsTrigger" }, "maxItems": 20, "type": "array", "x-zs-llm-description": "Use these trigger definitions with execute_when details when the trigger source is a related module." } }, "title": "Workflow Configurations Related Trigger Detail", "type": "object", "x-zs-$id": "WorkflowConfigurationsRelatedTriggerDetail", "x-zs-llm-description": "Use this object when configuring workflows that react to events from related modules." }, "WorkflowConfigurationsRequiredParamMissingError": { "additionalProperties": false, "description": "Represents the error response when the required module query parameter is omitted from the request.", "properties": { "code": { "description": "Represents the error code indicating a required parameter is missing.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the object containing details about the missing parameter.", "properties": { "param_name": { "description": "Represents the name of the missing required parameter.", "enum": [ "module" ], "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "example": "required param not found", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Required Param Missing Error", "type": "object", "x-zs-$id": "RequiredParamMissingError" }, "WorkflowConfigurationsTrigger": { "additionalProperties": false, "description": "A trigger type available for the module. Defines the event that initiates a workflow rule. Use the api_name value in the execute_when.type field when creating or updating a workflow rule via POST/PUT /settings/automation/workflow_rules.", "properties": { "actions": { "description": "Represents the list of action type API names supported by this trigger. Only these action types can be used in workflow rules with this trigger type. Cross-reference with the top-level actions array in the response for full action metadata, including per-type limits and scheduling support.", "items": { "description": "Represents an action type API name supported by this trigger (for example, field_updates, email_notifications, webhooks, assign_owner, add_tags, remove_tags, create_record, add_meeting, schedule_call, convert, functions, flow).", "maxLength": 255, "type": "string" }, "maxItems": 20, "type": "array", "x-zs-llm-description": "Use these values to restrict workflow actions to the action types supported by the selected trigger." }, "api_name": { "description": "Represents the API identifier of the trigger type. Use this value in the execute_when.type field when creating a workflow rule (for example, create, edit, create_or_edit, delete, field_update, section_update, date_or_datetime, score_increase, score_decrease, score_update).", "maxLength": 255, "type": "string", "x-zs-llm-description": "Use this value as the trigger type identifier in workflow rule payloads." }, "component_id": { "description": "Represents the component identifier for marketplace or custom triggers. Returns null for standard built-in trigger types.", "maxLength": 255, "type": [ "string", "null" ] }, "deprecated": { "description": "Indicates whether this trigger type is deprecated.\nPossible values:\ntrue - The trigger type is deprecated and should not be used for new workflow rules, though it may still appear on existing rules.\nfalse - The trigger type is active and available for use.", "type": "boolean" }, "generated_type": { "description": "Represents the generated type identifier for marketplace or custom triggers. Returns null for standard built-in trigger types.", "maxLength": 255, "type": [ "string", "null" ] }, "name": { "description": "Represents the display name of the trigger type as shown in the CRM UI (for example, Create, Edit, FieldUpdate, DateBased).", "maxLength": 255, "type": "string" }, "scheduled_actions_supported": { "description": "Indicates whether this trigger type supports scheduled (time-delayed) actions.\nPossible values:\ntrue - Both instant_actions and scheduled_actions are available for workflow rules with this trigger.\nfalse - Only instant_actions can be used in workflow rules with this trigger.", "type": "boolean" } }, "title": "Workflow Configurations Trigger", "type": "object", "x-zs-$id": "WorkflowConfigurationsTrigger", "x-zs-llm-description": "Use this object to choose a workflow trigger and to know which action api_names are compatible with that trigger." }, "WorkflowGroupedFilterCriterion": { "additionalProperties": false, "description": "Represents a grouped filter criterion containing multiple simple filter conditions evaluated together using a logical operator such as AND or OR.", "properties": { "group": { "description": "Represents the array of filter conditions to be evaluated together using the specified logical operator.", "items": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowSimpleFilterCriterion" }, { "$ref": "#/components/schemas/WorkflowGroupedFilterCriterion" } ] }, "maxItems": 25, "minItems": 2, "type": "array" }, "group_operator": { "description": "Represents the logical operator applied between the filter conditions in the group.", "enum": [ "AND", "OR" ], "type": "string" } }, "required": [ "group", "group_operator" ], "type": "object", "x-zs-$id": "WorkflowGroupedFilterCriterion", "x-zs-llm-description": "Grouped filter criterion containing multiple WorkflowSimpleFilterCriterion items joined by group_operator (AND/OR). Use for complex multi-field conditions. The group array holds the individual criteria and group_operator defines their logical relationship." }, "WorkflowRuleActionCountGroupSchema": { "additionalProperties": false, "description": "Represents the action count breakdown for a single workflow rule, encapsulating the rule ID and its associated condition-level action count groups.", "properties": { "conditions": { "description": "Represents array of condition objects containing criteria and actions for this rule.", "items": { "$ref": "#/components/schemas/WorkflowConditionActionCountSummarySchema" }, "maxItems": 10, "type": "array" }, "id": { "description": "Represents the unique ID of the WorkflowRuleActionCountGroup within the workflow rule.", "maxLength": 20, "type": "string" } }, "required": [ "conditions", "id" ], "title": "Workflow Rule Action Count Group", "type": "object", "x-zs-llm-description": "Single rule entry in the action counts response. Contains the rule id and conditions array listing action count summaries per condition." }, "WorkflowRulePostNestedSchema": { "additionalProperties": false, "description": "Represents the configuration object for a new workflow rule, including required fields such as name, target module, and trigger configuration.", "properties": { "conditions": { "description": "Specify the conditions that define the branching logic of the workflow rule. Each condition evaluates records against criteria and executes its own set of actions. At least one condition is required.", "items": { "$ref": "#/components/schemas/ConditionsNestedSchema" }, "maxItems": 10, "type": "array" }, "description": { "description": "Specify an optional description for the workflow rule. Set to null to clear an existing description.", "maxLength": 1000, "type": [ "string", "null" ] }, "execute_when": { "$ref": "#/components/schemas/ExecuteWhenNestedSchema", "description": "Specifies when the workflow rule is triggered. This is a required JSON object with \"type\" and \"details\" properties. For example: {\"type\": \"create_or_edit\", \"details\": {\"trigger_module\": {\"api_name\": \"Leads\", \"id\": \"...\"}, \"repeat\": false}}. Passing a string instead of a JSON object, such as \"create_or_edit\", returns an \"INVALID_DATA\" error. The \"details.trigger_module\" must match the module associated with the workflow rule. Use \"getWorkflowConfigurations\" to retrieve the available triggers and their supported actions." }, "lock": { "additionalProperties": false, "description": "Specify the lock configuration to prevent other users from editing the rule. Only administrators can lock or unlock rules.", "properties": { "message": { "description": "Specify the reason or context for locking the rule. Valid only when **lock.status** is set to true.", "format": "string", "type": "string" }, "status": { "description": "Specify whether to lock the rule.\nPossible values:\ntrue - Locks the rule to prevent editing.\nfalse - Unlocks the rule.", "type": "boolean" } }, "type": "object" }, "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema", "description": "The module to which the workflow rule applies. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs. Required. Must be a workflow-supported module. If both id and api_name are provided, they must match. Use `getWorkflowConfigurations` to discover supported modules. Cannot be changed after creation." }, "name": { "description": "Specify the workflow rule name. Required. Cannot exceed 100 characters. Special characters are not allowed.", "maxLength": 100, "type": "string" } }, "required": [ "conditions", "execute_when", "module", "name" ], "type": "object", "x-zs-llm-description": "The rule object for creating a workflow rule. Required fields: name (max 100 chars), module ({api_name, id}), execute_when (trigger config), conditions (array with actions). Optional: description (max 1000), lock ({status, message}). Must call getWorkflowConfigurations before constructing to validate trigger and action availability for the module." }, "WorkflowRuleProcessingSummary": { "additionalProperties": false, "description": "Represents the summary of workflow rule impact for the job, including counts of total evaluated, processed, and failed rules.", "properties": { "failed": { "description": "Represents the failed records.", "format": "int32", "type": "integer" }, "processed": { "description": "Represents the processed records.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the total records.", "format": "int32", "type": "integer" } }, "required": [ "failed", "processed", "total" ], "title": "Workflow Rule Processing Summary", "type": "object" }, "WorkflowRulePutNestedSchema": { "additionalProperties": false, "description": "Represents the configuration object for updating an existing workflow rule, including the rule ID and optional fields such as name, trigger, conditions, and lock status.", "properties": { "conditions": { "description": "Specify the array of condition objects to update. On update, unspecified conditions are preserved. Conditions with a null ID are added; conditions with an existing ID get replaced; conditions with a **_delete** flag are removed.", "items": { "$ref": "#/components/schemas/ConditionsNestedSchema" }, "maxItems": 20, "type": "array" }, "description": { "description": "Specify the workflow rule description.", "maxLength": 1000, "type": "string" }, "execute_when": { "$ref": "#/components/schemas/ExecuteWhenNestedSchema", "description": "Defines the conditions under which the workflow rule will be executed. (Required)" }, "id": { "description": "Represents the unique ID of the workflow rule to update. Required.", "maxLength": 30, "type": "string" }, "lock": { "additionalProperties": false, "description": "Specify whether the workflow rule should be locked to prevent editing by other users.", "properties": { "message": { "description": "Specify a note or label indicating the reason or context for locking the rule.", "format": "string", "type": "string" }, "status": { "description": "Specify whether to lock or unlock the workflow rule.\nPossible values:\ntrue - Locks the rule to prevent editing.\nfalse - Unlocks the rule.", "enum": [ true, false ], "type": "boolean" } }, "type": "object" }, "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema" }, "name": { "description": "Specify the workflow rule name. Required.", "maxLength": 100, "type": "string" }, "status": { "additionalProperties": false, "description": "Specify the activation state of the workflow rule. When setting **active** to false, you can optionally delete all associated scheduled actions.", "properties": { "active": { "description": "Specify whether the workflow rule is active or inactive.\nPossible values:\ntrue - The rule is active and executes when triggered.\nfalse - The rule is inactive and does not execute.", "type": "boolean" }, "delete_schedule_action": { "description": "Specify whether to delete all scheduled actions associated with the workflow rule when deactivating it.\nPossible values:\ntrue - Delete all scheduled actions when the rule is deactivated.\nfalse - Preserve scheduled actions when the rule is deactivated.", "type": "boolean" } }, "type": "object" } }, "type": "object", "x-zs-llm-description": "Rule object inside the PUT request body. All fields are optional for partial update: id (required for identification in bulk PUT), name, description, status ({active: bool}), execute_when (trigger), conditions (actions), lock, module. Omitted fields retain their current values." }, "WorkflowRuleReference": { "additionalProperties": false, "description": "Represents a reference to the workflow rule that triggered a webhook execution.", "properties": { "id": { "description": "Represents the unique identifier of the workflow rule.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the workflow rule.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-llm-description": "Reference to the workflow rule that triggered a webhook execution. Contains id and name." }, "WorkflowRuleSingleGetResponseSchema": { "additionalProperties": false, "description": "Represents the response body for a single workflow rule retrieval, containing a single-element array with the full rule details.", "properties": { "workflow_rules": { "description": "Represents the array containing the single workflow rule retrieved.", "items": { "$ref": "#/components/schemas/WorkflowRuleSingleGetSchema" }, "maxItems": 10, "type": "array" } }, "required": [ "workflow_rules" ], "title": "Workflow Rule List Response", "type": "object", "x-zs-$id": "WorkflowRuleSingleGetResponseSchema", "x-zs-llm-description": "Response wrapper for getWorkflowRuleById. Contains workflow_rules array with exactly one complete rule object." }, "WorkflowRuleSingleGetSchema": { "additionalProperties": false, "description": "Represents the full configuration and metadata of a single workflow rule, including its trigger, conditions, actions, lock status, and audit timestamps.", "properties": { "category": { "description": "Represents the classification category of the workflow rule.", "maxLength": 255, "type": "string" }, "conditions": { "description": "Represents the array of condition objects that define the criteria for executing the actions of the workflow rule.", "items": { "$ref": "#/components/schemas/ConditionsNestedSchema" }, "maxItems": 10, "type": "array" }, "created_by": { "$ref": "#/components/schemas/CreatedModifiedByObjectSchema" }, "created_time": { "description": "Represents the ISO 8601 timestamp indicating when the system created this workflow rule.", "format": "date-time", "maxLength": 255, "type": "string" }, "deletable": { "description": "Indicates whether the requesting user has permission to delete this workflow rule.", "type": "boolean" }, "deprecated": { "description": "Indicates whether this workflow rule is deprecated and should be migrated to a newer configuration.", "type": "boolean" }, "description": { "description": "Represents the user-defined description of the workflow rule. Null if not set.", "maxLength": 255, "type": [ "string", "null" ] }, "editable": { "description": "Indicates whether the requesting user has permission to edit this workflow rule.", "type": "boolean" }, "execute_when": { "$ref": "#/components/schemas/ExecuteWhenNestedSchema" }, "id": { "description": "Represents the unique ID of the workflow rule.", "maxLength": 20, "type": "string" }, "last_executed_time": { "description": "Represents the ISO 8601 timestamp of the last time this workflow rule was triggered. Null if the rule has never been triggered.", "format": "date-time", "type": [ "string", "null" ] }, "lock": { "$ref": "#/components/schemas/LockStatusSchema" }, "modified_by": { "$ref": "#/components/schemas/CreatedModifiedByObjectSchema" }, "modified_time": { "$ref": "#/components/schemas/TimeObjectSchema" }, "module": { "$ref": "#/components/schemas/ModuleOrFieldNestedSchema" }, "name": { "description": "Represents the name of the workflow rule.", "maxLength": 255, "type": "string" }, "source": { "description": "Represents the origin of the workflow rule. For example, **crm** for rules created through the CRM UI, or **API** for rules created through the API.", "maxLength": 255, "type": "string" }, "status": { "$ref": "#/components/schemas/ActivationStatusSchema" } }, "required": [ "created_by", "created_time", "deletable", "description", "editable", "execute_when", "id", "last_executed_time", "lock", "modified_by", "modified_time", "module", "name", "source", "status" ], "title": "Workflow Rule", "type": "object", "x-zs-llm-description": "Complete workflow rule entity as returned in GET responses. Contains all rule metadata: trigger (execute_when), conditions with actions, module reference, ownership (created_by, modified_by), timestamps, lock status, activation status, and capabilities (editable, deletable, deprecated). Use this to understand current rule state before updating." }, "WorkflowRuleUsageResponseSchema": { "additionalProperties": false, "description": "Represents the response body containing detailed execution usage metrics for one or more workflow rules within a queried date range.", "properties": { "workflow_rules": { "description": "Represents the array of workflow rule usage objects.", "items": { "additionalProperties": false, "description": "Represents the usage report for a single workflow rule, including execution metrics at the condition level.", "properties": { "conditions": { "description": "Represents the array of condition objects with usage metrics for the workflow rule.", "items": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowConditionUsageSummarySchema" }, { "$ref": "#/components/schemas/WorkflowConditionUsageWithTaggedInstantActionsSchema" } ] }, "maxItems": 10, "type": "array" }, "id": { "description": "Represents the unique ID of the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the name of the workflow rule.", "maxLength": 255, "type": "string" }, "reset_time": { "description": "Represents the ISO 8601 timestamp when the usage counters were last reset.", "maxLength": 255, "type": [ "string", "null" ] }, "trigger_count": { "description": "Represents the number of times this workflow rule was triggered within the queried date range.", "format": "int32", "type": "integer" } }, "required": [ "conditions", "id", "name", "reset_time", "trigger_count" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "workflow_rules" ], "title": "Workflow Rule Usage Response", "type": "object", "x-zs-$id": "WorkflowRuleUsageResponseSchema", "x-zs-llm-description": "Response from getWorkflowRuleUsage. Contains workflow_rules array with one entry holding per-condition usage metrics including success/failure counts and email engagement stats." }, "WorkflowRulesCountResponseSchema": { "additionalProperties": false, "description": "Represents the response body containing the organization-level workflow rule quota and current usage counts.", "properties": { "rules_count": { "additionalProperties": false, "description": "Represents the workflow rule count and limit details for the organization.", "properties": { "active_rules_configured": { "description": "Represents the number of currently active workflow rules configured in the organization.", "format": "int32", "type": "integer" }, "active_rules_limit": { "description": "Represents the maximum number of active workflow rules allowed in the organization.", "format": "int32", "type": "integer" }, "active_rules_limit_per_module": { "description": "Represents the maximum number of active workflow rules allowed per CRM module.", "format": "int32", "type": "integer" }, "rules_per_process_limit": { "description": "Represents the maximum number of workflow rules allowed per business process.", "format": "int32", "type": "integer" }, "scheduled_actions_per_rule_limit": { "description": "Represents the maximum number of scheduled action groups allowed per workflow rule.", "format": "int32", "type": "integer" }, "total_actions_per_rule_limit": { "description": "Represents the maximum total number of actions (instant and scheduled combined) allowed per workflow rule.", "format": "int32", "type": "integer" }, "total_rules_configured": { "description": "Represents the total number of workflow rules configured in the organization, including both active and inactive rules.", "format": "int32", "type": "integer" }, "total_rules_limit": { "description": "Represents the maximum total number of workflow rules allowed in the organization.", "format": "int32", "type": "integer" }, "total_rules_limit_per_module": { "description": "Represents the maximum number of workflow rules allowed per CRM module.", "format": "int32", "type": "integer" } }, "required": [ "active_rules_configured", "active_rules_limit", "active_rules_limit_per_module", "rules_per_process_limit", "scheduled_actions_per_rule_limit", "total_actions_per_rule_limit", "total_rules_configured", "total_rules_limit", "total_rules_limit_per_module" ], "type": "object" } }, "required": [ "rules_count" ], "title": "Workflow Rules Quota Response", "type": "object", "x-zs-$id": "WorkflowRulesCountResponseSchema", "x-zs-llm-description": "Response from getWorkflowRulesCount. Contains rules_count object with org-level limits: max rules, max actions per rule, max conditions per rule, max scheduled actions, and current usage counts." }, "WorkflowRulesGetResponseSchema": { "additionalProperties": false, "description": "Represents the paginated list response for workflow rules, containing an array of workflow rule objects and pagination metadata.", "properties": { "info": { "$ref": "#/components/schemas/InfoNestedSchema" }, "workflow_rules": { "description": "Represents the array of workflow rule objects returned in the list response.", "items": { "$ref": "#/components/schemas/WorkflowRuleSingleGetSchema" }, "maxItems": 200, "type": "array" } }, "required": [ "workflow_rules", "info" ], "title": "Workflow Rule List Response", "type": "object", "x-zs-$id": "WorkflowRulesGetResponseSchema", "x-zs-llm-description": "Response wrapper for getWorkflowRules (list). Contains workflow_rules array of rule objects and info object with pagination metadata (page, per_page, count, more_records)." }, "WorkflowSimpleFilterCriterion": { "additionalProperties": false, "description": "Represents a simple filter criterion for workflow rule queries, specifying the field API name, comparator, and value to match.", "properties": { "comparator": { "description": "Represents the comparison operator applied to the filter criterion. **${ANYVALUE}** is a special value supported only in field update triggers; it matches any change to the monitored field value.", "enum": [ "equal", "not_equal", "like", "not_like", "starts_with", "ends_with", "contains", "not_contains", "greater_than", "greater_equal", "less_equal", "less_than", "in", "not_in", "between", "${ANYVALUE}" ], "type": "string" }, "field": { "allOf": [ { "$ref": "#/components/schemas/FilterFieldBase" }, { "additionalProperties": true, "description": "Represents additional field reference constraints for the filter criterion, requiring the `api_name` property to identify the target field.", "required": [ "api_name" ], "type": "object" } ], "description": "Represents the field to which the filter criterion is applied." }, "type": { "default": "value", "description": "Indicates whether the criterion value is a direct value or a system variable placeholder.", "enum": [ "merge_field", "pre_defined", "value", "field" ], "type": "string" }, "value": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionValueString" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueNumber" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueBoolean" }, { "$ref": "#/components/schemas/SimpleFilterCriterionValueObjectRequest" } ] } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "WorkflowSimpleFilterCriterion", "x-zs-llm-description": "Single filter criterion in a workflow criteria array. Required: field ({api_name, id}), comparator (equal, not_equal, like, starts_with, etc.), value. Special: '${ANYVALUE}' comparator supported only in field_update triggers to match any value change. Type field distinguishes value source: 'value' (literal), 'merge_field' (runtime token), 'pre_defined' (system), 'field' (other field comparison)." }, "WorkflowSuccessSchema": { "additionalProperties": false, "description": "Represents the success response returned after creating a workflow rule, containing the result details of the created rule.", "properties": { "workflow_rules": { "description": "Represents the array of workflow rule objects returned in the success response.", "items": { "$ref": "#/components/schemas/SuccessResponseNestedSchema" }, "maxItems": 200, "type": "array" } }, "type": "object", "x-zs-$id": "WorkflowSuccessSchema", "x-zs-llm-description": "Success response wrapper for POST/PUT workflow rule operations. Contains workflow_rules array with per-rule status objects indicating success or failure with details." }, "WorkflowTasksAmbiguityDuringProcessingError": { "additionalProperties": false, "description": "Returned when the request contains ambiguous field or module references that cannot be resolved (e.g., invalid module ID, unrecognized field API name).", "properties": { "code": { "description": "Error code", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "ambiguity_due_to": { "description": "List of fields causing the ambiguity.", "items": { "additionalProperties": false, "description": "Ambiguity source details.", "properties": { "api_name": { "description": "API name of the expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the expected field location.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Error message", "example": "Ambiguity while processing the request", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "AmbiguityDuringProcessing Error", "type": "object", "x-zs-$id": "AmbiguityDuringProcessingError", "x-zs-llm-description": "The request contains ambiguous references (e.g., module ID that matches multiple contexts). Provide more specific identifiers." }, "WorkflowTasksLockStatus": { "additionalProperties": false, "description": "Represents the lock status of a resource, indicating whether it is currently locked or not.", "properties": { "locked": { "description": "Whether this automation task is locked from editing.", "type": "boolean" } }, "title": "Lock Status", "type": "object", "x-zs-llm-description": "Indicates whether the task is locked (non-editable). Locked tasks are managed by their parent automation (approval/blueprint)." }, "WorkflowTasksModuleDetails": { "additionalProperties": false, "description": "Contains module metadata, including labels, API name, IDs, and optional module_name for related module contexts.", "properties": { "api_name": { "description": "API name of the module used in API requests (e.g., Leads, Contacts, Deals).", "maxLength": 255, "type": "string" }, "id": { "description": "Unique Zoho CRM module ID.", "maxLength": 255, "type": "string" }, "moduleName": { "description": "Module display name (camelCase). Present on parent module objects only.", "maxLength": 255, "type": "string" }, "module_name": { "description": "Module system name (snake_case). Present on related_module objects only.", "maxLength": 255, "type": "string" }, "plural_label": { "description": "Plural display label of the module (e.g., Leads, Contacts).", "maxLength": 255, "type": "string" }, "singular_label": { "description": "Singular display label of the module (e.g., Lead, Contact).", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "title": "Module Details", "type": "object", "x-zs-$id": "ModuleDetails", "x-zs-llm-description": "Module metadata including api_name, numeric id, and display labels. Use api_name for API calls; use id for unique identification." }, "WorkflowTasksPaginationInfo": { "additionalProperties": false, "description": "Details about pagination for resource listings, such as count, page number, and if more records are available.", "properties": { "count": { "description": "Number of records/actions returned in the current response page.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional records/actions are available beyond the current page.", "type": "boolean" }, "page": { "description": "Current page number in the paginated result set (typically reflects the requested page value).", "format": "int32", "type": "integer" }, "per_page": { "description": "Maximum number of records/actions requested per page.", "format": "int32", "type": "integer" } }, "title": "Pagination Information", "type": "object", "x-zs-llm-description": "Pagination metadata for list responses. Use 'more_records' to decide whether to fetch the next page." }, "WorkflowTasksRequiredParamMissingError": { "additionalProperties": false, "description": "Missing required parameter: ids", "properties": { "code": { "description": "Error code", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "param_name": { "description": "Detail field: param_name", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Error message", "example": "One of the expected parameter is missing", "maxLength": 255, "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "RequiredParamMissing Error", "type": "object", "x-zs-$id": "RequiredParamMissingError", "x-zs-llm-description": "The required 'ids' query parameter is missing from the bulk delete request. Supply comma-separated task IDs." }, "ZiaOrgEnrichmentInvalidParam": { "additionalProperties": false, "description": "Error envelope returned when a supplied query parameter such as `status`, `sort_by`, or `sort_order` does not match the allowed set of values.", "properties": { "code": { "description": "Identifies the parameter-validation failure that was raised.\n\nPossible values:\n**INVALID_DATA** - The supplied query parameter value is not among the allowed values.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context that identifies the offending query parameter and lists the values that the parameter accepts.", "properties": { "param": { "description": "Shows the name of the query parameter whose value failed validation.", "enum": [ "status", "sort_order", "sort_by" ], "type": "string" }, "supported_values": { "anyOf": [ { "description": "Lists the values accepted by the `status` query parameter.", "items": { "description": "Represents a single value accepted by the `status` query parameter.\n\nPossible values:\n**COMPLETED** - The job has finished and enriched data is available.\n**SCHEDULED** - The job is queued and yet to run.\n**FAILED** - The job ended in a failure.\n**RUNNING** - The job is currently running.\n**DATA_NOT_FOUND** - The job completed but Zia could not locate public data to enrich.", "enum": [ "COMPLETED", "SCHEDULED", "FAILED", "RUNNING", "DATA_NOT_FOUND", "UPDATED" ], "type": "string" }, "maxItems": 5, "type": "array", "x-zs-$id": "ZiaOrgEnrichmentStatusSupportedValues" }, { "description": "Lists the values accepted by the `sort_order` query parameter.", "items": { "description": "Represents a single value accepted by the `sort_order` query parameter.\n\nPossible values:\n**asc** - Sort results in ascending order.\n**desc** - Sort results in descending order.", "enum": [ "asc", "desc" ], "type": "string" }, "maxItems": 2, "type": "array", "x-zs-$id": "ZiaOrgEnrichmentSortOrderSupportedValues" }, { "description": "Lists the values accepted by the `sort_by` query parameter.", "items": { "description": "Represents a single value accepted by the `sort_by` query parameter.\n\nPossible values:\n**created_time** - Sort results by the timestamp at which each enrichment job was scheduled.", "enum": [ "created_time" ], "type": "string" }, "maxItems": 1, "type": "array", "x-zs-$id": "ZiaOrgEnrichmentSortBySupportedValues" } ], "description": "Lists the values that the offending query parameter accepts. The exact list depends on which parameter raised the failure." } }, "required": [ "param", "supported_values" ], "type": "object" }, "message": { "description": "Provides a message that explains the parameter-validation failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because of a parameter-validation failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ZiaOrgEnrichmentInvalidParam" }, "ZiaSuggestedUsersTypeAssignToObject": { "additionalProperties": false, "description": "If assign to type is zia suggested user.", "properties": { "type": { "description": "Defines the type or users to associate as owner during execution.\nPossible values:\n**zia_suggested_users** - Represents zia suggested users. ", "enum": [ "zia_suggested_users" ], "type": "string" } }, "required": [ "type" ], "type": "object", "x-zs-$id": "ZiaSuggestedUsersTypeAssignToObject" }, "ZiaSuggestedUsersTypeAssignToRequestObject": { "additionalProperties": false, "description": "Assigns ownership using Zia AI suggestions. No resource configuration needed.", "properties": { "type": { "description": "Assign to type IDentifier. Must be 'zia_suggested_users'.\nPossible values:\n**zia_suggested_users** - Represents zia suggested users.", "enum": [ "zia_suggested_users" ], "type": "string" } }, "required": [ "type" ], "title": "Zia suggested users type assign to request object", "type": "object", "x-zs-$id": "ZiaSuggestedUsersTypeAssignToRequestObject" }, "ZohoFlowActionSchema": { "additionalProperties": false, "description": "Represents a non-associate action that triggers a Zoho Flow workflow when the workflow rule condition is met.", "properties": { "_delete": { "description": "Indicates that this Zoho Flow action should be removed from the workflow rule when set in a PUT request. Provide a null value to signal deletion.", "type": "null" }, "details": { "$ref": "#/components/schemas/AutomationZohoFlowDetails", "description": "Configuration for the Zoho Flow action. Requires the ID and name of the custom action to trigger in Zoho Flow.\n" }, "id": { "description": "Represents the unique ID of the Zoho Flow action within the workflow rule.", "maxLength": 20, "type": "string" }, "name": { "description": "Represents the display name of the Zoho Flow action. This field is required.", "maxLength": 100, "type": "string" }, "type": { "const": "flow", "description": "Represents the action type discriminator that identifies this as a Zoho Flow action within the workflow rule.", "type": "string" } }, "required": [ "type", "name", "details" ], "type": "object", "x-zs-$id": "ZohoFlowActionSchema", "x-zs-llm-description": "Inline action type='flow'. Triggers a Zoho Flow custom action. Limit 1/rule. Requires name, details.custom_action_id and details.custom_action_name (obtained from getCustomActions filtered by service_type='zoho_flow', component_type='workflow'). Verify 'flow' is enabled via getWorkflowConfigurations." } }, "securitySchemes": { "OAuth2": { "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "scopes": {}, "tokenUrl": "https://accounts.zoho.com/oauth/v2/token" } }, "type": "oauth2" } } }, "info": { "description": "Zoho's official CRM v8 documents from github.com/zoho/crm-oas at commit a6687fc961acdaa52592d39c5c7e4385e5b4c289, merged into one document. Paths carry each document's base path; the host is the connection's Zoho data center.", "title": "Zoho CRM", "version": "v8" }, "openapi": "3.1.0", "paths": { "/crm/bulk/v8/read": { "post": { "description": "To create a bulk read job in Zoho CRM. A bulk read job exports records from a specified CRM module to a CSV or ICS file. The job runs asynchronously; use the Get Bulk Read Job Details API to monitor the job status, and use the Download Bulk Read Result API to retrieve the exported file once the job is complete.", "operationId": "createBulkReadJob", "requestBody": { "content": { "application/json": { "examples": { "Example1": { "description": "A sample request to create a bulk read job for the Contacts module with filter criteria.", "summary": "Create bulk read job", "value": { "query": { "module": { "api_name": "string" } } } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload used to configure and create a bulk read job in Zoho CRM.", "properties": { "callback": { "additionalProperties": false, "description": "Specify the callback configuration to receive a POST notification when the bulk read job completes or fails.", "properties": { "method": { "description": "Specify the HTTP method for the callback request.\nPossible values:\n**post** - Sends the callback notification as an HTTP POST request.", "enum": [ "post" ], "type": "string" }, "url": { "description": "Specify a valid URL that accepts HTTP POST requests to receive the bulk read job completion notification.", "format": "uri", "type": "string" } }, "required": [ "url", "method" ], "type": "object" }, "file_type": { "description": "Specify the file format for the exported records.\nPossible values:\n**csv** - Exports records in CSV format.\n**ics** - Exports records in ICS format, applicable only when exporting from the **Events** module.", "enum": [ "csv", "ics" ], "type": "string" }, "query": { "additionalProperties": false, "description": "Specify the query parameters for the bulk read job, including the target module, optional field selection, optional Custom View, and optional filter criteria.", "properties": { "criteria": { "additionalProperties": false, "description": "Specify the filter criteria to narrow down the records exported in the bulk read job.", "properties": { "group": { "description": "Specify the list of filter conditions to apply to the bulk read export. Each condition must include a **field**, **value**, and **comparator**.", "items": { "additionalProperties": false, "description": "Specify a filter condition object that defines a single criterion for filtering records in the bulk read export.", "properties": { "comparator": { "description": "Specify the comparison operator to apply between the field and value in this filter condition.\nPossible values:\n**equal** - Records where the field value exactly matches the specified value.\n**not_equal** - Records where the field value does not match the specified value.\n**contains** - Records where the field value contains the specified value.\n**not_contains** - Records where the field value does not contain the specified value.\n**starts_with** - Records where the field value starts with the specified value.\n**ends_with** - Records where the field value ends with the specified value.", "enum": [ "equal", "contains", "ends_with", "not_contains", "not_equal", "starts_with" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the field to apply the filter condition on. Refer to the [Get Fields](fields.json#$.paths./settings/fields.get) resource for valid values.", "properties": { "api_name": { "description": "Specify the API name of the field to use in the filter condition.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "type": { "description": "Specify the type of the filter condition.\nPossible values:\n**value** - Compares the field against a static value.", "enum": [ "value" ], "type": "string" }, "value": { "description": "Specify the value to compare the field against in this filter condition.", "maxLength": 500, "type": "string" } }, "required": [ "field", "value", "comparator" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "group_operator": { "description": "Specify the logical operator to combine the filter conditions in the **group** array.\nPossible values:\n**and** - All conditions must be satisfied.\n**or** - At least one condition must be satisfied.", "enum": [ "or", "and" ], "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object" }, "cvid": { "description": "Represents the unique ID of the Custom View to filter records for the bulk read job. Refer to the [Get Custom Views](custom_views.json#$.paths./settings/custom_views.get) resource for valid values.", "maxLength": 100, "type": [ "string", "null" ] }, "fields": { "description": "Specify the list of field API names to include in the exported records. Refer to the [Get Fields](fields.json#$.paths./settings/fields.get) resource for valid values. **Note:** If exporting Events as an **ICS file**, do not include this key.", "items": { "description": "Specify the API name of a field to include in the exported records.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array" }, "module": { "additionalProperties": false, "description": "Specify the CRM module from which to export records. Refer to the [Get Modules](modules.json#$.paths./settings/modules.get) resource for valid values.", "properties": { "api_name": { "description": "Specify the API name of the CRM module to export records from.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "page": { "description": "Specify the page number of records to export in the bulk read job. The default value is **1** and means that the first **200,000** records matching your query will get exported. If you want to fetch the records from the range **200,001 to 400,000**, then mention the value as **'2'.**", "format": "int32", "type": [ "integer", "null" ] } }, "required": [ "module" ], "type": "object" } }, "required": [ "query" ], "type": "object" } } }, "description": "The JSON request body used to configure and create a bulk read job in Zoho CRM.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Example1": { "description": "A sample response confirming that the bulk read job was successfully created, including the assigned job ID and initial state.", "summary": "Bulk read job created", "value": { "data": [ { "code": "ADDED_SUCCESSFULLY", "details": { "created_by": { "id": "string" }, "created_time": "2023-01-01T00:00:00Z", "id": "string", "operation": "read", "state": "COMPLETED" }, "message": "Added successfully.", "status": "success" } ], "info": {} } } }, "schema": { "additionalProperties": false, "description": "Represents the response returned when a bulk read job is successfully created.", "properties": { "data": { "description": "Represents the list of job creation result objects. ", "items": { "additionalProperties": false, "description": "Represents a single job creation result object.", "properties": { "code": { "description": "Represents the status code for the job creation result.\nPossible values:\n**ADDED_SUCCESSFULLY** - Zoho CRM created the bulk read job successfully. ", "enum": [ "ADDED_SUCCESSFULLY" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the newly created bulk read job. ", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the user who created the bulk read job. Refer to the [Get Users](users.json#$.paths./users.get) endpoint for details. ", "properties": { "id": { "description": "Represents the unique ID of the user who created the bulk read job. ", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the name of the user who created the bulk read job.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "created_time": { "description": "Represents the date and time when Zoho CRM created the bulk read job. ", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique ID of the created bulk read job. ", "maxLength": 100, "type": "string", "x-zs-$id": "BulkReadJobId" }, "operation": { "description": "Represents the type of bulk operation performed. \nPossible values:\n**read** - Indicates a bulk read (export) operation.", "enum": [ "read" ], "maxLength": 500, "type": "string" }, "state": { "description": "Represents the current state of the bulk read job. \nPossible values:\n**ADDED** - The job has been accepted and is queued for processing.\n**IN PROGRESS** - The job is currently being processed.\n**COMPLETED** - The job has finished processing successfully.\n**FAILURE** - The job encountered an error during processing.", "enum": [ "COMPLETED", "ADDED", "IN PROGRESS", "FAILURE" ], "type": "string" } }, "required": [ "id", "operation", "state", "created_by", "created_time" ], "type": "object" }, "message": { "description": "Represents the result message for the job creation. \nPossible values:\n**Added successfully.** - Zoho CRM created the bulk read job successfully.", "enum": [ "Added successfully." ], "type": "string" }, "status": { "description": "Represents the status of the job creation request. \nPossible values:\n**success** - Zoho CRM created the bulk read job successfully.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents additional metadata about the bulk read job creation response. ", "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponse201" } } }, "description": "The bulk read job was successfully created. The response includes the job ID and initial state." }, "400": { "content": { "application/json": { "examples": { "Example1": { "description": "A sample error response indicating that the bulk read job creation request failed due to an invalid request body.", "summary": "Invalid request error", "value": { "code": "REQUEST_BODY_NOT_SUPPORTED", "details": {}, "message": "string", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response returned when the request body format is not supported.", "properties": { "code": { "description": "Represents the error code indicating that the request body format is not supported. \nPossible values:\n**REQUEST_BODY_NOT_SUPPORTED** - The request body structure does not conform to the expected format.", "enum": [ "REQUEST_BODY_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error. ", "type": "object" }, "message": { "description": "Represents the error message describing the issue. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request. \nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponse1" }, { "additionalProperties": false, "description": "Error response returned when a comparator used in the filter criteria is not supported or is incompatible with the field value.", "properties": { "code": { "description": "Represents the error code indicating a criteria comparator incompatibility issue. \nPossible values:\n**FIELD_COMPARATOR_IN_CRITERIA_NOT_SUPPORTED** - The comparator used for the specified field is not supported in the filter criteria.\n**COMPARATOR_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE** - The comparator and value combination used in the filter criteria is not compatible.", "enum": [ "FIELD_COMPARATOR_IN_CRITERIA_NOT_SUPPORTED", "COMPARATOR_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Error details including the field API name, comparator, type, and value involved in the incompatibility.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the criteria error. ", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used in the criteria filter where the incompatibility was detected. ", "maxLength": 500, "type": "string" }, "type": { "description": "Represents the data type of the field associated with the criteria error. ", "maxLength": 500, "type": "string" }, "value": { "anyOf": [ { "additionalProperties": false, "description": "Represents a criteria field value of type object.", "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails1ObjectValue" }, { "description": "Represents a criteria field value of type string.", "maxLength": 500, "type": "string", "x-zs-$id": "CreatebulkreadjobResponseDetails1StringValue" }, { "description": "Represents a criteria field value of type array.", "items": { "description": "Represents an individual value in the criteria array." }, "maxItems": 1000, "type": "array", "x-zs-$id": "CreatebulkreadjobResponseDetails1ArrayValue" }, { "description": "Represents a criteria field value of type Boolean.", "type": "boolean", "x-zs-$id": "CreatebulkreadjobResponseDetails2BooleanValue" }, { "description": "Represents a criteria field value of type number.", "type": "number", "x-zs-$id": "CreatebulkreadjobResponseDetails1NumberValue" } ], "description": "Represents the value used in the criteria filter. " } }, "required": [ "api_name", "comparator", "type", "value" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails1" }, { "additionalProperties": false, "description": "Error details including the comparator, type, and value involved in the incompatibility.", "properties": { "comparator": { "description": "Represents the comparator used in the criteria filter where the incompatibility was detected. ", "maxLength": 500, "type": "string" }, "type": { "description": "Represents the data type of the field associated with the criteria error. ", "maxLength": 500, "type": "string" }, "value": { "anyOf": [ { "additionalProperties": false, "description": "Represents a criteria field value of type object.", "properties": { "name": { "description": "Represents the name of the lookup value used in the criteria filter.", "maxLength": 25, "type": "string" } }, "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails2ObjectValue" }, { "description": "Represents a criteria field value of type string.", "maxLength": 500, "type": "string", "x-zs-$id": "CreatebulkreadjobResponseDetails2StringValue" }, { "description": "Represents a criteria field value of type array.", "items": { "description": "Represents an individual value in the criteria array." }, "maxItems": 1000, "type": "array", "x-zs-$id": "CreatebulkreadjobResponseDetails2ArrayValue" }, { "description": "Represents a criteria field value of type Boolean.", "type": "boolean", "x-zs-$id": "CreatebulkreadjobResponseDetails1BooleanValue" }, { "description": "Represents a criteria field value of type number.", "type": "number", "x-zs-$id": "CreatebulkreadjobResponseDetails2NumberValue" } ], "description": "Represents the value used in the criteria filter. " } }, "required": [ "comparator", "type", "value" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails2" }, { "additionalProperties": false, "description": "Error details including the field API name, comparator, type, and value with a field reference.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the criteria error. ", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used in the criteria filter where the incompatibility was detected.", "maxLength": 500, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field associated with the criteria error. ", "properties": { "api_name": { "description": "Represents the API name of the field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "type": { "description": "Represents the data type of the field associated with the criteria error.", "maxLength": 500, "type": "string" }, "value": { "additionalProperties": false, "description": "Represents the value used in the criteria filter.", "type": "object" } }, "required": [ "api_name", "field" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails3" }, { "additionalProperties": false, "description": "Error details including the field API name and list of supported options.", "properties": { "api_name": { "description": "Represents the API name of the field for which the comparator is not supported. ", "maxLength": 255, "type": "string" }, "supported": { "description": "Represents the list of supported options for the specified field. ", "items": { "description": "Represents a supported option for the specified field.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array" } }, "required": [ "api_name", "supported" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails4" } ], "description": "Represents additional details about the criteria incompatibility error. " }, "message": { "description": "Represents the error message describing the criteria incompatibility issue. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request. \nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponse2" }, { "additionalProperties": false, "description": "Error response returned when the filter criteria or a criteria group is ambiguous.", "properties": { "code": { "description": "Represents the error code indicating ambiguity in the filter criteria.\nPossible values:\n**AMBIGUOUS_CRITERIA** - The filter criteria is ambiguous and cannot be processed.\n**AMBIGUOUS_GROUP_IN_CRITERIA** - A criteria group is ambiguous and cannot be processed.", "enum": [ "AMBIGUOUS_CRITERIA", "AMBIGUOUS_GROUP_IN_CRITERIA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Error details including the API name of the ambiguous field.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the ambiguous criteria.", "maxLength": 500, "type": "string" } }, "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetailsAPIName" }, { "additionalProperties": false, "description": "Error details including the comparator, type, value, and field associated with the ambiguous criteria.", "properties": { "comparator": { "description": "Represents the comparator used in the ambiguous criteria filter.", "maxLength": 500, "type": "string" }, "field": { "additionalProperties": false, "description": "Indicates the field associated with the ambiguous criteria.", "properties": { "api_name": { "description": "Represents the API name of the field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "type": { "description": "Indicates the data type of the field associated with the ambiguous criteria.", "maxLength": 500, "type": "string" }, "value": { "additionalProperties": false, "description": "Specifies the value used in the ambiguous criteria filter.", "type": "object" } }, "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails5" }, { "additionalProperties": false, "description": "Error details including the field API name, type, and comparator.", "properties": { "api_name": { "description": "Represents the API name of the field with ambiguous criteria. ", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used in the ambiguous criteria filter. ", "maxLength": 25, "type": "string" }, "type": { "description": "The data type of the field with ambiguous criteria. ", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "type", "comparator" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetailsComp1" }, { "additionalProperties": false, "description": "Error details including the field API name, type, and value.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the ambiguous criteria. ", "maxLength": 255, "type": "string" }, "type": { "description": "Specifies the data type of the field with ambiguous criteria. ", "maxLength": 500, "type": "string" }, "value": { "anyOf": [ { "additionalProperties": false, "description": "Represents a criteria field value of type object.", "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetailsCompObjectValue" }, { "description": "Represents a criteria field value of type string.", "maxLength": 500, "type": "string", "x-zs-$id": "CreatebulkreadjobResponseDetailsCompStringValue" } ], "description": "Represents the value associated with the ambiguous criteria." } }, "required": [ "api_name", "type" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetailsComp" }, { "additionalProperties": false, "description": "Error details including the ambiguous criteria group and group operator.", "properties": { "group": { "description": "Represents the ambiguous criteria group.", "items": { "additionalProperties": false, "description": "Represents a criterion within the ambiguous group.", "properties": { "api_name": { "description": "Represents the API name of the field in the criterion. ", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used in the criterion.", "maxLength": 500, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field associated with the criterion.", "properties": { "api_name": { "description": "Represents the API name of the field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "type": { "description": "Represents the data type of the field in the criterion. ", "maxLength": 500, "type": "string" }, "value": { "anyOf": [ { "additionalProperties": false, "description": "Represents a criteria field value of type object.", "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails6ObjectValue" }, { "description": "Represents a criteria field value of type string.", "maxLength": 500, "type": "string", "x-zs-$id": "CreatebulkreadjobResponseDetails6StringValue" } ], "description": "Represents the value used in the criterion." } }, "required": [ "api_name", "comparator", "type", "value" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "group_operator": { "description": "Represents the logical operator used to combine criteria within the group.", "maxLength": 500, "type": "string" } }, "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails6" }, { "additionalProperties": false, "description": "Error details including the ambiguous criteria group without a group operator.", "properties": { "group": { "description": "Represents the ambiguous criteria group.", "items": { "additionalProperties": false, "description": "Represents a criterion within the ambiguous group.", "properties": { "comparator": { "description": "Represents the comparator used in the criterion.", "maxLength": 500, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field associated with the criterion.", "properties": { "api_name": { "description": "Represents the API name of the field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "type": { "description": "Represents the data type of the field in the criterion.", "maxLength": 500, "type": "string" }, "value": { "description": "Represents the value used in the criterion.", "maxLength": 25, "type": "string" } }, "type": "object" }, "maxItems": 2, "type": "array" } }, "type": "object", "x-zs-$id": "CreatebulkreadjobResponseDetails7" } ], "description": "Represents additional details about the ambiguous criteria error. " }, "message": { "description": "Represents the error message describing the ambiguous criteria issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponse3" }, { "additionalProperties": false, "description": "Error response returned when the callback method or URL specified in the request is not valid.", "properties": { "code": { "description": "Represents the error code indicating a callback configuration issue.\nPossible values:\n**INVALID_CALLBACK_METHOD** - The HTTP method specified for the callback URL is not valid.\n**INVALID_CALLBACK_URL** - The callback URL specified in the request is not valid.", "enum": [ "INVALID_CALLBACK_METHOD", "INVALID_CALLBACK_URL" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the callback configuration error, including the list of supported callback methods.", "properties": { "supported_callback_methods": { "description": "Represents the list of supported HTTP methods for callbacks.", "items": { "description": "Represents a supported HTTP method for the callback URL.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the callback configuration issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreatebulkreadjobResponse4" }, { "additionalProperties": false, "description": "Error response returned when the group operator used in the filter criteria is not supported.", "properties": { "code": { "description": "Represents the error code indicating that the group operator used in the filter criteria is not supported. \nPossible values:\n**GROUP_OPERATOR_NOT_SUPPORTED** - The logical operator used to combine criteria groups is not supported.", "enum": [ "GROUP_OPERATOR_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported group operator error, including the list of supported operators. ", "properties": { "supported": { "description": "Represents the list of supported group operators for the filter criteria.", "items": { "description": "Represents a supported group operator for the filter criteria.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array" } }, "required": [ "supported" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported group operator issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupOperatorNotSupportedError" }, { "additionalProperties": false, "description": "Error response returned when the requested page number exceeds the allowed range.", "properties": { "code": { "description": "Represents the error code indicating that the requested page number exceeds the allowed range.\nPossible values:\n**PAGE_RANGE_EXCEEDED** - The page number specified in the bulk read request exceeds the maximum allowed range.", "enum": [ "PAGE_RANGE_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the page range exceeded error, including the maximum allowed page limit.", "properties": { "max_limit": { "description": "Represents the maximum page number allowed for bulk read requests.", "format": "int32", "type": "integer" } }, "required": [ "max_limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the page range exceeded issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PageRangeExceededError" }, { "additionalProperties": false, "description": "Error response returned when the bulk read request is malformed or contains invalid parameters.", "properties": { "code": { "description": "Represents the error code indicating that the request is invalid.\nPossible values:\n**INVALID_REQUEST** - The bulk read request is malformed or contains invalid parameters.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid request error. ", "type": "object" }, "message": { "description": "Represents the error message describing the invalid request issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request. \nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidRequestError" }, { "additionalProperties": false, "description": "Error response returned when the specified module does not support bulk read operations.", "properties": { "code": { "description": "Represents the error code indicating that the specified module is not supported for bulk read operations.\nPossible values:\n**MODULE_NOT_SUPPORTED** - The module specified in the bulk read request does not support bulk read operations.", "enum": [ "MODULE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported module error.", "type": "object" }, "message": { "description": "Represents the error message describing the unsupported module issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModuleNotSupportedError" }, { "additionalProperties": false, "description": "Error response returned when the specified Custom View ID is not supported.", "properties": { "code": { "description": "Represents the error code indicating that the specified Custom View ID is not supported.\nPossible values:\n**CVID_NOT_SUPPORTED** - The Custom View ID (cvid) specified in the bulk read request is not supported.", "enum": [ "CVID_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported Custom View error. ", "type": "object" }, "message": { "description": "Represents the error message describing the unsupported Custom View ID issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CvidNotSupportedError" }, { "additionalProperties": false, "description": "Error response returned for various bulk read request failures, including permission issues, unsupported features, and invalid request formats.", "properties": { "code": { "description": "Represents the error code for the bulk read request failure.", "enum": [ "REQUEST_BODY_IS_EMPTY", "TOO_MANY_REQUESTS", "COMPARATOR_AND_ENCRYPTED_VALUE_IN_CRITERIA_NOT_COMPATIBLE", "PAGE_NOT_SUPPORTED", "NOT_SUPPORTED_FEATURE", "QUERY_NOT_SUPPORTED", "JOB_NOT_SUPPORTED", "REQUEST_BODY_NOT_READABLE", "FIELD_AND_COMPARATOR_IN_CRITERIA_NOT_COMPATIBLE", "INVALID_URL_PATTERN", "NO_PERMISSION", "FIELD_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE", "FIELD_IN_CRITERIA_NOT_AVAILABLE", "MEDIA_TYPE_NOT_SUPPORTED", "INVALID_BULK_OPERATION", "CALLBACK_FAILURE", "INVALID_SERVICE_NAME", "JOIN_LIMIT_EXCEEDED", "CRITERIA_NOT_SUPPORTED", "INVALID_REQUEST_METHOD", "INVALID_TOKEN" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Empty error details object returned when no additional context is available.", "type": "object", "x-zs-$id": "InvalidCriteriaErrorDetails1" }, { "additionalProperties": false, "description": "Error details including the criteria object associated with the request failure.", "properties": { "criteria": { "additionalProperties": false, "description": "Represents the criteria object associated with the error. ", "properties": { "field": { "additionalProperties": false, "description": "Represents the field associated with the invalid criteria.", "type": "object" } }, "type": "object" } }, "required": [ "criteria" ], "type": "object", "x-zs-$id": "InvalidCriteriaErrorDetailsForCriteria" }, { "additionalProperties": false, "description": "Error details including the API name and module associated with the request failure.", "properties": { "api_name": { "description": "Represents the API name of the module or field associated with the error.", "maxLength": 255, "type": "string" }, "module": { "description": "Represents the name of the module associated with the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "module" ], "type": "object", "x-zs-$id": "InvalidCriteriaErrorDetails" }, { "additionalProperties": false, "description": "Error details including the API name, reason, and module associated with the request failure.", "properties": { "api_name": { "description": "Represents the API name of the field or module associated with the error.", "maxLength": 255, "type": "string" }, "module": { "description": "Represents the name of the module associated with the error.", "maxLength": 500, "type": "string" }, "reason": { "description": "Represents the reason for the error.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "reason" ], "type": "object", "x-zs-$id": "InvalidCriteriaErrorDetails2" }, { "additionalProperties": false, "description": "Error details including the field API name, comparator, and list of supported options.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the error.", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator associated with the error.", "maxLength": 500, "type": "string" }, "supported": { "description": "Represents the list of supported options for the specified field.", "items": { "description": "Represents a supported option for the specified field.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array" } }, "required": [ "comparator", "api_name", "supported" ], "type": "object", "x-zs-$id": "InvalidCriteriaErrorDetails3" }, { "additionalProperties": false, "description": "Error details including the API name of the field associated with the request failure.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "InvalidCriteriaErrorDetails4" }, { "additionalProperties": false, "description": "Error details including the field API name and display label associated with the request failure.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the error.", "maxLength": 255, "type": "string" }, "field_label": { "description": "Represents the display label of the field associated with the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "field_label" ], "type": "object", "x-zs-$id": "InvalidCriteriaErrorDetails5" } ], "description": "Represents additional details about the error. " }, "message": { "description": "Represents the error message describing the request failure. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidCriteriaError" }, { "additionalProperties": false, "description": "Error response returned when the filter criteria is invalid.", "properties": { "code": { "description": "Represents the error code indicating that the filter criteria in the request is invalid.\nPossible values:\n**INVALID_CRITERIA** - The criteria provided in the bulk read job request is not valid.", "enum": [ "INVALID_CRITERIA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid criteria error, including the field and criteria values that caused the issue. ", "properties": { "api_name": { "description": "Represents the API name of the field involved in the invalid criteria condition.", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used in the invalid criteria condition.", "maxLength": 500, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field object associated with the invalid criteria condition.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the invalid criteria.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the field associated with the invalid criteria.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Represents the type of the criteria condition that caused the error.", "maxLength": 500, "type": "string" }, "value": { "anyOf": [ { "additionalProperties": false, "description": "Represents a criteria field value of type object.", "properties": { "name": { "description": "Represents the display name of the value involved in the invalid criteria condition.", "maxLength": 25, "type": "string" } }, "type": "object", "x-zs-$id": "InvalidCriteriaError2ObjectValue" }, { "description": "Represents a criteria field value of type string.", "maxLength": 500, "type": "string", "x-zs-$id": "InvalidCriteriaError2StringValue" }, { "description": "Represents a criteria field value of type Boolean.", "type": "boolean", "x-zs-$id": "InvalidCriteriaError2BooleanValue" }, { "description": "Represents a criteria field value of type array.", "items": { "description": "Represents a single item in the array value associated with the invalid criteria condition.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array", "x-zs-$id": "InvalidCriteriaError2ArrayValue" } ], "description": "Represents the value used in the invalid criteria condition." } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid criteria issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidCriteriaError2" }, { "additionalProperties": false, "description": "Error response returned when the value type used in the filter criteria is not supported.", "properties": { "code": { "description": "Represents the error code indicating that the value type used in the filter criteria is not supported.\nPossible values:\n**VALUE_TYPE_NOT_SUPPORTED** - The data type of the value provided for a criteria field is not supported.", "enum": [ "VALUE_TYPE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported value type error, including the field API name and the list of supported value types.", "properties": { "api_name": { "description": "Represents the API name of the field for which the value type is not supported.", "maxLength": 255, "type": "string" }, "supported": { "description": "Represents the list of supported value types for the specified field.", "items": { "description": "Represents a supported value type for the criteria field.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array" } }, "required": [ "api_name", "supported" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported value type issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ValueTypeNotSupportedError" }, { "additionalProperties": false, "description": "Error response returned when the specified field is not supported for use in the bulk read criteria.", "properties": { "code": { "description": "Represents the error code indicating that the specified field is not supported for use in the bulk read criteria.\nPossible values:\n**FIELD_NOT_SUPPORTED** - The field specified in the filter criteria is not supported for bulk read operations.", "enum": [ "FIELD_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported field error, including the API name of the field.", "properties": { "api_name": { "description": "Represents the API name of the field that is not supported.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the unsupported field issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ExpiredValueError" }, { "additionalProperties": false, "description": "Error response returned when the specified module is not available in the CRM organization.", "properties": { "code": { "description": "Represents the error code indicating that the specified module is not available in the CRM organization.\nPossible values:\n**MODULE_NOT_AVAILABLE** - The module specified in the bulk read request is not available.", "enum": [ "MODULE_NOT_AVAILABLE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unavailable module error.", "properties": { "api_name": { "description": "Represents the API name of the module that is not available.", "maxLength": 255, "type": "string" }, "module": { "description": "Represents the name of the module associated with the error.", "maxLength": 500, "type": "string" }, "reason": { "description": "Represents the reason why the module is not available.", "maxLength": 500, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the unavailable module issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataError" }, { "additionalProperties": false, "description": "Error response returned when the specified field is not available in the CRM organization.", "properties": { "code": { "description": "Represents the error code indicating that the specified field is not available in the CRM organization.\nPossible values:\n**FIELD_NOT_AVAILABLE** - The field specified in the bulk read request is not available.", "enum": [ "FIELD_NOT_AVAILABLE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unavailable field error.", "type": "object" }, "message": { "description": "Represents the error message describing the unavailable field issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataError2" }, { "additionalProperties": false, "description": "Error response returned when the number of filter criteria groups exceeds the maximum allowed limit.", "properties": { "code": { "description": "Represents the error code indicating that the number of filter criteria groups exceeds the maximum allowed limit.\nPossible values:\n**CRITERIA_LIMIT_EXCEEDED** - The number of criteria groups in the bulk read request exceeds the maximum limit.", "enum": [ "CRITERIA_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the criteria limit exceeded error.", "properties": { "max_limit": { "description": "Represents the maximum number of filter criteria groups allowed in a bulk read request.\nPossible values:\n**25** - The maximum number of criteria groups permitted per request.", "enum": [ 25 ], "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the criteria limit exceeded issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CriteriaLimitExceededError" }, { "additionalProperties": false, "description": "Error response returned when the number of values in the filter criteria exceeds the maximum allowed limit.", "properties": { "code": { "description": "Represents the error code indicating that the number of values in the filter criteria exceeds the maximum allowed limit.\nPossible values:\n**VALUE_LIMIT_EXCEEDED_IN_CRITERIA** - The number of values provided in the bulk read criteria exceeds the maximum limit of 200.", "enum": [ "VALUE_LIMIT_EXCEEDED_IN_CRITERIA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the value limit exceeded error.", "properties": { "max_limit": { "description": "Represents the maximum number of values allowed in the filter criteria.\nPossible values:\n**200** - The maximum number of criteria values permitted per request.", "enum": [ 200 ], "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the value limit exceeded issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ValueLimitExceededInCriteriaError" }, { "additionalProperties": false, "description": "Error response returned when a value used in the filter criteria is not supported.", "properties": { "code": { "description": "Represents the error code indicating that a value used in the filter criteria is not supported.\nPossible values:\n**VALUE_IN_CRITERIA_NOT_SUPPORTED** - The value provided for the criteria field is not supported.", "enum": [ "VALUE_IN_CRITERIA_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported criteria value error, including the field information, comparator, and value used.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the unsupported criteria value.", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used in the criteria filter where the unsupported value was detected.", "maxLength": 500, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field associated with the unsupported criteria value.", "properties": { "api_name": { "description": "Represents the API name of the field. ", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the field. ", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Represents the data type of the field associated with the unsupported criteria value.", "maxLength": 500, "type": "string" }, "value": { "additionalProperties": false, "description": "Represents the value that is not supported in the filter criteria.", "type": "object" } }, "type": "object" }, "message": { "description": "Represents the error message describing the unsupported criteria value issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ValueTypeNotSupportedError1" }, { "additionalProperties": false, "description": "Error response returned when the criteria contains invalid data.", "properties": { "code": { "description": "Represents the error code indicating that the criteria contains invalid data. \nPossible values:\n**INVALID_DATA** - The data provided in the bulk read criteria is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Error details including the field reference associated with the invalid data error.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the invalid data error.", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used in the criteria filter where the invalid data was detected.", "maxLength": 500, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field associated with the invalid data error.", "properties": { "api_name": { "description": "Represents the API name of the field. ", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the field. ", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Represents the data type of the field associated with the invalid data error.", "maxLength": 500, "type": "string" }, "value": { "additionalProperties": false, "description": "Represents the value that caused the invalid data error.", "type": "object" } }, "type": "object", "x-zs-$id": "InvalidDataErrorDetailsWithField" }, { "additionalProperties": false, "description": "Error details including the supported values for the specified field.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the invalid data error.", "maxLength": 255, "type": "string" }, "supported_values": { "description": "Represents the list of valid values accepted for the specified field.", "items": { "description": "Represents a valid value accepted for the specified field.", "maxLength": 25, "type": "string" }, "maxItems": 2, "type": "array" } }, "type": "object", "x-zs-$id": "InvalidDataErrorDetailsWithSupportedValues" } ], "description": "Represents additional details about the invalid data error. " }, "message": { "description": "Represents the error message describing the invalid data issue. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request. \nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataError3" }, { "additionalProperties": false, "description": "Error response returned when a field used in the filter criteria is not supported for bulk read operations.", "properties": { "code": { "description": "Represents the error code indicating that a field used in the filter criteria is not supported. \nPossible values:\n**FIELD_IN_CRITERIA_NOT_SUPPORTED** - The field specified in the filter criteria is not supported for bulk read operations.", "enum": [ "FIELD_IN_CRITERIA_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported criteria field error. ", "properties": { "api_name": { "description": "Represents the API name of the field that is not supported in the filter criteria. ", "maxLength": 255, "type": "string" }, "comparator": { "description": "Represents the comparator used with the unsupported criteria field. ", "maxLength": 500, "type": "string" }, "type": { "description": "Represents the data type of the unsupported criteria field. ", "maxLength": 500, "type": "string" }, "value": { "description": "Represents the value used with the unsupported criteria field. ", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "comparator", "value", "type" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported criteria field issue. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request. \nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FieldInCriteriaNotSupportedError" } ], "description": "Represents the error response returned when the bulk read job creation request fails due to client-side validation errors.", "x-zs-$id": "CreatebulkreadjobResponse400" } } }, "description": "The request to create the bulk read job failed due to client-side validation errors." } }, "security": [ { "OAuth2": [ "ZohoCRM.bulk.READ", "ZohoCRM.modules.ALL" ] } ], "summary": "Create a bulk read job", "tags": [ "bulk_read" ], "x-zoho-document": "bulk_read" } }, "/crm/bulk/v8/read/{jobId}": { "get": { "description": "To retrieve the details of a bulk read job in Zoho CRM. Use this API to check the current state of a bulk read job and obtain the download URL once the job is complete. Specify the unique job ID that Zoho CRM returned when you created the job.", "operationId": "getBulkReadJobDetails", "parameters": [ { "$ref": "#/components/parameters/BulkReadJobId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Example1": { "description": "A sample response showing the details of a completed bulk read job, including the download URL and result summary.", "summary": "Bulk read job details", "value": { "data": [ { "created_by": { "id": "string", "name": "string" }, "created_time": "2023-01-01T00:00:00Z", "file_type": "csv", "id": "string", "operation": "string", "query": { "module": { "api_name": "string", "id": "string" }, "page": 0 }, "state": "COMPLETED" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response returned when the bulk read job details are successfully retrieved.", "properties": { "data": { "description": "Represents the list of bulk read job details returned in the response. ", "items": { "additionalProperties": false, "description": "Represents the details of a bulk read job.", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the user who created the bulk read job. ", "properties": { "id": { "description": "Represents the unique identifier of the user who created the job. ", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the display name of the user who created the job. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the date and time when Zoho CRM created the bulk read job, in ISO 8601 format. ", "format": "date-time", "type": "string" }, "file_type": { "description": "Indicates the format of the exported file. \nPossible values:\n**csv** - The records are exported in CSV format.", "enum": [ "csv" ], "type": "string" }, "id": { "description": "Represents the unique identifier of the bulk read job. ", "maxLength": 100, "type": "string", "x-zs-$id": "BulkReadId" }, "operation": { "description": "Specifies the type of action the API completed. Sample - \"operation\" : \"read”.", "maxLength": 500, "type": "string" }, "query": { "additionalProperties": false, "description": "Represents the query configuration used to create the bulk read job, including the module, filter criteria, and field selections. ", "properties": { "criteria": { "additionalProperties": false, "description": "Represents the filter criteria used to narrow the records exported in the bulk read job.", "properties": { "group": { "description": "Indicates the list of filter conditions applied to the bulk read query. ", "items": { "additionalProperties": false, "description": "Represents a single filter condition in the criteria group.", "properties": { "comparator": { "description": "Indicates the comparison operator used in the filter condition. ", "enum": [ "equal", "contains", "ends_with", "not_contains", "not_equal", "starts_with" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field used in the filter condition. ", "properties": { "api_name": { "description": "Indicates the API name of the filter field. ", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the filter field. ", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "api_name", "id" ], "type": "object" }, "id": { "description": "Represents the position identifier of the filter condition within the criteria group. ", "maxLength": 100, "type": [ "string", "null" ] }, "type": { "description": "Specifies the data type of the filter field. ", "enum": [ "value" ], "type": "string" }, "value": { "description": "Represents the value used in the filter condition. ", "maxLength": 500, "type": "string" } }, "required": [ "field", "value", "type", "comparator" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "group_operator": { "description": "Specifies the logical operator used to combine conditions within the criteria group. \nPossible values:\n**and** - All filter conditions must be satisfied.\n**or** - At least one filter condition must be satisfied.", "enum": [ "or", "and" ], "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object" }, "cvid": { "description": "Represents the unique identifier of the Custom View used to pre-filter the records for the bulk read job.", "maxLength": 100, "type": "string" }, "fields": { "description": "Represents the list of field API names included in the exported data.", "items": { "description": "Represents the API name of a field included in the exported data.", "maxLength": 500, "type": "string" }, "maxItems": 1000, "type": "array" }, "module": { "additionalProperties": false, "description": "Represents the CRM module from which records are exported. ", "properties": { "api_name": { "description": "Represents the API name of the CRM module. ", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the CRM module. ", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "page": { "description": "Specifies the page number of records to export. ", "format": "int32", "type": "integer" } }, "required": [ "module", "page" ], "type": "object" }, "result": { "additionalProperties": false, "description": "specifies the export result details of the bulk read job, including the download URL and pagination information. Present when the job has completed or partially completed.", "properties": { "count": { "description": "Specifies the total number of records exported in the bulk read job. ", "format": "int32", "type": "integer" }, "download_url": { "description": "Specifies the URL to download the exported file. ", "maxLength": 2048, "type": "string" }, "more_records": { "description": "Indicates whether additional records are available beyond the current page. ", "type": "boolean" }, "next_page_token": { "description": "Represents a token used to retrieve the next page of exported records in subsequent requests.", "maxLength": 500, "type": "string" }, "page": { "description": "Represents the page number of the exported result. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of records per page in the exported result. ", "format": "int32", "type": "integer" } }, "required": [ "page", "count", "download_url", "per_page", "more_records" ], "type": "object" }, "state": { "description": "Represents the current processing state of the bulk read job. \nPossible values:\n**ADDED** - The job has been created and is awaiting processing.\n**QUEUED** - The job is queued and scheduled for processing.\n**IN PROGRESS** - The job is currently being processed.\n**COMPLETED** - The job has finished processing and the result is available for download.", "enum": [ "COMPLETED", "ADDED", "QUEUED", "IN PROGRESS" ], "type": "string" } }, "required": [ "id", "operation", "state", "query", "created_by", "created_time", "file_type" ], "type": "object" }, "maxItems": 1000, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "GetbulkreadjobdetailsResponse200" } } }, "description": "The bulk read job details were successfully retrieved." }, "404": { "content": { "application/json": { "examples": { "Example1": { "description": "A sample error response indicating that the specified bulk read job was not found.", "summary": "Job not found error", "value": { "code": "RESOURCE_NOT_FOUND", "details": { "resource": "string" }, "message": "string", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Indicates the error response returned when the specified bulk read job does not exist.", "properties": { "code": { "description": "Represents the error code indicating that the requested bulk read job was not found. \nPossible values:\n**RESOURCE_NOT_FOUND** - The bulk read job with the specified ID does not exist.", "enum": [ "RESOURCE_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Specifies additional details about the resource not found error. ", "properties": { "resource": { "description": "Represents the type of resource that was not found. ", "maxLength": 500, "type": "string" } }, "required": [ "resource" ], "type": "object" }, "message": { "description": "Represents the error message describing the resource not found issue. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Specifies the status of the API request. \nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetbulkreadjobdetailsResponse404" } } }, "description": "The specified bulk read job was not found." } }, "security": [ { "OAuth2": [ "ZohoCRM.bulk.READ", "ZohoCRM.modules.ALL" ] } ], "summary": "Get bulk read job details", "tags": [ "bulk_read" ], "x-zoho-document": "bulk_read" } }, "/crm/bulk/v8/read/{jobId}/result": { "get": { "description": "To download the exported records from a completed bulk read job in Zoho CRM. This API returns a ZIP archive containing the CSV or ICS file with the exported records. The bulk read job must have a COMPLETED state before you can download the result.", "operationId": "downloadBulkReadResult", "parameters": [ { "$ref": "#/components/parameters/BulkReadJobId" } ], "responses": { "200": { "content": { "application/zip": { "schema": { "description": "Represents the ZIP archive containing the exported bulk read records.", "format": "binary", "type": "string", "x-zs-$id": "DownloadresultResponse200" } } }, "description": "The bulk read result file was successfully downloaded as a ZIP archive." }, "404": { "content": { "application/json": { "examples": { "Example1": { "description": "A sample error response indicating that the specified bulk read job result was not found.", "summary": "Job result not found error", "value": { "code": "RESOURCE_NOT_FOUND", "details": { "resource": "string" }, "message": "string", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the specified bulk read job result does not exist.", "properties": { "code": { "description": "Represents the error code indicating that the bulk read job result was not found. \nPossible values:\n**RESOURCE_NOT_FOUND** - The bulk read job with the specified ID does not exist or the result is not yet available.", "enum": [ "RESOURCE_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the resource not found error. ", "properties": { "resource": { "description": "Represents the type of resource that was not found. ", "maxLength": 500, "type": "string" } }, "required": [ "resource" ], "type": "object" }, "message": { "description": "Represents the error message describing the resource not found issue. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the API request. \nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DownloadresultResponse404" } } }, "description": "The specified bulk read job or its result was not found." } }, "security": [ { "OAuth2": [ "ZohoCRM.bulk.READ", "ZohoCRM.modules.ALL" ] } ], "summary": "Download bulk read result", "tags": [ "bulk_read" ], "x-zoho-document": "bulk_read" } }, "/crm/bulk/v8/write": { "post": { "description": "To create a bulk write job in your Zoho CRM organization that creates, updates, or upserts records in a target module from a previously uploaded file. The job is processed asynchronously; the response returns the job identifier that the get job details operation uses to poll job status, and an optional callback URL is notified on completion or failure.", "operationId": "createBulkWriteJob", "requestBody": { "content": { "application/json": { "examples": { "BulkWriteRequest": { "description": "Shows a bulk write request that creates records in the Contacts module from a previously uploaded file, with one field mapping and a callback URL.", "summary": "Bulk write request with one resource and one field mapping", "value": { "callback": { "method": "post", "url": "http://requestbin.fullcontact.com/1fcimk51" }, "operation": "insert", "resource": [ { "field_mappings": [ { "api_name": "Last_Name", "index": 0 } ], "file_id": "3524001000005697001", "file_names": [ "data.csv" ], "find_by": "id", "module": { "api_name": "Contacts" }, "type": "data" } ] } } }, "schema": { "additionalProperties": false, "description": "Defines the payload for creating a bulk write job, including the operation type, optional callback configuration, and the list of resource configurations.", "properties": { "callback": { "additionalProperties": false, "description": "Specify the callback configuration that Zoho CRM uses to notify your endpoint when the bulk write job completes or fails.", "properties": { "method": { "description": "Specify the HTTP method that Zoho CRM uses to invoke the callback URL.\nPossible values:\npost - Sends the job completion notification as an HTTP POST request.", "enum": [ "post" ], "type": "string" }, "url": { "description": "Specify the URL that receives the job completion notification. The URL must accept the HTTP POST method and be reachable from Zoho CRM servers.", "format": "uri", "type": "string" } }, "required": [ "url", "method" ], "type": "object" }, "character_encoding": { "description": "Specify the character encoding of the uploaded file. Zoho CRM auto-detects the encoding when this value is omitted; supply a value to override auto-detection and force the file to be read with the specified charset.", "maxLength": 50, "type": [ "string", "null" ] }, "operation": { "description": "Specify the type of bulk write operation to perform on the file.\nPossible values:\ninsert - Creates the records from the file as new records in the target module.\nupdate - Updates existing records in the target module without creating new ones.\nupsert - Updates existing records and creates new records that do not exist already.", "enum": [ "insert", "update", "upsert" ], "type": "string" }, "resource": { "description": "Specify the list of resource configurations to process in the bulk write job. Each entry describes the target module, the uploaded file to read, and the field mappings to apply.", "items": { "additionalProperties": false, "description": "Specify the configuration for a single bulk write resource, including the target module, the uploaded file ID, the matching key, and the field mappings to apply when the job runs.", "properties": { "field_mappings": { "description": "Specify the mapping between columns in the uploaded file and fields on the target module. When omitted, Zoho CRM auto-maps columns to fields whose API names match the CSV header.", "items": { "additionalProperties": false, "description": "Specify the mapping between a single column in the uploaded file and a field on the target module.", "properties": { "api_name": { "description": "Specify the API name of the field on the target module to populate with the column value. Refer to the [Fields API](fields.yaml#$.paths./settings/fields.get) resource for valid values.", "maxLength": 100, "type": "string" }, "index": { "description": "Specify the zero-based column index in the uploaded file whose value populates the mapped field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "index" ], "type": "object" }, "maxItems": 500, "type": "array" }, "file_id": { "description": "Specify the identifier of the previously uploaded file that the bulk write job must read. Obtain this value from the response of the bulk upload file API.", "maxLength": 100, "type": "string" }, "file_names": { "description": "Specify the names of the files inside the uploaded archive that the bulk write job must process.", "items": { "description": "Represents the name of a single file inside the uploaded archive that the bulk write job processes.", "maxLength": 255, "type": "string" }, "maxItems": 10, "type": "array" }, "find_by": { "description": "Specify the field that the bulk write job uses to locate existing records when performing an update or upsert operation.\nPossible values:\nid - Matches records by their unique record ID in the target module.", "enum": [ "id" ], "type": "string" }, "ignore_empty": { "description": "Specify whether to skip empty cells in the uploaded file when updating records.\nPossible values:\ntrue - Ignores empty values in a column and updates only the fields that carry a non-empty value.\nfalse - Updates the target field with the empty value supplied in the file.", "type": "boolean" }, "module": { "additionalProperties": false, "description": "Specify the target CRM module into which the records from the uploaded file are written.", "properties": { "api_name": { "description": "Specify the API name of the target CRM module into which records are imported. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "type": { "description": "Specify the type of the resource being imported.\nPossible values:\ndata - Indicates that the resource contains record data to be written into the target module.", "enum": [ "data" ], "type": "string" } }, "required": [ "type", "file_names", "module", "file_id", "find_by" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "operation", "resource" ], "type": "object" } } }, "description": "The request body must contain a resource array. You can include a maximum of 100 objects per request.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Returns the unique identifier of the scheduled bulk write job and the ID of the creating user.", "summary": "Successful bulk write job creation", "value": { "code": "SUCCESS", "details": { "created_by": { "id": "3524001000000186003" }, "id": "3524001000005697001" }, "message": "success", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Represents the success envelope that Zoho CRM returns after scheduling a bulk write job. Contains the overall status, response code, message, and the details of the newly scheduled job.", "properties": { "code": { "description": "Represents the response code returned for the bulk write job creation. \nPossible values:\n**SUCCESS** - Indicates that the bulk write job was scheduled successfully.\n**FILE_UPLOAD_SUCCESS** - Indicates that the file associated with the job was uploaded successfully.", "enum": [ "SUCCESS", "FILE_UPLOAD_SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the newly scheduled bulk write job. ", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who created the bulk write job. ", "properties": { "id": { "description": "Represents the unique identifier of the Zoho CRM user who created the bulk write job. Refer to the [Users API](users.yaml#$.paths./users.get) endpoint for details. ", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the display name of the Zoho CRM user who created the bulk write job. Refer to the [Users API](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "id": { "description": "Represents the unique identifier of the newly scheduled bulk write job. Use this value to query the job status through the get job details operation. ", "maxLength": 100, "type": "string" } }, "required": [ "id", "created_by" ], "type": "object" }, "message": { "description": "Represents the response message for the bulk write job creation. \nPossible values:\n**success** - Confirms that Zoho CRM scheduled the bulk write job.\n**file uploaded** - Confirms that Zoho CRM accepted the uploaded file for the job.", "enum": [ "success", "file uploaded." ], "type": "string" }, "status": { "description": "Represents the overall status of the bulk write job creation request. \nPossible values:\nsuccess - Indicates that Zoho CRM scheduled the bulk write job successfully.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "BulkWriteCreateResponse" } } }, "description": "Returns the details of the bulk write job that was scheduled, including its unique identifier and the user who created it." }, "400": { "content": { "application/json": { "examples": { "InvalidCallbackUrlError": { "description": "Demonstrates the error response returned when the supplied callback URL fails validation.", "summary": "INVALID_CALLBACK_URL error for an unreachable callback", "value": { "code": "INVALID_CALLBACK_URL", "details": {}, "message": "Invalid callback URL provided", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error variant returned when the callback URL is invalid, identified by the INVALID_CALLBACK_URL error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**INVALID_CALLBACK_URL** - Indicates that the supplied callback URL is invalid.", "enum": [ "INVALID_CALLBACK_URL" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidCallbackUrlErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when one or more supplied values are invalid, identified by the INVALID_DATA error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**INVALID_DATA** - Indicates that one of the supplied values is invalid or has an unsupported type.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidDataErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when a mandatory key is missing from the request payload, identified by the MANDATORY_NOT_FOUND error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**MANDATORY_NOT_FOUND** - Indicates that a mandatory key was omitted from the request payload.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the message returned for the missing mandatory key.\nPossible values:\n**Required key parent_column_index** is not available - Returned when the parent_column_index key is missing for a lookup mapping.\n**Required key find_by is not available** - Returned when the find_by key is missing for an update or upsert operation.", "enum": [ "Required key parent_column_index is not available", "Required key find_by is not available" ], "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "MandatoryNotFoundErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when two mutually exclusive keys are supplied together, identified by the COEXISTENCE_NOT_ALLOWED error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**COEXISTENCE_NOT_ALLOWED** - Indicates that two mutually exclusive keys were supplied together in the request.", "enum": [ "COEXISTENCE_NOT_ALLOWED" ], "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "CoexistenceNotAllowedErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when the uploaded file format is not supported, identified by the FILE_NOT_SUPPORTED error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**FILE_NOT_SUPPORTED** - Indicates that the uploaded file format is not supported by the bulk write job.", "enum": [ "FILE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "FileNotSupportedErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when the uploaded file is not found for the supplied file ID, identified by the FILE_NOT_FOUND error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**FILE_NOT_FOUND** - Indicates that no uploaded file exists for the supplied file ID.", "enum": [ "FILE_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "FileNotFoundErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when the request payload is malformed, identified by the INVALID_REQUEST error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**INVALID_REQUEST** - Indicates that the request payload is malformed or does not conform to the documented contract.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidRequestErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when a mandatory field on the target module is not mapped in the field_mappings array, identified by the **MANDATORY_FIELDS_NOT_MAPPED** error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**MANDATORY_FIELDS_NOT_MAPPED** - Indicates that one or more mandatory fields on the target module were not mapped in the field_mappings array.", "enum": [ "MANDATORY_FIELDS_NOT_MAPPED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "MandatoryFieldsNotMappedErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when the supplied callback HTTP method is not supported, identified by the INVALID_CALLBACK_METHOD error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**INVALID_CALLBACK_METHOD** - Indicates that the supplied callback HTTP method is not supported.", "enum": [ "INVALID_CALLBACK_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Provides additional context about the invalid callback method, including the list of supported callback methods.", "properties": { "supported_callback_methods": { "description": "Lists the HTTP methods that the callback URL is allowed to use.", "items": { "description": "Represents a single HTTP method name supported by the callback URL.", "maxLength": 50, "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\nerror - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidCallbackMethodErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when a required key is missing at a specific JSON path in the payload, identified by the MISSING_REQUIRED_KEY error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**MISSING_REQUIRED_KEY** - Indicates that a required key is missing at the JSON path identified in the error details.", "enum": [ "MISSING_REQUIRED_KEY" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Provides additional context about the missing required key, including the JSON path that identifies its location in the request payload.", "properties": { "json_path": { "description": "Represents the JSON path in the request payload at which the required key was expected.", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "MissingRequiredKeyErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when the supplied module API name does not correspond to any module in the organization, identified by the MODULE_NOT_AVAILABLE error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**MODULE_NOT_AVAILABLE** - Indicates that the supplied module API name does not match any module available in the Zoho CRM organization.", "enum": [ "MODULE_NOT_AVAILABLE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "ModuleNotAvailableErrorResponse" }, { "additionalProperties": false, "description": "Represents the error variant returned when the request body content type is not supported, identified by the **REQUEST_BODY_NOT_SUPPORTED** error code.", "properties": { "code": { "description": "Represents the error code returned for this failure mode.\nPossible values:\n**REQUEST_BODY_NOT_SUPPORTED** - Indicates that the request body content type is not supported by this operation.", "enum": [ "REQUEST_BODY_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Provides additional context about the failure, when available.", "type": "object" }, "message": { "description": "Represents the error message returned for the failure, describing the validation problem.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the response status for this failure.\nPossible values:\n**error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "RequestBodyNotSupportedErrorResponse" } ], "description": "Represents the validation error envelope returned for a failed bulk write job creation. Resolves to one of the documented error variants based on the failure cause.", "x-zs-$id": "BulkWriteCreateErrorResponses" } } }, "description": "The request payload failed validation. Resolution: The cause is identified by the **code** in the response. The offending field, mapping, callback configuration, or file reference must be corrected before retrying the request." } }, "security": [ { "OAuth2": [ "ZohoCRM.bulk.CREATE" ] } ], "summary": "Create a bulk write job", "tags": [ "bulk_write" ], "x-zoho-document": "bulk_write" } }, "/crm/bulk/v8/write/{jobId}": { "get": { "description": "To retrieve the details of a previously created bulk write job in your Zoho CRM organization, including its current status, per-resource and per-file processing counts, the creator, and the download URL of the result archive once the job completes. The download URL remains accessible for up to seven days after the job completes.", "operationId": "getBulkWriteJobDetails", "parameters": [ { "$ref": "#/components/parameters/BulkWriteJobId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "BulkWriteJobDetailsResponse": { "description": "Returns the full state of a completed bulk write job that processed one resource containing 100 records in the Contacts module.", "summary": "Completed bulk write job with one resource", "value": { "callback": { "method": "post", "url": "http://requestbin.fullcontact.com/1fcimk51" }, "character_encoding": "UTF-8", "created_by": { "id": "3524001000000186003", "name": "John Doe" }, "created_time": "2023-01-01T12:00:00Z", "id": "3524001000005697001", "operation": "insert", "resource": [ { "field_mappings": [ { "api_name": "Last_Name", "index": 0 } ], "file": { "added_count": 100, "name": "data.csv", "skipped_count": 0, "status": "COMPLETED", "total_count": 100, "updated_count": 0 }, "module": { "api_name": "Contacts", "id": "3524001000000002179" }, "status": "COMPLETED", "type": "data" } ], "result": { "download_url": "https://download.zohocrm.com/v2/bulk/write/3524001000005697001/result" }, "status": "COMPLETED" } } }, "schema": { "additionalProperties": false, "description": "Represents the full state and processing result of a bulk write job, including the overall status, the per-resource processing summary, the job creator, and the download URL of the result archive.", "properties": { "callback": { "additionalProperties": false, "description": "Represents the callback configuration registered for the bulk write job, used to notify the configured URL when the job completes or fails. ", "properties": { "method": { "description": "Represents the HTTP method used to invoke the callback URL.\nPossible values:\npost - The callback URL is invoked with an HTTP POST request.", "enum": [ "post" ], "type": "string" }, "url": { "description": "Represents the URL that receives the job completion notification.\nPossible values:\nhttp://requestbin.fullcontact.com/1fcimk51 - Sample callback URL recorded for the job.", "enum": [ "http://requestbin.fullcontact.com/1fcimk51" ], "type": "string" } }, "required": [ "url", "method" ], "type": "object" }, "character_encoding": { "description": "Represents the character encoding used to read the uploaded file. Returned with the value detected automatically by Zoho CRM, or with the value supplied in the original create request when it was specified.", "maxLength": 50, "type": "string" }, "created_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who created the bulk write job. ", "properties": { "id": { "description": "Represents the unique identifier of the Zoho CRM user who created the bulk write job. Refer to the [Users API](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the display name of the Zoho CRM user who created the bulk write job. Refer to the [Users API](users.yaml#$.paths./users.get) endpoint for details.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the ISO 8601 timestamp at which Zoho CRM created the bulk write job. ", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique identifier of the bulk write job. ", "maxLength": 100, "type": "string" }, "operation": { "description": "Represents the type of bulk write operation performed by the job, such as **insert**, **update**, or **upsert**. ", "maxLength": 50, "type": "string" }, "resource": { "description": "Represents the list of resource entries processed by the bulk write job, one entry per resource configuration submitted in the create request. ", "items": { "additionalProperties": false, "description": "Represents the processing record for a single resource configuration in the bulk write job. ", "properties": { "code": { "description": "Represents the result code returned by Zoho CRM for the processing of this resource entry.", "maxLength": 100, "type": "string" }, "field_mappings": { "description": "Represents the field mappings applied between columns in the uploaded file and fields on the target module for this resource.", "items": { "additionalProperties": false, "description": "Represents the mapping between a single column in the uploaded file and a field on the target module.", "properties": { "api_name": { "description": "Represents the API name of the field on the target module that received the column value. Refer to the [Fields API](fields.yaml#$.paths./settings/fields.get) resource for details.", "maxLength": 100, "type": "string" }, "default_value": { "additionalProperties": false, "description": "Represents the default value used to populate the field when the corresponding column in the file was empty.", "properties": { "value": { "description": "Represents the default value that replaces empty cells in the mapped column.", "maxLength": 500, "type": "string" } }, "required": [ "value" ], "type": "object" }, "find_by": { "description": "Represents the field that the bulk write job used to match existing records for this mapping. Returned as **null** when no matching key was supplied.", "maxLength": 100, "type": [ "string", "null" ] }, "format": { "description": "Represents the value format applied to the column when the field requires a specific date, datetime, numeric, or currency pattern. Returned as **null** when no explicit format was supplied.", "maxLength": 100, "type": [ "string", "null" ] }, "index": { "description": "Represents the zero-based column index in the uploaded file whose value was written to the mapped field.", "format": "int32", "type": "integer" }, "module": { "description": "Represents the related module API name supplied for lookup-style mappings that resolve values against a sibling module. Returned as **null** when no related module was supplied.", "maxLength": 100, "type": [ "string", "null" ] }, "parent_column_index": { "description": "Represents the column index of the parent record reference when the mapped field is part of a subform or related record. Returned as **null** when no parent column was supplied.", "format": "int32", "type": [ "integer", "null" ] } }, "required": [ "api_name", "index" ], "type": "object" }, "maxItems": 500, "type": "array" }, "file": { "additionalProperties": false, "description": "Represents the per-file processing summary for this resource entry. ", "properties": { "added_count": { "description": "Represents the number of records that were created from the file. ", "format": "int32", "type": "integer" }, "name": { "description": "Represents the file name read from the uploaded archive. ", "maxLength": 255, "type": "string" }, "skipped_count": { "description": "Represents the number of records that were skipped during processing. The error column in the result file explains why each record was skipped.", "format": "int32", "type": "integer" }, "status": { "description": "Represents the processing status of the file within this resource entry. \nPossible values:\n**COMPLETED** - The file was fully processed.\n**ADDED** - The file was queued for processing.\n**INPROGRESS** - The file is currently being processed.\n**SKIPPED** - The file was skipped.", "enum": [ "COMPLETED", "ADDED", "INPROGRESS", "SKIPPED" ], "type": "string" }, "total_count": { "description": "Represents the total number of records that were created, updated, or skipped during processing. ", "format": "int32", "type": "integer" }, "updated_count": { "description": "Represents the number of records that were updated from the file. ", "format": "int32", "type": "integer" } }, "required": [ "status", "name", "added_count", "skipped_count", "updated_count", "total_count" ], "type": "object" }, "ignore_empty": { "description": "Indicates whether empty cells in the uploaded file were skipped when updating records.\nPossible values:\n**true** - Empty values in a column were ignored and only non-empty values were written.\n**false** - Empty values in a column were written to the corresponding field.", "type": "boolean" }, "module": { "additionalProperties": false, "description": "Represents the target CRM module into which the resource was written. ", "properties": { "api_name": { "description": "Represents the API name of the target CRM module into which records were written. Refer to the [Modules](modules.yaml#$.paths./settings/modules.get) resource for details.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the target CRM module. Refer to the [Modules](modules.yaml#$.paths./settings/modules.get) resource for details.", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "status": { "description": "Represents the processing status of this resource entry. \nPossible values:\n**COMPLETED** - All records in the resource were processed successfully.\n**ADDED** - The resource was queued for processing.\n**INPROGRESS** - The resource is currently being processed.\n**SKIPPED** - The resource was skipped without being processed.", "enum": [ "COMPLETED", "ADDED", "INPROGRESS", "SKIPPED" ], "type": "string" }, "type": { "description": "Represents the type of the processed resource. \nPossible values:\n**data** - Indicates that the resource contained record data.", "enum": [ "data" ], "type": "string" } }, "required": [ "status", "type", "module" ], "type": "object" }, "maxItems": 100, "type": "array" }, "result": { "additionalProperties": false, "description": "Represents the result metadata of the completed bulk write job, including the **download URL** of the result archive.", "properties": { "download_url": { "description": "Represents the URL from which the result archive of the bulk write job can be downloaded. The download URL is accessible for up to **seven** days after job completion.", "maxLength": 500, "type": "string" } }, "required": [ "download_url" ], "type": "object" }, "status": { "description": "Represents the current overall status of the bulk write job. Sample values include **ADDED**, **INPROGRESS**, **COMPLETED**, and **SKIPPED**.", "maxLength": 50, "type": "string" } }, "required": [ "status", "resource", "id", "created_by", "operation", "created_time", "callback" ], "type": "object", "x-zs-$id": "BulkWriteJobDetailsResponse" } } }, "description": "Returns the full state and processing result of the bulk write job identified by the supplied **jobId**, including the per-resource and per-file counts and the download URL of the result archive." } }, "security": [ { "OAuth2": [ "ZohoCRM.bulk.CREATE" ] } ], "summary": "Get bulk write job details", "tags": [ "bulk_write" ], "x-zoho-document": "bulk_write" } }, "/crm/v8/Appointments__s": { "delete": { "description": "To delete one or more appointment records in your Zoho CRM organization. Note that this API will not delete any deals created on the completion of the deleted appointments.\n", "operationId": "deleteAppointmentsS", "parameters": [ { "$ref": "#/components/parameters/AppointmentsParamQueryIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful deletion response for three appointment records. Each entry in the data array returns a SUCCESS code, a \"record deleted\" message, and the corresponding record ID.\n", "summary": "All three appointment records deleted successfully.\n", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "111115000000147279" }, "message": "record deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111115000000147229" }, "message": "record deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111115000000147224" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteappointmentssResponse200" } } }, "description": "Returns a confirmation that all specified appointment records were deleted successfully. Each item in the data array contains the record ID, a SUCCESS code, and a \"record deleted\" message.\n" }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Shows a partial deletion response where the API deleted one appointment record and could not delete another. The data array returns a SUCCESS entry for the deleted record and an INVALID_DATA entry with a \"record not deleted\" message for the failed record.\n", "summary": "Partial deletion where one record deleted, one failed with INVALID_DATA.\n", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "111115000000147279" }, "message": "record deleted", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "23132423" }, "message": "record not deleted", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the Multi-Status response body returned when a bulk deletion request results in a mix of successful and failed appointment deletion attempts.\n", "properties": { "data": { "allOf": [ { "description": "Represents the constraint that the data array contains at least one successful deletion result, where each matching item holds the deleted record ID.\n" }, { "description": "Represents the constraint that the data array contains at least one failed deletion result, where each matching item describes an appointment record that could not be deleted.\n" } ], "description": "Represents the list of result objects for each appointment deletion attempt. Each item is either a success confirmation or an error response.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/Delete207SuccessResponse" } ], "description": "Represents a single result item for an appointment deletion attempt, which is either a success confirmation or an error response.\n" }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteappointmentssResponse207" } } }, "description": "Returns a mixed-status response when the delete operation partially succeeds. Each item in the data array contains either a SUCCESS code with a \"record deleted\" message or an INVALID_DATA code with a \"record not deleted\" message, based on the outcome for each individual record.\n" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows an error response when the specified appointment ID is invalid or the record has already been deleted. The response returns an INVALID_DATA code with a \"record not deleted\" message and the corresponding record ID in the details object.\n", "summary": "INVALID_DATA error where appointment ID is invalid or already deleted\n", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "23132423" }, "message": "record not deleted", "status": "error" } ] } }, "InvalidModuleResponse1": { "description": "Shows an error response when the module name in the request is invalid. The response returns an INVALID_MODULE code with the message \"the module name given seems to be invalid\" and a resource_path_index in the details object.\n", "summary": "Invalid module API name provided in the request.\n", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Shows an error response when the caller uses an invalid HTTP request method to access this endpoint. Only the DELETE method applies to this API.\n", "summary": "Invalid HTTP request method type used in the request.\n", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response body containing a list of INVALID_DATA errors, where each item corresponds to an appointment record that could not be deleted.\n", "properties": { "data": { "description": "Represents the list of error objects for the appointment records that could not be deleted.\n", "items": { "$ref": "#/components/schemas/ErrorResponseCore2137699283" }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteappointmentssError400Wrapper" }, { "$ref": "#/components/schemas/ErrorResponseCore1875045219" }, { "$ref": "#/components/schemas/ErrorResponseCore1604218709" } ], "description": "Represents the error response body for a failed DELETE Appointments request, containing either a list of record-level validation errors or a single request-level error.\n", "x-zs-$id": "DeleteappointmentssError400" } } }, "description": "The request could not be processed due to an invalid appointment ID, an invalid module name, or an unsupported HTTP request method.\n\n**Resolution:** For INVALID_DATA, make a GET Appointments API call and provide a valid appointment ID. For INVALID_REQUEST_METHOD, use only the DELETE method. For INVALID_MODULE, verify that the module API name in the request is correct." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.appointments.DELETE" ] } ], "summary": "Delete one or more appointment records\n", "tags": [ "appointments" ], "x-zoho-document": "appointments" }, "get": { "description": "To retrieve appointment records from your Zoho CRM organization. \n\nUse the `page` and `per_page` parameters to paginate up to 2,000 records, or use the `page_token` received in a prior response to paginate beyond 2,000 records up to a maximum of 100,000. Each request returns a maximum of 200 records. \n\nSubform data is not included when retrieving multiple appointments. The API returns field values containing sensitive health data only when the Restrict Data access through API option is disabled in compliance settings.", "operationId": "getAppointmentsS", "parameters": [ { "$ref": "#/components/parameters/AppointmentsFields" }, { "$ref": "#/components/parameters/AppointmentsCvid" }, { "$ref": "#/components/parameters/AppointmentsPageToken" }, { "$ref": "#/components/parameters/AppointmentsPage" }, { "$ref": "#/components/parameters/AppointmentsPerPage" }, { "$ref": "#/components/parameters/AppointmentsSortOrder" }, { "$ref": "#/components/parameters/AppointmentsSortBy" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Illustrates a successful response for GET Appointments, returning two appointment records with their owner, service name, appointment times, and status.", "summary": "Successful retrieval of appointment records", "value": { "data": [ { "$currency_symbol": "£", "$editable": true, "$field_states": null, "$sharing_permission": "full_access", "$status": "cv_1", "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-16T18:30:00+05:30", "Appointment_For": { "id": "111115000000120725", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "ll" }, "Appointment_Name": "service06 - ll", "Appointment_Start_Time": "2026-01-16T18:00:00+05:30", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T16:50:29+05:30", "Date_1": null, "Duration": 30, "Job_Sheet_Created__s": false, "Job_Sheet_Description__s": null, "Job_Sheet_Name__s": null, "Job_Sheet_Section__s": "Job Sheet Information", "Last_Activity_Time": null, "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T16:50:29+05:30", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Record_Status__s": "Available", "Remind_At": null, "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Rescheduled_To": null, "Service_Name": { "id": "111115000000127506", "name": "service06" }, "Status": "Overdue", "Tag": [], "id": "111115000000147279" }, { "$currency_symbol": "£", "$editable": true, "$field_states": null, "$sharing_permission": "full_access", "$status": "cv_1", "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-16T15:30:00+05:30", "Appointment_For": { "id": "111115000000120715", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "bb" }, "Appointment_Name": "hh", "Appointment_Start_Time": "2026-01-16T15:00:00+05:30", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T14:11:13+05:30", "Date_1": null, "Duration": 30, "Job_Sheet_Created__s": false, "Job_Sheet_Description__s": null, "Job_Sheet_Name__s": null, "Job_Sheet_Section__s": "Job Sheet Information", "Last_Activity_Time": null, "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T14:11:13+05:30", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Record_Status__s": "Available", "Remind_At": null, "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Rescheduled_To": null, "Service_Name": { "id": "111115000000127506", "name": "service06" }, "Status": "Overdue", "Tag": [], "id": "111115000000147238" } ] } } }, "schema": { "$ref": "#/components/schemas/GetappointmentssResponse200" } } }, "description": "Returns the list of appointment records that match the request criteria." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse1": { "description": "Illustrates an error response when an invalid module API name is provided in the request URL, returning error code `INVALID_MODULE`.", "summary": "An error response for an invalid module API name.", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Illustrates an error response when the request uses an unsupported HTTP method instead of GET, returning error code `INVALID_REQUEST_METHOD`.", "summary": "An error response for an unsupported HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseCore1604218709" }, { "$ref": "#/components/schemas/ErrorResponseCore1875045219" } ], "description": "Represents the error response body returned for a failed GET operation, capturing either an invalid module API name or an unsupported HTTP request method error.", "x-zs-$id": "GetappointmentssError400" } } }, "description": "The request fails due to an invalid module API name in the request URL or an unsupported HTTP request method.\n**Resolution:** The module API name in the request URL must be `Appointments__s`, and the request must use the GET method." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.appointments.READ" ] } ], "summary": "Get Appointment Records", "tags": [ "appointments" ], "x-zoho-document": "appointments" }, "post": { "description": "To create one or more appointment records in your Zoho CRM organization.", "operationId": "createAppointmentsS", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Demonstrates a request body containing four appointment objects, each representing a distinct appointment status: scheduled, rescheduled, cancelled, and completed.", "summary": "Request body with four appointment objects covering varied statuses.", "value": { "data": [ { "$currency_symbol": "£", "$editable": true, "$sharing_permission": "full_access", "$state": "save", "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-29T12:30:00+04:00", "Appointment_For": { "id": "111115000000120715", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "bb" }, "Appointment_Name": "service04 - bb", "Appointment_Start_Time": "2026-01-29T12:00:00+04:00", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T09:39:43+04:00", "Duration": 30, "Job_Sheet_Created__s": false, "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T09:39:43+04:00", "Owner": { "email": "madeshwaran.g+csez02@zohotest.com", "id": "111115000000122075", "name": "madesh" }, "Record_Status__s": "Available", "Remind_At": [ { "period": "minutes", "unit": 15 } ], "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Rescheduled_To": null, "Service_Name": { "id": "111115000000127440", "name": "service04" }, "Status": "Scheduled", "Tag": [] }, { "$currency_symbol": "£", "$editable": true, "$field_states": null, "$sharing_permission": "full_access", "$status": "cmv_1-1", "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-22T13:30:00+04:00", "Appointment_For": { "id": "111115000000120715", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "bb" }, "Appointment_Name": "service-reschedule", "Appointment_Start_Time": "2026-01-22T13:00:00+04:00", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T09:39:43+04:00", "Date_1": "2026-01-14", "Duration": 30, "Job_Sheet_Created__s": false, "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:29:58+04:00", "Owner": { "email": "madeshwaran.g+csez02@zohotest.com", "id": "111115000000122075", "name": "madesh" }, "Record_Status__s": "Available", "Remind_At": [ { "period": "minutes", "unit": 15 } ], "Reschedule_Count": 2, "Reschedule_Note": "for customer need", "Reschedule_Reason": "By Customer", "Rescheduled_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Rescheduled_From": "2026-01-21T14:30:00+04:00", "Rescheduled_Time": "2026-01-16T10:29:58+04:00", "Rescheduled_To": "2026-01-22T13:00:00+04:00", "Service_Name": { "id": "111115000000127440", "name": "service04" }, "Status": "Scheduled", "Tag": [] }, { "$currency_symbol": "£", "$editable": true, "$sharing_permission": "full_access", "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-22T13:30:00+04:00", "Appointment_For": { "id": "111115000000120715", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "bb" }, "Appointment_Name": "service04 - bb", "Appointment_Start_Time": "2026-01-22T13:00:00+04:00", "Cancellation_Note": "request from customer", "Cancellation_Reason": "By Customer", "Cancelled_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Cancelled_Time": "2026-01-16T10:34:44+04:00", "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T09:39:43+04:00", "Date_1": "2026-01-14", "Duration": 30, "Job_Sheet_Created__s": false, "Last_Activity_Time": "2026-01-16T10:34:44+04:00", "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:34:44+04:00", "Owner": { "email": "madeshwaran.g+csez02@zohotest.com", "id": "111115000000122075", "name": "madesh" }, "Record_Status__s": "Available", "Remind_At": [ { "period": "minutes", "unit": 15 } ], "Reschedule_Count": 2, "Reschedule_Note": "for customer need", "Reschedule_Reason": "By Customer", "Rescheduled_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Rescheduled_From": "2026-01-21T14:30:00+04:00", "Rescheduled_Time": "2026-01-16T10:29:58+04:00", "Rescheduled_To": "2026-01-22T13:00:00+04:00", "Service_Name": { "id": "111115000000127440", "name": "service04" }, "Status": "Cancelled", "Tag": [] }, { "$currency_symbol": "£", "$editable": true, "$sharing_permission": "full_access", "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-07T15:00:00+04:00", "Appointment_For": { "id": "111115000000120715", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "bb" }, "Appointment_Name": "service-jobsheet", "Appointment_Start_Time": "2026-01-07T13:00:00+04:00", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:40:45+04:00", "Date_1": null, "Duration": 120, "Job_Sheet_Created__s": true, "Job_Sheet_Description__s": "done and dusted", "Job_Sheet_Name__s": "ss", "Job_Sheet_Section__s": "Job Sheet Information", "Last_Activity_Time": null, "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:40:45+04:00", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Record_Status__s": "Available", "Remind_At": null, "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Rescheduled_To": null, "Service_Name": { "id": "111115000000127405", "name": "service03" }, "Status": "Completed", "Tag": [] } ] } } }, "schema": { "$ref": "#/components/schemas/PostappointmentssRequest" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain a data array. You can include a maximum of 100 objects per request." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a success response in which four appointment records were created. Each entry in the data array contains a SUCCESS code along with the record identifier and associated audit timestamps.", "summary": "All four appointment records created successfully.", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147145" }, "message": "record added", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147147" }, "message": "record added", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147149" }, "message": "record added", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147151" }, "message": "record added", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostappointmentssResponse200" } } }, "description": "Returns a success response indicating that all appointment records in the request were successfully created." }, "201": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a success response in which appointment records were created. Each entry in the data array contains a SUCCESS code along with the record identifier and associated audit timestamps.", "summary": "Appointment records created successfully.", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147145" }, "message": "record added", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147147" }, "message": "record added", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147149" }, "message": "record added", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T10:52:02+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T10:52:02+04:00", "id": "111115000000147151" }, "message": "record added", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostappointmentssResponse200" } } }, "description": "Returns a success response indicating that the appointment record was successfully created." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Illustrates a Multi-Status response where one appointment record fails validation with a MANDATORY_NOT_FOUND error and the server creates a second record successfully.", "summary": "207 with one MANDATORY_NOT_FOUND failure and one success.", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "data", "json_path": "$.data[0].data" }, "message": "required field not found", "status": "error" }, { "code": "SUCCESS", "details": { "id": "generated_id_0" }, "message": "Proper success message", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response body returned when bulk creating appointment records. The data array contains individual result items, each independently indicating success or failure for the corresponding submitted record.", "properties": { "data": { "allOf": [ { "description": "Indicates that the data array contains at least one success item representing a successfully created appointment record." }, { "description": "Indicates that the data array may contain zero or more error items, each representing an appointment record that could not be created." } ], "description": "Represents the collection of result items returned for the bulk create operation. Each item independently indicates success or failure for the corresponding appointment record submitted in the request. ", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentsPost207multistatusResponse207" }, { "$ref": "#/components/schemas/PostappointmentssResponse207ErrorItem" } ], "description": "Represents a single result item in the multi-status response. Each item is either a success object containing the created record details or an error object describing the reason the corresponding record could not be created." }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostappointmentssResponse207" } } }, "description": "Returns a multi-status response indicating that the create operation produced a mix of successful and failed results. Each entry in the response data array contains an individual status code reflecting whether the server processed that record successfully or encountered an error." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingAddressResponse1": { "description": "Illustrates an error returned when the Address field is omitted while the dependent Location field has been provided, triggering a DEPENDENT_FIELD_MISSING validation failure.", "summary": "DEPENDENT_FIELD_MISSING for Address when Location is set.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Address", "dependee": { "api_name": "Location", "json_path": "$.data[0].Location" }, "json_path": "$.data[0].Address" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse1": { "description": "Illustrates an error returned when Reschedule_Reason is provided but the required Rescheduled_From field is left empty, triggering a DEPENDENT_FIELD_MISSING validation failure.", "summary": "DEPENDENT_FIELD_MISSING when Rescheduled_From is empty.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Rescheduled_From", "dependee": { "api_name": "Reschedule_Reason", "json_path": "$.data[0].Reschedule_Reason" }, "json_path": "$.data[0].Rescheduled_From" }, "message": "Rescheduled_From cannot be empty", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Illustrates an error returned when cancellation information fields are populated but the appointment Status field is not set to Cancelled, triggering a DEPENDENT_FIELD_MISSING validation failure.", "summary": "DEPENDENT_FIELD_MISSING for Status not set to Cancelled.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Status", "dependee": { "api_name": "Cancellation_Reason", "json_path": "$.data[0].Cancellation_Reason" }, "json_path": "$.data[0].Status" }, "message": "To Update the fields of Cancellation Information Section, value of Status should be Cancelled", "status": "error" } ] } }, "DependentFieldUnchangedResponse1": { "description": "Illustrates an error returned when Rescheduled_From and Appointment_Start_Time carry identical values, indicating no actual reschedule has occurred and triggering a DEPENDENT_FIELD_UNCHANGED validation failure.", "summary": "DEPENDENT_FIELD_UNCHANGED for Rescheduled_From equals start time.", "value": { "data": [ { "code": "DEPENDENT_FIELD_UNCHANGED", "details": { "api_name": "Rescheduled_From", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Rescheduled_From" }, "message": "Reschedule_From and Appointment_Start_Time cannot be same", "status": "error" } ] } }, "DependentMismatchCancellationResponse1": { "description": "Illustrates an error returned when the Cancellation_Reason field is provided but the Status field is not set to Cancelled, triggering a DEPENDENT_MISMATCH validation failure.", "summary": "DEPENDENT_MISMATCH for Cancellation_Reason without Status Cancelled.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Cancellation_Reason", "json_path": "$.data[0].Cancellation_Reason" }, "json_path": "$.data[0].Status" }, "message": "To Update the fields of Cancellation Information Section, value of Status should be Cancelled", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Illustrates an error returned when the appointment Owner ID does not correspond to a member of the service specified in Service_Name, triggering a DEPENDENT_MISMATCH validation failure.", "summary": "DEPENDENT_MISMATCH for Owner not in service members.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "api_name": "Services.Members", "json_path": "$.data[0].Services.Members" }, "json_path": "$.data[0].Owner.id" }, "message": "Appointment Owner is not a part of Service Members", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Illustrates an error returned when the appointment Status is set to Completed before the appointment end time has elapsed, triggering a DEPENDENT_MISMATCH validation failure.", "summary": "DEPENDENT_MISMATCH for Status Completed before end time.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as completed before the appointment ends", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Illustrates an error returned when attempting to create a job sheet for an appointment whose Status is not yet set to Completed, triggering a DEPENDENT_MISMATCH validation failure.", "summary": "DEPENDENT_MISMATCH for job sheet on incomplete appointment.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Job_Sheet_Name__s", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Job_Sheet_Name__s" }, "message": "Job Sheet can be created only for completed appointment", "status": "error" } ] } }, "DependentMismatchResponse4": { "description": "Illustrates an error returned when the appointment Status is set to Overdue before the appointment end time has elapsed, triggering a DEPENDENT_MISMATCH validation failure.", "summary": "DEPENDENT_MISMATCH for Status Overdue before end time.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as overdue before the appointment ends", "status": "error" } ] } }, "DependentMismatchResponse5": { "description": "Illustrates an error returned when the appointment start time is set to a past date, which is not allowed, triggering a DEPENDENT_MISMATCH validation failure.", "summary": "DEPENDENT_MISMATCH for appointment scheduled in the past.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be scheduled for past dates", "status": "error" } ] } }, "InvalidDataMaxLengthAdditionalInformationResponse1": { "description": "Illustrates an error returned when the value of the Additional_Information field exceeds the maximum allowed length, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA max length exceeded for Additional_Information.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Additional_Information", "json_path": "$.data[0].Additional_Information", "maximum_length": 32000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataMaxLengthAddressResponse1": { "description": "Illustrates an error returned when the value of the Address field exceeds the maximum allowed length, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA max length exceeded for Address.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Address", "json_path": "$.data[0].Address", "maximum_length": 255 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataMaxLengthAppointmentNameResponse1": { "description": "Illustrates an error returned when the value of the Appointment_Name field exceeds the maximum allowed length, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA max length exceeded for Appointment_Name.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Appointment_Name", "json_path": "$.data[0].Appointment_Name", "maximum_length": 225 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataMaxLengthCancellationNoteResponse1": { "description": "Illustrates an error returned when the value of the Cancellation_Note field exceeds the maximum allowed length, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA max length exceeded for Cancellation_Note.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Cancellation_Note", "json_path": "$.data[0].Cancellation_Note", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataMaxLengthRescheduleNoteResponse1": { "description": "Illustrates an error returned when the value of the Reschedule_Note field exceeds the maximum allowed length, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA max length exceeded for Reschedule_Note.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Reschedule_Note", "json_path": "$.data[0].Reschedule_Note", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Illustrates an error returned when the value provided for the Appointment_For module field is not a valid JSON object, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA for Appointment_For module invalid JSON object.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.data[0].Appointment_For.module" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Illustrates an error returned when the module API name specified in the Appointment_For field does not exist in the multi-module lookup, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA for Appointment_For module not in multi-module lookup", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.data[0].Appointment_For.module.api_name" }, "message": "the given module name is not exist in multimodulelookup", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Illustrates an error returned when the data array in the request body exceeds the maximum allowed number of objects, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA for data array exceeding maximum length.", "value": { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.data", "maximum_length": 4 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse4": { "description": "Illustrates an error returned when an invalid data type is provided for the unit field in a Remind_At reminder object, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA invalid type for Remind_At unit field.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.data[0].Remind_At[0].unit" }, "message": "INVALID_DATA", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Illustrates an error returned when the value of the unit field in a Remind_At reminder object falls outside the allowed numeric range, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA for Remind_At unit value out of allowed range.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.data[0].Remind_At[0].unit", "range": { "from": 0, "to": 100 } }, "message": "Please check whether the input values are correct", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Illustrates an error returned when an unsupported value is provided for the period field in a Remind_At reminder object, triggering an INVALID_DATA validation failure.", "summary": "INVALID_DATA unsupported value for Remind_At period field.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.data[0].Remind_At[0].period", "supported_values": [ "minutes", "hours", "days" ] }, "message": "INVALID_DATA", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Illustrates an error returned when the required Appointment_For field is missing from the request, triggering a MANDATORY_NOT_FOUND validation failure.", "summary": "MANDATORY_NOT_FOUND for missing Appointment_For field.", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Appointment_For", "json_path": "$.data[2].Appointment_For" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Illustrates an error returned when the required unit key is absent from a Remind_At reminder object, triggering a MANDATORY_NOT_FOUND validation failure.", "summary": "MANDATORY_NOT_FOUND for missing unit key in Remind_At.", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "unit", "json_path": "$.data[0].Remind_At[0].unit" }, "message": "mandatory key missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Illustrates an error returned when the selected service is not available at the specified Appointment_Start_Time, triggering a NOT_ALLOWED validation failure.", "summary": "NOT_ALLOWED for service unavailable at appointment start time.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "message": "Service is not available on the given time", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "Illustrates an error returned when the appointment start time falls outside the configured business hours, triggering a NOT_ALLOWED validation failure.", "summary": "NOT_ALLOWED for appointment start time outside business hours.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "message": "Appointment time does not falls under business hours", "status": "error" } ] } }, "NotAllowedResponse3": { "description": "Illustrates an error returned when an appointment is marked as Completed without a job sheet having been created first, triggering a NOT_ALLOWED validation failure.", "summary": "NOT_ALLOWED for marking appointment Completed without job sheet.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Status", "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as completed without creating the jobsheet", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the wrapped error response body returned when one or more individual appointment records fail validation. The data array contains an error object for each record that could not be created.", "properties": { "data": { "description": "Represents the collection of error objects returned for failed appointment records. Each object describes a validation failure for the corresponding record submitted in the request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseCore1720623915" }, { "$ref": "#/components/schemas/ErrorResponseCore622374562" }, { "$ref": "#/components/schemas/ErrorResponseCore261228299" }, { "$ref": "#/components/schemas/ErrorResponseCore1207168962" }, { "$ref": "#/components/schemas/ErrorResponseCore1818284114" }, { "$ref": "#/components/schemas/ErrorResponseCore1277582131" }, { "$ref": "#/components/schemas/ErrorResponseCore1593946428" }, { "$ref": "#/components/schemas/ErrorResponseCore2114620743" }, { "$ref": "#/components/schemas/PostappointmentssDependentFieldMissingCancellationStatusErrorItem" }, { "$ref": "#/components/schemas/PostappointmentssDependentMismatchCancellationStatusErrorItem" }, { "$ref": "#/components/schemas/ErrorResponseCore1090893661" }, { "$ref": "#/components/schemas/ErrorResponseCore653152835" }, { "$ref": "#/components/schemas/ErrorResponseCore899638570" }, { "$ref": "#/components/schemas/ErrorResponseCore496791912" }, { "$ref": "#/components/schemas/ErrorResponseCore201487910" }, { "$ref": "#/components/schemas/ErrorResponseCore55175210" }, { "$ref": "#/components/schemas/PostappointmentssDependentFieldMissingAddressLocationErrorItem" }, { "$ref": "#/components/schemas/ErrorResponseCore1009543207" } ], "description": "Represents an error for a failed appointment record. Each object contains the error code, the affected field details, a descriptive error message, and the status of the operation for that record." }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostappointmentssError400Wrapper" }, { "$ref": "#/components/schemas/ErrorResponseCore1009543207" }, { "$ref": "#/components/schemas/PostappointmentssInvalidDataRangeErrorResponse" }, { "$ref": "#/components/schemas/PostappointmentssInvalidDataSupportedValuesErrorResponse" } ], "description": "Represents the error response body returned when the request to create appointment records fails. The response contains either a list of record-level validation errors or a single request-level error indicating a broader issue with the request.", "x-zs-$id": "PostappointmentssError400" } } }, "description": "The request could not be processed due to invalid or missing field values, an unsupported HTTP method, or other validation errors.\n\n**Resolution:** Ensure all required fields are present with valid values, and confirm the POST method for accessing this endpoint." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.appointments.CREATE" ] } ], "summary": "Create Appointment records", "tags": [ "appointments" ], "x-zoho-document": "appointments" }, "put": { "description": "To update one or more appointment records in your Zoho CRM organization. You can update a maximum of 100 appointments per API call.\n", "operationId": "updateAppointmentsS", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Illustrates a PUT request body containing two appointment objects with a full field set, including appointment name, contact, service, start time, location, owner, reminders, status, and rescheduling fields.\n", "summary": "PUT request body with two appointment objects for update\n", "value": { "data": [ { "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-16T18:30:00+05:30", "Appointment_For": { "id": "111115000000120725", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "ll" }, "Appointment_Name": "service06 - ll", "Appointment_Start_Time": "2026-01-16T18:00:00+05:30", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T16:50:29+05:30", "Date_1": null, "Duration": 30, "Job_Sheet_Created__s": false, "Job_Sheet_Description__s": null, "Job_Sheet_Name__s": null, "Last_Activity_Time": "2026-01-19T16:12:24+05:30", "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-19T16:12:24+05:30", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Remind_At": [ { "period": "hours", "unit": 1 } ], "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Service_Name": { "id": "111115000000127506", "name": "service06" }, "Status": "Overdue", "Tag": [] }, { "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-16T18:30:00+05:30", "Appointment_For": { "id": "111115000000120725", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "ll" }, "Appointment_Name": "service06 - ll", "Appointment_Start_Time": "2026-01-16T18:00:00+05:30", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T16:50:29+05:30", "Date_1": null, "Duration": 30, "Job_Sheet_Created__s": false, "Job_Sheet_Description__s": null, "Job_Sheet_Name__s": null, "Last_Activity_Time": "2026-01-19T16:12:24+05:30", "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-19T16:12:24+05:30", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Remind_At": [ { "period": "hours", "unit": 1 } ], "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Rescheduled_To": null, "Service_Name": { "id": "111115000000127506", "name": "service06" }, "Status": "Overdue", "Tag": [] } ] } } }, "schema": { "$ref": "#/components/schemas/PutappointmentssRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain a **data** array with one or more appointment objects to update. You can include a maximum of **100** objects per request. Each object must include the **ID** field to identify the appointment record to update.\n" }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response for a batch update in which both appointment records were updated. Each result object carries a SUCCESS code, a confirmation message, and a details block containing the record ID, creation timestamp, modification timestamp, and the identities of the creating and modifying users.\n", "summary": "Successful update of two appointment records\n", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T16:50:29+05:30", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-19T17:42:07+05:30", "id": "111115000000147279" }, "message": "record updated", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T14:11:13+05:30", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-19T17:42:07+05:30", "id": "111115000000147238" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PutappointmentssResponse200" } } }, "description": "Returns a confirmation for each successfully updated appointment record, including the record ID, creation and modification timestamps, and the identities of the users who created and last modified the record.\n" }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Illustrates a Multi-Status response in which one appointment record updated successfully and a second record failed with an invalid appointment ID error, showing how partial success and error entries coexist in the same response payload.", "summary": "Multi-status response with one success and one invalid-ID error.\n", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T16:50:29+05:30", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-19T17:45:52+05:30", "id": "111115000000147279" }, "message": "record updated", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[1].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the Multi-Status response body returned when the update request produces a mix of successfully updated and failed appointment updates. The response contains at least one success and at least one error.\n", "properties": { "data": { "allOf": [ { "description": "Constrains the data array to contain at least one success response object, ensuring the response always reflects at least one successfully updated appointment record.\n" }, { "description": "Constrains the data array to contain at least one error response object, ensuring the response always reflects at least one failed appointment update attempt.\n" } ], "description": "Represents the list of result objects returned for each appointment update attempt. Each item is either a success response for a successfully updated record or an error response for a failed update.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/AppointmentsPost207multistatusResponse207" }, { "$ref": "#/components/schemas/ErrorResponseCore1544688711" } ], "description": "Represents a single result in the response array. it is either a success object containing the updated record details with a status code and message, or an error object indicating a failed update due to an invalid appointment ID.\n" }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutappointmentssResponse207" } } }, "description": "Returns a mixed-status response when the batch contains both successfully updated appointment records and records that failed the update. Each item in the response array is either a success object or an error object with an INVALID_DATA code indicating an invalid appointment ID.\n" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Represents a DEPENDENT_FIELD_MISSING error returned when a Reschedule_Reason value is provided in the request but the required Rescheduled_From field is left empty, as Rescheduled_From must be populated whenever reschedule information fields are included.\n", "summary": "Error when Reschedule_Reason is set but Rescheduled_From is empty.\n", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Rescheduled_From", "dependee": { "api_name": "Reschedule_Reason", "json_path": "$.data[0].Reschedule_Reason" }, "json_path": "$.data[0].Rescheduled_From" }, "message": "Rescheduled_From cannot be empty", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Represents a DEPENDENT_FIELD_MISSING error returned when cancellation information fields such as Cancellation_Reason are included in the request but the appointment Status is not set to Cancelled, as the Cancelled status is required to process any cancellation-related fields.\n", "summary": "Error when cancellation fields are set but Status is not Cancelled.\n", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Status", "dependee": { "api_name": "Cancellation_Reason", "json_path": "$.data[0].Cancellation_Reason" }, "json_path": "$.data[0].Status" }, "message": "To Update the fields of Cancellation Information Section, value of Status should be Cancelled", "status": "error" } ] } }, "DependentFieldUnchangedResponse1": { "description": "Represents a DEPENDENT_FIELD_UNCHANGED error returned when the Rescheduled_From value provided in the request matches the existing Appointment_Start_Time, as the new appointment time must differ from the current start time to constitute a valid reschedule.\n", "summary": "Error when Rescheduled_From matches the existing appointment start time.\n", "value": { "data": [ { "code": "DEPENDENT_FIELD_UNCHANGED", "details": { "api_name": "Rescheduled_From", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Rescheduled_From" }, "message": "Reschedule_From and Appointment_Start_Time cannot be same", "status": "error" } ] } }, "DependentFieldUnchangedResponse2": { "description": "Represents a DEPENDENT_FIELD_UNCHANGED error returned when reschedule information fields such as Reschedule_Reason are included in the request without the appointment having been rescheduled at least once, as those fields can only be updated after Rescheduled_From has been set on a prior update.\n", "summary": "Error when reschedule information fields change without a prior reschedule.", "value": { "data": [ { "code": "DEPENDENT_FIELD_UNCHANGED", "details": { "api_name": "Rescheduled_From", "dependee": { "api_name": "Reschedule_Reason", "json_path": "$.data[0].Reschedule_Reason" }, "json_path": "$.data[0].Rescheduled_From" }, "message": "Reschedule the appointment atleast once to Update the fields of Reschedule Information Section", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Represents a DEPENDENT_MISMATCH error returned when the specified appointment owner is not a member of the service associated with the appointment.\n", "summary": "Error when appointment owner is not a member of the service\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "api_name": "Services.Members", "json_path": "$.data[0].Services.Members" }, "json_path": "$.data[0].Owner.id" }, "message": "Appointment Owner is not a part of Service Members", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Represents a DEPENDENT_MISMATCH error returned when the appointment Status is set to Completed before the scheduled Appointment_End_Time has passed. An appointment can only be marked as Completed after the appointment time has ended.\n", "summary": "Error when Status is set to Completed before appointment end time.\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as completed before the appointment ends", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Represents a DEPENDENT_MISMATCH error returned when Job_Sheet_Created__s is set on an appointment whose Status is not Completed. A job sheet can only be created for an appointment that has been marked as Completed.\n", "summary": "Error when a job sheet creation targets an incomplete appointment", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Job_Sheet_Name__s", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Job_Sheet_Name__s" }, "message": "Job Sheet can be created only for completed appointment", "status": "error" } ] } }, "DependentMismatchResponse4": { "description": "Represents a DEPENDENT_MISMATCH error returned when the appointment Status is set to Overdue before the scheduled Appointment_End_Time has passed. An appointment can only be marked as Overdue after the appointment time has ended.\n", "summary": "Error when Status is set to Overdue before appointment end time.\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as overdue before the appointment ends", "status": "error" } ] } }, "DependentMismatchResponse5": { "description": "Represents a DEPENDENT_MISMATCH error returned when the Appointment_Start_Time is set to a value in the past. The appointment start time must be greater than the current time.\n", "summary": "Error when Appointment_Start_Time is set to a past date or time.\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be scheduled for past dates", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows an error when the Appointment_For field value has an invalid format, indicated by the api_name field in the details object.\n", "summary": "Invalid data error for Appointment_For module format.\n", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.data[0].Appointment_For.module" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an error when the module API name provided in the Appointment_For field does not match a valid module in the CRM organization.\n", "summary": "Invalid data error for unknown module API name in Appointment_For.\n", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.data[0].Appointment_For.module.api_name" }, "message": "the given module name is not exist in multimodulelookup", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an error when the data array in the request body exceeds the maximum allowed limit of 100 appointments per API call.\n", "summary": "Invalid data error when data array exceeds 100-record limit.\n", "value": { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.data", "maximum_length": 4 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse4": { "description": "Shows an error when the unit field in the Remind_At array contains an invalid data type; the unit value must be an integer.\n", "summary": "Invalid data error for Remind_At unit field.\n", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.data[0].Remind_At[0].unit" }, "message": "INVALID_DATA", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an error when the appointment ID provided in the request is invalid. Use the Get Appointments API to retrieve valid appointment IDs.\n", "summary": "Invalid data error for an invalid appointment ID\n", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows a MANDATORY_NOT_FOUND error returned when the required Appointment_For field is absent from the request payload at $.data[2].Appointment_For.\n", "summary": "Error when required Appointment_For field is missing.\n", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Appointment_For", "json_path": "$.data[2].Appointment_For" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows a MANDATORY_NOT_FOUND error returned when the required unit key is absent from a Remind_At reminder object at $.data[0].Remind_At[0].unit.\n", "summary": "Error when required unit key is missing from Remind_At.\n", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "unit", "json_path": "$.data[0].Remind_At[0].unit" }, "message": "mandatory key missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Shows a NOT_ALLOWED error returned when the selected Service_Name is not available at the given appointment time, as indicated at $.data[0].Service_Name.\n", "summary": "Error when Service_Name is unavailable at the appointment time.\n", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "message": "Service is not available on the given time", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "Shows a NOT_ALLOWED error returned when the Appointment_Start_Time falls outside configured business hours, as indicated at $.data[0].Appointment_Start_Time.\n", "summary": "Error when Appointment_Start_Time is outside business hours.\n", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "message": "Appointment time does not falls under business hours", "status": "error" } ] } }, "NotAllowedResponse3": { "description": "Shows a NOT_ALLOWED error returned when an appointment is marked as completed but no job sheet has been submitted, as indicated at $.data[0].Job_Sheet_Created__s.\n", "summary": "Error when appointment is completed without a job sheet.\n", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Status", "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as completed without creating the jobsheet", "status": "error" } ] } }, "RecordLockedResponse1": { "description": "Returned when the target appointment record is locked and the update operation cannot be performed. The response includes the affected field path and the locking action that prevented the request.\n", "summary": "Error when appointment record is locked.\n", "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "api_name": "id", "json_path": "$.data[0].id" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the wrapped error response body returned when one or more individual appointment update requests fail validation. Contains an array of per-record error objects.\n", "properties": { "data": { "description": "Contains the list of error objects for appointment records that failed validation during the update request. Each object corresponds to one failed record.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseCore1720623915" }, { "$ref": "#/components/schemas/ErrorResponseCore622374562" }, { "$ref": "#/components/schemas/ErrorResponseCore261228299" }, { "$ref": "#/components/schemas/ErrorResponseCore1207168962" }, { "$ref": "#/components/schemas/ErrorResponseCore1818284114" }, { "$ref": "#/components/schemas/ErrorResponseCore1277582131" }, { "$ref": "#/components/schemas/ErrorResponseCore1593946428" }, { "$ref": "#/components/schemas/ErrorResponseCore2114620743" }, { "$ref": "#/components/schemas/PostappointmentssDependentFieldMissingCancellationStatusErrorItem" }, { "$ref": "#/components/schemas/PostappointmentssDependentMismatchCancellationStatusErrorItem" }, { "$ref": "#/components/schemas/ErrorResponseCore1090893661" }, { "$ref": "#/components/schemas/ErrorResponseCore653152835" }, { "$ref": "#/components/schemas/ErrorResponseCore899638570" }, { "$ref": "#/components/schemas/ErrorResponseCore496791912" }, { "$ref": "#/components/schemas/ErrorResponseCore201487910" }, { "$ref": "#/components/schemas/ErrorResponseCore55175210" }, { "$ref": "#/components/schemas/ErrorResponseCoreRecordLocked" }, { "$ref": "#/components/schemas/ErrorResponseCore1009543207" } ], "description": "Represents a single failed appointment update. Each object contains the error code, the affected field details, the error message, and the status.\n" }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutappointmentssError400Wrapper" }, { "$ref": "#/components/schemas/ErrorResponseCore1009543207" } ], "description": "Represents the error response body returned when the PUT request to update appointment records fails. \n\nThe response is one of two variants: a wrapped array of per-record validation error objects, or a flat error object for request-level failures.\n", "x-zs-$id": "PutappointmentssError400" } } }, "description": "The request was not processed due to invalid or missing fields. \n\n**Resolution:** Verify that all required fields are present and that field values satisfy the validation requirements for the requested appointment update operation.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionCancelResponse1": { "description": "Returned when the authenticated user lacks the Crm_Implied_Cancel_Appointments permission required to cancel an appointment. The request is denied with a NO_PERMISSION error.\n", "summary": "Permission denied to cancel appointment.\n", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Cancel_Appointments" ] }, "message": "permission denied", "status": "error" } ] } }, "NoPermissionCompleteResponse1": { "description": "Returned when the authenticated user lacks the Crm_Implied_Mark_As_Complete_Appointments permission required to mark an appointment as complete. The request is denied with a NO_PERMISSION error.\n", "summary": "Permission denied to mark appointment as complete\n", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Mark_As_Complete_Appointments" ] }, "message": "permission denied", "status": "error" } ] } }, "NoPermissionRescheduleResponse1": { "description": "Returned when the authenticated user lacks the Crm_Implied_Reschedule_Appointments permission required to reschedule an appointment. The request is denied with a NO_PERMISSION error.\n", "summary": "Permission denied to reschedule appointment.\n", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Reschedule_Appointments" ] }, "message": "permission denied", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the authenticated user lacks permission to update appointments, containing a list of error objects that describe the permission failure.\n", "properties": { "data": { "description": "Contains the list of error objects returned when the caller lacks permission to update the requested appointment records.\n", "items": { "$ref": "#/components/schemas/ErrorResponseCoreNoPermission" }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutappointmentssError403" } } }, "description": "The authenticated user does not have the required Zoho CRM profile permission to perform the requested appointment action. A NOT_ALLOWED error is also returned when the operation attempts to reschedule or change the status of an appointment that is already completed or cancelled.\n\n**Resolution:** A CRM administrator must grant the appropriate appointment-action permissions in the Zoho CRM user's profile.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.appointments.UPDATE" ] } ], "summary": "Update appointment records\n", "tags": [ "appointments" ], "x-zoho-document": "appointments" } }, "/crm/v8/Appointments__s/{appointmentId}": { "delete": { "description": "To delete a single appointment record from your Zoho CRM organization by its unique ID. Note that this operation will not delete any deals created upon completion of the appointment.\n", "operationId": "deleteAppointmentById", "parameters": [ { "$ref": "#/components/parameters/ParamPathAppointmentid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Confirms successful deletion of a single appointment record in Zoho CRM. The response includes the deleted appointment's ID and a status of success.\n", "summary": "Successful deletion of a single appointment record.\n", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "111115000000147279" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteidResponse200" } } }, "description": "Returns a confirmation that the specified appointment record was successfully deleted from Zoho CRM, including the ID of the deleted record.\n" }, "400": { "content": { "application/json": { "examples": { "InvalidDataFlatResponse1": { "description": "Illustrates a structured error response returned when the appointment ID provided in the request URL is invalid or refers to a record that has already been deleted. The response includes the resource path index in the error details.\n", "summary": "INVALID_DATA error response when the appointment ID is invalid or already deleted.\n", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "record not deleted", "status": "error" } }, "InvalidDataResponse1": { "description": "Illustrates a wrapped error response returned when the appointment ID provided in the DELETE request URL is invalid or refers to a record that has already been deleted. The response includes the ID of the appointment for which the DELETE request failed.\n", "summary": "INVALID_DATA error where the appointment ID is invalid or record already deleted\n", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "23132423" }, "message": "record not deleted", "status": "error" } ] } }, "InvalidModuleResponse1": { "description": "Represents an error response returned when the module API name provided in the request is invalid. The response includes the INVALID_MODULE error code and the index of the resource path parameter for which the value is invalid.\n", "summary": "INVALID_MODULE error where module API name is invalid\n", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Represents an error response returned when a method other than DELETE is called on this endpoint. The response includes the INVALID_REQUEST_METHOD error code, indicating that only the DELETE method is accepted.\n", "summary": "INVALID_REQUEST_METHOD error where unsupported HTTP method used.\n", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response in which the error details are wrapped in a `data` array, returned when the appointment ID provided in the request is invalid or refers to a record that has already been deleted.\n", "properties": { "data": { "description": "Represents the list of error objects returned when the DELETE request fails due to an invalid appointment ID or a reference to a record that has already been deleted. \n", "items": { "$ref": "#/components/schemas/ErrorResponseCore2137699283" }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteidError400Wrapper" }, { "$ref": "#/components/schemas/ErrorResponseCore1875045219" }, { "$ref": "#/components/schemas/ErrorResponseCore1604218709" }, { "$ref": "#/components/schemas/ErrorResponseCoreInvalidDataFlat" } ], "description": "Represents the error response body for a failed DELETE request to remove a single appointment record. The response conforms to one of several error variants depending on the cause of the failure.\n", "x-zs-$id": "DeleteidError400" } } }, "description": "The request failed due to an invalid appointment ID, an unsupported HTTP method, or an invalid module name.\n\n**Resolution:** Verify that the appointment ID is correct and has not already been deleted. Use only the DELETE HTTP method and ensure the module name in the request URL is valid.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.appointments.DELETE" ] } ], "summary": "Delete an Appointment by ID\n", "tags": [ "appointments" ], "x-zoho-document": "appointments" }, "get": { "description": "To retrieve the details of a single appointment record from your Zoho CRM organization.\n", "operationId": "getAppointmentById", "parameters": [ { "$ref": "#/components/parameters/ParamPathAppointmentid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response containing the details of the specified appointment record, including Owner, Service_Name, Appointment_For, Appointment_Name, and Status.\n", "summary": "Successful retrieval of a single appointment record by ID.\n", "value": { "data": [ { "$currency_symbol": "£", "$editable": true, "$field_states": null, "$sharing_permission": "full_access", "$status": "cv_1", "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-11T16:30:00+05:30", "Appointment_For": { "id": "111115000000120715", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "bb" }, "Appointment_Name": "service-jobsheetcomplete", "Appointment_Start_Time": "2026-01-11T14:30:00+05:30", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T14:00:11+05:30", "Date_1": null, "Duration": 120, "Job_Sheet_Created__s": true, "Job_Sheet_Description__s": "done and dusted", "Job_Sheet_Name__s": "ss", "Job_Sheet_Section__s": "Job Sheet Information", "Last_Activity_Time": null, "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-16T14:00:11+05:30", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Remind_At": null, "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Rescheduled_To": null, "Service_Name": { "id": "111115000000127405", "name": "service03" }, "Status": "Completed", "Tag": [], "id": "111115000000147219" } ] } } }, "schema": { "$ref": "#/components/schemas/GetappointmentssResponse200" } } }, "description": "Returns the details of the specified appointment record, including fields such as Owner, Service_Name, Appointment_For, Appointment_Name, and Status.\n" }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse1": { "description": "Shows an error when the module API name in the request URL is invalid. The response includes the INVALID_MODULE error code and the index of the resource path where the error was detected.\n", "summary": "INVALID_MODULE error when module API name in the URL is invalid.", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseCore1604218709" }, { "$ref": "#/components/schemas/ErrorResponseCore2271053024" } ], "description": "Represents the error response body when the module API name or the appointment ID in the request URL is invalid. Contains one of two error such as an INVALID_MODULE error when the module name is unrecognized, or an INVALID_URL_PATTERN error when the appointment ID cannot be resolved.", "x-zs-$id": "GetappointmentByIdError400" } } }, "description": "The request was not processed because the module API name or the appointment ID in the request URL is invalid.\n\n**Resolution:** Verify that the module API name in the request URL is correct. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the valid module API name, and confirm that the appointment ID corresponds to an existing record.\n" }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPatternResponse1": { "description": "Shows an error when the appointment ID in the request URL does not match a valid URL pattern. The response includes the INVALID_URL_PATTERN error code and prompts the caller to verify the URL.\n", "summary": "INVALID_URL_PATTERN error when the appointment ID in the URL is invalid.\n", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ErrorResponseCore2271053024", "x-zs-$id": "GetappointmentByIdError404" } } }, "description": "The request was not processed because the URL or the appointment ID is invalid.\n\n**Resolution:** Verify that the appointment ID in the request URL corresponds to an existing appointment record in the organization.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.appointments.READ" ] } ], "summary": "Get an Appointment Record by ID\n", "tags": [ "appointments" ], "x-zoho-document": "appointments" }, "put": { "description": "To update a single appointment record by its ID in your Zoho CRM organization.", "operationId": "updateAppointmentById", "parameters": [ { "$ref": "#/components/parameters/AppointmentsParamQueryId" }, { "$ref": "#/components/parameters/ParamPathAppointmentid" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Illustrates a request body with a **data** array containing a single appointment record object with fields for rescheduling, including **Appointment_Start_Time**, **Rescheduled_From**, **Reschedule_Reason**, and supporting appointment metadata.", "summary": "PUT request body with a data array for a single appointment record update", "value": { "data": [ { "Additional_Information": null, "Address": null, "Appointment_End_Time": "2026-01-16T18:30:00+05:30", "Appointment_For": { "id": "111115000000120725", "module": { "api_name": "Contacts", "id": "111115000000002654" }, "name": "ll" }, "Appointment_Name": "service06 - ll", "Appointment_Start_Time": "2026-01-16T18:00:00+05:30", "Cancellation_Note": null, "Cancellation_Reason": null, "Cancelled_By": null, "Cancelled_Time": null, "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T16:50:29+05:30", "Date_1": null, "Duration": 30, "Job_Sheet_Created__s": false, "Job_Sheet_Description__s": null, "Job_Sheet_Name__s": null, "Last_Activity_Time": "2026-01-19T16:12:24+05:30", "Location": "Business Address", "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-19T16:12:24+05:30", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Remind_At": [ { "period": "hours", "unit": 1 } ], "Reschedule_Count": 0, "Reschedule_Note": null, "Reschedule_Reason": null, "Rescheduled_By": null, "Rescheduled_From": null, "Rescheduled_Time": null, "Rescheduled_To": null, "Service_Name": { "id": "111115000000127506", "name": "service06" }, "Status": "Overdue", "Tag": [] } ] } } }, "schema": { "$ref": "#/components/schemas/PutappointmentssRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain a **data** array with the appointment fields to update for the record." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Represents a successful response confirming the appointment record update. The payload contains the record **ID**, modification timestamps (**Modified_Time**, **Created_Time**), and the identities of the **Modified_By** and **Created_By** users.", "summary": "Successful update of a single appointment record.", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-16T13:07:30+05:30", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-19T18:42:32+05:30", "id": "111115000000147181" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PutappointmentssResponse200" } } }, "description": "Returns a confirmation of the successful appointment record update, including the record ID, creation and modification timestamps, and the associated user details." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Illustrates a **DEPENDENT_FIELD_MISSING** error returned when **Reschedule_Reason** is provided in the request but the required **Appointment_Start_Time** field is absent. The **Appointment_Start_Time** field is mandatory when rescheduling an appointment.", "summary": "DEPENDENT_FIELD_MISSING error when Appointment_Start_Time is absent during reschedule.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Rescheduled_From", "dependee": { "api_name": "Reschedule_Reason", "json_path": "$.data[0].Reschedule_Reason" }, "json_path": "$.data[0].Rescheduled_From" }, "message": "Rescheduled_From cannot be empty", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Illustrates a **DEPENDENT_FIELD_MISSING** error returned when cancellation fields such as **Cancellation_Reason** are provided but the appointment **Status** is not set to **Cancelled**. The **Status** field must be set to **Cancelled** before cancellation information fields can be updated.", "summary": "DEPENDENT_FIELD_MISSING error when Status is not Cancelled but cancellation fields are set.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Status", "dependee": { "api_name": "Cancellation_Reason", "json_path": "$.data[0].Cancellation_Reason" }, "json_path": "$.data[0].Status" }, "message": "To Update the fields of Cancellation Information Section, value of Status should be Cancelled", "status": "error" } ] } }, "DependentFieldUnchangedResponse1": { "description": "Illustrates a **DEPENDENT_FIELD_UNCHANGED** error returned when **Rescheduled_From** and **Appointment_Start_Time** carry the same timestamp, indicating no effective time change. \n\nThe new **Appointment_Start_Time** must be later than the existing value to constitute a valid reschedule.", "summary": "DEPENDENT_FIELD_UNCHANGED error when reschedule time matches existing Appointment_Start_Time.", "value": { "data": [ { "code": "DEPENDENT_FIELD_UNCHANGED", "details": { "api_name": "Rescheduled_From", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Rescheduled_From" }, "message": "Reschedule_From and Appointment_Start_Time cannot be same", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Illustrates a **DEPENDENT_MISMATCH** error returned when the assigned **Owner** is not a member of the service associated with **Service_Name**. The appointment **Owner** must be a service member of the specified service for the update to succeed.", "summary": "**DEPENDENT_MISMATCH** error when appointment **Owner** is not a **Service_Name** member.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "api_name": "Services.Members", "json_path": "$.data[0].Services.Members" }, "json_path": "$.data[0].Owner.id" }, "message": "Appointment Owner is not a part of Service Members", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Illustrates a **DEPENDENT_MISMATCH** error returned when **Status** is set to Completed before the **Appointment_Start_Time** end threshold has passed. \n\nThe API rejects the transition to prevent premature completion of an active appointment.", "summary": "**DEPENDENT_MISMATCH** error when **Status** set to Completed before appointment ends.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as completed before the appointment ends", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Illustrates a **DEPENDENT_MISMATCH** error returned when **Job_Sheet_Name__s** is provided for an appointment whose **Status** is not yet Completed. \n\nThe API enforces that job sheets may only be created once an appointment reaches the Completed status.", "summary": "**DEPENDENT_MISMATCH** error when **Job_Sheet_Name__s** set on a non-completed appointment.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Job_Sheet_Name__s", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Job_Sheet_Name__s" }, "message": "Job Sheet can be created only for completed appointment", "status": "error" } ] } }, "DependentMismatchResponse4": { "description": "Illustrates a **DEPENDENT_MISMATCH** error returned when **Status** is set to Overdue before the **Appointment_Start_Time** end threshold has passed. \n\nThe API rejects the transition to prevent premature overdue marking of an active appointment.", "summary": "**DEPENDENT_MISMATCH** error when **Status** set to Overdue before appointment ends.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as overdue before the appointment ends", "status": "error" } ] } }, "DependentMismatchResponse5": { "description": "Illustrates a **DEPENDENT_MISMATCH** error returned when **Status** is set to Scheduled but **Appointment_Start_Time** falls in the past. The API rejects scheduling requests that reference past dates to preserve appointment integrity.", "summary": "**DEPENDENT_MISMATCH** error when **Status** set to Scheduled with a past **Appointment_Start_Time**", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "json_path": "$.data[0].Status" }, "message": "Appointment cannot be scheduled for past dates", "status": "error" } ] } }, "InvalidDataMaxLengthResponse1": { "description": "Represents an **INVALID_DATA** error returned when the **data** array in the request body exceeds the permitted maximum length of one record. The response identifies the offending field via **json_path** and reports the enforced **maximum_length**.", "summary": "**INVALID_DATA** error when maximum length exceeded for the **data** field.", "value": { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.data", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse1": { "description": "Illustrates an **INVALID_DATA** error returned when the **Appointment_For.module** field value is not a valid JSON object. \n\nThe **details** object identifies the offending field via **api_name** and **json_path**, with **expected_data_type** set to `jsonobject`.", "summary": "**INVALID_DATA** error when the **Appointment_For.module** value is not a valid JSON object.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.data[0].Appointment_For.module" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Illustrates an **INVALID_DATA** error returned when the **api_name** provided in the **Appointment_For.module** does not match any module configured in the multi-module lookup. \n\nThe **details** object identifies the invalid field at **json_path** `$.data[0].Appointment_For.module.api_name`.", "summary": "**INVALID_DATA** error is thrown when **api_name** in **Appointment_For.module** not found in multi-module lookup.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.data[0].Appointment_For.module.api_name" }, "message": "the given module name is not exist in multimodulelookup", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Illustrates an **INVALID_DATA** error returned when the **appointmentId** path parameter in the request URL does not correspond to a valid appointment record. \n\nThe **details** object includes **resource_path_index** to indicate the position of the invalid ID in the resource path.", "summary": "**INVALID_DATA** error is thrown when the **appointmentId** path parameter does not match a valid appointment record.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidDataResponse4": { "description": "Illustrates an **INVALID_DATA** error returned when the **Status** field value provided in the request body fails validation. The **details** object identifies the offending field via **api_name** and **json_path** set to `$.data[0].Status`.", "summary": "**INVALID_DATA** error when the **Status** field value fails validation.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Status", "json_path": "$.data[0].Status" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Illustrates an **INVALID_DATA** error returned when the **Remind_At[0].unit** field receives a value that is not an integer. The **details** object identifies the offending field via **api_name** `unit` and **expected_data_type** `integer`, with **json_path** pointing to `$.data[0].Remind_At[0].unit`.", "summary": "**INVALID_DATA** error when **unit** field in **Remind_At** receives a non-integer value.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.data[0].Remind_At[0].unit" }, "message": "INVALID_DATA", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Illustrates the **MANDATORY_NOT_FOUND** error returned when the required **Appointment_For** field is absent from the request payload. The response identifies the missing field via **api_name** and pinpoints its expected location using **json_path** (`$.data[2].Appointment_For`).", "summary": "**MANDATORY_NOT_FOUND** error when required **Appointment_For** field is absent.", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Appointment_For", "json_path": "$.data[2].Appointment_For" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Illustrates the **MANDATORY_NOT_FOUND** error returned when the **unit** key is missing from a **Remind_At** reminder object in the request. \n\nThe response identifies the absent field via **api_name** and its expected location at `$.data[0].Remind_At[0].unit`.", "summary": "**MANDATORY_NOT_FOUND** error when the **unit** key is missing from a **Remind_At** object.", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "unit", "json_path": "$.data[0].Remind_At[0].unit" }, "message": "mandatory key missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Illustrates the **NOT_ALLOWED** error returned when the requested service is unavailable at the specified **Appointment_Start_Time**. \n\nThe response message confirms that the service is not available on the given time, with the offending field identified at `$.data[0].Appointment_Start_Time`.", "summary": "**NOT_ALLOWED** error when the service is unavailable at the given **Appointment_Start_Time**.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "message": "Service is not available on the given time", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "Illustrates the **NOT_ALLOWED** error returned when the provided **Appointment_Start_Time** falls outside the configured business hours. \n\nThe response message states that the appointment time does not fall under business hours, with the violating field located at `$.data[0].Appointment_Start_Time`.", "summary": "**NOT_ALLOWED** error when **Appointment_Start_Time** falls outside configured business hours.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Appointment_Start_Time", "json_path": "$.data[0].Appointment_Start_Time" }, "message": "Appointment time does not falls under business hours", "status": "error" } ] } }, "NotAllowedResponse3": { "description": "Illustrates the **NOT_ALLOWED** error returned when the **Status** field is set to completed but no job sheet has been created for the appointment. \n\nThe response message confirms that the appointment cannot be marked as completed without creating the jobsheet, with the violating field identified at `$.data[0].Status`.", "summary": "**NOT_ALLOWED** error when completing an appointment without a job sheet.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Status", "json_path": "$.data[0].Status" }, "message": "Appointment cannot be marked as completed without creating the jobsheet", "status": "error" } ] } }, "RecordLockedResponse1": { "description": "Illustrates a **RECORD_LOCKED** error returned when an attempt is made to update an appointment whose record has been locked via the **record_locking** action. The **ID** field identifies the locked record, and the operation is rejected until the record is unlocked.", "summary": "**RECORD_LOCKED** error when the appointment record is locked and cannot be modified.", "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "api_name": "id", "json_path": "$.data[0].id" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the wrapped error response body containing a list of validation errors for the appointment update request.", "properties": { "data": { "description": "Contains the error objects returned for the appointment update request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseCore1720623915" }, { "$ref": "#/components/schemas/ErrorResponseCore622374562" }, { "$ref": "#/components/schemas/ErrorResponseCore261228299" }, { "$ref": "#/components/schemas/ErrorResponseCore1207168962" }, { "$ref": "#/components/schemas/ErrorResponseCore1818284114" }, { "$ref": "#/components/schemas/ErrorResponseCore1277582131" }, { "$ref": "#/components/schemas/ErrorResponseCore1593946428" }, { "$ref": "#/components/schemas/ErrorResponseCore2114620743" }, { "$ref": "#/components/schemas/ErrorResponseCore1332683101" }, { "$ref": "#/components/schemas/ErrorResponseCore1090893661" }, { "$ref": "#/components/schemas/ErrorResponseCore653152835" }, { "$ref": "#/components/schemas/ErrorResponseCore899638570" }, { "$ref": "#/components/schemas/ErrorResponseCore496791912" }, { "$ref": "#/components/schemas/ErrorResponseCore201487910" }, { "$ref": "#/components/schemas/ErrorResponseCore55175210" }, { "$ref": "#/components/schemas/ErrorResponseCoreRecordLocked" } ], "description": "Represents a single error object for a failed appointment update request, containing the error code, affected field details, error message, and status." }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutappointmentByIdError400Wrapper" }, { "$ref": "#/components/schemas/ErrorResponseCore1944579470" }, { "$ref": "#/components/schemas/ErrorResponseCore1009543207" } ], "description": "Represents the error response body for a failed appointment update request, containing either a wrapped list of validation errors or a single request-level error.", "x-zs-$id": "PutappointmentByIdError400" } } }, "description": "One or more request fields are invalid or missing.\n\n**Resolution:** Ensure that all required fields are present and that field values conform to the validation requirements for the appointment update." }, "403": { "content": { "application/json": { "examples": { "NoPermissionCancelResponse1": { "description": "Illustrates a **NO_PERMISSION** error returned when the caller lacks the **Crm_Implied_Cancel_Appointments** permission required to cancel an appointment. The response identifies the missing permission in the **permissions** array within the **details** object.", "summary": "**NO_PERMISSION** error when the caller lacks permission to cancel the appointment.", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Cancel_Appointments" ] }, "message": "permission denied", "status": "error" } ] } }, "NoPermissionCompleteResponse1": { "description": "Illustrates a **NO_PERMISSION** error returned when the caller lacks the **Crm_Implied_Mark_As_Complete_Appointments** permission required to mark an appointment as complete. \n\nThe response identifies the missing permission in the **permissions** array within the **details** object.", "summary": "**NO_PERMISSION** error when the caller lacks permission to complete the appointment.", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Mark_As_Complete_Appointments" ] }, "message": "permission denied", "status": "error" } ] } }, "NoPermissionFlatResponse1": { "description": "Represents a (non-wrapped) **NO_PERMISSION** error returned when the appointment record is inaccessible to the caller. The **resource_path_index** field in **details** identifies the position in the resource path that triggered the access denial.", "summary": "**NO_PERMISSION** error when the appointment record is not accessible to the caller.", "value": { "code": "NO_PERMISSION", "details": { "resource_path_index": 1 }, "message": "record not accessible", "status": "error" } }, "NoPermissionRescheduleResponse1": { "description": "Illustrates a **NO_PERMISSION** error returned when the caller lacks the **Crm_Implied_Reschedule_Appointments** permission required to reschedule an appointment. \n\nThe response identifies the missing permission in the **permissions** array within the **details** object.", "summary": "**NO_PERMISSION** error when the caller lacks permission to reschedule the appointment.", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Reschedule_Appointments" ] }, "message": "permission denied", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PutappointmentByIdError403" }, { "$ref": "#/components/schemas/ErrorResponseCoreNoPermissionFlat" } ], "description": "Represents the error response body returned when an appointment update is denied due to insufficient permissions, containing either a list of action-level permission errors or a record-level permission error.", "x-zs-$id": "UpdateAppointmentByIdError403" } } }, "description": "The user does not have permission to update the specified appointment.\n\n**Resolution:** Contact the system administrator to grant the required update permissions to the user profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.appointments.UPDATE" ] } ], "summary": "Update an Appointment Record by ID", "tags": [ "appointments" ], "x-zoho-document": "appointments" } }, "/crm/v8/Contacts/roles": { "delete": { "description": "Deletes one or more contact roles by their unique identifiers in your Zoho CRM organization.", "operationId": "deleteContactRoles", "parameters": [ { "$ref": "#/components/parameters/ContactRolesIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response for a single contact role deletion, confirming the deleted role ID.", "summary": "Successful contact role deletion", "value": { "contact_roles": [ { "code": "SUCCESS", "details": { "id": "123456789" }, "message": "Contact role deleted successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the results of the contact role deletion operation.", "properties": { "contact_roles": { "description": "Contains the deletion results for each contact role in the request.", "items": { "additionalProperties": false, "description": "Represents the deletion result for a single contact role in the request.", "properties": { "code": { "description": "Represents the status code of the deletion operation.\n\n**Possible values:**\n- **SUCCESS** - The contact role deletion completed successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the deleted contact role.", "properties": { "id": { "description": "Represents the unique ID of the deleted contact role.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "Contactroledeletiondetails" }, "message": { "description": "Represents the message describing the result of the deletion operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the deletion operation.\n\n**Possible values:**\n- **success** - The contact role deletion completed successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "Contactroledeletionresultdetails" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "DeleteContactRolesResponse" } } }, "description": "Returns the deletion results for all contact roles in the request." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows an error response when the specified contact role ID does not exist in the CRM organization.", "summary": "Invalid contact role ID", "value": { "contact_roles": [ { "code": "INVALID_DATA", "details": { "id": "123456789" }, "message": "Invalid data provided", "status": "error" } ] } }, "LowerLimitReached": { "description": "Shows an error response when deleting the contact role would reduce the total count below the minimum required.", "summary": "Lower limit reached on contact roles", "value": { "contact_roles": [ { "code": "LOWER_LIMIT_REACHED", "details": { "id": "123456789", "limit": 1 }, "message": "Lower limit reached", "status": "error" } ] } }, "RequiredParamMissing": { "description": "Shows an error response when the required ids query parameter is not provided in the DELETE request.", "summary": "Required query parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Contains the list of error responses for contact roles that failed deletion.", "properties": { "contact_roles": { "description": "Represents the list of error results for each contact role that failed during deletion.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents an invalid data error for a contact role that does not exist or is invalid.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **INVALID_DATA** - The contact role data is invalid.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid data.", "properties": { "id": { "description": "Represents the ID of the contact role that triggered the invalid data error.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The contact role deletion failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidDataErrorSimpleDelete" }, { "additionalProperties": false, "description": "Represents an error when deleting a contact role would violate the minimum required number of roles.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **LOWER_LIMIT_REACHED** - Deleting the contact role would reduce the total below the minimum required.\n", "enum": [ "LOWER_LIMIT_REACHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the limit violation.", "properties": { "id": { "description": "Represents the ID of the contact role that triggered the limit error.", "maxLength": 19, "type": "string" }, "limit": { "description": "Represents the minimum number of contact roles required in the CRM organization.", "format": "int32", "type": "integer" } }, "required": [ "limit", "id" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The contact role deletion failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LowerLimitReachedErrorSimpleDelete" } ], "description": "Represents a single deletion error for a contact role." }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "ErrorResponseWrapperForContactRoleDeleteFailures" }, { "additionalProperties": false, "description": "Represents an error when the required **ids** query parameter is not provided in the request.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **REQUIRED_PARAM_MISSING** - The required **ids** query parameter is missing from the request.\n", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the missing parameter.", "properties": { "param_name": { "description": "Represents the API name of the missing required parameter.", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The contact role deletion failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingError" } ], "description": "Contains the error details for the contact role deletion request.", "x-zs-$id": "ErrorResponseDeleteContactRoles" } } }, "description": "The contact roles could not be deleted due to invalid IDs or a missing required parameter.\n\n**Resolution:** The **ids** query parameter must be provided and all specified contact role IDs must exist in the CRM organization.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.DELETE" ] } ], "summary": "Delete Contact Roles", "tags": [ "contact_roles" ], "x-zoho-document": "contact_roles" }, "get": { "description": "Retrieves the list of contact roles available in your Zoho CRM organization.", "operationId": "getContactRoles", "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response with a single contact role entry, including the role name, unique ID, and picklist position.", "summary": "Successful retrieval of contact roles", "value": { "contact_roles": [ { "id": "123456789", "name": "Manager", "sequence_number": 2 } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the list of contact roles configured in the CRM organization.", "properties": { "contact_roles": { "description": "Represents the list of contact roles configured in the CRM organization.", "items": { "additionalProperties": false, "description": "Represents a contact role configured in the CRM organization.", "properties": { "id": { "description": "Represents the unique ID of the contact role. Use the [List Contact Roles](contact_roles.yaml#$.paths./contacts/roles.get) resource to retrieve contact role IDs.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the contact role.", "maxLength": 50, "pattern": "[A-Za-z0-9 ]", "type": "string" }, "sequence_number": { "description": "Represents the display position of the contact role in the CRM UI picklist.", "type": "number" } }, "required": [ "name", "id", "sequence_number" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "ContactRolesResponse" } } }, "description": "Returns the list of contact roles configured in the CRM organization." }, "204": { "description": "Indicates that no contact roles are configured in the CRM organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.READ" ] } ], "summary": "List Contact Roles", "tags": [ "contact_roles" ], "x-zoho-document": "contact_roles" }, "post": { "description": "Creates one or more contact roles in your Zoho CRM organization.", "operationId": "createContactRoles", "requestBody": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a request to create one contact role with its name and picklist position.", "summary": "Create a single contact role", "value": { "contact_roles": [ { "name": "Manager", "sequence_number": 2 } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the contact role details to create in the CRM organization.", "properties": { "contact_roles": { "description": "Specify the list of contact roles to create.", "items": { "additionalProperties": false, "description": "Specify the details of a single contact role to create.", "properties": { "name": { "description": "Specify the name of the contact role.", "maxLength": 50, "pattern": "[A-Za-z0-9 ]{1,50}", "type": "string" }, "sequence_number": { "description": "Specify the display position of the contact role in the CRM UI picklist.", "type": "number" } }, "required": [ "name", "sequence_number" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object" } } }, "description": "The request body must contain a `contact_roles` array. You can include a maximum of 100 objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response for a single contact role creation, including the generated unique ID.", "summary": "Successful contact role creation", "value": { "contact_roles": [ { "code": "SUCCESS", "details": { "id": "123456789" }, "message": "Contact role created successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the results of the contact role creation, with a status entry for each contact role in the request.", "properties": { "contact_roles": { "description": "Contains the results for each contact role in the request.", "items": { "$ref": "#/components/schemas/ContactRoleSuccessSchema" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "CreateContactRolesResponse" } } }, "description": "Returns the contact role creation results when all contact roles in the request succeed." }, "207": { "content": { "application/json": { "examples": { "MultiStatus": { "description": "Shows a multi-status response with one successfully created contact role and one with invalid data.", "summary": "Mixed success and error results", "value": { "contact_roles": [ { "code": "SUCCESS", "details": { "id": "123456789" }, "message": "Contact role created successfully.", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.contact_roles[1].name" }, "message": "invalid data provided", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains mixed success and error results for bulk contact role creation.", "properties": { "contact_roles": { "allOf": [ { "description": "Ensures the array contains at least one successfully created contact role." }, { "description": "Ensures the array contains at least one contact role that failed validation." } ], "description": "Contains the mixed results for each contact role in the request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandatoryFieldNotFoundErrorSchema" }, { "$ref": "#/components/schemas/InvalidDataErrorSchemaPOST" }, { "$ref": "#/components/schemas/DuplicateDataErrorSchemaPOST" }, { "$ref": "#/components/schemas/ContactRoleSuccessSchema" } ], "description": "Represents a single result entry, which is either a success record or an error record." }, "maxItems": 100, "minItems": 2, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "CreateContactRolesMultiStatus207" } } }, "description": "Returns a mixed response when the CRM creates some contact roles successfully and others fail validation." }, "400": { "content": { "application/json": { "examples": { "DuplicateData": { "description": "Shows an error response when a contact role with the same name already exists in the CRM organization.", "summary": "Duplicate contact role name", "value": { "contact_roles": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.contact_roles[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataSimple": { "description": "Shows an error response when an invalid value is provided for a contact role field during creation.", "summary": "Invalid data in contact role field", "value": { "contact_roles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.contact_roles[0].name" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFound": { "description": "Shows an error response when a required field is missing from the contact role request.", "summary": "Required field missing in request", "value": { "contact_roles": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.contact_roles[0].name" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the validation errors for the contact role creation request.", "properties": { "contact_roles": { "description": "Contains the validation errors for each contact role that failed.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandatoryFieldNotFoundErrorSchema" }, { "$ref": "#/components/schemas/InvalidDataErrorSchemaPOST" }, { "$ref": "#/components/schemas/DuplicateDataErrorSchemaPOST" } ], "description": "Represents a single validation error for a contact role that failed creation." }, "maxItems": 100, "type": "array", "x-zs-$id": "CreateContactRolesErrorArray" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "CreateContactRolesErrorResponse" } } }, "description": "The contact roles could not be created due to validation errors.\n\n**Resolution:** Review the error details for each contact role in the response, correct any invalid fields, and retry the request.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.WRITE" ] } ], "summary": "Create Contact Roles", "tags": [ "contact_roles" ], "x-zoho-document": "contact_roles" }, "put": { "description": "Updates the properties of one or more existing contact roles in your Zoho CRM organization.", "operationId": "updateContactRoles", "requestBody": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a request to update one contact role with its name, ID, and picklist position.", "summary": "Update a single contact role", "value": { "contact_roles": [ { "id": "123456789", "name": "Manager", "sequence_number": 2 } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the contact role details to update in the CRM organization.", "properties": { "contact_roles": { "description": "Specify the list of contact roles to update.", "items": { "additionalProperties": false, "description": "Specify the details of a single contact role to update.", "properties": { "id": { "description": "Specify the unique ID of the contact role to update. Use the [List Contact Roles](contact_roles.yaml#$.paths./contacts/roles.get) resource to retrieve contact role IDs.", "maxLength": 19, "type": "string" }, "name": { "description": "Specify the name of the contact role.", "maxLength": 50, "pattern": "[A-Za-z0-9 ]{1,50}", "type": "string" }, "sequence_number": { "description": "Specify the display position of the contact role in the CRM UI picklist.", "type": "number" } }, "required": [ "name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object" } } }, "description": "The request body must contain a `contact_roles` array. You can include a maximum of 100 objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response for a single contact role update, confirming the updated role ID.", "summary": "Successful contact role update", "value": { "contact_roles": [ { "code": "SUCCESS", "details": { "id": "123456789" }, "message": "Contact role updated successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the results of the contact role update operation.", "properties": { "contact_roles": { "description": "Contains the update results for each contact role in the request.", "items": { "additionalProperties": false, "description": "Represents the update result for a single contact role in the request.", "properties": { "code": { "description": "Represents the status code of the update operation.\n\n**Possible values:**\n- **SUCCESS** - The contact role update completed successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the updated contact role.", "properties": { "id": { "description": "Represents the unique ID of the updated contact role.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the result of the update operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the update operation.\n\n**Possible values:**\n- **success** - The contact role update completed successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "Contactroleupdateresultdetails" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "UpdateContactRolesResponse" } } }, "description": "Returns the results after the CRM updates all contact roles in the request successfully." }, "207": { "content": { "application/json": { "examples": { "MultiStatus": { "description": "Shows a multi-status response with one successfully updated contact role and one missing a required field.", "summary": "Mixed success and error results", "value": { "contact_roles": [ { "code": "SUCCESS", "details": { "id": "123456789" }, "message": "Contact role created successfully.", "status": "success" }, { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.contact_roles[0].id" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains mixed success and error results for bulk contact role update.", "properties": { "contact_roles": { "allOf": [ { "description": "Ensures the array contains at least one successfully updated contact role." }, { "description": "Ensures the array contains at least one contact role that failed validation." } ], "description": "Contains the mixed results for each contact role in the request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandatoryFieldNotFoundErrorSchema" }, { "$ref": "#/components/schemas/InvalidDataErrorSchemaPut" }, { "$ref": "#/components/schemas/DuplicateDataErrorSchemaPUT" }, { "$ref": "#/components/schemas/ArrayOfDuplicateSchema" }, { "$ref": "#/components/schemas/ContactRoleSuccessSchema" } ], "description": "Represents a single result entry, which is either a success record or an error record." }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "UpdateContactRolesMultiStatus207" } } }, "description": "Returns a mixed response when the CRM updates some contact roles successfully and others fail validation." }, "400": { "content": { "application/json": { "examples": { "DuplicateData": { "description": "Shows an error response when a contact role with the same name already exists in the CRM organization.", "summary": "Duplicate contact role name", "value": { "contact_roles": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "id": "1718237000010991001", "json_path": "$.contact_roles[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidData": { "description": "Shows an error response when an invalid value is provided for a contact role field during update.", "summary": "Invalid data in contact role field", "value": { "contact_roles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "id": "1718237000010991001", "json_path": "$.contact_roles[0].name" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFound": { "description": "Shows an error response when a required field is missing from the contact role update request.", "summary": "Required field missing in request", "value": { "contact_roles": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.contact_roles[0].id" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Contains the list of error responses for contact roles that failed during the update operation.", "properties": { "contact_roles": { "description": "Contains the error details for each contact role that failed during the update operation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandatoryFieldNotFoundErrorSchema" }, { "$ref": "#/components/schemas/InvalidDataErrorSchemaPut" }, { "$ref": "#/components/schemas/DuplicateDataErrorSchemaPUT" }, { "$ref": "#/components/schemas/ArrayOfDuplicateSchema" } ], "description": "Represents a single validation error for a contact role that failed the update operation." }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "Errorresponsewrapperforcontactroleupdatefailures" } ], "description": "Contains the error details for the contact role update request.", "x-zs-$id": "Errorinupdatingcontactroles" } } }, "description": "The contact roles could not be updated due to validation errors.\n\n**Resolution:** Review the error details for each contact role in the response, correct any invalid fields, and retry the request.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.UPDATE" ] } ], "summary": "Update Contact Roles", "tags": [ "contact_roles" ], "x-zoho-document": "contact_roles" } }, "/crm/v8/Contacts/roles/{role}": { "delete": { "description": "Deletes a specific contact role by its unique identifier in your Zoho CRM organization.", "operationId": "deleteContactRole", "parameters": [ { "$ref": "#/components/parameters/ContactRolesRole" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response for a contact role deletion, confirming the deleted role ID.", "summary": "Successful contact role deletion", "value": { "contact_roles": [ { "code": "SUCCESS", "details": { "id": "123456789" }, "message": "Contact role deleted successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the result of the contact role deletion operation.", "properties": { "contact_roles": { "description": "Contains the deletion results for the contact role.", "items": { "additionalProperties": false, "description": "Represents the deletion result for the specified contact role.", "properties": { "code": { "description": "Represents the status code of the deletion operation.\n\n**Possible values:**\n- **SUCCESS** - The contact role deletion completed successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the deleted contact role.", "properties": { "id": { "description": "Represents the unique ID of the deleted contact role.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the result of the deletion operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the deletion operation.\n\n**Possible values:**\n- **success** - The contact role deletion completed successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ContactroledeletionresultDetails" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "DeleteSccessResponse" } } }, "description": "Returns the result of the contact role deletion when the operation completes successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows an error response when the specified contact role ID does not exist in the CRM organization.", "summary": "Invalid contact role ID", "value": { "contact_roles": [ { "code": "INVALID_DATA", "details": { "id": "123456789" }, "message": "Invalid data provided", "status": "error" } ] } }, "LowerLimitReached": { "description": "Shows an error response when deleting the contact role would reduce the total count below the minimum required.", "summary": "Lower limit reached on contact roles", "value": { "contact_roles": [ { "code": "LOWER_LIMIT_REACHED", "details": { "id": "123456789", "limit": 1 }, "message": "Lower limit reached", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Contains the list of error responses for the contact role that failed deletion.", "properties": { "contact_roles": { "description": "Represents the list of error results for the contact role deletion operation.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents an invalid data error for a contact role that does not exist or is invalid.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **INVALID_DATA** - The contact role data is invalid.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid data.", "properties": { "id": { "description": "Represents the ID of the contact role that triggered the invalid data error.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The contact role deletion failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidDataErrorSimpleDeleteSingle" }, { "additionalProperties": false, "description": "Represents an error when deleting the contact role would violate the minimum required number of roles.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **LOWER_LIMIT_REACHED** - Deleting the contact role would reduce the total below the minimum required.\n", "enum": [ "LOWER_LIMIT_REACHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the limit violation.", "properties": { "id": { "description": "Represents the ID of the contact role that triggered the limit error.", "maxLength": 19, "type": "string" }, "limit": { "description": "Represents the minimum number of contact roles required in the CRM organization.", "format": "int32", "type": "integer" } }, "required": [ "limit", "id" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The contact role deletion failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LowerLimitReachedErrorSimpleDeleteSingle" } ], "description": "Represents a single deletion error for the specified contact role." }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "Errorresponsewrapperforcontactroledeletefailures" } ], "description": "Contains the error details for the contact role deletion request.", "x-zs-$id": "Errorindeletingcontactrole" } } }, "description": "The contact role could not be deleted due to an invalid ID or a limit violation.\n\n**Resolution:** The contact role ID must be valid and deleting it must not reduce the total number of contact roles below the minimum required.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.DELETE" ] } ], "summary": "Delete a Contact Role", "tags": [ "contact_roles" ], "x-zoho-document": "contact_roles" }, "get": { "description": "Retrieves the details of a specific contact role by its unique identifier in your Zoho CRM organization.", "operationId": "getContactRole", "parameters": [ { "$ref": "#/components/parameters/ContactRolesRole" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response for a specific contact role, including the role name, unique ID, and picklist position.", "summary": "Successful retrieval of a specific contact role", "value": { "contact_roles": [ { "id": "123456789", "name": "Manager", "sequence_number": 1 } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the details of the specified contact role.", "properties": { "contact_roles": { "description": "Represents the details of the specified contact role.", "items": { "additionalProperties": false, "description": "Represents a contact role entry, including its name, unique ID, and display position.", "properties": { "id": { "description": "Represents the unique ID of the contact role.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the contact role.", "maxLength": 50, "pattern": "[A-Za-z0-9 ]", "type": "string" }, "sequence_number": { "description": "Represents the display position of the contact role in the CRM UI picklist.", "type": "number" } }, "required": [ "name", "id", "sequence_number" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "Responsecontaininglistofcontactroles" } } }, "description": "Returns the details of the specified contact role." }, "204": { "description": "Indicates that the specified contact role does not exist in the CRM organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.READ" ] } ], "summary": "Get a Contact Role", "tags": [ "contact_roles" ], "x-zoho-document": "contact_roles" }, "put": { "description": "Updates a specific contact role by its unique identifier in your Zoho CRM organization.", "operationId": "updateContactRole", "parameters": [ { "$ref": "#/components/parameters/ContactRolesRole" } ], "requestBody": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a request to update a contact role with its name and picklist position.", "summary": "Update a specific contact role", "value": { "contact_roles": [ { "name": "Manager", "sequence_number": 2 } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the contact role details to update.", "properties": { "contact_roles": { "description": "Specify the list of contact roles to update.", "items": { "additionalProperties": false, "description": "Specify the details of the contact role to update.", "properties": { "name": { "description": "Specify the name of the contact role.", "maxLength": 50, "pattern": "[A-Za-z0-9 ]", "type": "string" }, "sequence_number": { "description": "Specify the display position of the contact role in the CRM UI picklist.", "format": "int32", "type": "integer" } }, "required": [ "name" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object" } } }, "description": "The request body must contain a `contact_roles` array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response for a contact role update, confirming the updated role ID.", "summary": "Successful contact role update", "value": { "contact_roles": [ { "code": "SUCCESS", "details": { "id": "123456789" }, "message": "Contact role updated successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the result of the contact role update operation.", "properties": { "contact_roles": { "description": "Contains the update result for the specified contact role.", "items": { "additionalProperties": false, "description": "Represents the update result for the specified contact role.", "properties": { "code": { "description": "Represents the status code of the update operation.\n\n**Possible values:**\n- **SUCCESS** - The contact role update completed successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the updated contact role.", "properties": { "id": { "description": "Represents the unique ID of the updated contact role.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the result of the update operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the update operation.\n\n**Possible values:**\n- **success** - The contact role update completed successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ContactroleupdateresultDetails" }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "MultipleSuccessResponse200" } } }, "description": "Returns the result of the contact role update when the operation completes successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataWithId": { "description": "Shows an error response when the contact role ID in the request is invalid.", "summary": "Invalid contact role ID in request", "value": { "contact_roles": [ { "code": "INVALID_DATA", "details": { "id": "738964000000242001" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFound": { "description": "Shows an error response when a required field is missing from the contact role update request.", "summary": "Required field missing in request", "value": { "contact_roles": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.contact_roles[0]" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Contains the error details for the contact role that failed during the update operation.", "properties": { "contact_roles": { "description": "Represents the list of error results for the contact role update operation.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error when a required field is missing from the request.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **MANDATORY_NOT_FOUND** - A required field is missing from the request.\n", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the missing field.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing required field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The contact role update failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "MandatoryFieldNotFoundErrorSimpleUpdateSingle" }, { "additionalProperties": false, "description": "Represents an invalid data error for a contact role field.", "properties": { "code": { "description": "Represents the error code.\n\n**Possible values:**\n- **INVALID_DATA** - The contact role data is invalid.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid data.", "properties": { "id": { "description": "Represents the ID of the contact role that triggered the invalid data error.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status.\n\n**Possible values:**\n- **error** - The contact role update failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidDataErrorSimpleUpdateSingle" } ], "description": "Represents a single error result for the contact role update operation." }, "maxItems": 100, "type": "array" } }, "required": [ "contact_roles" ], "type": "object", "x-zs-$id": "ErrorresponsewrapperforcontactroleupdatedFailures" } ], "description": "Contains the error details for the contact role update request.", "x-zs-$id": "Errorwhileupdatingparticularcontactrole" } } }, "description": "The contact role could not be updated due to a validation error.\n\n**Resolution:** Review the error details, correct any invalid fields, and retry the request.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.UPDATE" ] } ], "summary": "Update a Contact Role", "tags": [ "contact_roles" ], "x-zoho-document": "contact_roles" } }, "/crm/v8/Contacts/{contactId}/Emails/actions/link_record": { "delete": { "description": "To unlink deals from one or more of a contact's emails. An email will only be linked to a single deal at a time. When you call this API, the specified email(s) will be unlinked from them. The user's profile requires \"View\" permission for Deals and Contacts modules to use this API.", "operationId": "unlinkEmailsFromDeal", "parameters": [ { "$ref": "#/components/parameters/ContactId" }, { "$ref": "#/components/parameters/MessageIds" }, { "$ref": "#/components/parameters/OwnerId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SampleResponse": { "summary": "Unlink Emails from Deals - Response", "value": { "Emails": [ { "code": "SUCCESS", "details": { "message_id": "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782" }, "message": "Email unlinked from the record successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema", "properties": { "Emails": { "description": "List of email unlink operation results", "items": { "additionalProperties": false, "description": "Email unlink operation result", "properties": { "code": { "description": "Result code of the unlink operation", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the unlink operation", "properties": { "message_id": { "description": "Unique identifier of the email message", "maxLength": 256, "type": "string" } }, "required": [ "message_id" ], "type": "object" }, "message": { "description": "Detailed message about the unlink operation", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the unlink operation", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 20, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "UnlinkEmailsFromRecordsResponse" } } }, "description": "The emails were unlinked from the deals successfully." }, "400": { "content": { "application/json": { "examples": { "SampleErrorResponse": { "summary": "Unlink Emails from Records - Error Response", "value": { "Emails": [ [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "message_id", "json_path": "message_ids[0]" }, "message": "message_id is mandatory", "status": "error" } ] ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Details of errors for each email unlink operation", "properties": { "Emails": { "description": "Array of error details for each email unlink operation.", "items": { "anyOf": [ { "description": "Errors due to missing mandatory fields", "items": { "additionalProperties": false, "description": "Details of a mandatory field missing error.", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional details about the error.", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 20, "type": "array", "x-zs-$id": "MandatoryNotFoundError1" }, { "description": "Errors due to invalid data", "items": { "additionalProperties": false, "description": "Details of an invalid data error.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional details about the error.", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "invalid data" ], "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 20, "type": "array", "x-zs-$id": "InvalidDataError1" } ] }, "maxItems": 20, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "UnlinkEmailsFromRecordsErrorDetails" }, { "additionalProperties": false, "description": "General error response for unlink emails from records operation", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional details about the error.", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 256, "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnlinkEmailsFromRecordsGeneralError" } ], "x-zs-$id": "UnlinkEmailsFromRecordsErrorResponse" } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "anyOf": [ { "additionalProperties": false, "description": "Returned when the request URL is incorrect.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An empty object. No additional details are provided for this error.", "type": "object" }, "message": { "description": "A message describing the error.", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnlinkEmailsFromRecordsNotFoundErrorDetails" }, { "additionalProperties": false, "description": "General not found error response for unlink emails from records operation", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "An empty object. No additional details are provided for this error.", "type": "object" }, "message": { "description": " Unique identifier of the module", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnlinkEmailsFromRecordsNotFoundErrorGeneral" } ], "description": "Details of not found error", "type": "object", "x-zs-$id": "UnlinkEmailsFromRecordsNotFoundError" } } }, "description": "Not Found" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.CREATE", "ZohoCRM.modules.emails.CREATE", "ZohoCRM.modules.deals.CREATE" ] } ], "summary": "Unlink Emails from Deals", "tags": [ "deal_link_emails" ], "x-zoho-document": "deal_link_emails" }, "post": { "description": "To link a deal with one or more of a contact's emails. An email can only be linked to a single deal at a time. Zoho CRM automatically links a contact's incoming emails to the deals using the [Deal Prediction Mechanism](https://help.zoho.com/portal/en/kb/crm/connect-with-customers/email/user-functions/articles/email-association-with-deal#Auto-link_Emails_by_Deal_Prediction_Mechanism). You can also manage these links using the Link Deal to Emails API and [Unlink Deal from Emails API](deal_link_emails.yaml#$.paths./Contacts/{contactId}/Emails/{messageId}/actions/link_record.delete).", "operationId": "linkEmailsToDeals", "parameters": [ { "$ref": "#/components/parameters/ContactId" } ], "requestBody": { "content": { "application/json": { "examples": { "SampleRequestBody": { "summary": "Link Emails to Deals", "value": { "Emails": [ { "linked_record": { "id": "4876876000000514024", "module": { "api_name": "Deals", "id": "4876876000000000131" }, "name": "Acme Renewal Deal" }, "message_id": "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782", "owner": { "id": "4876876000000362001" } }, { "linked_record": { "id": "4876876000000002676", "module": { "api_name": "Deals", "id": "4876876000000000131" } }, "message_id": "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782", "owner": { "id": "4876876000000362001" } } ] } } }, "schema": { "additionalProperties": false, "description": "The request body schema for linking emails to deals.", "properties": { "Emails": { "description": "Array containing the details of the emails to link to deals. Mandatory.", "items": { "additionalProperties": false, "description": "Object containing the details of the email to link to a deal.", "properties": { "linked_record": { "additionalProperties": false, "description": "The details of the deal record to be linked to the email. Mandatory. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs", "properties": { "id": { "description": "The unique ID of the deal record that the email must be linked to. Mandatory.", "examples": [ "4876876000000514024" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" }, "module": { "additionalProperties": false, "description": "The details of the Deals module. Mandatory.", "properties": { "api_name": { "description": "The API name of the Deals module. Mandatory.", "enum": [ "Deals" ], "type": "string" }, "id": { "description": "The unique ID of the Deals module. Mandatory.", "examples": [ "4876876000000000131" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": { "description": "The name of the deal record that the email must be linked to. Mandatory.", "examples": [ "Acme Renewal Deal" ], "maxLength": 255, "type": "string" } }, "required": [ "module", "id" ], "type": "object" }, "message_id": { "description": "The unique message ID of the email to which the deal will be linked. Mandatory when linking multiple emails. You can obtain message ID of a record through [Get Emails of a Record API](emails.yaml#$.paths.{moduleApiName}/{id}/Emails/{messageId}.get).", "examples": [ "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782" ], "maxLength": 500, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "owner": { "additionalProperties": false, "description": "The details of the user whose email you want to link. Mandatory.", "properties": { "id": { "description": "The unique ID of the user whose email you want to link. Mandatory.", "examples": [ "4876876000000362001" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" } }, "type": "object" } }, "required": [ "message_id", "owner", "linked_record" ], "type": "object" }, "maxItems": 20, "type": "array" } }, "type": "object" } } }, "description": "The request body to link emails to deals.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SampleResponse": { "summary": "Link Emails to Deals - Response", "value": { "Emails": [ { "code": "SUCCESS", "details": { "message_id": "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782" }, "message": "Email linked to the record successfully", "status": "success" }, { "code": "SUCCESS", "details": { "message_id": "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782" }, "message": "Email linked to the record successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful response containing the link operation results.", "properties": { "Emails": { "description": "List of email link operation results", "items": { "additionalProperties": false, "description": "Email link operation result", "properties": { "code": { "description": "Result code of the link operation", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the link operation", "properties": { "message_id": { "description": "Unique identifier of the email message", "maxLength": 255, "type": "string" } }, "required": [ "message_id" ], "type": "object" }, "message": { "description": "Detailed message about the link operation", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the link operation", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 20, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "LinkEmailsToDealsResponse" } } }, "description": "The emails were linked to the deals successfully." }, "400": { "content": { "application/json": { "examples": { "SampleErrorResponse": { "summary": "Link Emails to Deals - Error Response", "value": { "Emails": [ [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "message_id", "json_path": "Emails[0].message_id" }, "message": "message_id is mandatory", "status": "error" } ], [ { "code": "INVALID_DATA", "details": { "api_name": "linked_record.id", "json_path": "Emails[1].linked_record.id" }, "message": "invalid data", "status": "error" } ] ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Details of errors for each email link operation", "properties": { "Emails": { "description": "List of error details for each email link operation", "items": { "anyOf": [ { "description": "Errors due to missing mandatory fields", "items": { "additionalProperties": false, "description": "Details of a mandatory field missing error", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 20, "type": "array", "x-zs-$id": "MandatoryNotFoundError" }, { "description": "Errors due to invalid data", "items": { "additionalProperties": false, "description": "Details of an invalid data error", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 20, "type": "array", "x-zs-$id": "InvalidDataError" } ] }, "maxItems": 20, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "LinkEmailsToDealsErrorDetails" }, { "additionalProperties": false, "description": "General error response for link emails to deals operation", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LinkEmailsToDealsGeneralError" } ], "description": "Error response schema", "x-zs-$id": "LinkEmailsToDealsErrorResponse" } } }, "description": "Bad Request" }, "404": { "content": { "application/json": { "examples": { "SampleNotFoundResponse": { "summary": "Link Emails to Deals - Not Found Response", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Details of not found error", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "type": "object" }, "message": { "description": "Error message", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LinkEmailsToDealsNotFoundError" } } }, "description": "Not Found" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.emails.CREATE", "ZohoCRM.modules.deals.CREATE", "ZohoCRM.modules.contacts.CREATE" ] } ], "summary": "Link Emails to Deals", "tags": [ "deal_link_emails" ], "x-zoho-document": "deal_link_emails" } }, "/crm/v8/Contacts/{contactId}/Emails/{messageId}/actions/link_record": { "delete": { "description": "Unlinks an email from a specified record in CRM.", "operationId": "unlinkEmailFromRecord", "parameters": [ { "$ref": "#/components/parameters/ContactId" }, { "$ref": "#/components/parameters/DealLinkEmailsMessageId" }, { "$ref": "#/components/parameters/OwnerId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SampleResponse": { "summary": "Unlink Email from Record - Response", "value": { "Emails": [ { "code": "SUCCESS", "details": { "message_id": "6e78663d9e92be2868fc339bf88fea06cadeb6f678479e5d3e8aacd7c544ae8eea1034c510cec43527a3eec50151290f" }, "message": "Email unlinked from the record successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema for unlinking email from record", "properties": { "Emails": { "description": "List of email unlink operation results", "items": { "additionalProperties": false, "description": "Email unlink operation result", "properties": { "code": { "description": "Result code of the unlink operation", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the unlink operation", "properties": { "message_id": { "description": "Unique identifier of the email message", "maxLength": 256, "type": "string" } }, "required": [ "message_id" ], "type": "object" }, "message": { "description": "Detailed message about the unlink operation", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the unlink operation", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "UnlinkEmailFromRecordResponse" } } }, "description": "success response" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "anyOf": [ { "additionalProperties": false, "description": "Details of errors for the email unlink operation", "properties": { "Emails": { "description": " Unique identifier of the module", "items": { "anyOf": [ { "description": "Errors due to missing mandatory fields", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "MandatoryNotFoundError4" }, { "description": "Errors due to invalid data", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "enum": [ "invalid data" ], "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "InvalidDataError4" } ] }, "maxItems": 1, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "UnlinkEmailFromRecordErrorDetails" }, { "additionalProperties": false, "description": "Details of errors for the email unlink operation", "properties": { "Emails": { "description": " Unique identifier of the module", "items": { "anyOf": [ { "description": "Errors due to missing mandatory fields", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "MandatoryNotFoundError5" }, { "description": "Errors due to invalid data", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "enum": [ "invalid data" ], "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "InvalidDataError5" } ] }, "maxItems": 1, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "UnlinkEmailFromRecordErrorDetails1" } ], "description": "Error response schema for unlinking email from record", "x-zs-$id": "UnlinkEmailFromRecordErrorResponse" } } }, "description": "Bad Request - Invalid input or missing required parameters" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.CREATE", "ZohoCRM.modules.emails.CREATE", "ZohoCRM.modules.deals.CREATE" ] } ], "summary": "Unlink Deal Email", "tags": [ "deal_link_emails" ], "x-zoho-document": "deal_link_emails" }, "post": { "description": "Links an email to a specified record in CRM.", "operationId": "linkEmailToRecord", "parameters": [ { "$ref": "#/components/parameters/ContactId" }, { "$ref": "#/components/parameters/DealLinkEmailsMessageId" } ], "requestBody": { "content": { "application/json": { "examples": { "SampleRequestBody": { "summary": "Link Email to Record - Request Body", "value": { "Emails": [ { "linked_record": { "id": "4876876000000514024", "module": { "api_name": "Deals", "id": "4876876000000000131" }, "name": "Acme Renewal Deal" }, "owner": { "id": "4876876000000362001" } } ] } } }, "schema": { "additionalProperties": false, "description": "Request body schema for linking email to record", "properties": { "Emails": { "description": "List of emails to be linked to records", "items": { "additionalProperties": false, "description": "Details of an email to be linked to a record", "properties": { "linked_record": { "additionalProperties": false, "description": "Record to which the email is to be linked", "properties": { "id": { "description": "Unique identifier of the record", "examples": [ "4876876000000514024" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" }, "module": { "additionalProperties": false, "description": "Module of the record", "properties": { "api_name": { "description": "API name of the module", "enum": [ "Deals" ], "type": "string" }, "id": { "description": "Unique identifier of the module", "examples": [ "4876876000000000131" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": { "description": "Name of the record", "examples": [ "Acme Renewal Deal" ], "maxLength": 255, "type": "string" } }, "required": [ "module", "id" ], "type": "object" }, "owner": { "additionalProperties": false, "description": "Owner of the email", "properties": { "id": { "description": "Unique identifier of the owner", "examples": [ "4876876000000362001" ], "maxLength": 100, "pattern": "^[0-9]+$", "type": "string" } }, "type": "object" } }, "required": [ "owner", "linked_record" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SampleResponse": { "summary": "Link Email to Record - Response", "value": { "Emails": [ { "code": "SUCCESS", "details": { "message_id": "f129cbd6953db55b4464b4dfc6f5cd3ebc57ab5c83a16c6d08843a24d4f4cfbc04e4b089882b920f306be5735ce55782" }, "message": "Email linked to the record successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema for linking email to record", "properties": { "Emails": { "description": "List of email link operation results", "items": { "additionalProperties": false, "description": "Email link operation result", "properties": { "code": { "description": "Result code of the link operation", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the link operation", "properties": { "message_id": { "description": "Unique identifier of the email message", "maxLength": 256, "type": "string" } }, "required": [ "message_id" ], "type": "object" }, "message": { "description": "Detailed message about the link operation", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the link operation", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "LinkEmailToRecordResponse" } } }, "description": "Successful response" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "additionalProperties": false, "description": "Details of errors for the email link operation", "properties": { "Emails": { "description": " Unique identifier of the module", "items": { "anyOf": [ { "description": "Errors due to missing mandatory fields", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "MandatoryNotFoundError2" }, { "description": "Errors due to invalid data", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "enum": [ "invalid data" ], "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "InvalidDataError2" } ] }, "maxItems": 1, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "LinkEmailToRecordErrorDetails" }, { "additionalProperties": false, "description": "Details of errors for the email link operation", "properties": { "Emails": { "description": " Unique identifier of the module", "items": { "anyOf": [ { "description": "Errors due to missing mandatory fields", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the missing field", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the missing field", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "MandatoryNotFoundError3" }, { "description": "Errors due to invalid data", "items": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "api_name": { "description": "API name of the field with invalid data", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field with invalid data", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": " Unique identifier of the message", "enum": [ "invalid data" ], "maxLength": 256, "type": "string" }, "status": { "description": "Status of the error", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array", "x-zs-$id": "InvalidDataError3" } ] }, "maxItems": 1, "type": "array" } }, "required": [ "Emails" ], "type": "object", "x-zs-$id": "LinkEmailToRecordErrorDetails1" } ], "x-zs-$id": "LinkEmailToRecordErrorResponse" } } }, "description": "Bad Request - Invalid input parameters" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "anyOf": [ { "additionalProperties": false, "description": " Unique identifier of the module", "properties": { "code": { "description": " Unique identifier of the module", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "type": "object" }, "message": { "description": " Unique identifier of the module", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": " Unique identifier of the module", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LinkEmailToRecordNotFoundErrorDetails" }, { "additionalProperties": false, "description": "General not found error response for link email to record operation", "properties": { "code": { "description": " Unique identifier of the module", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": " Unique identifier of the module", "type": "object" }, "message": { "description": " Unique identifier of the module", "enum": [ "Please check if the URL trying to access is a correct one" ], "type": "string" }, "status": { "description": " Unique identifier of the module", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LinkEmailToRecordNotFoundErrorGeneral" } ], "description": "Details of not found error", "x-zs-$id": "LinkEmailToRecordNotFoundError" } } }, "description": "Not Found - The specified contact or email does not exist" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.contacts.CREATE", "ZohoCRM.modules.emails.CREATE", "ZohoCRM.modules.deals.CREATE" ] } ], "summary": "Link Deal Email", "tags": [ "deal_link_emails" ], "x-zoho-document": "deal_link_emails" } }, "/crm/v8/Events/{event}/actions/cancel": { "post": { "description": "To cancel a meeting and send an email regarding the meeting cancellation to the participants. A meeting can only be cancelled if attendees have already been invited and the meeting has not passed its scheduled end time. To check the cancellation status of a meeting, refer to the $event_cancelled key in the response from the [Get Records API](record.yaml#$.paths./module.get).", "operationId": "cancelMeetings", "parameters": [ { "$ref": "#/components/parameters/Event" } ], "requestBody": { "content": { "application/json": { "examples": { "RequestBodyExample": { "value": { "data": [ { "send_cancelling_mail": false } ] } } }, "schema": { "additionalProperties": false, "description": "The request body for the cancel meeting operation.", "properties": { "data": { "description": "Array containing the cancellation notification preference. Mandatory.", "items": { "additionalProperties": false, "description": "Object specifying whether to send a cancellation notification email to participants.", "properties": { "cancelled_by": { "additionalProperties": false, "description": "The user who cancelled the meeting. If specified, send_cancelling_mail must be true.", "properties": { "id": { "description": "The ID of the user who cancelled the meeting.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "send_cancelling_mail": { "description": "Indicates whether to send a meeting cancellation notification email to all participants. Mandatory. Possible values: true - Sends a cancellation notification email to all participants. false - Cancels the meeting without sending a notification email", "type": "boolean" } }, "required": [ "send_cancelling_mail" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "CancelMeetingSuccessResponse": { "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4876876000001563018" }, "message": "The event is successfully cancelled", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful response containing the cancellation result.", "properties": { "data": { "description": "Array containing the cancellation result for the meeting.", "items": { "additionalProperties": false, "description": "Object containing the result of the cancellation operation.", "properties": { "code": { "description": "The status code of the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing the ID of the cancelled meeting.", "properties": { "id": { "description": "The unique identifier of the cancelled meeting.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "A message describing the result of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "Successresponse" } } }, "description": "The meeting was cancelled successfully." }, "400": { "content": { "application/json": { "examples": { "ErrorResponse": { "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The request method is incorrect.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the HTTP request method is incorrect. Use the HTTP POST method for this API call.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details.", "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, { "additionalProperties": false, "description": "Required field not found. A required field is missing in the request.", "properties": { "data": { "description": "List of error details", "items": { "additionalProperties": false, "description": "Error detail object", "properties": { "code": { "description": "Error code", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing the API name and JSON path of the missing mandatory field.", "properties": { "api_name": { "description": "The API name of the missing mandatory field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the missing mandatory field in the request body.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "A message describing the error", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, { "additionalProperties": false, "description": "Returned when the meeting ID specified in the URL is invalid. Specify a valid meeting ID.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing the API name and JSON path of the invalid field.", "properties": { "api_name": { "description": "The API name of the field with the invalid value.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type", "maxLength": 255, "type": "string" }, "json_path": { "description": "The JSON path to the field with the invalid value.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidDataError" }, { "additionalProperties": false, "description": "Returned when the meeting is already cancelled. Specify a valid meeting ID that has not been cancelled.", "properties": { "data": { "description": "Contains the list of error details.", "items": { "additionalProperties": false, "description": "Contains the error detail object", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "EventAlreadyCancelledError" }, { "additionalProperties": false, "description": "Returned when the meeting has no invited participants. Invite participants before cancelling the meeting.", "properties": { "data": { "description": "List of error details", "items": { "additionalProperties": false, "description": "Error detail object", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "id": { "description": "Record ID", "maxLength": 255, "type": "string" }, "reason": { "description": "The reason for the error.", "enum": [ "no_participants_invited" ], "type": "string" } }, "required": [ "reason", "id" ], "type": "object" }, "message": { "description": "A message describing the error", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NoParticipantsError" }, { "additionalProperties": false, "description": "Returned when attempting to cancel a meeting after its scheduled end time. Specify a meeting that has not passed its scheduled end time.", "properties": { "data": { "description": "List of error details", "items": { "additionalProperties": false, "description": "Error detail object", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "id": { "description": "Record ID", "maxLength": 255, "type": "string" }, "reason": { "description": "Reason for the error", "enum": [ "completed_meeting" ], "type": "string" } }, "required": [ "reason", "id" ], "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MeetingCancelledAfterEndTimeError" }, { "additionalProperties": false, "description": "Returned when the user does not have permission to perform an action on the record. Contact the system administrator.", "properties": { "data": { "description": "Contains the list of error details.", "items": { "additionalProperties": false, "description": "Error detail object", "properties": { "code": { "description": "Contains the error code.", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "type": "object" }, "message": { "description": "Contains a message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Contains the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CannotPerformactionError" }, { "additionalProperties": false, "description": "Returned when the user has reached the daily email sending limit. Cancel the meeting without sending an email, or retry the next day.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "DAILY_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details.", "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "Dailylimitreached" }, { "additionalProperties": false, "description": "The given id seems to be invalid. Specify a valid Meeting ID.", "properties": { "data": { "description": "List of error details", "items": { "additionalProperties": false, "description": "Error detail object", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "id": { "description": "The invalid record ID", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "InvalidDataRecordError" }, { "additionalProperties": false, "description": "Invalid data for a specific field. Specify valid data for the field and try again.", "properties": { "data": { "description": "List of error details", "items": { "additionalProperties": false, "description": "Error detail object", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "api_name": { "description": "Detail_field - api_name", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail_field - json_path", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "InvalidDataFieldError" }, { "additionalProperties": false, "description": "Dependent field mismatch. send_cancelling_mail must be true if cancelled_by is present.", "properties": { "data": { "description": "List of error details", "items": { "additionalProperties": false, "description": "Error detail object", "properties": { "code": { "description": "Error code", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "api_name": { "description": "Detail_field - api_name", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The field that the current field depends on", "properties": { "api_name": { "description": "Detail_field - api_name", "maxLength": 255, "type": "string" }, "json_path": { "description": "Detail_field - json_path", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Detail_field - json_path", "maxLength": 255, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DependentMismatchError" } ], "description": "One of the possible error responses for the cancel meeting operation.", "x-zs-$id": "ErrorResponse" } } }, "description": "The request failed due to an invalid request method, missing mandatory fields, invalid meeting ID, an already cancelled meeting, no participants, meeting past end time, insufficient permissions, or daily email limit exceeded." }, "401": { "content": { "application/json": { "examples": { "ForbiddenErrorResponse": { "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "The access token you have used to make this API call does not have the required scope. Generate a new access token with the required scopes for this API.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details.", "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "OAuthScopeMismatchErrorDetail" } ], "x-zs-$id": "OAuthScopeMismatchError" } } }, "description": "The access token is invalid, expired, or does not have the required scope." }, "403": { "content": { "application/json": { "examples": { "NoPermissionErrorResponse": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Events" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "permission denied. The user does not have permission to cancel the meeting. Contact your system administrator.", "properties": { "code": { "description": "Error code", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details", "properties": { "permissions": { "description": "Required permissions", "items": { "description": "Permission name", "maxLength": 255, "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "NoPermissionError" } } }, "description": "Forbidden - The user does not have permission to perform this action." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "The request URL is incorrect.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details.", "type": "object" }, "message": { "description": "A message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "The status of the response (error).", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidUrlPatternErrorDetail" } ], "x-zs-$id": "InvalidUrlPatternError" } } }, "description": "The request URL is incorrect or the resource was not found." } }, "security": [ { "OAuth2": [ "ZohoCRM.Modules.Events.UPDATE" ] } ], "summary": "Cancel a Meeting", "tags": [ "cancel_meetings" ], "x-zoho-document": "cancel_meetings", "x-zs-llm-description": "Use this API to cancel an existing meeting (Event) in Zoho CRM and optionally send a cancellation notification email to all participants. Before calling this API, you need the Event ID of the meeting you want to cancel. You can obtain the Event ID by calling the GET /Events API to list events or from the response of a previously created event. The meeting must have participants, must not already be cancelled, and must not have passed its end time.", "x-zs-llm-examples": [ { "description": "Cancel a meeting and send cancellation email to participants", "request": { "body": { "data": [ { "send_cancelling_mail": true } ] }, "method": "POST", "path": "/Events/4876876000001563018/actions/cancel" } }, { "description": "Cancel a meeting without sending cancellation email", "request": { "body": { "data": [ { "send_cancelling_mail": false } ] }, "method": "POST", "path": "/Events/4876876000001563018/actions/cancel" } } ] } }, "/crm/v8/Leads/actions/mass_convert": { "get": { "description": "To retrieve the current status and conversion counts of a previously scheduled mass convert job in your Zoho CRM organization.", "operationId": "getMassConvertJobStatus", "parameters": [ { "$ref": "#/components/parameters/MassConvertJobId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "CompletedStatus": { "description": "Shows the job status response for a completed mass convert job where some leads failed conversion.", "summary": "Example of completed mass convert job with partial conversion failures.", "value": { "data": [ { "Converted_Count": 45, "Failed_Count": 5, "Not_Converted_Count": 0, "Status": "completed", "Total_Count": 40 } ] } }, "FailedStatus": { "description": "Shows the job status response for a mass convert job that encountered a complete failure, with no leads converted.", "summary": "Example of failed mass convert job with no leads converted.", "value": { "data": [ { "Converted_Count": 0, "Failed_Count": 50, "Not_Converted_Count": 0, "Status": "failed", "Total_Count": 50 } ] } }, "InProgressStatus": { "description": "Shows the job status response for a mass convert job currently in progress, with conversion partially complete.", "summary": "Example of mass convert job currently in progress with partial conversions.", "value": { "data": [ { "Converted_Count": 25, "Failed_Count": 5, "Not_Converted_Count": 20, "Status": "in progress", "Total_Count": 50 } ] } }, "ScheduledStatus": { "description": "Shows the job status response for a mass convert job that is scheduled and awaiting execution.", "summary": "Example of scheduled mass convert job awaiting execution.", "value": { "data": [ { "Converted_Count": 0, "Failed_Count": 0, "Not_Converted_Count": 50, "Status": "scheduled", "Total_Count": 50 } ] } }, "Success": { "description": "Shows the job status response for a successfully completed mass convert job where all scheduled leads were converted.", "summary": "Example of completed mass convert job with all leads converted.", "value": { "data": [ { "Converted_Count": 50, "Failed_Count": 0, "Not_Converted_Count": 0, "Status": "Completed", "Total_Count": 50 } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for a mass convert job status request, containing a data array of job status entries.", "properties": { "data": { "description": "Represents the list of job status objects for the scheduled mass convert job. ", "items": { "additionalProperties": false, "description": "Represents a single job status entry containing conversion counts and the current processing status of the mass convert job.", "properties": { "Converted_Count": { "description": "Represents the number of leads that were successfully converted in the job. ", "format": "int32", "type": "integer" }, "Failed_Count": { "description": "Represents the number of leads for which conversion failed. ", "format": "int32", "type": "integer" }, "Not_Converted_Count": { "description": "Represents the number of leads that have not yet been converted. ", "format": "int32", "type": "integer" }, "Status": { "description": "Indicates the current processing status of the mass convert job.\nPossible values:\n**completed** - The job finished processing all scheduled leads.\n**scheduled** - The job is queued for execution.\n**in progress** - The job is currently running.\n**failed** - The job did not complete.\n", "maxLength": 50, "type": "string" }, "Total_Count": { "description": "Represents the total number of leads scheduled for conversion in the job. ", "format": "int32", "type": "integer" } }, "required": [ "Status", "Total_Count", "Converted_Count", "Not_Converted_Count", "Failed_Count" ], "type": "object" }, "maxItems": 5, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MassConvert200Response" } } }, "description": "Returns the current status and conversion counts for the specified mass convert job." }, "400": { "content": { "application/json": { "examples": { "InvalidJobId": { "description": "Shows the error response when the provided job_id value is not a valid mass convert job identifier.", "summary": "Example of invalid job_id value provided in the request.", "value": { "code": "INVALID_DATA", "details": { "param_name": "job_id" }, "message": "The jobid given seems to be invalid", "status": "error" } }, "RequiredParamMissing": { "description": "Shows the error response when the required job_id query parameter is missing from the request.", "summary": "Example of missing job_id query parameter in the request.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "json_path": "$.job_id", "param": "job_id" }, "message": "job_id is required.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents a validation error response returned when the job status request fails due to missing or invalid parameters.", "properties": { "code": { "description": "Represents the error code identifying the type of validation failure.\nPossible values:\n**REQUIRED_PARAM_MISSING** - A required parameter is missing from the request.\n**INVALID_DATA** - The provided parameter value is invalid.\n", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_DATA" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error, such as the name of the missing or invalid parameter. ", "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. ", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status category of the response.\nPossible values:\n**error** - The request encountered a validation error.\n", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassConvert400Response" } } }, "description": "The request is invalid due to a missing or invalid **job_id** parameter.\n*Resolution:** A valid **job_id** must be included in the request as a query parameter.\n" }, "403": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the error response when the requesting user lacks the required permission to retrieve the mass convert job status.", "summary": "Example of forbidden response when the user lacks mass convert permission.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Mass_Convert_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents a permission error response returned when the requesting user lacks permission to retrieve the mass convert job status.", "properties": { "code": { "description": "Represents the error code indicating a permission failure.\nPossible values:\n**NO_PERMISSION** - The user does not have permission to perform this action.\n", "enum": [ "NO_PERMISSION" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the permission error. ", "type": "object" }, "message": { "description": "Represents the error message describing the permission failure. ", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status category of the response.\nPossible values:\n**error** - The request was denied due to insufficient permissions.\n", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassConvert403Response" } } }, "description": "Permission denied to retrieve the mass convert job status.\n**Resolution:** The CRM administrator must grant the required permission to the user's profile.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.mass_convert.leads.READ" ] } ], "summary": "Get mass convert job status", "tags": [ "mass_convert" ], "x-zoho-document": "mass_convert" }, "post": { "description": "To submit a mass convert job that converts lead records into Contacts, Accounts, or Deals in your Zoho CRM organization. The job runs asynchronously and returns a job identifier for status tracking.", "operationId": "massConvert", "requestBody": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a mass convert request with two lead IDs, a Deal template, tag carry-over for three modules, related module transfer for Tasks, Events, and Calls, and attachment movement to Contacts.", "summary": "Example of mass convert request with two leads, Deal creation, tag carry-over, and related module transfer.", "value": { "Deals": { "Deal_Name": "test7000" }, "assign_to": { "id": "3652397000000281001" }, "carry_over_tags": [ { "api_name": "Contacts", "id": "3652397000000002179" }, { "api_name": "Accounts", "id": "3652397000000002180" }, { "api_name": "Deals", "id": "3652397000000002172" } ], "ids": [ "3652397000009850001", "3652397000009851001" ], "move_attachments_to": { "api_name": "Contacts", "id": "3652397000000002179" }, "related_modules": [ { "api_name": "Tasks", "id": "3652397000000002193" }, { "api_name": "Events", "id": "3652397000000002195" }, { "api_name": "Calls", "id": "3652397000000002197" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload for a mass convert operation, containing the lead IDs to convert and optional configuration fields.", "properties": { "Deals": { "additionalProperties": false, "description": "Must contain the mandatory keys \"Deal_Name\", \"Stage\", \"Closing_Date\", and \"Pipeline\"(if enabled), besides the other mandatory fields configured for the Deals module. Note that if there are layouts other than Standard, the custom-defined mandatory fields will not be processed while converting the lead.", "properties": { "Deal_Name": { "description": "Specify the name of the deal to create for the converted lead.", "maxLength": 255, "type": "string" } }, "required": [ "Deal_Name" ], "type": "object" }, "apply_assignment_threshold": { "description": "Specify whether assignment threshold rules should be applied when assigning the converted records.\nPossible values:\n**true** - Apply assignment threshold rules (default).\n**false** - Skip assignment threshold rules.\n", "type": "boolean" }, "assign_to": { "additionalProperties": false, "description": "Specify the user to assign the converted records to. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values.", "properties": { "id": { "description": "Specify the ID of the user to assign the converted records to. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } } }, "required": [ "id" ], "type": "object" }, "carry_over_tags": { "description": "The name and ID of the module you want to associate the tags to while converting the lead. For example, if you give contacts in this array, the tags of the lead will be carried over to the contact that the lead is converted to. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the ID of the module. Note that you can carry over tags to Contacts, Deals, and Accounts.", "items": { "additionalProperties": false, "description": "Each object specifies the module API name and ID for each tag to carry over to the converted record.", "properties": { "api_name": { "description": "Specify the API name of the module to carry the tags over to. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Specify the ID of the module to carry the tags over to. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 3, "type": "array" }, "ids": { "description": "The record IDs of the leads you want to convert. Use the [Get Records API](record.yaml#$.paths./{module}.get) to get the record IDs. Note that you can give a maximum of up to 50 records IDs in this array.", "items": { "description": "Each object specifies a lead record ID to include in the mass convert job.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" }, "move_attachments_to": { "additionalProperties": false, "description": "The name and ID of the module you want to move the attachments of the lead to after converting. Use the Modules API to get the ID of the module. Note that you can move the attachments to either Contacts, Deals, or Accounts.", "properties": { "api_name": { "description": "Specify the API name of the module to move the lead's attachments to. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Specify the ID of the target module to move the lead's attachments to.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } } }, "required": [ "api_name", "id" ], "type": "object" }, "portal_user_type": { "additionalProperties": false, "description": "Specify the portal user type for the contact created from the converted lead. Refer to the [Get Portal User Types](portal_user_type.yaml#$.paths./settings/portals/{portal}/user_type/users.get) resource for valid values.", "properties": { "id": { "description": "Specify the ID of the portal user type to assign to the converted contact. Refer to the [Get Portal User Types](portal_user_type.yaml#$.paths./settings/portals/{portal}/user_type/users.get) resource for valid values.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalUserTypes", "propertyId": "PortalUserTypesId" } ], "resource": "portal_user_type" } } }, "required": [ "id" ], "type": "object" }, "related_modules": { "description": "The API name and ID of the modules such as Tasks, Meetings, or Calls. If the lead has one or all of these related records, the owner of these records will be changed to the user given in the \"assign_to\" key.\nUse the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the ID of the module.", "items": { "additionalProperties": false, "description": "Each object specifies the API name and ID of a related module to include in the conversion.", "properties": { "api_name": { "description": "Specify the API name of the related module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for API name.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Specify the ID of the related module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for ID.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 3, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "description": "The request body must contain the conversion parameters, including the required **ids** array of lead record IDs and optional conversion configuration fields.", "required": true }, "responses": { "202": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the response when a mass convert job is successfully scheduled, including the job identifier.", "summary": "Example of a successful mass convert job scheduling response.", "value": { "code": "SCHEDULED", "details": { "job_id": "1234567890" }, "message": "Mass Convert scheduled successfully", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Represents the response returned when the mass convert job is successfully scheduled.", "properties": { "code": { "description": "Represents the response code indicating the job has been scheduled.\nPossible values:\n**SCHEDULED** - The mass convert job has been accepted and scheduled for execution.\n", "enum": [ "SCHEDULED" ], "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduled mass convert job, including the job identifier. ", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled mass convert job, returned for use in subsequent job status requests.", "maxLength": 255, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the message describing the outcome of the mass convert job scheduling. ", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status category of the response.\nPossible values:\n*success** - The mass convert job was scheduled successfully.\n", "enum": [ "success" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassConvert202Response" } } }, "description": "Returns confirmation that the mass convert job has been scheduled, along with a job identifier for status tracking." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "description": "Shows the error response when the api_name and ID in a related_modules entry refer to different modules.", "summary": "Example of conflicting api_name and ID in a related_modules entry.", "value": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.related_modules[0].id" }, { "api_name": "api_name", "json_path": "$.related_modules[0].api_name" } ] }, "message": "two modules are different", "status": "error" } }, "ExpectedFieldMissing": { "description": "Shows the error response when the related_modules entry is missing one or more expected fields.", "summary": "Example of missing expected field in a related_modules entry.", "value": { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.related_modules[0].id" }, { "api_name": "api_name", "json_path": "$.related_modules[0].api_name" } ] }, "message": "Specify Atleast one field", "status": "error" } }, "InvalidAssigneeData": { "description": "Shows the error response when the assign_to user data does not match any valid user.", "summary": "Example of mismatched or invalid assign_to user data.", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.assignee.id" }, "message": "Given assignee param does not match", "status": "error" } }, "InvalidDataBoolean": { "description": "Shows the error response when a non-Boolean value is provided for the apply_assignment_threshold field.", "summary": "Example of invalid apply_assignment_threshold value in the request.", "value": { "code": "INVALID_DATA", "details": { "api_name": "apply_assignment_threshold", "json_path": "$.apply_assignment_threshold" }, "message": "invalid data", "status": "error" } }, "InvalidDataType": { "description": "Shows the error response when an ids entry contains a value that is not a valid Long integer.", "summary": "Example of non-integer value in the ids array.", "value": { "code": "INVALID_DATA", "details": { "api_name": "ids", "expected_data_type": "long", "json_path": "$.ids[0]" }, "message": "invalid data", "status": "error" } }, "InvalidPortalUserType": { "description": "Shows the error response when the portal_user_type ID is invalid or does not correspond to a valid portal user type.", "summary": "Example of invalid portal_user_type ID in the request.", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.portal_user_type.id" }, "message": "invalid data", "status": "error" } }, "InvalidRecordIds": { "description": "Shows the error response when one or more values in the ids array are not valid lead record IDs.", "summary": "Example of invalid lead record ID in the ids array.", "value": { "code": "INVALID_DATA", "details": { "api_name": "ids", "json_path": "$.ids[0]" }, "message": "invalid data", "status": "error" } }, "LimitExceeded": { "description": "Shows the error response when the ids array exceeds the maximum limit of 50 lead record IDs per request.", "summary": "Example of ids array exceeds the maximum limit of 50 entries.", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 50, "limit_due_to": [ { "api_name": "ids", "json_path": "$.ids" } ] }, "message": "Limit exceeded for mass convert", "status": "error" } }, "MandatoryDealFieldMissing": { "description": "Shows the error response when the mandatory Deal_Name field is missing from the Deals object.", "summary": "Example of missing mandatory Deal_Name field in the Deals object.", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Deal_Name", "json_path": "$.Deals.Deal_Name" }, "message": "required field missing", "status": "error" } }, "MandatoryIdsMissing": { "description": "Shows the error response when the mandatory Ids field is absent from the request body.", "summary": "Example of missing mandatory ids field in the request body.", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "ids", "json_path": "$.ids" }, "message": "required field not found", "status": "error" } }, "NonSubordinateUser": { "description": "Shows the error response when the user specified in assign_to is not a subordinate of the requesting user.", "summary": "Example of non-subordinate user specified in the assign_to field.", "value": { "code": "INVALID_DATA", "details": { "api_name": "assign_to", "json_path": "$.assign_to.id" }, "message": "Non Subordinate User Found", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents a validation error response returned when the mass convert request fails due to invalid or missing data.", "properties": { "code": { "description": "Represents the error code identifying the type of validation failure.\nPossible values:\n**INVALID_REQUEST_METHOD** - The HTTP method used is not allowed for this endpoint.\n**INVALID_DATA** - The provided data is invalid.\n**REQUIRED_PARAM_MISSING** - A required parameter is missing.\n**NOT_ALLOWED** - The requested operation is not permitted.\n**MANDATORY_NOT_FOUND** - A mandatory field is missing from the request.\n**LIMIT_EXCEEDED** - The request exceeds the allowed limit.\n**EXPECTED_FIELD_MISSING** - An expected field is absent from the request.\n**AMBIGUITY_DURING_PROCESSING** - The request contains conflicting or ambiguous data.\n", "enum": [ "INVALID_REQUEST_METHOD", "INVALID_DATA", "REQUIRED_PARAM_MISSING", "NOT_ALLOWED", "MANDATORY_NOT_FOUND", "LIMIT_EXCEEDED", "EXPECTED_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the validation error, such as field names, JSON paths, expected data types, and limit values. ", "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. ", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status category of the response.\nPossible values:\n**error** - The request encountered a validation error.\n", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassConvert400ErrorResponse" } ], "description": "Represents the possible validation error responses for the mass convert operation.", "x-zs-$id": "MassConvertErrorResponse" } } }, "description": "The request failed validation due to missing required fields, invalid data, or exceeded limits.\n**Resolution:** The request body must include the required fields with valid values and must not exceed the documented limits.\n" }, "403": { "content": { "application/json": { "examples": { "Failure": { "description": "Shows the error response when the requesting user lacks the mass conversion permission.", "summary": "Example of forbidden response when the user lacks mass conversion permission.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Mass_Convert_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents a permission error response returned when the requesting user lacks permission to perform the mass conversion.", "properties": { "code": { "description": "Represents the error code indicating a permission failure.\nPossible values:\n**NO_PERMISSION** - The user does not have permission to perform this action.\n", "enum": [ "NO_PERMISSION" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the permission error. ", "type": "object" }, "message": { "description": "Represents the error message describing the permission failure. ", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status category of the response.\nPossible values:\n**error** - The request was denied due to insufficient permissions.\n", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassConvertNoPermissionResponse" } } }, "description": "Permission denied to perform the mass conversion.\n**Resolution:** The CRM administrator must grant the required permission to the user's profile.\n" }, "500": { "content": { "application/json": { "examples": { "Failure": { "description": "Shows the error response when the server encounters an unexpected internal error while processing the mass convert request.", "summary": "Example of internal server error during mass convert request.", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents a server error response returned when an unexpected error occurs during the mass convert operation.", "properties": { "code": { "description": "Represents the error code indicating a server-side failure.\nPossible values:\n**INTERNAL_ERROR** - The server encountered an unexpected error.\n", "enum": [ "INTERNAL_ERROR" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the server error, if available. ", "type": "object" }, "message": { "description": "Represents the error message describing the server failure. ", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status category of the response.\nPossible values:\n**error** - The request failed due to a server error.\n", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassConvert500Response" } } }, "description": "The server encountered an unexpected error while processing the mass convert request.\n**Resolution:** The request can be retried. If the error persists, the issue must be investigated on the server side.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.mass_convert.leads.CREATE" ] } ], "summary": "Submit mass convert job for leads", "tags": [ "mass_convert" ], "x-zoho-document": "mass_convert" } }, "/crm/v8/Leads/{leadId}/__conversion_options": { "get": { "description": "Retrieves available conversion options for a lead including matching contacts, accounts, field mappings, and layout preferences. This endpoint helps determine what conversion paths are available before performing the actual lead conversion.", "operationId": "getLeadConversionOptions", "parameters": [ { "$ref": "#/components/parameters/ConversionOptionLeadId" }, { "$ref": "#/components/parameters/ConversionOptionIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ContactMinimalFieldsResponse": { "description": "Shows a matched Contact response with a minimal field set, approval-process pending state, and no associated Account or Account field mappings.", "summary": "Contact with minimal fields and approval pending state", "value": { "__conversion_options": { "Accounts": null, "Contacts": [ { "$approval_state": "approval_process_pending", "$editable": true, "Account_Name": null, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000000000001", "name": "standard" }, "Locked__s": false, "id": "1041770000009231053" } ], "module_preference": { "api_name": "Contacts", "id": "1041770000000002179" }, "modules_with_multiple_layouts": null, "preference_field_matched_value": { "Contacts": [ { "field": { "api_name": "Full_Name", "field_label": "Full Name", "id": "1041770000000002529", "unique": null }, "matched_lead_value": "abc" } ] } } } }, "ContactWithAccountSpecialStatesResponse": { "description": "Shows a matched Contact record linked to an Account, with an approval-process pending state, GDPR stop-processing basis value, and lock status details.", "summary": "Contact with associated account, approval pending, data processing stopped, and record locked", "value": { "__conversion_options": { "Accounts": null, "Contacts": [ { "$approval_state": "approval_process_pending", "$editable": true, "Account_Name": { "Locked__s": false, "id": "111111000000055373", "name": "zoho" }, "Data_Processing_Basis": "Consent - Stop Processing", "Email": null, "Full_Name": "zoho", "Layout": { "id": "111111000000000001", "name": "standard" }, "Locked__s": true, "id": "111111000000055377" } ], "module_preference": { "api_name": "Contacts", "id": "111111000000000044" }, "modules_with_multiple_layouts": null, "preference_field_matched_value": { "Accounts": null, "Contacts": [ { "field": { "api_name": "Full_Name", "field_label": "Full Name", "id": "111111000000002478", "unique": null }, "matched_lead_value": "zoho" } ] } } } }, "ContactWithSpecialStatesResponse": { "description": "Shows a matched Contact record with a pending approval process, a GDPR stop-processing basis value, and an indicator that the record is locked.", "summary": "Contact with approval pending, data processing stopped, and record locked", "value": { "__conversion_options": { "Accounts": null, "Contacts": [ { "$approval_state": "approval_process_pending", "$editable": true, "Account_Name": null, "Data_Processing_Basis": "Consent - Stop Processing", "Email": null, "Full_Name": "zoho", "Layout": { "id": "111111000000000001", "name": "standard" }, "Locked__s": true, "id": "111111000000055377" } ], "module_preference": { "api_name": "Contacts", "id": "111111000000000044" }, "modules_with_multiple_layouts": null, "preference_field_matched_value": { "Accounts": null, "Contacts": [ { "field": { "api_name": "Full_Name", "field_label": "Full Name", "id": "111111000000002478", "unique": null }, "matched_lead_value": "zoho" } ] } } } }, "ConversionOptionsResponse": { "description": "Shows a successful response with matched Contact and Account records, including preferred module details and field-level mapping values.", "summary": "Conversion options with matched contacts and accounts", "value": { "__conversion_options": { "Accounts": [ { "$approval_state": "approved", "$editable": true, "Account_Name": "xyz", "Account_Type": null, "Locked__s": false, "Phone": null, "Website": null, "id": "1041770000009242000" } ], "Contacts": [ { "$approval_state": "approved", "$editable": true, "Account_Name": { "Locked__s": false, "id": "1041770000009242000", "name": "xyz" }, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000003952003", "name": "new" }, "Locked__s": false, "id": "1041770000009231053" } ], "module_preference": { "api_name": "Accounts", "id": "1041770000000002177" }, "modules_with_multiple_layouts": [ { "api_name": "Contacts", "id": "1041770000000002179" }, { "api_name": "Deals", "id": "1041770000000002181" } ], "preference_field_matched_value": { "Accounts": [ { "field": { "api_name": "Account_Name", "field_label": "Account Name", "id": "1041770000000002425", "unique": null }, "matched_lead_value": "xyz" } ], "Contacts": [ { "field": { "api_name": "Full_Name", "field_label": "Full Name", "id": "1041770000000002529", "unique": null }, "matched_lead_value": "abc" } ] } } } }, "MinimalOptionsResponse": { "description": "Shows a minimal response where no module preference, matched records, or field mappings are available. Only layout-related module entries are returned.", "summary": "Conversion options with only layout information available", "value": { "__conversion_options": { "Accounts": null, "Contacts": null, "module_preference": null, "modules_with_multiple_layouts": [ { "api_name": "Contacts", "id": "1041770000000002179" }, { "api_name": "Deals", "id": "1041770000000002181" } ], "preference_field_matched_value": null } } }, "MultipleContactsResponse": { "description": "Shows a response with multiple matched Contact records, no matched Account records, and Contact-specific field mapping details.", "summary": "Conversion options with multiple matching contacts but no accounts", "value": { "__conversion_options": { "Accounts": null, "Contacts": [ { "$approval_state": "approved", "$editable": true, "Account_Name": { "Locked__s": false, "id": "1041770000009242000", "name": "xyz" }, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000003952003", "name": "new" }, "Locked__s": false, "id": "1041770000009231053" }, { "$approval_state": "approved", "$editable": true, "Account_Name": null, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000003952003", "name": "new" }, "Locked__s": false, "id": "1041770000009225124" } ], "module_preference": { "api_name": "Contacts", "id": "1041770000000002179" }, "modules_with_multiple_layouts": [ { "api_name": "Contacts", "id": "1041770000000002179" }, { "api_name": "Deals", "id": "1041770000000002181" } ], "preference_field_matched_value": { "Accounts": null, "Contacts": [ { "field": { "api_name": "Full_Name", "field_label": "Full Name", "id": "1041770000000002529", "unique": null }, "matched_lead_value": "abc" } ] } } } }, "MultipleContactsSimplifiedResponse": { "description": "Shows a simplified multiple-contact response where entries have different approval states and no matched Account records.", "summary": "Multiple contacts with different approval states - simplified structure", "value": { "__conversion_options": { "Accounts": null, "Contacts": [ { "$approval_state": "approved", "$editable": true, "Account_Name": null, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000000000001", "name": "standard" }, "Locked__s": false, "id": "1041770000009243193" }, { "$approval_state": "approval_process_pending", "$editable": true, "Account_Name": null, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000000000001", "name": "standard" }, "Locked__s": false, "id": "1041770000009231053" } ], "module_preference": { "api_name": "Contacts", "id": "1041770000000002179" }, "modules_with_multiple_layouts": null, "preference_field_matched_value": { "Accounts": null, "Contacts": [ { "field": { "api_name": "Full_Name", "field_label": "Full Name", "id": "1041770000000002529", "unique": null }, "matched_lead_value": "abc" } ] } } } }, "MultipleContactsWithDifferentStatesResponse": { "description": "Shows multiple matched Contact records where approval states differ across entries, alongside shared field mapping data.", "summary": "Multiple contacts with different approval states", "value": { "__conversion_options": { "Accounts": null, "Contacts": [ { "$approval_state": "approved", "$editable": true, "Account_Name": null, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000000000001", "name": "standard" }, "Locked__s": false, "id": "1041770000009243193" }, { "$approval_state": "approval_process_pending", "$editable": true, "Account_Name": null, "Data_Processing_Basis": "null", "Email": null, "Full_Name": "abc", "Layout": { "id": "1041770000000000001", "name": "standard" }, "Locked__s": false, "id": "1041770000009231053" } ], "module_preference": { "api_name": "Contacts", "id": "1041770000000002179" }, "modules_with_multiple_layouts": null, "preference_field_matched_value": { "Accounts": null, "Contacts": [ { "field": { "api_name": "Full_Name", "field_label": "Full Name", "id": "1041770000000002529", "unique": null }, "matched_lead_value": "abc" } ] } } } }, "NoMatchingRecordsResponse": { "description": "Shows a response where no matching Contact or Account records are available and only conversion layout context is returned.", "summary": "Conversion options when no matching contacts or accounts are found", "value": { "__conversion_options": { "Accounts": null, "Contacts": null, "module_preference": null, "modules_with_multiple_layouts": [ { "api_name": "Contacts", "id": "1041770000000002179" }, { "api_name": "Deals", "id": "1041770000000002181" } ], "preference_field_matched_value": null } } } }, "schema": { "additionalProperties": false, "description": "Conversion options response containing available contacts, accounts, and field mappings for lead conversion", "properties": { "__conversion_options": { "additionalProperties": false, "description": "Container for all conversion option data", "properties": { "Accounts": { "anyOf": [ { "description": "Array of existing Account records that match the lead data", "items": { "additionalProperties": false, "description": "Account record with matching lead information", "properties": { "$approval_state": { "description": "Current approval state of the account record", "enum": [ "approved", "pending", "rejected", "approval_process_pending", "approval_process_rejected" ], "type": "string" }, "$editable": { "description": "Indicates if the account record can be edited", "type": "boolean" }, "Account_Name": { "description": "Name of the account", "maxLength": 200, "type": "string" }, "Account_Type": { "anyOf": [ { "description": "Type of the account", "maxLength": 100, "type": "string", "x-zs-$id": "AccountType" }, { "description": "No account type specified", "type": "null", "x-zs-$id": "NoAccountType" } ], "description": "Represents the account type value. Returns the account type when available, or null when the account type is not specified." }, "Locked__s": { "description": "Indicates if the account record is locked", "type": "boolean" }, "Phone": { "anyOf": [ { "description": "Phone number of the account", "maxLength": 50, "type": "string", "x-zs-$id": "AccountPhone" }, { "description": "No phone number provided", "type": "null", "x-zs-$id": "NoAccountPhone" } ], "description": "Represents the account phone value. Returns a phone number when available, or null when the account has no phone value." }, "Website": { "anyOf": [ { "description": "Website URL of the account", "maxLength": 2000, "type": "string", "x-zs-$id": "AccountWebsite" }, { "description": "No website URL provided", "type": "null", "x-zs-$id": "NoAccountWebsite" } ], "description": "Represents the account website value. Returns the website URL when available, or null when the account has no website value." }, "id": { "description": "Unique identifier of the account record (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ConversionOptionAccountsId" } }, "required": [ "Phone", "Account_Type", "Website", "Account_Name", "$editable", "Locked__s", "$approval_state", "id" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "MatchingAccountsArray" }, { "description": "No accounts found matching the lead data", "type": "null", "x-zs-$id": "NoMatchingAccounts" } ], "description": "Represents matching Account records for the lead. Returns an array when matches exist, or null when no matching accounts are found." }, "Contacts": { "anyOf": [ { "description": "Array of existing Contact records that match the lead data", "items": { "additionalProperties": false, "description": "Contact record with matching lead information", "properties": { "$approval_state": { "description": "Current approval state of the contact record", "enum": [ "approved", "pending", "rejected", "approval_process_pending", "approval_process_rejected" ], "type": "string" }, "$editable": { "description": "Indicates if the contact record can be edited", "type": "boolean" }, "Account_Name": { "anyOf": [ { "additionalProperties": false, "description": "Associated account information", "properties": { "Locked__s": { "description": "Indicates if the account record is locked", "type": "boolean" }, "id": { "description": "Unique identifier of the account (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ConversionOptionAccountNameId" }, "name": { "description": "Name of the account", "maxLength": 200, "type": "string" } }, "required": [ "id", "name", "Locked__s" ], "type": "object", "x-zs-$id": "AssociatedAccount" }, { "description": "No account associated with this contact", "type": "null", "x-zs-$id": "NoAssociatedAccount" } ], "description": "Represents the account associated with the matched contact. Returns account details when an association exists, or null when no account is linked." }, "Data_Processing_Basis": { "anyOf": [ { "description": "GDPR data processing basis for the contact", "maxLength": 100, "type": "string", "x-zs-$id": "ContactGDPRBasis" }, { "description": "No GDPR data processing basis specified", "type": "null", "x-zs-$id": "NoContactGDPRBasis" } ], "description": "Represents the GDPR data processing basis for the matched contact. Returns a basis value when configured, or null when it is not specified." }, "Email": { "anyOf": [ { "description": "Email address of the contact", "format": "email", "type": "string", "x-zs-$id": "ContactEmail" }, { "description": "No email address provided", "type": "null", "x-zs-$id": "NoContactEmail" } ], "description": "Represents the contact email value. Returns the email address when available, or null when the contact has no email value." }, "Full_Name": { "description": "Full name of the contact", "maxLength": 200, "type": "string" }, "Layout": { "additionalProperties": false, "description": "Layout information for the contact record", "properties": { "id": { "description": "Unique identifier of the layout (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ConversionOptionLayoutId" }, "name": { "description": "Name of the layout", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Locked__s": { "description": "Indicates if the contact record is locked", "type": "boolean" }, "id": { "description": "Unique identifier of the contact record (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "LeadConversionOptionsId" } }, "required": [ "Full_Name", "Email", "Locked__s", "$editable", "id", "$approval_state", "Data_Processing_Basis" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "MatchingContactsArray" }, { "description": "No contacts found matching the lead data", "type": "null", "x-zs-$id": "NoMatchingContacts" } ], "description": "Represents matching Contact records for the lead. Returns an array when matches exist, or null when no matching contacts are found." }, "module_preference": { "anyOf": [ { "additionalProperties": false, "description": "Preferred module for conversion based on system configuration", "properties": { "api_name": { "description": "API name of the preferred module", "maxLength": 100, "type": "string", "x-zs-$id": "ConversionOptionApiName" }, "id": { "description": "Unique identifier of the preferred module (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ConversionOptionId" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "PreferredModule" }, { "description": "No module preference set", "type": "null", "x-zs-$id": "NoPreferredModule" } ], "description": "Represents the preferred module selected for lead conversion. Returns the module API name and ID when a preference exists, or null when no preference is set." }, "modules_with_multiple_layouts": { "anyOf": [ { "description": "Modules that have multiple layout options available", "items": { "additionalProperties": false, "description": "Module with multiple layouts", "properties": { "api_name": { "description": "API name of the module", "maxLength": 100, "type": "string", "x-zs-$id": "LeadConversionOptionsApiName" }, "id": { "description": "Unique identifier of the module (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ConversionOptionModulesWithMultipleLayoutsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 20, "type": "array", "x-zs-$id": "ModulesWithMultipleLayoutsArray" }, { "description": "No modules have multiple layout options", "type": "null", "x-zs-$id": "MultipleMappingsArray" } ], "description": "Represents modules that provide multiple layout choices during conversion. Returns module details when available, or null when no module offers multiple layouts." }, "preference_field_matched_value": { "anyOf": [ { "additionalProperties": false, "description": "Field mappings showing how lead values match to Contact and Account fields", "properties": { "Accounts": { "anyOf": [ { "description": "Account field mappings", "items": { "additionalProperties": false, "description": "Field mapping for account", "properties": { "field": { "additionalProperties": false, "description": "Details of the field being mapped, including its API name, display label, uniqueness constraint, and ID.", "properties": { "api_name": { "description": "API name of the field", "maxLength": 100, "type": "string", "x-zs-$id": "LeadConversionOptionsApiName2" }, "field_label": { "description": "Display label of the field", "maxLength": 200, "type": "string" }, "id": { "description": "Unique identifier of the field (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "LeadConversionOptionsId2" }, "unique": { "anyOf": [ { "description": "Indicates if the field has unique constraint", "type": "boolean", "x-zs-$id": "IsAccountFieldUnique" }, { "description": "Field does not have unique constraint information", "type": "null", "x-zs-$id": "NoAccountFieldUniqueInfo" } ], "description": "Indicates whether the matched Account field has a uniqueness constraint. Returns true if the field is unique, false if it is not, or null if the uniqueness metadata is unavailable." } }, "required": [ "api_name", "id" ], "type": "object" }, "matched_lead_value": { "description": "Value from the lead that matches this field", "maxLength": 500, "type": "string" } }, "required": [ "field", "matched_lead_value" ], "type": "object" }, "maxItems": 50, "type": "array", "x-zs-$id": "AccountFieldMappingsArray" }, { "description": "No account field mappings available", "type": "null", "x-zs-$id": "NoAccountFieldMappings" } ], "description": "Represents Account field mappings for matched lead values. Returns mapping entries when Account matches exist, or null when no Account mappings are available." }, "Contacts": { "anyOf": [ { "description": "Contact field mappings", "items": { "additionalProperties": false, "description": "Field mapping for contact", "properties": { "field": { "additionalProperties": false, "description": "Details of the field being mapped, including its API name, display label, uniqueness constraint, and ID.", "properties": { "api_name": { "description": "API name of the field", "maxLength": 100, "type": "string", "x-zs-$id": "ConversionOptionFieldApiName" }, "field_label": { "description": "Display label of the field", "maxLength": 200, "type": "string" }, "id": { "description": "Unique identifier of the field (int64 as string)", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ConversionOptionFieldId" }, "unique": { "anyOf": [ { "description": "Indicates if the field has unique constraint", "type": "boolean", "x-zs-$id": "IsFieldUnique" }, { "description": "Field does not have unique constraint information", "type": "null", "x-zs-$id": "NoFieldUniqueInfo" } ], "description": "Represents whether the matched Contact field has a uniqueness constraint. Returns a Boolean when uniqueness metadata is available, or null when it is not available." } }, "required": [ "api_name", "id" ], "type": "object" }, "matched_lead_value": { "description": "Value from the lead that matches this field", "maxLength": 500, "type": "string" } }, "required": [ "field", "matched_lead_value" ], "type": "object" }, "maxItems": 50, "type": "array", "x-zs-$id": "ContactFieldMappingsArray" }, { "description": "No contact field mappings available", "type": "null", "x-zs-$id": "NoContactFieldMappings" } ], "description": "Represents Contact field mappings for matched lead values. Returns mapping entries when Contact matches exist, or null when no Contact mappings are available." } }, "type": "object", "x-zs-$id": "FieldMappings" }, { "description": "No field mappings available for conversion", "type": "null", "x-zs-$id": "NoFieldMappings" } ], "description": "Represents field-level values from the lead that match existing Contact and Account fields. Returns mapped field details when matches exist, or null when no mappings are available." } }, "required": [ "module_preference", "Contacts", "Accounts", "preference_field_matched_value", "modules_with_multiple_layouts" ], "type": "object" } }, "type": "object", "x-zs-$id": "ConversionOptionsResponse" } } }, "description": "Successfully retrieved lead conversion options. Returns available contacts, accounts, field mappings, and layout preferences for the specified lead." }, "204": { "description": "No conversion options available for this lead. The lead may not have any matching records or predefined conversion paths." }, "400": { "content": { "application/json": { "examples": { "InvalidLeadId": { "description": "Shows the error response returned when the provided Lead ID is invalid.", "summary": "Invalid lead ID provided", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the given id seems to be invalid", "status": "error" } }, "NotApprovedLead": { "description": "Shows the error response returned when the Lead record is not approved.", "summary": "Lead record is not approved", "value": { "code": "NOT_APPROVED", "details": { "resource_path_index": 1 }, "message": "record not approved", "status": "error" } }, "RecordLocked": { "description": "Shows the error response returned when the Lead record is locked because of an active merge operation.", "summary": "Lead record is locked for merging", "value": { "code": "RECORD_LOCKED", "details": { "resource_path_index": 1 }, "message": "record under merge is locked", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Standard error response for invalid data or record issues", "properties": { "code": { "description": "Error code indicating the type of failure", "enum": [ "INVALID_DATA", "NOT_APPROVED", "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including resource path information", "properties": { "resource_path_index": { "description": "Index of the resource path parameter that caused the error", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message describing the issue", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the request", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ErrorResponse" } ], "description": "Represents the error response payload returned when the lead conversion options request fails validation or encounters record state restrictions.", "x-zs-$id": "ErrorResponseSchema" } } }, "description": "Bad request due to invalid lead ID, record approval issues, or record locking conflicts." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.READ" ] } ], "summary": "Lead Conversion Options", "tags": [ "conversion_option" ], "x-zoho-document": "conversion_option" } }, "/crm/v8/Leads/{leadId}/actions/convert": { "post": { "description": "Converts a Lead record into Contact, Account, and/or Deal records. Allows configuration of conversion behavior including overwrite settings, notifications, owner assignment, and tag carryover.", "operationId": "convertLead", "parameters": [ { "$ref": "#/components/parameters/ConvertLeadId" } ], "requestBody": { "content": { "application/json": { "examples": { "BasicConversion": { "description": "Shows a request payload that converts a lead to a contact without creating a deal.", "summary": "Basic lead conversion to Contact only", "value": { "data": [ { "notify_lead_owner": true, "notify_new_entity_owner": false, "overwrite": false } ] } }, "ConversionWithDeal": { "description": "Shows a request payload that converts a lead and creates a deal with pipeline details.", "summary": "Lead conversion with Deal creation", "value": { "data": [ { "Deals": { "Amount": 50000, "Closing_Date": "2025-12-31", "Deal_Name": "Enterprise Package Deal", "Pipeline": "Standard (Standard)", "Probability": 60, "Stage": "Qualification" }, "notify_lead_owner": true, "notify_new_entity_owner": true, "overwrite": false } ] } } }, "schema": { "$ref": "#/components/schemas/ConversionRequestWrapper" }, "x-zs-llm-examples": [ "BasicConversion", "ConversionWithDeal" ] } }, "description": "Lead conversion configuration including optional Deal creation, owner assignment, notification preferences, and tag carryover settings.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "FullConversion": { "description": "Shows a successful conversion response that returns contact, account, and deal references.", "summary": "Complete lead conversion with Contact, Deal, and Account", "value": { "data": [ { "code": "SUCCESS", "details": { "Accounts": { "id": "1643514000006145040", "name": "Acme Corp" }, "Contacts": { "id": "1643514000006145045", "name": "John Doe" }, "Deals": { "id": "1643514000006145051", "name": "Enterprise Deal" } }, "message": "The record has been converted successfully", "status": "success" } ] } }, "SuccessfulConversion": { "description": "Shows a successful conversion response that returns only the converted contact reference.", "summary": "Successful lead conversion with Contact only", "value": { "data": [ { "code": "SUCCESS", "details": { "Accounts": null, "Contacts": { "id": "1643514000006142991", "name": "John Doe" }, "Deals": null }, "message": "The record has been converted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ConversionSuccessWrapper" } } }, "description": "Lead successfully converted. Returns details of created Contact, Account, and Deal records with their IDs and names." }, "202": { "content": { "application/json": { "examples": { "ScheduledConversion": { "description": "Shows a scheduled conversion response with a job ID for asynchronous processing.", "summary": "Lead conversion scheduled successfully", "value": { "data": [ { "code": "SCHEDULED", "details": { "job_id": "1643514000006145007" }, "message": "Convert lead scheduled successfully", "status": "success" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ConversionScheduledWrapper" }, { "$ref": "#/components/schemas/ValidationErrorWrapper" } ], "description": "Represents the response payload for scheduled conversion processing or validation-level errors.", "x-zs-$id": "Convert202Response" } } }, "description": "Lead conversion request accepted and scheduled for processing, or contains validation errors." }, "400": { "content": { "application/json": { "examples": { "AlreadyConverted": { "description": "Shows an error response returned when the specified lead has already been converted.", "summary": "Lead already converted", "value": { "code": "ID_ALREADY_CONVERTED", "details": { "resource_path_index": 1 }, "message": "id already converted", "status": "error" } }, "NonSubordinateUser": { "description": "Returned when a user tries to convert a Lead and assign the resulting records to a non-subordinate user. This error is triggered under two permission settings: 1) 'List subordinates only' (role hierarchy) - For example, if User2 (Manager role) has this permission enabled, they can only assign ownership to their subordinates (e.g., User3, User4) based on the role hierarchy, not to users above them (e.g., User1 with CEO role). 2) 'Territories and Sub-Territory Users Only' (territory hierarchy) - For example, given a territory structure: Root Territory → Territory A (User1, User2) → Territory B (User3, User4), and Root Territory → Territory C (User5, User6), if the current user (User1) belongs to Territory A, only users from Territory A (User1, User2) and its sub-territory Territory B (User3, User4) can be assigned as the new owner. Assigning a user from a non-subordinate territory such as Territory C (User5, User6) will trigger this error.", "summary": "Non subordinate user assigned as record owner", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Owner", "json_path": "$.data[0].Owner" }, "message": "Non Subordinate User Found", "status": "error" } ] } }, "PipelineStageMismatch": { "description": "Shows an error response returned when the specified stage does not belong to the selected pipeline.", "summary": "Pipeline doesn't contain the specified Stage", "value": { "data": [ { "code": "MAPPING_MISMATCH", "details": { "api_name": "Stage", "json_path": "$.data[0].Stage", "mapped_field": "Pipeline" }, "message": "Pipeline doesn't contain the Stage", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ValidationErrorWrapper" }, { "$ref": "#/components/schemas/ConvertErrorResponse" } ], "description": "Represents the response payload for invalid input or request-level conversion errors.", "x-zs-$id": "Convert400Response" } } }, "description": "Bad request due to invalid input data, malformed request, or attempting to convert an already converted Lead." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CREATE" ] } ], "summary": "Convert a Lead", "tags": [ "convert" ], "x-zoho-document": "convert" } }, "/crm/v8/Notes": { "delete": { "description": "Permanently deletes one or more notes using comma-separated note IDs.", "operationId": "deleteNotesModule", "parameters": [ { "$ref": "#/components/parameters/NotesIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "BulkDeletion": { "summary": "Multiple notes successfully deleted", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4876876000006021002" }, "message": "record deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "4876876000006021003" }, "message": "record deleted", "status": "success" } ] } }, "SuccessfulDeletion": { "summary": "Note successfully deleted", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4876876000006021002" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for note deletion", "properties": { "data": { "description": "Array of deletion results", "items": { "additionalProperties": false, "description": "Individual note deletion result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Deleted note details", "properties": { "id": { "description": "Unique identifier of the deleted note", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotesDeleteSuccessResponse" } } }, "description": "Success - Note(s) successfully deleted" }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "summary": "Partial success - some notes deleted, some failed", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "111111000000116001" }, "message": "record deleted", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "111111000000116002" }, "message": "record not deleted", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Multi-status response for note deletion with mixed results", "properties": { "data": { "description": "Array of deletion results with mixed success and error statuses", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful note deletion result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Deleted note details", "properties": { "id": { "description": "Unique identifier of the deleted note", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "DeleteNoteSuccessResult" }, { "additionalProperties": false, "description": "Failed note deletion result", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Error details", "properties": { "id": { "description": "Unique identifier of the note that failed to delete", "format": "int64", "type": "string" } }, "type": "object" }, "message": { "description": "Error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "DeleteNoteErrorResult" } ] }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteNotesMultiStatusResponse207" } } }, "description": "Multi-Status - Partial success with some records deleted and some failed" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotesRequiredParamMissingError" }, { "$ref": "#/components/schemas/NotesInvalidDataError" } ], "x-zs-$id": "DeleteNotesBadRequestError" } } }, "description": "Bad Request - Invalid parameters or missing required parameter" }, "401": { "$ref": "#/components/responses/NotesUnauthorized" }, "404": { "$ref": "#/components/responses/NotesNotFound" }, "500": { "$ref": "#/components/responses/NotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.notes.DELETE" ] } ], "summary": "Notes", "tags": [ "notes" ], "x-zoho-document": "notes", "x-zs-llm-description": "Deletes multiple notes by ids query parameter. Use this for batch cleanup and inspect 207 responses to handle mixed success per note id." }, "get": { "description": "Retrieves a list of notes.", "operationId": "getNotesModule", "parameters": [ { "$ref": "#/components/parameters/NotesFields" }, { "$ref": "#/components/parameters/NotesIds" }, { "$ref": "#/components/parameters/NotesPerPage" }, { "$ref": "#/components/parameters/NotesPage" }, { "$ref": "#/components/parameters/NotesPageToken" }, { "$ref": "#/components/parameters/NotesSortOrder" }, { "$ref": "#/components/parameters/NotesSortBy" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Successful notes retrieval", "value": { "data": [ { "$attachments": [ { "$file_id": "2rsp48b6960fb9f4d444dada8740791775f35", "File_Name": "20251117_194524.jpg", "Size": "1623514", "id": "1043386000020248003" } ], "Created_Time": "2025-11-14T11:54:12+05:30", "Modified_Time": "2025-11-19T19:27:53+05:30", "Note_Content": "sdf", "Note_Title": null, "Owner": { "email": "prasanna.saravanan@zohocorp.com", "id": "1043386000000322001", "name": "Prasanna" }, "Parent_Id": { "id": "1043386000019763257", "module": { "api_name": "Leads", "id": "1043386000000002175" }, "name": "a" }, "id": "1043386000020244003" } ], "info": { "count": 1, "more_records": false, "next_page_token": null, "page": 1, "page_token_expiry": null, "per_page": 200, "previous_page_token": null, "sort_by": "Created_Time", "sort_order": "asc" } } } }, "schema": { "additionalProperties": false, "description": "Response containing note data and pagination information", "properties": { "data": { "description": "Array of note records", "items": { "additionalProperties": true, "description": "A note record with static fields and dynamic additional properties", "properties": { "$attachments": { "description": "Attachments associated with the note", "items": { "additionalProperties": true, "description": "Attachment file details", "properties": { "$file_id": { "description": "Unique file identifier for the attachment", "maxLength": 255, "type": "string" }, "File_Name": { "description": "Name of the attached file", "maxLength": 255, "type": "string" }, "Size": { "description": "File size in bytes", "format": "int64", "type": "string" }, "id": { "description": "Unique identifier of the attachment record", "format": "int64", "type": "string" } }, "type": "object" }, "maxItems": 5, "type": [ "array", "null" ] }, "Note_Content": { "description": "The content/body of the note", "maxLength": 65535, "type": [ "string", "null" ] }, "Note_Title": { "description": "The title of the note", "maxLength": 120, "type": [ "string", "null" ] }, "Parent_Id": { "additionalProperties": false, "description": "Parent record information", "properties": { "id": { "description": "Unique identifier of the parent record", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Module information of the parent record", "properties": { "api_name": { "description": "API name of the parent module", "maxLength": 50, "type": "string" }, "id": { "description": "Module ID", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Name of the parent record", "maxLength": 255, "type": "string" } }, "required": [ "module", "id", "name" ], "type": "object" }, "id": { "description": "Unique identifier of the note", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Pagination metadata", "properties": { "count": { "description": "Number of records in current page", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates if more records are available", "type": "boolean" }, "next_page_token": { "description": "Token for retrieving the next page of note records.", "maxLength": 2000, "type": [ "string", "null" ] }, "page": { "description": "Current page number", "format": "int32", "type": "integer" }, "page_token_expiry": { "description": "Expiry time of page tokens", "format": "date-time", "type": [ "string", "null" ] }, "per_page": { "description": "Number of records per page", "format": "int32", "type": "integer" }, "previous_page_token": { "description": "Token for retrieving the previous page of note records.", "maxLength": 2000, "type": [ "string", "null" ] }, "sort_by": { "description": "Field by which the results are sorted", "maxLength": 50, "type": "string" }, "sort_order": { "description": "Sort order of the results", "enum": [ "asc", "desc" ], "type": "string" } }, "required": [ "page", "per_page", "count", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "NotesGetResponse" } } }, "description": "Successful response with note records" }, "204": { "$ref": "#/components/responses/NotesNoContent" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotesRequiredParamMissingError" }, { "$ref": "#/components/schemas/NotesDiscretePaginationLimitExceededError" }, { "$ref": "#/components/schemas/ExpiredValueError" } ], "x-zs-$id": "GetNotesBadRequestError" } } }, "description": "Bad Request - Invalid parameters or malformed request" }, "401": { "$ref": "#/components/responses/NotesUnauthorized" }, "404": { "$ref": "#/components/responses/NotesNotFound" }, "500": { "$ref": "#/components/responses/NotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.notes.READ" ] } ], "summary": "Notes", "tags": [ "notes" ], "x-zoho-document": "notes", "x-zs-llm-description": "Lists note records across modules and supports pagination, sorting, and field filtering. Use this to discover note ids before calling get-by-id, update, or delete operations." }, "post": { "description": "Creates one or more note records.", "operationId": "createNotesModule", "requestBody": { "content": { "application/json": { "examples": { "CreateNote": { "summary": "Create a note for a lead", "value": { "data": [ { "Note_Content": "Need to do further tracking", "Note_Title": "Contacted", "Parent_Id": { "id": "4876876000005996165", "module": { "api_name": "Leads", "id": "4876876000000002175" } } } ] } } }, "schema": { "additionalProperties": false, "description": "Request payload for creating notes", "properties": { "data": { "description": "Array of note objects to create", "items": { "additionalProperties": true, "description": "Note object with title, content, and parent information", "properties": { "Note_Content": { "description": "The content/body of the note", "maxLength": 65535, "type": [ "string", "null" ] }, "Note_Title": { "description": "The title of the note", "maxLength": 120, "type": [ "string", "null" ] }, "Parent_Id": { "additionalProperties": false, "description": "Parent record information", "properties": { "id": { "description": "Unique identifier of the parent record", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Module information of the parent record", "properties": { "api_name": { "description": "API name of the parent module", "maxLength": 50, "type": "string" }, "id": { "description": "Module ID", "format": "int64", "type": "string" } }, "type": "object" } }, "required": [ "module", "id" ], "type": "object" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object" }, "x-zs-llm-examples": [ "CreateNote" ] } }, "description": "Request body containing note data to create", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessfulCreation": { "summary": "Note successfully created", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:07+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T16:45:07+05:30", "id": "4876876000006021002" }, "message": "record added", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for note creation", "properties": { "data": { "description": "Array of creation results", "items": { "additionalProperties": false, "description": "Individual note creation result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Created note details", "properties": { "Created_By": { "additionalProperties": false, "description": "User who created the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 120, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Timestamp recording note creation", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "User who last modified the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Timestamp when the note was last modified", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the created note", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotesPostSuccessResponse" } } }, "description": "Created - Note(s) successfully created" }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "summary": "Partial success - some notes created, some failed", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Created_Time": "2026-01-05T14:27:48+05:30", "Modified_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Modified_Time": "2026-01-05T14:27:48+05:30", "id": "111111000000116018" }, "message": "record added", "status": "success" }, { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "Note_Content", "json_path": "$.data[1].Note_Content" }, { "api_name": "Note_Title", "json_path": "$.data[1].Note_Title" } ] }, "message": "should contain either content or title", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Multi-status response for note creation with mixed results", "properties": { "data": { "description": "Array of creation results with mixed success and error statuses", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful note creation result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Created note details", "properties": { "Created_By": { "additionalProperties": false, "description": "User who created the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Timestamp recording note creation", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "User who last modified the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Timestamp when the note was last modified", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the created note", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateNoteSuccessResult" }, { "additionalProperties": false, "description": "Failed note creation result", "properties": { "code": { "description": "Error code", "enum": [ "EXPECTED_FIELD_MISSING", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Error details", "type": "object" }, "message": { "description": "Error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateNoteErrorResult" } ] }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CreateNotesMultiStatusResponse207" } } }, "description": "Multi-Status - Partial success with some records created and some failed" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotesExpectedFieldMissingError" }, { "$ref": "#/components/schemas/NotesInvalidDataError" }, { "$ref": "#/components/schemas/InvalidDataLimitExceededError" }, { "$ref": "#/components/schemas/NotesNotAllowedError" }, { "$ref": "#/components/schemas/NotesFileSizeExceedsError" } ], "x-zs-$id": "NotesPostErrorResponse" } } }, "description": "Bad Request - Invalid parameters or malformed request" }, "401": { "$ref": "#/components/responses/NotesUnauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotesNoPermissionError" } } }, "description": "Forbidden - User lacks required permissions" }, "404": { "$ref": "#/components/responses/NotesNotFound" }, "500": { "$ref": "#/components/responses/NotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.notes.CREATE" ] } ], "summary": "Create Notes", "tags": [ "notes" ], "x-zoho-document": "notes", "x-zs-llm-description": "Creates one or more standalone note records. For each item, provide at least one of Note_Content or Note_Title, and include Parent_Id when the note should be attached to a specific CRM record." }, "put": { "description": "Updates one or more existing note records. Either note content or note title must be provided (at least one is mandatory) for each note.", "operationId": "updateNotesModule", "requestBody": { "content": { "application/json": { "examples": { "UpdateMultipleNotes": { "summary": "Update multiple notes", "value": { "data": [ { "Note_Content": "Customer requested additional information", "Note_Title": "Follow-up Completed", "id": "4876876000006021002" }, { "Note_Content": "Discussed project requirements", "Note_Title": "Meeting Notes", "id": "4876876000006021003" } ] } } }, "schema": { "additionalProperties": false, "description": "Request payload for updating notes", "properties": { "data": { "description": "Array of note objects to update", "items": { "additionalProperties": true, "description": "Note object with an ID, title, and/or content to update.", "properties": { "Note_Content": { "description": "The content/body of the note", "maxLength": 65535, "type": [ "string", "null" ] }, "Note_Title": { "description": "The title of the note", "maxLength": 120, "type": [ "string", "null" ] }, "id": { "description": "Unique identifier of the note to update", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateMultipleNotes" ] } }, "description": "Request body containing note data to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpdate": { "summary": "Notes successfully updated", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:07+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T17:30:15+05:30", "id": "4876876000006021002" }, "message": "record updated", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:08+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T17:30:16+05:30", "id": "4876876000006021003" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for note update", "properties": { "data": { "description": "Array of update results", "items": { "additionalProperties": false, "description": "Individual note update result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Updated note details", "properties": { "Created_By": { "additionalProperties": false, "description": "User who created the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Timestamp recording note creation", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "User who last modified the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Timestamp when the note was last modified", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the updated note", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotesUpdateSuccessResponse" } } }, "description": "Success - Note(s) successfully updated" }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "summary": "Partial success - some notes updated, some failed", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Created_Time": "2026-01-05T14:27:48+05:30", "Modified_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Modified_Time": "2026-01-05T14:27:48+05:30", "id": "111111000000116018" }, "message": "record updated", "status": "success" }, { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "Note_Content", "json_path": "$.data[1].Note_Content" }, { "api_name": "Note_Title", "json_path": "$.data[1].Note_Title" } ] }, "message": "should contain either content or title", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Multi-status response for note update with mixed results", "properties": { "data": { "description": "Array of update results with mixed success and error statuses", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful note update result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Updated note details", "properties": { "Created_By": { "additionalProperties": false, "description": "User who created the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Timestamp recording note creation", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "User who last modified the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Timestamp when the note was last modified", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the updated note", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateNoteSuccessResult" }, { "additionalProperties": false, "description": "Failed note update result", "properties": { "code": { "description": "Error code", "enum": [ "EXPECTED_FIELD_MISSING", "MANDATORY_NOT_FOUND", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Error details", "type": "object" }, "message": { "description": "Error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateNoteErrorResult" } ] }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UpdateNotesMultiStatusResponse207" } } }, "description": "Multi-Status - Partial success with some records updated and some failed" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotesExpectedFieldMissingError" }, { "$ref": "#/components/schemas/NotesMandatoryNotFoundError" }, { "$ref": "#/components/schemas/NotesInvalidDataError" }, { "$ref": "#/components/schemas/InvalidDataLimitExceededError" }, { "$ref": "#/components/schemas/NotesNotAllowedError" }, { "$ref": "#/components/schemas/NotesCannotPerformActionError" } ], "x-zs-$id": "NotesUpdateErrorResponse" } } }, "description": "Bad Request - Invalid parameters or malformed request" }, "401": { "$ref": "#/components/responses/NotesUnauthorized" }, "404": { "$ref": "#/components/responses/NotesNotFound" }, "500": { "$ref": "#/components/responses/NotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.notes.UPDATE" ] } ], "summary": "Update Notes", "tags": [ "notes" ], "x-zoho-document": "notes", "x-zs-llm-description": "Bulk-updates existing notes by id. Each item must include id and at least one editable note field such as Note_Content or Note_Title. Prefer this endpoint when updating multiple notes in one request." } }, "/crm/v8/Notes/{id}": { "delete": { "description": "Permanently deletes a specific note by its ID.", "operationId": "deleteNoteById", "parameters": [ { "$ref": "#/components/parameters/NotesId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDeletion": { "summary": "Note successfully deleted", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4876876000006021002" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for note deletion", "properties": { "data": { "description": "Array of deletion results", "items": { "additionalProperties": false, "description": "Individual note deletion result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Deleted note details", "properties": { "id": { "description": "Unique identifier of the deleted note", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotesDeleteByIdSuccessResponse" } } }, "description": "Success - Note successfully deleted" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataErrorSingle" }, { "$ref": "#/components/schemas/NotesInvalidIdError" } ], "x-zs-$id": "NotesDeleteByIdErrorResponse" } } }, "description": "Bad Request - Invalid data" }, "401": { "$ref": "#/components/responses/NotesUnauthorized" }, "404": { "$ref": "#/components/responses/NotesNotFound" }, "500": { "$ref": "#/components/responses/NotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.notes.DELETE" ] } ], "summary": "Delete a Specific Note", "tags": [ "notes" ], "x-zoho-document": "notes", "x-zs-llm-description": "Deletes one note by path id. Use this for a single known target; for deleting multiple notes, use the module-level bulk delete endpoint with ids query parameter." }, "get": { "description": "Retrieves details of a specific note by its ID.", "operationId": "getNoteById", "parameters": [ { "$ref": "#/components/parameters/NotesId" }, { "$ref": "#/components/parameters/NotesFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Successful note retrieval", "value": { "data": [ { "$attachments": [ { "$file_id": "2rsp48b6960fb9f4d444dada8740791775f35", "File_Name": "20251117_194524.jpg", "Size": "1623514", "id": "1043386000020248003" } ], "Created_Time": "2025-11-14T11:54:12+05:30", "Modified_Time": "2025-11-19T19:27:53+05:30", "Note_Content": "sdf", "Note_Title": null, "Owner": { "email": "prasanna.saravanan@zohocorp.com", "id": "1043386000000322001", "name": "Prasanna" }, "Parent_Id": { "id": "1043386000019763257", "module": { "api_name": "Leads", "id": "1043386000000002175" }, "name": "a" }, "id": "1043386000020244003" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing a single note", "properties": { "data": { "description": "Array containing the single requested note", "items": { "additionalProperties": true, "description": "A note record with static fields and dynamic additional properties", "properties": { "$attachments": { "description": "Attachments associated with the note", "items": { "additionalProperties": true, "description": "Attachment file details", "properties": { "$file_id": { "description": "Unique file identifier for the attachment", "maxLength": 255, "type": "string" }, "File_Name": { "description": "Name of the attached file", "maxLength": 255, "type": "string" }, "Size": { "description": "File size in bytes", "format": "int64", "type": "string" }, "id": { "description": "Unique identifier of the attachment record", "format": "int64", "type": "string" } }, "type": "object" }, "maxItems": 5, "type": [ "array", "null" ] }, "Note_Content": { "description": "The content/body of the note", "maxLength": 65535, "type": "string" }, "Note_Title": { "description": "The title of the note", "maxLength": 120, "type": [ "string", "null" ] }, "Parent_Id": { "additionalProperties": false, "description": "Parent record information", "properties": { "id": { "description": "Unique identifier of the parent record", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Module information of the parent record", "properties": { "api_name": { "description": "API name of the parent module", "maxLength": 50, "type": "string" }, "id": { "description": "Module ID", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Name of the parent record", "maxLength": 255, "type": "string" } }, "required": [ "module", "id", "name" ], "type": "object" }, "id": { "description": "Unique identifier of the note", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotesGetByIdSuccessResponse" } } }, "description": "Successfully retrieved the note" }, "204": { "$ref": "#/components/responses/NotesNoContent" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotesRequiredParamMissingError" } } }, "description": "Bad Request - Invalid parameters or malformed request" }, "401": { "$ref": "#/components/responses/NotesUnauthorized" }, "404": { "$ref": "#/components/responses/NotesNotFound" }, "500": { "$ref": "#/components/responses/NotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.notes.READ" ] } ], "summary": "Get a Specific Note", "tags": [ "notes" ], "x-zoho-document": "notes", "x-zs-llm-description": "Fetches a single note by id and optional fields filter. Use this before update or delete calls to confirm the exact target note and available data." }, "put": { "description": "Updates a specific note by its ID. Either note content or note title must be provided (at least one is mandatory).", "operationId": "updateNoteById", "parameters": [ { "$ref": "#/components/parameters/NotesId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateNote": { "summary": "Update a note's content and title", "value": { "data": [ { "Note_Content": "Customer requested additional information", "Note_Title": "Follow-up Completed" } ] } } }, "schema": { "additionalProperties": false, "description": "Request payload for updating a note", "properties": { "data": { "description": "Array containing the note to update (single item only)", "items": { "additionalProperties": true, "description": "Note object with title and/or content to update", "properties": { "Note_Content": { "description": "The content/body of the note", "maxLength": 65535, "type": [ "string", "null" ] }, "Note_Title": { "description": "The title of the note", "maxLength": 120, "type": [ "string", "null" ] } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateNote" ] } }, "description": "Request body containing note data to update", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpdate": { "summary": "Note successfully updated", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:07+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T17:30:15+05:30", "id": "4876876000006021002" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for note update", "properties": { "data": { "description": "Array of update results", "items": { "additionalProperties": false, "description": "Individual note update result", "properties": { "code": { "description": "Result code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Updated note details", "properties": { "Created_By": { "additionalProperties": false, "description": "User who created the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Timestamp recording note creation", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "User who last modified the note", "properties": { "id": { "description": "Unique identifier of the user", "format": "int64", "type": "string" }, "name": { "description": "Name of the user", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Timestamp when the note was last modified", "format": "date-time", "type": "string" }, "id": { "description": "Unique identifier of the updated note", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Result message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "NotesUpdateByIdSuccessResponse" } } }, "description": "Success - Note successfully updated" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedFieldMissingErrorSingle" }, { "$ref": "#/components/schemas/InvalidDataErrorSingle" }, { "$ref": "#/components/schemas/NotesInvalidIdError" }, { "$ref": "#/components/schemas/NotesNotAllowedErrorSingle" }, { "$ref": "#/components/schemas/NotesCannotPerformActionErrorSingle" } ], "x-zs-$id": "NotesUpdateByIdErrorResponse" } } }, "description": "Bad Request - Invalid parameters or malformed request" }, "401": { "$ref": "#/components/responses/NotesUnauthorized" }, "404": { "$ref": "#/components/responses/NotesNotFound" }, "500": { "$ref": "#/components/responses/NotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.notes.UPDATE" ] } ], "summary": "Update a Specific Note", "tags": [ "notes" ], "x-zoho-document": "notes", "x-zs-llm-description": "Updates one note identified by path id. Provide at least one of Note_Content or Note_Title in the request body. Use this for single-note edits where bulk update is unnecessary." } }, "/crm/v8/Services__s": { "delete": { "description": "To delete one or more service records from your Zoho CRM organization. All appointments associated with the deleted services are also deleted; however, deals created upon completion of those appointments are not deleted.", "operationId": "deleteServicesS", "parameters": [ { "$ref": "#/components/parameters/ServicesParamQueryIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Represents a successful single-record delete response from the DELETE operation. The data array contains one entry with code=SUCCESS, the deleted service ID under `details.id`, message=\"record deleted\", and status=\"success\".", "summary": "Single service record deleted successfully", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4671651000000867047" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteservicessResponse200" } } }, "description": "Returns the result of a single-record service delete operation. The response body contains a `data` array with one entry that includes the status code `SUCCESS`, the deleted record ID, a confirmation message, and the operation status." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Represents a multi-status response from the DELETE /Services__s endpoint when a batch delete yields mixed results. The data array contains one entry with code=SUCCESS indicating a successfully deleted record and one entry with code=INVALID_DATA indicating a record that could not be deleted.", "summary": "Mixed batch delete when one record deleted, one fails with INVALID_DATA", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "4671651000010893004" }, "error_meta": "invalid_field", "message": "record not deleted", "status": "error" }, { "code": "SUCCESS", "details": { "id": "4671651000000950132" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped multi-status response for a batch service delete operation. Contains a `data` array (2–200 items) with one entry per service record in the request; each entry independently indicates success or failure for that record.", "properties": { "data": { "description": "Represents the per-record status array in the multi-status response. Contains between 2 and 200 entries, each independently indicating success or failure for the corresponding service ID supplied in the `ids` query parameter.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/ServicesPost207multistatusResponse207" }, { "$ref": "#/components/schemas/InvalidDataMultiStatusError" } ], "description": "Represents one entry in the multi-status data array, indicating success or failure for the corresponding service record." }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteservicessResponse207" } } }, "description": "Returns a multi-status response. Each item in the array independently indicates success or failure for the corresponding service ID in the ids query parameter." }, "400": { "content": { "application/json": { "examples": { "InternalErrorResponse1": { "description": "Represents an error response from the DELETE operation when an internal server error occurs during processing. The payload carries code=INTERNAL_ERROR, message='internal server error', and status='error'.", "summary": "Delete request fails due to an internal server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } }, "InvalidDataResponse1": { "description": "Represents an error response from the DELETE operation when the provided service ID is incorrect or refers to an already-deleted record. The payload carries code=INVALID_DATA, the offending ID under `details.id`, message='record not deleted', and status='error'.", "summary": "Delete fails with INVALID_DATA where service ID is incorrect or already deleted", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "record not deleted", "status": "error" } }, "InvalidModuleResponse1": { "description": "Represents an error response from the DELETE operation when the module name in the request URL is invalid. The payload carries code=INVALID_MODULE, details.resource_path_index=0, message='the module name given seems to be invalid', and status='error'.", "summary": "Delete fails with INVALID_MODULE when module name in the request URL is invalid", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "RequiredParamMissingResponse1": { "description": "Error response returned when the `ids` query parameter is omitted from the DELETE /Services__s request. Including the `ids` query parameter with at least one valid service record ID resolves this error.", "summary": "Required parameter missing when ids query parameter absent from DELETE request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotDeletedError" }, { "$ref": "#/components/schemas/ServicesInvalidModuleNameError" }, { "$ref": "#/components/schemas/RequiredParamMissingForDeleteError" }, { "$ref": "#/components/schemas/DataError" } ], "description": "Bad-request error response for the delete services operation. Returned when the module name is invalid, the `ids` parameter is missing, or one or more service records could not be deleted. The response body conforms to one of: `RecordNotDeletedError`, `InvalidModuleNameError`, `RequiredParamMissingForDeleteError`, or `DataError`.", "x-zs-$id": "DeleteservicessError400" } } }, "description": "Returned when the service ID is invalid or already deleted, the `ids` query parameter is missing, or the module name is unrecognized.\n\n**Resolution:** A valid service record ID must be supplied in the `ids` query parameter. The module name must match a recognized API name before retrying the request." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.services.DELETE" ] } ], "summary": "Delete one or more service records", "tags": [ "services" ], "x-zoho-document": "services" }, "get": { "description": "To retrieve the list of service records in your Zoho CRM organization that match the specified filter criteria. Supports pagination using either the **page** or **page_token** parameter and can return up to 100,000 services across paginated requests.\n", "operationId": "getServicesS", "parameters": [ { "$ref": "#/components/parameters/ServicesFields" }, { "$ref": "#/components/parameters/ServicesCvid" }, { "$ref": "#/components/parameters/ServicesPageToken" }, { "$ref": "#/components/parameters/ServicesPage" }, { "$ref": "#/components/parameters/ServicesPerPage" }, { "$ref": "#/components/parameters/ServicesSortOrder" }, { "$ref": "#/components/parameters/ServicesSortBy" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a success response for the Get Services endpoint, with a data array containing four service records (Bike Service, Car Service, AC Repair, Wall Painting) and an info object with pagination metadata.\n", "summary": "Successful response listing four service records", "value": { "data": [ { "$currency_symbol": "£", "$data_source_details": {}, "$editable": true, "$field_states": null, "$has_more": { "Members": false }, "$photo_id": null, "$sharing_permission": "full_access", "$status": "cmv_1-1", "Availability_Type": "Specific Date Range", "Available_Dates": [], "Available_Days": [], "Available_From": "2026-01-13", "Available_Till": "2026-01-15", "Available_Timings": [ { "From": "09:00", "To": "16:30" } ], "Created_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-13T10:51:09+04:00", "Description": null, "Duration": 30, "Job_Sheet_Required": "No", "Job_Sheet_Section__s": null, "Last_Activity_Time": "2026-01-13T15:08:50+04:00", "Location": "Business Address", "Members": [ { "Members": { "id": "111115000000122075", "module": "Users", "name": "madesh" }, "id": "111115000000127292" }, { "Members": { "id": "111115000000058229", "module": "Users", "name": "madesh04" }, "id": "111115000000127291" } ], "Modified_By": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-13T15:08:50+04:00", "Owner": { "email": "madeshwaran.g+csez04@zohotest.com", "id": "111115000000058229", "name": "madesh04" }, "Price": 34, "Record_Image": null, "Record_Status__s": "Available", "Service_Name": "service00", "Status": "Available", "Tag": [], "Tax": [], "Unavailable_From": null, "Unavailable_Till": null, "id": "111115000000127290" } ] } } }, "schema": { "$ref": "#/components/schemas/GetservicessResponse200" } } }, "description": "Returns the list of service records matching the specified filter criteria, up to 200 records per page. Each record includes the full set of service fields. \n\nThe response also contains an **info** object with pagination details such as **per_page**, **page**, **more_records**, and **sort_order**.\n" }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse1": { "description": "Shows an error Request error response returned when an invalid module name is provided in the request URL, including the INVALID_MODULE error code and a message indicating that only Services__s is a valid module name.\n", "summary": "An error response for an invalid module name\n", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "RequiredParamMissingResponse1": { "description": "Shows a Bad Request error response returned when a required query parameter is absent from the request, including the REQUIRED_PARAM_MISSING error code and details.\n", "summary": "Anexample of error response for a missing required parameter\n", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ServicesInvalidModuleNameError" }, { "$ref": "#/components/schemas/ServicesRequiredParamMissingError" } ], "description": "Contains the error response for a 400 Bad Request on the Get Services endpoint. The schema is one of `InvalidModuleNameError` or `RequiredParamMissingError`, depending on the type of validation failure.\n", "x-zs-$id": "GetservicessError400" } } }, "description": "The request could not be processed because the module name in the URL is invalid or a required query parameter is missing.\n\n**Resolution:** The module API name in the request URL must reference a valid module, and the required query parameters must be included in the request." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.services.READ" ] } ], "summary": "Get services", "tags": [ "services" ], "x-zoho-document": "services" }, "post": { "description": "To create one or more service records in your Zoho CRM organization, submitting up to 100 service objects per request, each configurable with a name, duration, price, location, members, availability type, and availability window.", "operationId": "createServicesS", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a complete service create request for a 60-minute AC Repair service with specific-day availability on Monday and Tuesday, client-address location, an available status, and a job-sheet requirement referencing the Standard job sheet section.", "summary": "Successful creation of a service with specific-day availability and job-sheet configuration", "value": { "data": [ { "$zia_owner_assignment": "owner_recommendation_unavailable", "Availability_Type": "Every Business Days", "Available_From": null, "Available_Till": null, "Duration": 60, "Layout": { "id": "111115000000070573" }, "Location": "Client Address", "Members": [ { "Members": { "id": "111115000000058229", "name": "madesh04" } } ], "Owner": { "full_name": "madesh04", "id": "111115000000058229", "name": "madesh04" }, "Price": 434, "Service_Name": "firstService", "zia_suggested_users": {} }, { "$zia_owner_assignment": "owner_recommendation_unavailable", "Availability_Type": "Specific Date Range", "Available_From": "2026-01-10", "Available_Till": "2026-01-16", "Duration": 30, "Layout": { "id": "111115000000070573" }, "Location": "Business Address and Client Address", "Members": [ { "Members": { "id": "111115000000058229", "name": "madesh04" } } ], "Owner": { "full_name": "madesh04", "id": "111115000000058229", "name": "madesh04" }, "Price": 343, "Service_Name": "secondService", "zia_suggested_users": {} }, { "$zia_owner_assignment": "owner_recommendation_unavailable", "Availability_Type": "Specific Date(s)", "Available_Dates": [ "2026-01-13", "2026-01-14", "2026-01-15" ], "Available_From": null, "Available_Till": null, "Available_Timings": [ { "From": "01:00", "To": "04:00" }, { "From": "06:00", "To": "08:00" } ], "Duration": 30, "Layout": { "id": "111115000000070573" }, "Location": "Client Address", "Members": [ { "Members": { "id": "111115000000058229", "name": "madesh04" } } ], "Owner": { "full_name": "madesh04", "id": "111115000000058229", "name": "madesh04" }, "Price": 666, "Service_Name": "thirdService", "zia_suggested_users": {} }, { "$zia_owner_assignment": "owner_recommendation_unavailable", "Availability_Type": "Specific Day(s)", "Available_Days": [ "Tuesday", "Wednesday", "Thursday", "Friday" ], "Available_From": null, "Available_Till": null, "Duration": 30, "Layout": { "id": "111115000000070573" }, "Location": "Business Address", "Members": [ { "Members": { "id": "111115000000058229", "name": "madesh04" } } ], "Owner": { "full_name": "madesh04", "id": "111115000000058229", "name": "madesh04" }, "Price": 3848, "Service_Name": "fourthService", "zia_suggested_users": {} }, { "$zia_owner_assignment": "owner_recommendation_unavailable", "Availability_Type": "Specific Date Range", "Available_From": "2026-01-02", "Available_Till": "2026-01-22", "Available_Timings": [ { "From": "00:00", "To": "06:00" }, { "From": "07:00", "To": "14:00" } ], "Description": "service description", "Duration": 60, "Job_Sheet_Required": "Yes", "Layout": { "id": "111115000000070573" }, "Location": "Business Address", "Members": [ { "Members": { "id": "111115000000058229", "name": "madesh04" } } ], "Owner": { "full_name": "madesh04", "id": "111115000000058229", "name": "madesh04" }, "Price": 777, "Service_Name": "fifthService", "Tax": [ { "id": null, "value": "Sales Tax - 0.0 %" }, { "id": null, "value": "Vat - 0.0 %" } ], "zia_suggested_users": {} } ], "skip_mandatory": false } } }, "schema": { "$ref": "#/components/schemas/PostservicessRequest" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain a data array. You can include a maximum of 100 objects per request." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Shows the success response returned after the API creates a single service record successfully, including the new record ID, creation and modification timestamps, and the identities of the users who created and last modified the record.", "summary": "Successful single-record service creation returning a 201 with new record ID and audit metadata.", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-12T11:03:03+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-12T11:03:03+04:00", "id": "111115000000121665" }, "message": "record added", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "111115000000058229", "name": "madesh04" }, "Created_Time": "2026-01-12T11:25:46+04:00", "Modified_By": { "id": "111115000000058229", "name": "madesh04" }, "Modified_Time": "2026-01-12T11:25:46+04:00", "id": "111115000000121687" }, "message": "record added", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostservicessResponse201" } } }, "description": "Returns a data array confirming the successful creation of each service record. Each item contains the success code, the ID assigned to the created record, and audit metadata including the creation and last-modified timestamps and the users who performed those actions." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Shows the multi-status response returned when a batch request partially succeeds: the API creates the first record and assigns a new ID, while rejecting the second record with an INVALID_DATA error indicating that the Duration value falls outside the permitted range.", "summary": "Partial batch success with one record created and one rejected due to an invalid Duration value.", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "generated_id_0" }, "message": "Proper success message", "status": "success" }, { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "data", "json_path": "$.data[0].data" }, "error_meta": "mandatory_missing", "message": "Mandatory field data not found", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response returned when some service records were created successfully and others encountered errors. Contains a data array with one entry per service record submitted in the request; each entry independently indicates success or failure for its corresponding record.", "properties": { "data": { "description": "Contains one entry per service record submitted in the request, indicating success or failure for the corresponding record.", "items": { "anyOf": [ { "$ref": "#/components/schemas/ServicesPost207multistatusResponse207" }, { "$ref": "#/components/schemas/MandatoryFieldNotFoundMultiStatusError" } ], "description": "Represents one entry in the multi-status data array. Each item is either a success object containing the created record's ID and audit metadata, or an error object describing the validation failure for the corresponding service record." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostservicessResponse207" } } }, "description": "Returns a multi-status response when the submitted service records yield mixed outcomes. Each item in the data array independently indicates success or failure for its corresponding record. Successful operation include the created record's ID and audit metadata, while failed items include the error code and a description of the validation failure." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows a DEPENDENT_FIELD_MISSING error response triggered when the Availability_Type field is provided but its required dependent field, Available_From, is omitted from the request payload.", "summary": "DEPENDENT_FIELD_MISSING error when Available_From is omitted despite Availability_Type being set.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Unavailable_From", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_From" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows a DEPENDENT_FIELD_MISSING error response triggered when the Status field is provided but its required dependent field, Unavailable_From, is absent from the request payload.", "summary": "Dependent field missing error when Unavailable_From is absent for Status.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Shows the DEPENDENT_MISMATCH error returned when the Available_Days values do not align with the business days defined by the Availability_Type field. The API rejects the request with a DEPENDENT_MISMATCH error indicating that Available_Days must be a subset of the configured business days.", "summary": "Dependent mismatch error when Available_Days conflict with business days.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Days", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Days" }, "message": "The given Available Days are not there in business days", "status": "error" } ] } }, "DependentMismatchResponse10": { "description": "Shows the DEPENDENT_MISMATCH error returned when Unavailable_From is set while the service Status is Available, violating the dependency rule that requires Unavailable_From to be null or specified alone without Unavailable_Till.", "summary": "Dependent mismatch when Unavailable_From is invalid for Available status.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Status" }, "message": "When the service status is available, Unavailable From must be greater than current date", "status": "error" } ] } }, "DependentMismatchResponse11": { "description": "Shows the DEPENDENT_MISMATCH error returned when the supplied Unavailable_Till value does not exceed the current server time, violating the temporal constraint imposed by the Status dependency. The API rejects the request indicating that Unavailable_Till must be set to a future datetime.", "summary": "Dependent mismatch error when Unavailable_Till is not a future datetime.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be greater than current Time.", "status": "error" } ] } }, "DependentMismatchResponse12": { "description": "Shows the DEPENDENT_MISMATCH error returned when both Unavailable_From and Unavailable_Till are provided while Status is Available, which violates the rule requiring both fields to be null or only Unavailable_From to carry a value.", "summary": "Dependent mismatch when both unavailability fields are set for Available status.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_Till", "json_path": "$.data[0].Unavailable_Till" }, "json_path": "$.data[0].Status" }, "message": "When the service status is available, either both Unavailable From and Unavailable Till must be null, or only Unavailable From can have a value.", "status": "error" } ] } }, "DependentMismatchResponse13": { "description": "Shows the DEPENDENT_MISMATCH error returned when the Unavailable_Till value is not chronologically later than Unavailable_From, violating the ordering constraint imposed by the Status dependency. The API rejects the request requiring Unavailable_Till to be set after Unavailable_From.", "summary": "Dependent mismatch where Unavailable_Till is not earlier than Unavailable_From.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be lesser than Unavailable From", "status": "error" } ] } }, "DependentMismatchResponse14": { "description": "Shows the DEPENDENT_MISMATCH error returned when a service record is submitted with a Status of Not In Use while Unavailable_From is set to a future date. The API rejects the request because a future unavailability start date is incompatible with the Not In Use status.", "summary": "Dependent mismatch when Not In Use status conflicts with a future Unavailable_From date.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Status" }, "message": "Services status cannot be marked as Not In Use when Unavailable From falls after the current Date", "status": "error" } ] } }, "DependentMismatchResponse15": { "description": "Shows the DEPENDENT_MISMATCH error returned when the Available_From field is set to a date that precedes the current date. The API rejects the request because the service availability start date must not fall before the current date.", "summary": "Dependent mismatch when Available_From precedes the current date.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Status" }, "message": "Starting date of service availability falls before the current Date, so service cannot be marked as Scheduled", "status": "error" } ] } }, "DependentMismatchResponse16": { "description": "Shows the DEPENDENT_MISMATCH error returned when Available_Till is set to a past date while the service Status is Available, Scheduled, or Temporarily Unavailable. \n\nThe API rejects the request because an expired availability end date is incompatible with those active status values.", "summary": "Dependent mismatch when a past Available_Till conflicts with an active service status.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Available_Till", "json_path": "$.data[0].Available_Till" }, "json_path": "$.data[0].Status" }, "message": "End Date of service availability falls before the current Date, so service cannot be marked as Available or Scheduled or Temporarily Unavailable", "status": "error" } ] } }, "DependentMismatchResponse17": { "description": "Shows the DEPENDENT_MISMATCH error returned when a status of Not In Use or Temporarily Unavailable is requested for a service that has future appointments scheduled. \n\nThe API rejects the request because a service with upcoming bookings must retain a status compatible with active scheduling.", "summary": "Dependent mismatch when a scheduled service is set to Not In Use or Temporarily Unavailable.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Service status cannot be marked as Not In Use or Temporarily Unavailable for scheduled services.", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Shows the DEPENDENT_MISMATCH error returned when the service's Available_Timings fall outside the configured business hours while the Status is Available. \n\nThe API rejects the request because the service availability window must align with the organisation's business timing configuration.", "summary": "Dependent mismatch where Available_Timings value does not satisfy business timing constraints.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "To", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Timings[0].To" }, "message": "Service available time does not satisfy the business timing", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Shows an error returned when the service Duration does not fall within the configured available timings. The API responds with code DEPENDENT_MISMATCH, identifying Duration as the field whose value conflicts with the Status-driven timing requirement.", "summary": "Dependent mismatch where Duration does not fit within the configured service timing window.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Duration", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Duration" }, "message": "Duration does not satisfy the service timing", "status": "error" } ] } }, "DependentMismatchResponse7": { "description": "Shows an error returned when Job_Sheet_Section__s is supplied but Job_Sheet_Required is set to No. The API responds with code DEPENDENT_MISMATCH, indicating that Job_Sheet_Section__s may only carry a value when its controlling field Job_Sheet_Required is set to Yes.", "summary": "Dependent mismatch where Job_Sheet_Section__s is set but Job_Sheet_Required is No.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Job_Sheet_Section__s", "dependee": { "api_name": "Job_Sheet_Required", "json_path": "$.data[0].Job_Sheet_Required" }, "json_path": "$.data[0].Job_Sheet_Section__s" }, "message": "Job_Sheet_Section__s can have value only when value of Job_Sheet_Required is Yes", "status": "error" } ] } }, "DependentMismatchResponse8": { "description": "Shows an error returned when the To time in an Available_Timings window is not later than the corresponding From time. The API responds with code DEPENDENT_MISMATCH, identifying the To field as invalid because a valid availability window requires To to be strictly greater than From.", "summary": "Dependent mismatch where the Available_Timings To value is not greater than the From value.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Till", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Available_Till" }, "message": "To value must be Greater than From value", "status": "error" } ] } }, "DependentMismatchResponse9": { "description": "Shows an error returned when one or more dates provided in Available_Dates fall on a holiday or outside configured business days. The API responds with code DEPENDENT_MISMATCH, indicating that all Available_Dates values must correspond to valid, non-holiday business days.", "summary": "Dependent mismatch where Available_Dates includes a holiday or non-business day.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Dates", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Dates" }, "message": "Available Dates value in holiday or Not in BusinessDays", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows an error returned when the value supplied for Availability_Type is not a recognised picklist option. The API responds with code INVALID_DATA, identifying the field and indicating that only predefined picklist values are accepted.", "summary": "Availability_Type value rejected as not a valid picklist entry.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Availability_Type", "json_path": "$.data[0].Availability_Type" }, "message": "The given Availability Type is not in picklist", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows an INVALID_DATA error returned when the Owner field value submitted to the Services endpoint exceeds the maximum allowed field length. The response identifies the Owner field as the source of the invalid data.", "summary": "Owner field value exceeds the maximum allowed field length.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Owner", "json_path": "$.data[*].Owner", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an INVALID_DATA error returned when the Unavailable_From time submitted to the Services endpoint falls outside the configured availability window for the service. The response identifies the Unavailable_From field as the source of the scheduling conflict.", "summary": "Unavailable_From time falls outside the service availability window.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "message": "Unavailable From time does not fall within service availability", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an INVALID_DATA error returned for a service record that contains invalid field data. This example represents a minimal error response where no specific error code is present in the payload.", "summary": "Invalid data error returned with no specific error code in the payload.", "value": { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.data", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse13": { "description": "Shows an INVALID_DATA error returned when the Status field receives a value of an incorrect data type instead of the expected text type. The response identifies the Status field and specifies that the expected data type is text.", "summary": "Status field rejected due to incorrect data type instead of expected text.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Status", "expected_data_type": "text", "json_path": "$.data[*].Status" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an INVALID_DATA error returned when the Status field value exceeds the maximum allowed length of 120 characters. The response identifies the Status field as the source of the length violation.", "summary": "Status value exceeds maximum allowed length.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Status", "json_path": "$.data[*].Status", "maximum_length": 120 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows the INVALID_DATA error returned when the Unavailable_Till field contains a value not in the supported picklist. The accepted values are Temporarily Unavailable, Available, Not In Use, and Scheduled.", "summary": "Unavailable_Till contains an unsupported picklist value.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Unavailable_Till", "json_path": "$.data[*].Unavailable_Till", "supported_values": [ "Temporarily Unavailable", "Available", "Not In Use", "Scheduled" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows the INVALID_DATA error returned when the Job_Sheet_Required field receives a value of an incorrect data type instead of the expected text type. The API rejects the request with an invalid data type message.", "summary": "Job_Sheet_Required receives an invalid data type.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Job_Sheet_Required", "expected_data_type": "text", "json_path": "$.data[*].Job_Sheet_Required" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows the INVALID_DATA error returned when the Job_Sheet_Required field contains a value that exceeds the maximum allowed length of three characters. The API rejects the request with an invalid data message.", "summary": "Job_Sheet_Required value exceeds the maximum allowed length.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Job_Sheet_Required", "json_path": "$.data[*].Job_Sheet_Required", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows the INVALID_DATA error returned when the Available_Dates field contains a value that does not conform to the required YYYY-MM-DD date format. The API rejects the request with an invalid data message.", "summary": "Available_Dates contains a value in an invalid date format.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Available_Dates", "expected_data_type": "date", "json_path": "$.data[0].Available_Dates" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows the INVALID_DATA error returned when the Duration field contains a value outside the permitted range of five minutes to 24 hours. The API rejects the request with a message indicating the duration constraint violation.", "summary": "Invalid data when duration value is outside allowed range.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Duration", "json_path": "$.data[0].Duration" }, "message": "Duration value should not be greater than 24hrs or less than 5mins", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Returned when the Unavailable_From time does not fall within the configured service availability window. The API rejects the request with an INVALID_DATA error indicating the time value is out of range.", "summary": "Invalid data when Unavailable_From time is outside service availability.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "message": "Unavailable From time does not fall within service availability", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Returned when a custom time value supplied in the To field of Available_Timings is not a valid time. The API rejects the request with an INVALID_DATA error targeting the offending entry in the availability timings array.", "summary": "Invalid data when custom time value in Available_Timings is invalid.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "To", "json_path": "$.data[0].Available_Timings" }, "message": " The given custom time is invalid", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Returned when a user specified in the Members array has not confirmed their account. The API rejects the request with an INVALID_DATA error and identifies the unconfirmed member's ID in the response.", "summary": "Invalid data when member has not confirmed their account.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Members[0].Members.id", "user_status": "unconfirmed" }, "message": "Members is not Confirmed", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Returned when a user specified in the Members array has an inactive status. The API rejects the request with an INVALID_DATA error because only active users may be associated with a service.", "summary": "Invalid data when member is inactive.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Members[0].Members.id", "user_status": "inactive" }, "message": "Members is not Active", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Returned when the Owner field receives a value of an incorrect data type; the API expects a JSON object but received an incompatible type. The request is rejected with an INVALID_DATA error identifying the Owner field.", "summary": "Invalid data when Owner field received wrong data type.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Owner", "expected_data_type": "jsonobject", "json_path": "$.data[*].Owner" }, "message": "Invalid data type", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Returned when the Members array contains more than 100 users, exceeding the per-service member limit. The API rejects the request with a LIMIT_EXCEEDED error on the Members field.", "summary": "Limit exceeded when Members array exceeds 100-user maximum.", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Members", "json_path": "$.data[0].Members", "limit": 100 }, "message": "More than 100 users cannot be associated", "status": "error" } ] } }, "LimitExceededResponse2": { "description": "Returned when the organization has already reached the maximum of 500 active services and a new service with an active status is submitted. The API rejects the request with a LIMIT_EXCEEDED error on the Status field.", "summary": "Limit exceeded when organization has reached 500 active services.", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Status", "json_path": "$.data[0].Status", "limit": 3 }, "message": "You cannot create more than 500 active services", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Returned when the required Members field is absent from the request payload. The API rejects the request with a MANDATORY_NOT_FOUND error identifying Members as the missing required field.", "summary": "Mandatory not found when required Members field is missing", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Members", "json_path": "$.data[0].Members" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Returned when the required Location field is absent from the request payload. The API rejects the request with a MANDATORY_NOT_FOUND error identifying Location as the missing required field.", "summary": "Mandatory not found when required Location field is missing.", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Location", "json_path": "$.data[*].Location" }, "message": "Required field is missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Returned when Job_Sheet_Required is set to Yes but job sheets have not been enabled in the organization's service preferences. The API rejects the request with a NOT_ALLOWED error on the Job_Sheet_Required field.", "summary": "Not allowed when job sheets not configured in service preferences.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Job_Sheet_Required", "json_path": "$.data[0].Job_Sheet_Required" }, "message": "Job Sheet is not configured in services preferences", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "additionalProperties": false, "description": "Represents the wrapped error response returned when one or more service records in the request fail per-record validation. Contains a data array where each item describes the specific validation failure for the corresponding service record.", "properties": { "data": { "description": "Contains one error entry for each service record in the request that failed validation, describing the specific reason the record was rejected.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataTypeGenericError" }, { "$ref": "#/components/schemas/InvalidDataForFieldError" }, { "$ref": "#/components/schemas/ServicesDuplicateDataError" }, { "$ref": "#/components/schemas/ServicesMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableFromFutureError" }, { "$ref": "#/components/schemas/ServiceUnavailableTillFutureError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableWindowRuleError" }, { "$ref": "#/components/schemas/UnavailableWindowOrderError" }, { "$ref": "#/components/schemas/NotInUseStatusWithFutureUnavailableFromError" }, { "$ref": "#/components/schemas/ScheduledStatusPastStartDateError" }, { "$ref": "#/components/schemas/PastEndDateStatusConflictError" }, { "$ref": "#/components/schemas/UnavailableFromTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/UnavailableTillTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/InvalidRequestPayloadError" }, { "$ref": "#/components/schemas/InvalidAvailabilityTypeNotInPicklistError" }, { "$ref": "#/components/schemas/AvailableDaysNotInBusinessDaysError" }, { "$ref": "#/components/schemas/ServiceTimeNotInBusinessTimingError" }, { "$ref": "#/components/schemas/ServicesInvalidDataGenericError" }, { "$ref": "#/components/schemas/InvalidDurationRangeError" }, { "$ref": "#/components/schemas/JobSheetNotConfiguredError" }, { "$ref": "#/components/schemas/DurationNotSatisfyServiceTimingError" }, { "$ref": "#/components/schemas/RequiredFieldNotFoundError" }, { "$ref": "#/components/schemas/ServicesDependentFieldMissingError" }, { "$ref": "#/components/schemas/MembersAssociationLimitExceededError" }, { "$ref": "#/components/schemas/ActiveServicesLimitExceededError" }, { "$ref": "#/components/schemas/JobSheetSectionDependentMismatchError" }, { "$ref": "#/components/schemas/ToValueMustBeGreaterThanFromError" }, { "$ref": "#/components/schemas/AvailableDatesInHolidayOrNonBusinessDayError" }, { "$ref": "#/components/schemas/InvalidCustomTimeError" }, { "$ref": "#/components/schemas/MembersNotConfirmedError" }, { "$ref": "#/components/schemas/MembersNotActiveError" }, { "$ref": "#/components/schemas/ScheduledServiceStatusRestrictionError" } ], "description": "Represents a single validation error for a rejected service record. Each item identifies the affected field, the error code, and a descriptive message explaining why the record failed. For example, an invalid data type, a missing mandatory field, an unavailable status, or a dependent field mismatch." }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostservicessError400Wrapper" }, { "$ref": "#/components/schemas/InvalidDataTypeForDataFieldError" } ], "description": "Represents the bad-request error response returned when the request payload or query parameters fail validation. Contains one of several error structures depending on whether the failure is a top-level data-type error, a per-record validation error, or an invalid value for a data field.", "x-zs-$id": "PostservicessError400" } } }, "description": "The request could not be processed because one or more service records contain invalid data, fail a field-level validation check, or violate a service-availability constraint.\n\n**Resolution:** The caller must inspect each error item to identify the offending field, correct the request payload accordingly, and resubmit the request." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.services.CREATE" ] } ], "summary": "Create service records in Zoho CRM", "tags": [ "services" ], "x-zoho-document": "services" }, "put": { "description": "To update one or more existing service records in your Zoho CRM organization. Each request can include up to 100 service objects identified by their record IDs; only the fields supplied in the payload are modified.", "operationId": "updateServicesS", "parameters": [ { "$ref": "#/components/parameters/ParamQueryAffectedData" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Represents a PUT request body updating two service records with different availability configurations. One record uses Specific Day(s) availability with a limited date range and a 30-minute duration, while the other demonstrates an alternative availability type alongside status, pricing, and member assignment fields.\n", "summary": "Update two services with mixed availability types and date range constraints.\n", "value": { "data": [ { "Availability_Type": "Specific Day(s)", "Available_Dates": [], "Available_Days": [ "Monday", "Tuesday", "Wednesday" ], "Available_From": "2026-01-13", "Available_Till": "2026-01-13", "Available_Timings": null, "Description": null, "Duration": 30, "Job_Sheet_Required": "No", "Job_Sheet_Section__s": null, "Location": "Business Address", "Members": [ { "Members": { "id": "4671651000000635001", "module": "Users", "name": "Madeshwaran G" }, "id": "4671651000000862031" } ], "Owner": { "email": "madeshwaran.g@zohocorp.com", "id": "4671651000000635001", "name": "Madeshwaran G" }, "Price": 3993, "Record_Image": null, "Service_Name": "service99", "Status": "Not in Use", "Tag": [], "Tax": [], "Unavailable_From": "2026-01-13T15:40:03+05:30", "Unavailable_Till": null, "id": "4671651000000862030" }, { "Availability_Type": "Specific Date Range", "Available_Dates": [], "Available_Days": [], "Available_From": "2026-01-01", "Available_Till": "2026-01-29", "Available_Timings": null, "Description": null, "Duration": 120, "Job_Sheet_Required": "No", "Job_Sheet_Section__s": null, "Location": "Business Address", "Members": [ { "Members": { "id": "4671651000000635001", "module": "Users", "name": "Madeshwaran G" }, "id": "4671651000000867005" } ], "Owner": { "email": "madeshwaran.g@zohocorp.com", "id": "4671651000000635001", "name": "Madeshwaran G" }, "Price": 44, "Record_Image": null, "Service_Name": "dd", "Status": "Not in Use", "Tag": [], "Tax": [], "Unavailable_From": "2026-01-14T12:20:35+05:30", "Unavailable_Till": null, "id": "4671651000000867004" } ] } } }, "schema": { "$ref": "#/components/schemas/PutservicessBulkRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain a data array of service objects to be updated. You can include a maximum of 100 service objects per request.\n" }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Represents a fully successful response in which all submitted service records were updated without error. Each item in the data array carries a SUCCESS code, full audit metadata (creation and modification timestamps with actor details), the record ID, and an affected_data entry indicating no automation flow was triggered.\n", "summary": "All service records updated successfully with audit metadata and affected_data.\n", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Created_Time": "2025-12-16T17:04:11+05:30", "Modified_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Modified_Time": "2026-01-14T16:57:16+05:30", "affected_data": [ { "$process_flow": false, "id": "4671651000000862030" } ], "id": "4671651000000862030" }, "message": "record updated", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Created_Time": "2025-12-17T12:20:24+05:30", "Modified_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Modified_Time": "2026-01-14T16:57:16+05:30", "affected_data": [ { "$process_flow": false, "id": "4671651000000867004" } ], "id": "4671651000000867004" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PutservicessResponse200" } } }, "description": "Returns a per-record status array. Each item contains the success code, the persisted record ID, the audit metadata, and the affected_data block for a service record that was successfully updated.\n" }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Represents a partial-success response where one service record updated successfully while a second record failed validation. The failing record returns an INVALID_DATA error identifying the Duration field, indicating the supplied value falls outside the permitted range of five minutes to 24 hours.\n", "summary": "Partial success with one record updated and one INVALID_DATA error on Duration.\n", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Created_Time": "2025-12-16T17:04:11+05:30", "Modified_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Modified_Time": "2026-01-14T17:25:57+05:30", "affected_data": [ { "$process_flow": false, "id": "4671651000000862030" } ], "id": "4671651000000862030" }, "message": "record updated", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "Duration", "json_path": "$.data[1].Duration" }, "error_meta": "invalid_field", "message": "Duration value should not be greater than 24hrs or less than 5mins", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped multi-status response. Contains a data array with one entry for each service record in the request, where each entry independently indicates success or failure.\n", "properties": { "data": { "description": "Represents the per-record status array in the multi-status response. Contains one entry for each service record in the request, where each entry independently indicates success or failure for that record.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/ServicesPost207multistatusResponse207" }, { "$ref": "#/components/schemas/DataError" } ], "description": "Represents one entry in the multi-status data array. Each item is either a success entry carrying the result code, message, status, and details for the corresponding service record, or an error entry containing the error code, message, status, and a details block identifying the offending field.\n" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutservicessResponse207" } } }, "description": "Returns a multi-status response. Each item in the data array independently indicates success or failure for the corresponding service record in the request body.\n" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Represents an error response in which a required dependent field was omitted from the request. The error identifies Unavailable_From as the missing field, with Status acting as its dependee, indicating that Unavailable_From must be provided whenever the service status implies unavailability.\n", "summary": "DEPENDENT_FIELD_MISSING error when Unavailable_From is absent and Status is its dependee.\n", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Unavailable_From", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_From" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Represents an error response in which Available_From was omitted while Availability_Type was set to Specific Date Range. The error identifies Availability_Type as the dependee, indicating that a start date must be supplied whenever a date-range availability type is selected.\n", "summary": "An error when Available_From missing when Availability_Type is Specific Date Range\n", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Represents an error response returned when the provided Available_Days values fall outside the configured business days. This DEPENDENT_MISMATCH error is triggered because the Available_Days field depends on the Status field for valid values.\n", "summary": "An error when Available_Days values not within configured business days.\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Days", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Days" }, "message": "The given Available Days are not there in business days", "status": "error" } ] } }, "DependentMismatchResponse10": { "description": "Represents an error response returned when the service status is set to Available but the Unavailable_From field violates the null constraint.\n\nThis DEPENDENT_MISMATCH error requires that when status is Available, either both Unavailable_From and Unavailable_Till are null, or only Unavailable_From may carry a value.\n", "summary": "An error when Unavailable_From violates null rule when status is Available.\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Status" }, "message": "When the service status is available, Unavailable From must be greater than current date", "status": "error" } ] } }, "DependentMismatchResponse11": { "description": "Represents an error response returned when Unavailable_Till is not set to a datetime greater than the current time. \n\nThis DEPENDENT_MISMATCH error is triggered when status is Temporarily Unavailable and the supplied Unavailable_Till value fails the future-datetime constraint.\n", "summary": "An error when Unavailable_Till not greater than current time\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be greater than current Time.", "status": "error" } ] } }, "DependentMismatchResponse12": { "description": "Represents an error response returned when status is Available but only one of Unavailable_From or Unavailable_Till is supplied. This DEPENDENT_MISMATCH error enforces that when status is Available, either both fields are null or only Unavailable_From may carry a value.\n", "summary": "An error when invalid Unavailable_Till supplied when status is Available\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_Till", "json_path": "$.data[0].Unavailable_Till" }, "json_path": "$.data[0].Status" }, "message": "When the service status is available, either both Unavailable From and Unavailable Till must be null, or only Unavailable From can have a value.", "status": "error" } ] } }, "DependentMismatchResponse13": { "description": "Represents an error response returned when the supplied Unavailable_Till value is not less than Unavailable_From. This DEPENDENT_MISMATCH error enforces the chronological ordering constraint between the two unavailability boundary fields.\n", "summary": "Dependent mismatch when Unavailable Till must be before Unavailable From\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be lesser than Unavailable From", "status": "error" } ] } }, "DependentMismatchResponse14": { "description": "Illustrates a DEPENDENT_MISMATCH error returned when the Available_From date falls before the current date. A service with a past start date cannot be set to a status of Available, Scheduled, or Temporarily Unavailable.\n", "summary": "Dependent mismatch when past Available_From blocks Available/Scheduled status\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Service status cannot be marked as Not In Use or Temporarily Unavailable for scheduled services.", "status": "error" } ] } }, "DependentMismatchResponse15": { "description": "Illustrates a DEPENDENT_MISMATCH error returned when the Available_Till date falls before the current date. A service with a past end date cannot be set to a status of Available, Scheduled, or Temporarily Unavailable.\n", "summary": "Dependent mismatch when past Available_Till blocks Available/Scheduled status\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Status" }, "message": "Services status cannot be marked as Not In Use when Unavailable From falls after the current Date", "status": "error" } ] } }, "DependentMismatchResponse16": { "description": "Illustrates a DEPENDENT_MISMATCH error returned when the Available_From date falls before the current date. A service with a past start date cannot be marked as Scheduled.\n", "summary": "Dependent mismatch when past Available_From prevents Scheduled status\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Status" }, "message": "Starting date of service availability falls before the current Date, so service cannot be marked as Scheduled", "status": "error" } ] } }, "DependentMismatchResponse17": { "description": "Illustrates a DEPENDENT_MISMATCH error returned when the Available_Till date falls before the current date. A service with a past end date cannot be set to a status of Available, Scheduled, or Temporarily Unavailable.\n", "summary": "Dependent mismatch when past Available_Till blocks Available/Scheduled/Temp Unavailable\n", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Available_Till", "json_path": "$.data[0].Available_Till" }, "json_path": "$.data[0].Status" }, "message": "End Date of service availability falls before the current Date, so service cannot be marked as Available or Scheduled or Temporarily Unavailable", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Illustrates a DEPENDENT_MISMATCH error returned when the To time in Available_Timings does not satisfy the configured business timing. The service available time slot must fall within the defined business hours.\n", "summary": "Dependent mismatch when Available_Timings To value fails business timing", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "To", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Timings[0].To" }, "message": "Service available time does not satisfy the business timing", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Returned when the Duration field does not satisfy the service timing constraint imposed by the Status dependee. The response includes code DEPENDENT_MISMATCH and identifies Duration as the offending field.", "summary": "Dependent mismatch when Duration does not satisfy service timing", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Duration", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Duration" }, "message": "Duration does not satisfy the service timing", "status": "error" } ] } }, "DependentMismatchResponse7": { "description": "Returned when Job_Sheet_Section__s is provided but Job_Sheet_Required is not set to Yes. The response includes code DEPENDENT_MISMATCH and identifies Job_Sheet_Section__s as the field that cannot hold a value under this condition.", "summary": "Dependent mismatch when Job_Sheet_Section__s requires Job_Sheet_Required is Yes", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Job_Sheet_Section__s", "dependee": { "api_name": "Job_Sheet_Required", "json_path": "$.data[0].Job_Sheet_Required" }, "json_path": "$.data[0].Job_Sheet_Section__s" }, "message": "Job_Sheet_Section__s can have value only when value of Job_Sheet_Required is Yes", "status": "error" } ] } }, "DependentMismatchResponse8": { "description": "Returned when the To time in Available_Timings is not greater than the corresponding From time. The response includes code DEPENDENT_MISMATCH with the json_path $.data[0].Available_Timings[0].To identifying the offending value.", "summary": "Dependent mismatch when Available_Timings To must be greater than From.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Till", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Available_Till" }, "message": "To value must be Greater than From value", "status": "error" } ] } }, "DependentMismatchResponse9": { "description": "Returned when an Available_Dates value falls on a holiday or a non-business day. The response includes code DEPENDENT_MISMATCH with Status as the dependee field driving the constraint.", "summary": "Dependent mismatch when Available_Dates falls on a holiday or non-business day.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Dates", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Dates" }, "message": "Available Dates value in holiday or Not in BusinessDays", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Returned when the Availability_Type field contains a value not present in the allowed picklist. Valid values are Every Business Days, Specific Date Range, Specific Date(s), and Specific Day(s).", "summary": "Invalid data error when Availability_Type is not a valid picklist value.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Availability_Type", "json_path": "$.data[0].Availability_Type" }, "message": "The given Availability Type is not in picklist", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows an INVALID_DATA failure for the Available_From field, indicating that the supplied value does not conform to the required YYYY-MM-DD date format.", "summary": "Invalid data error when Available_From has an invalid date format.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Status", "json_path": "$.data[*].Status", "maximum_length": 120 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an INVALID_DATA failure for the Available_Till field, indicating that the supplied value does not conform to the required date format.", "summary": "Invalid data error when Available_Till has an invalid date format.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Unavailable_Till", "json_path": "$.data[*].Unavailable_Till", "supported_values": [ "Temporarily Unavailable", "Available", "Not In Use", "Scheduled" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an INVALID_DATA failure for the Duration field, indicating that the supplied value falls outside the permitted range of five minutes to 24 hours.", "summary": "Invalid data error when Duration is outside the permitted 5-min to 24-hr range.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Duration", "json_path": "$.data[0].Duration" }, "message": "Duration value should not be greater than 24hrs or less than 5mins", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows an INVALID_DATA failure for a From or To field within Available_Timings, indicating that the supplied time value does not conform to the required HH:MM 24-hour format.", "summary": "Invalid data error when Available_Timings From or To is not in HH:MM format.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "To", "json_path": "$.data[0].Available_Timings" }, "message": " The given custom time is invalid", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an INVALID_DATA failure for the Owner field, indicating that the supplied value is not of the expected object data type.", "summary": "Invalid data type error for the Owner field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Owner", "expected_data_type": "jsonobject", "json_path": "$.data[*].Owner" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows an INVALID_DATA failure for the Available_Till field, indicating that the supplied value is not valid. The response identifies the offending field and its position in the request payload.", "summary": "Invalid data error when Available_Till has an invalid value", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Owner", "json_path": "$.data[*].Owner", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an INVALID_DATA failure where the provided date value for Available_Dates is not in the accepted format. The response identifies the field and the expected data type.", "summary": "Invalid data error when an Available_Dates value has an invalid format", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Available_Dates", "expected_data_type": "date", "json_path": "$.data[0].Available_Dates" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an INVALID_DATA failure returned when one of the Members is an unconfirmed user. The response identifies the Members field and its JSON path in the request payload.", "summary": "Invalid data error when a Members entry is an unconfirmed user", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Members[0].Members.id", "user_status": "unconfirmed" }, "message": "Members is not Confirmed", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows an INVALID_DATA failure returned when one of the Members is an inactive user. The response identifies the Members field and its JSON path in the request payload.", "summary": "Invalid data error when a Members entry is an inactive user", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Members[0].Members.id", "user_status": "inactive" }, "message": "Members is not Active", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an INVALID_DATA failure for the Job_Sheet_Required field, indicating that the supplied value is of an invalid data type. The response identifies the field and its position in the request payload.", "summary": "Invalid data type error for the Job_Sheet_Required field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Job_Sheet_Required", "expected_data_type": "text", "json_path": "$.data[*].Job_Sheet_Required" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an INVALID_DATA failure for the Available_Timings field, indicating that the request payload for Available_Timings is invalid. The response identifies the field by name and JSON path.", "summary": "Invalid data error for the Available_Timings request payload.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Job_Sheet_Required", "json_path": "$.data[*].Job_Sheet_Required", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows an INVALID_DATA failure where the Unavailable_From time does not fall within the configured service availability window. The response identifies the Unavailable_From field and its position in the request.", "summary": "Invalid data error when Unavailable_From falls outside the service availability window.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "message": "Unavailable From time does not fall within service availability", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows an INVALID_DATA failure for the Available_Dates field, indicating that one of the specified dates is a holiday or falls on a non-business day. The response identifies the field and its position in the request payload.", "summary": "Invalid data error when an Available_Dates value falls on a holiday or non-business day", "value": { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.data", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse9": { "description": "Shows an INVALID_DATA failure for the Status field, indicating that the supplied value is of an incorrect data type. The response identifies the field by name and JSON path.", "summary": "Invalid data type error for the Status field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Status", "expected_data_type": "text", "json_path": "$.data[*].Status" }, "message": "Invalid data type", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows a LIMIT_EXCEEDED failure returned when the Members array contains more than five users for a single service. The response identifies the Members field and its position in the request payload.", "summary": "LIMIT_EXCEEDED error when more than five members are associated with a service", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Members", "json_path": "$.data[0].Members", "limit": 100 }, "message": "More than 100 users cannot be associated", "status": "error" } ] } }, "LimitExceededResponse2": { "description": "Shows a LIMIT_EXCEEDED failure returned when the organization has reached the maximum of 500 active services. The response identifies the constraint at the record level.", "summary": "LIMIT_EXCEEDED error when the 500-active-service limit for the organization is reached", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Status", "json_path": "$.data[0].Status", "limit": 3 }, "message": "You cannot create more than 500 active services", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows a MANDATORY_NOT_FOUND failure returned when a required service field is absent from the request. The response identifies the missing field by name and JSON path.", "summary": "MANDATORY_NOT_FOUND error when a required service field is missing from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.data[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows a MANDATORY_NOT_FOUND failure returned when a required field is not present in the request payload. The response identifies the absent field by name and its position in the request.", "summary": "MANDATORY_NOT_FOUND error when another required field is absent from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Members", "json_path": "$.data[0].Members" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows a MANDATORY_NOT_FOUND failure returned when a third required field is missing from the request payload. The response identifies the field by name and JSON path.", "summary": "MANDATORY_NOT_FOUND error when a third required field is absent from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Location", "json_path": "$.data[*].Location" }, "message": "Required field is missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Shows a NOT_ALLOWED failure returned when Job Sheet is not configured in the organization's service preferences. The response indicates that job sheet must be enabled before services requiring it can be created or updated.", "summary": "NOT_ALLOWED error when Job Sheet is not configured in service preferences", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Job_Sheet_Required", "json_path": "$.data[0].Job_Sheet_Required" }, "message": "Job Sheet is not configured in services preferences", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "Shows a NOT_ALLOWED failure returned when the service availability dates are in the past and the status cannot be changed to Available or Temporarily Unavailable. The response identifies the constraint.", "summary": "NOT_ALLOWED error when past availability dates prevent an Active or Temporarily Unavailable status change", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Status", "json_path": "$.data[0].Status" }, "message": "As service availability is not valid, status cannot be changed", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "additionalProperties": false, "description": "Wrapped error response. Contains a data array where each item describes the validation failure for the corresponding service record in the request.\n", "properties": { "data": { "description": "Represents the per-record error array returned for the failed service records in the request. Contains one entry for each service record that failed validation.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataTypeGenericError" }, { "$ref": "#/components/schemas/InvalidDataForFieldError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableFromFutureError" }, { "$ref": "#/components/schemas/ScheduledServiceStatusRestrictionError" }, { "$ref": "#/components/schemas/NotInUseStatusWithFutureUnavailableFromError" }, { "$ref": "#/components/schemas/ScheduledStatusPastStartDateError" }, { "$ref": "#/components/schemas/PastEndDateStatusConflictError" }, { "$ref": "#/components/schemas/UnavailableFromTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/UnavailableTillTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/InvalidRequestPayloadError" }, { "$ref": "#/components/schemas/AvailableDaysNotInBusinessDaysError" }, { "$ref": "#/components/schemas/ServiceTimeNotInBusinessTimingError" }, { "$ref": "#/components/schemas/ServicesInvalidDataGenericError" }, { "$ref": "#/components/schemas/DurationNotSatisfyServiceTimingError" }, { "$ref": "#/components/schemas/ServicesDependentFieldMissingError" }, { "$ref": "#/components/schemas/MembersAssociationLimitExceededError" }, { "$ref": "#/components/schemas/ActiveServicesLimitExceededError" }, { "$ref": "#/components/schemas/JobSheetSectionDependentMismatchError" }, { "$ref": "#/components/schemas/ToValueMustBeGreaterThanFromError" }, { "$ref": "#/components/schemas/AvailableDatesInHolidayOrNonBusinessDayError" }, { "$ref": "#/components/schemas/MembersNotConfirmedError" }, { "$ref": "#/components/schemas/MembersNotActiveError" }, { "$ref": "#/components/schemas/InvalidDurationRangeError" }, { "$ref": "#/components/schemas/JobSheetNotConfiguredError" }, { "$ref": "#/components/schemas/ServiceAvailabilityInvalidStatusChangeError" }, { "$ref": "#/components/schemas/InvalidAvailabilityTypeNotInPicklistError" }, { "$ref": "#/components/schemas/ServicesMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/ServiceUnavailableTillFutureError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableWindowRuleError" }, { "$ref": "#/components/schemas/UnavailableWindowOrderError" }, { "$ref": "#/components/schemas/RequiredFieldNotFoundError" }, { "$ref": "#/components/schemas/InvalidCustomTimeError" } ], "description": "Represents one error entry returned for a failed service record. Each item conforms to one of the error schemas, such as an invalid data type error or a field-level validation error, and identifies the field and reason for the failure.\n" }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutservicessError400Wrapper" }, { "$ref": "#/components/schemas/InvalidDataTypeForDataFieldError" } ], "description": "Bad-request error response for the Services endpoint. Returned when the request payload fails validation.\n", "x-zs-$id": "PutservicessError400" } } }, "description": "The request could not be processed because one or more service records contain invalid data, fail a Validation Rule, or violate a service-availability constraint.\n\n**Resolution:** Each error item identifies the offending field; the payload must be corrected and the request retried." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.services.UPDATE" ] } ], "summary": "Update service records", "tags": [ "services" ], "x-zoho-document": "services" } }, "/crm/v8/Services__s/{id}": { "delete": { "description": "To delete a service record from your Zoho CRM organization by its unique ID. When a service record is removed, all appointments associated with that service are also removed; however, deals created upon completion of an appointment under the service are not affected.", "operationId": "deleteServiceById", "parameters": [ { "$ref": "#/components/parameters/ParamPathServiceId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Illustrates a successful DELETE response in which a single service record has been deleted. The response body contains a SUCCESS code, a record deleted message, and the ID of the deleted service in the details object.\n", "summary": "Successful deletion of a single service record", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "111115000000128210" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteservicessResponse200" } } }, "description": "Returns the success status code and the ID of the service record after deletion." }, "400": { "content": { "application/json": { "examples": { "InternalErrorResponse1": { "description": "Illustrates an error response returned when the server encounters an unexpected internal error while processing the service DELETE request. The response body contains an INTERNAL_ERROR code, an Internal Server Error message, and the index of the affected resource path in the details object.\n", "summary": "Internal server error during a service DELETE request", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } }, "InvalidDataResponse1": { "description": "Illustrates an error response returned when the specified service record cannot be deleted because the service ID in the request URL is incorrect or the record has already been deleted. The response body contains an INVALID_DATA code and a record not deleted message.\n", "summary": "Invalid data error for a service record that could not be deleted", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "record not deleted", "status": "error" } }, "InvalidModuleResponse1": { "description": "Illustrates an error response returned when the module name provided in the request URL does not match any module in the Zoho CRM organization. The response body contains an INVALID_MODULE code and a message indicating that the module name is invalid.\n", "summary": "Invalid module name error for a service DELETE request", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "RequiredParamMissingResponse1": { "description": "Illustrates an error response returned when the service ID is omitted from the DELETE request URL, causing the API to respond with a REQUIRED_PARAM_MISSING error and a details object identifying the missing parameter. Specifying the service ID in the request URL resolves this error.", "summary": "Missing service ID parameter error for a DELETE request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotDeletedError" }, { "$ref": "#/components/schemas/ServicesInvalidModuleNameError" }, { "$ref": "#/components/schemas/RequiredParamMissingForDeleteError" }, { "$ref": "#/components/schemas/DataError" } ], "description": "Represents the bad-request error response for the delete service operation. Contains error variants for invalid service record data, an invalid module name, a missing required parameter, or a general data error.", "x-zs-$id": "DeleteServiceByIdError400" } } }, "description": "The request failed because the service ID in the request URL is invalid or already deleted, the service ID parameter is missing, or the module name is invalid.\n\n**Resolution:** Verify that the module API name is correct, provide a valid service ID in the request URL, and retry the request.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.services.DELETE" ] } ], "summary": "Delete a service record by ID", "tags": [ "services" ], "x-zoho-document": "services" }, "get": { "description": "To retrieve the full details of a single service record from your Zoho CRM organization using its unique ID, including its availability configuration, members, pricing, tax details, and subform data.\n", "operationId": "getServiceById", "parameters": [ { "$ref": "#/components/parameters/ServicesParamPathId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Represents a successful response to the Get Service by ID request. The response contains a single service record with its complete set of fields, including availability configuration, members, owner, pricing, tax, and audit timestamps.\n", "summary": "Successful retrieval of a service record by ID\n", "value": { "data": [ { "$currency_symbol": "£", "$editable": true, "$field_states": null, "$formatted_currency": { "Price": "44.00" }, "$has_more": { "Members": false }, "$home_converted_currency": null, "$photo_id": null, "$sharing_permission": "full_access", "$state": "save", "$status": "cmv_1-1", "Availability_Type": "Specific Date Range", "Available_Dates": [], "Available_Days": [], "Available_From": "2026-01-01", "Available_Till": "2026-01-29", "Available_Timings": null, "Created_By": { "email": "madeshwaran.g@zohocorp.com", "id": "4671651000000635001", "name": "Madeshwaran G" }, "Created_Time": "2025-12-17T12:20:24+05:30", "Description": null, "Duration": 120, "Job_Sheet_Required": "No", "Job_Sheet_Section__s": null, "Last_Activity_Time": "2026-01-14T16:57:16+05:30", "Location": "Business Address", "Members": [ { "Members": { "id": "4671651000000635001", "module": "Users", "name": "Madeshwaran G" }, "id": "4671651000000867005" } ], "Modified_By": { "email": "madeshwaran.g@zohocorp.com", "id": "4671651000000635001", "name": "Madeshwaran G" }, "Modified_Time": "2026-01-14T16:57:16+05:30", "Owner": { "email": "madeshwaran.g@zohocorp.com", "id": "4671651000000635001", "name": "Madeshwaran G" }, "Price": 44, "Record_Image": null, "Service_Name": "dd", "Status": "Not in Use", "Tag": [], "Tax": [], "Unavailable_From": "2026-01-14T12:20:35+05:30", "Unavailable_Till": null, "id": "4671651000000867004" } ] } } }, "schema": { "$ref": "#/components/schemas/GetServiceByIdResponse200" } } }, "description": "Returns the full details of the requested service record, including its availability configuration, members, owner, pricing, tax, audit timestamps, and currency-formatted values.\n" }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse1": { "description": "Represents a 400 error response returned when the module name in the request URL does not match any existing module. The code field is set to INVALID_MODULE and details.resource_path_index identifies the position of the invalid segment in the resource path.\n", "summary": "An error response for an invalid module name in the request URL\n", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "RequiredParamMissingResponse1": { "description": "Represents a 400 error response returned when a required query parameter is absent from the request. The code field is set to REQUIRED_PARAM_MISSING and details.param_name identifies the missing parameter, in this example fields.\n", "summary": "An error response for a missing required query parameter\n", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ServicesInvalidModuleNameError" }, { "$ref": "#/components/schemas/ServicesRequiredParamMissingError" } ], "description": "Error response returned when the module name in the request URL is invalid or a required query parameter is missing from the request. Contains one of: `InvalidModuleNameError` or `RequiredParamMissingError`.\n", "x-zs-$id": "GetServiceByIdError400" } } }, "description": "The request cannot be processed because the module name in the URL is invalid or a required query parameter is missing.\n\n**Resolution:** Ensure the module API name in the request URL references an existing module and that all required query parameters are included in the request.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.services.READ" ] } ], "summary": "Retrieve a specific service record by ID\n", "tags": [ "services" ], "x-zoho-document": "services" }, "put": { "description": "To update a single service record in your Zoho CRM organization, identified by its unique ID. Only the fields supplied in the request payload are modified on the targeted service.", "operationId": "updateServiceSById", "parameters": [ { "$ref": "#/components/parameters/ParamQueryAffectedData" }, { "$ref": "#/components/parameters/ServicesParamPathId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Demonstrates a PUT request to update a service record with a 30-minute duration, Business Address location, Specific Day(s) availability across Monday through Wednesday, one assigned member, Not in Use status, configured available date range, a defined price, and Job Sheet Required set to No.", "summary": "Service update with availability, status, and pricing fields.", "value": { "data": [ { "Availability_Type": "Specific Day(s)", "Available_Dates": [], "Available_Days": [ "Monday", "Tuesday", "Wednesday" ], "Available_From": "2026-01-13", "Available_Till": "2026-01-13", "Available_Timings": null, "Description": null, "Duration": 30, "Job_Sheet_Required": "No", "Job_Sheet_Section__s": null, "Location": "Business Address", "Members": [ { "Members": { "id": "4671651000000635001", "module": "Users", "name": "Madeshwaran G" }, "id": "4671651000000862031" } ], "Owner": { "email": "madeshwaran.g@zohocorp.com", "id": "4671651000000635001", "name": "Madeshwaran G" }, "Price": 3993, "Record_Image": null, "Service_Name": "service99", "Status": "Not in Use", "Tag": [], "Tax": [], "Unavailable_From": "2026-01-13T15:40:03+05:30", "Unavailable_Till": null } ] } } }, "schema": { "$ref": "#/components/schemas/PutservicessRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain a data array with one object representing the service record to update." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Represents a successful service record update, returning a SUCCESS code along with modification metadata, the record ID, and affected data indicating whether a process flow was triggered.", "summary": "Successful single service record update.", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Created_Time": "2025-12-16T17:04:11+05:30", "Modified_By": { "id": "4671651000000635001", "name": "Madeshwaran G" }, "Modified_Time": "2026-01-14T16:57:16+05:30", "affected_data": [ { "$process_flow": false, "id": "4671651000000862030" } ], "id": "4671651000000862030" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PutServiceByIdResponse200" } } }, "description": "Returns a success status with the updated service record's ID, audit metadata (creation and modification timestamps and users), and the affected_data block reflecting the applied changes." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Returned when the Unavailable_From field is omitted while Status is set to Temporarily Unavailable. The response identifies the missing dependent field and the Status field that triggered the requirement.", "summary": "DEPENDENT_FIELD_MISSING when Unavailable_From required when Status is Temporarily Unavailable.", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Unavailable_From", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_From" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Returned when Available_Days is omitted while Availability_Type is set to Specific Day(s). The response identifies the missing dependent field and the Availability_Type field that triggered the requirement.", "summary": "DEPENDENT_FIELD_MISSING when Available_Days required when Availability_Type is Specific Day(s).", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Returned when the provided Available_Days values fall outside the configured business days. The response identifies the conflicting Available_Days field and the dependee Status field responsible for the validation constraint.", "summary": "DEPENDENT_MISMATCH when Available_Days not within configured business days.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Days", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Days" }, "message": "The given Available Days are not there in business days", "status": "error" } ] } }, "DependentMismatchResponse10": { "description": "Returned when the Status field is set to available but Unavailable_From does not fall after the current date. This scenario demonstrates that Unavailable_From must be a future date whenever the service status is available.", "summary": "Status available but Unavailable_From is not a future date.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Status" }, "message": "When the service status is available, Unavailable From must be greater than current date", "status": "error" } ] } }, "DependentMismatchResponse11": { "description": "Returned when Unavailable_Till is set to a value that does not exceed the current time as required by the dependent Status field. This scenario demonstrates that Unavailable_Till must always be a future timestamp relative to the current time.", "summary": "Unavailable_Till is not greater than the current time", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be greater than current Time.", "status": "error" } ] } }, "DependentMismatchResponse12": { "description": "Returned when Status is available but Unavailable_Till is provided in a configuration that violates the allowed null/value combination. This scenario demonstrates that when status is available, Unavailable_Till must be null unless Unavailable_From also carries a value.", "summary": "Status available with invalid Unavailable_Till null/value combination.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_Till", "json_path": "$.data[0].Unavailable_Till" }, "json_path": "$.data[0].Status" }, "message": "When the service status is available, either both Unavailable From and Unavailable Till must be null, or only Unavailable From can have a value.", "status": "error" } ] } }, "DependentMismatchResponse13": { "description": "Returned when Unavailable_Till is set to a value that is not less than Unavailable_From, violating the required chronological ordering. This scenario demonstrates that Unavailable_Till must always precede Unavailable_From in time.", "summary": "Unavailable_Till is not lesser than Unavailable_From.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be lesser than Unavailable From", "status": "error" } ] } }, "DependentMismatchResponse14": { "description": "Returned when Unavailable_Till is supplied for a service that has a scheduled Available_From date, making Not In Use or Temporarily Unavailable statuses invalid. This scenario demonstrates that scheduled services cannot be transitioned to Not In Use or Temporarily Unavailable states.", "summary": "Unavailable_Till set on a scheduled service with Available_From.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Service status cannot be marked as Not In Use or Temporarily Unavailable for scheduled services.", "status": "error" } ] } }, "DependentMismatchResponse15": { "description": "Returned when Status is set to Not In Use but Unavailable_From is a future date, making the transition invalid. This scenario demonstrates that a Not In Use status cannot be applied when Unavailable_From extends beyond the current date.", "summary": "Status Not In Use conflicts with a future Unavailable_From date.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "json_path": "$.data[0].Status" }, "message": "Services status cannot be marked as Not In Use when Unavailable From falls after the current Date", "status": "error" } ] } }, "DependentMismatchResponse16": { "description": "Returned when Status is set to Scheduled but Available_From falls before the current date, making the scheduling invalid. This scenario demonstrates that a Scheduled status requires Available_From to be a future date.", "summary": "Status Scheduled but Available_From is a past date", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Status" }, "message": "Starting date of service availability falls before the current Date, so service cannot be marked as Scheduled", "status": "error" } ] } }, "DependentMismatchResponse17": { "description": "Returned when Status is set to Available, Scheduled, or Temporarily Unavailable but Available_Till has already passed the current date. This scenario demonstrates that an expired Available_Till prevents the service from being placed in any active or forward-looking status.", "summary": "Status conflicts with an expired Available_Till date", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Status", "dependee": { "api_name": "Available_Till", "json_path": "$.data[0].Available_Till" }, "json_path": "$.data[0].Status" }, "message": "End Date of service availability falls before the current Date, so service cannot be marked as Available or Scheduled or Temporarily Unavailable", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Returned when the To field specifies a service availability time that falls outside the permitted business hours based on the current Status. This scenario demonstrates that the service available time window must align with defined business timing constraints.", "summary": "To field violates business timing for the given Status.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "To", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Timings[0].To" }, "message": "Service available time does not satisfy the business timing", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Returned when the Duration field does not conform to the timing constraints defined by the current service Status. This scenario demonstrates that the service duration must fall within the bounds permitted by the associated service timing rules.", "summary": "Duration does not satisfy service timing for the given Status.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Duration", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Duration" }, "message": "Duration does not satisfy the service timing", "status": "error" } ] } }, "DependentMismatchResponse7": { "description": "Returned when Job_Sheet_Section__s is provided without Job_Sheet_Required being set to Yes. The DEPENDENT_MISMATCH error indicates that Job_Sheet_Section__s can only hold a value when its dependency Job_Sheet_Required equals Yes.", "summary": "DEPENDENT_MISMATCH on Job_Sheet_Section__s requiring Job_Sheet_Required as Yes.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Job_Sheet_Section__s", "dependee": { "api_name": "Job_Sheet_Required", "json_path": "$.data[0].Job_Sheet_Required" }, "json_path": "$.data[0].Job_Sheet_Section__s" }, "message": "Job_Sheet_Section__s can have value only when value of Job_Sheet_Required is Yes", "status": "error" } ] } }, "DependentMismatchResponse8": { "description": "Returned when the Available_Till value is not greater than the Available_From value. The DEPENDENT_MISMATCH error enforces that the To value of Available_Till must exceed the From value of Available_From.", "summary": "DEPENDENT_MISMATCH on Available_Till where To value must exceed Available_From.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Till", "dependee": { "api_name": "Available_From", "json_path": "$.data[0].Available_From" }, "json_path": "$.data[0].Available_Till" }, "message": "To value must be Greater than From value", "status": "error" } ] } }, "DependentMismatchResponse9": { "description": "Returned when Available_Dates contains a date that falls on a holiday or outside defined business days relative to the Status field. The DEPENDENT_MISMATCH error indicates the supplied Available_Dates value conflicts with the Status-dependent business day constraints.", "summary": "DEPENDENT_MISMATCH on Available_Dates falling on a holiday or non-business day.", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Available_Dates", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Available_Dates" }, "message": "Available Dates value in holiday or Not in BusinessDays", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Returned when the supplied Availability_Type value does not match any entry in the configured picklist. The INVALID_DATA error indicates that only predefined picklist values are accepted for the Availability_Type field.", "summary": "INVALID_DATA on Availability_Type value not found in picklist.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Availability_Type", "json_path": "$.data[0].Availability_Type" }, "message": "The given Availability Type is not in picklist", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Returned when the value provided for the Status field fails server-side data validation. The INVALID_DATA error indicates the Status value is malformed or does not conform to the expected format or allowed values.", "summary": "INVALID_DATA on Status field containing an unacceptable value.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Status", "json_path": "$.data[*].Status", "maximum_length": 120 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Returned when the value submitted for Unavailable_Till fails server-side data validation. The INVALID_DATA error indicates the Unavailable_Till value is malformed or does not conform to the expected date-time format.", "summary": "INVALID_DATA on Unavailable_Till field containing a malformed value.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Unavailable_Till", "json_path": "$.data[*].Unavailable_Till", "supported_values": [ "Temporarily Unavailable", "Available", "Not In Use", "Scheduled" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Returned when the Duration value exceeds 24 hours or is less than five minutes. The INVALID_DATA error indicates the submitted Duration is outside the permitted range.", "summary": "INVALID_DATA on Duration outside the permitted range.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Duration", "json_path": "$.data[0].Duration" }, "message": "Duration value should not be greater than 24hrs or less than 5mins", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "The server returns INVALID_DATA when the Available_Dates field contains a value in an unrecognised date format. The api_name field in the response identifies Available_Dates as the source of the error.", "summary": "INVALID_DATA error for Available_Dates due to date format mismatch.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Available_Dates", "expected_data_type": "date", "json_path": "$.data[0].Available_Dates" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "The server returns INVALID_DATA when the Members record referenced by ID is not in a Confirmed state. The api_name field in the response identifies the Members record as the source of the validation failure.", "summary": "INVALID_DATA error for Members record because member is not Confirmed.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Members[0].Members.id", "user_status": "unconfirmed" }, "message": "Members is not Confirmed", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "The server returns INVALID_DATA when the Members record referenced by ID is not in an Active state. The api_name field in the response identifies the Members record as the source of the validation failure.", "summary": "INVALID_DATA error for Members record because member is not Active.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Members[0].Members.id", "user_status": "inactive" }, "message": "Members is not Active", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "The server returns INVALID_DATA when the Job_Sheet_Required field receives a value of an incorrect data type. The api_name field in the response identifies Job_Sheet_Required as the source of the type mismatch.", "summary": "INVALID_DATA error for Job_Sheet_Required due to incorrect data type.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Job_Sheet_Required", "expected_data_type": "text", "json_path": "$.data[*].Job_Sheet_Required" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "The server returns INVALID_DATA when the Job_Sheet_Required field contains a value that is not permitted. The api_name field in the response identifies Job_Sheet_Required as the source of the invalid value.", "summary": "INVALID_DATA error for Job_Sheet_Required due to an invalid value.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Job_Sheet_Required", "json_path": "$.data[*].Job_Sheet_Required", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "The server returns INVALID_DATA when the Unavailable_From time falls outside the configured service availability window. The api_name field in the response identifies Unavailable_From as the source of the scheduling conflict.", "summary": "INVALID_DATA error for Unavailable_From outside service availability window.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Unavailable_From", "json_path": "$.data[0].Unavailable_From" }, "message": "Unavailable From time does not fall within service availability", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "The server returns INVALID_DATA when the data field contains a null or otherwise invalid payload that cannot be processed. The api_name field in the response identifies data as the source of the error.", "summary": "INVALID_DATA error for the data field with a null or unprocessable value.", "value": { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.data", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse9": { "description": "The server returns INVALID_DATA when the Status field receives a value of an incorrect data type. The api_name field in the response identifies Status as the source of the type mismatch.", "summary": "INVALID_DATA error for Status field due to incorrect data type.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Status", "expected_data_type": "text", "json_path": "$.data[*].Status" }, "message": "Invalid data type", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "The server returns LIMIT_EXCEEDED when the Members field exceeds the maximum allowed association of 100 users. The api_name field in the response identifies Members as the source of the limit violation.", "summary": "LIMIT_EXCEEDED error for Members exceeding the 100-user association cap.", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Members", "json_path": "$.data[0].Members", "limit": 100 }, "message": "More than 100 users cannot be associated", "status": "error" } ] } }, "LimitExceededResponse2": { "description": "The server returns LIMIT_EXCEEDED when updating the Status field would cause the organisation to exceed the 500 active service limit. The api_name field in the response identifies Status as the source of the limit violation.", "summary": "LIMIT_EXCEEDED error for Status breaching the 500 active services limit.", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Status", "json_path": "$.data[0].Status", "limit": 3 }, "message": "You cannot create more than 500 active services", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "The server returns NOT_ALLOWED when the Job_Sheet_Required field is supplied but Job Sheet has not been configured in services preferences. The api_name field in the response identifies Job_Sheet_Required as the source of the restriction.", "summary": "NOT_ALLOWED error for Job_Sheet_Required when Job Sheet is unconfigured.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Job_Sheet_Required", "json_path": "$.data[0].Job_Sheet_Required" }, "message": "Job Sheet is not configured in services preferences", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "The server returns NOT_ALLOWED when the Status field cannot be changed because the service's availability configuration is invalid. The api_name field in the response identifies Status as the source of the restriction.", "summary": "NOT_ALLOWED error for Status when service availability configuration is invalid.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Status", "json_path": "$.data[0].Status" }, "message": "As service availability is not valid, status cannot be changed", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataError" }, { "additionalProperties": false, "description": "Represents the wrapped error response containing a data array in which each item describes the failure for the corresponding service record in the request.", "properties": { "data": { "description": "Represents the per-record error array returned for each failed service record in the request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataTypeGenericError" }, { "$ref": "#/components/schemas/InvalidDataForFieldError" }, { "$ref": "#/components/schemas/ServicesDuplicateDataError" }, { "$ref": "#/components/schemas/ServicesRecordLockedError" }, { "$ref": "#/components/schemas/AvailableDaysNotInBusinessDaysError" }, { "$ref": "#/components/schemas/ServiceTimeNotInBusinessTimingError" }, { "$ref": "#/components/schemas/ServicesInvalidDataGenericError" }, { "$ref": "#/components/schemas/DurationNotSatisfyServiceTimingError" }, { "$ref": "#/components/schemas/ServicesDependentFieldMissingError" }, { "$ref": "#/components/schemas/MembersAssociationLimitExceededError" }, { "$ref": "#/components/schemas/ActiveServicesLimitExceededError" }, { "$ref": "#/components/schemas/JobSheetSectionDependentMismatchError" }, { "$ref": "#/components/schemas/ToValueMustBeGreaterThanFromError" }, { "$ref": "#/components/schemas/AvailableDatesInHolidayOrNonBusinessDayError" }, { "$ref": "#/components/schemas/MembersNotConfirmedError" }, { "$ref": "#/components/schemas/MembersNotActiveError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableFromFutureError" }, { "$ref": "#/components/schemas/ScheduledServiceStatusRestrictionError" }, { "$ref": "#/components/schemas/NotInUseStatusWithFutureUnavailableFromError" }, { "$ref": "#/components/schemas/ScheduledStatusPastStartDateError" }, { "$ref": "#/components/schemas/PastEndDateStatusConflictError" }, { "$ref": "#/components/schemas/UnavailableFromTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/UnavailableTillTimeOutsideAvailabilityError" }, { "$ref": "#/components/schemas/InvalidRequestPayloadError" }, { "$ref": "#/components/schemas/InvalidDurationRangeError" }, { "$ref": "#/components/schemas/JobSheetNotConfiguredError" }, { "$ref": "#/components/schemas/ServiceAvailabilityInvalidStatusChangeError" }, { "$ref": "#/components/schemas/InvalidAvailabilityTypeNotInPicklistError" }, { "$ref": "#/components/schemas/ServicesMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/ServiceUnavailableTillFutureError" }, { "$ref": "#/components/schemas/AvailableStatusUnavailableWindowRuleError" }, { "$ref": "#/components/schemas/UnavailableWindowOrderError" }, { "$ref": "#/components/schemas/RequiredFieldNotFoundError" }, { "$ref": "#/components/schemas/InvalidCustomTimeError" } ], "description": "Represents an error entry describing the failure for a single service record in the request." }, "maxItems": 25, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PutServiceByIdDataWrapperError" }, { "$ref": "#/components/schemas/InvalidDataTypeForDataFieldError" } ], "description": "Represents the bad-request error response for the Update Service by ID endpoint, returned when the request payload or query parameters fail validation.", "x-zs-$id": "PutServiceByIdError400" } } }, "description": "The request could not be processed because the service record contains invalid field values, is missing a required dependent field, violates a service-availability constraint, or has exceeded the active service limit.\n\n**Resolution:** The error response identifies the offending field and error code; correct the corresponding values in the request payload and resubmit the request." }, "403": { "content": { "application/json": { "examples": { "NotAllowedResponse1": { "description": "The server returns a 403 error when the authenticated user lacks the permission required to update the target service record. This response indicates that the operation was understood but is not permitted for the caller's current role or profile.", "summary": "NOT_ALLOWED error when caller lacks permission to update the service.", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Status", "json_path": "$.data[0].Status" }, "message": "As service availability is not valid, status cannot be changed", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/PutservicesByIdError400Wrapper" } } }, "description": "The authenticated user does not have permission to update the service record, the Job Sheet preference has not been configured in service settings, or the service's availability dates are in the past.\n\n**Resolution:** For permission errors, the user should contact the system administrator to obtain the required access. For Job Sheet errors, the administrator must enable the Job Sheet preference in service settings. For past-dated availability errors, the service's availability dates must be updated before marking the service as available or temporarily unavailable." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.services.UPDATE" ] } ], "summary": "Update a specific service record by ID", "tags": [ "services" ], "x-zoho-document": "services" } }, "/crm/v8/__apis": { "get": { "description": "To retrieve the list of available REST API endpoints in your Zoho CRM organization for a specific API version. You can filter the results by module, OAuth scope, or request method using the filters parameter.", "operationId": "getAvailableApis", "parameters": [ { "$ref": "#/components/parameters/ApisFilters" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ApiResponse": { "description": "Shows a sample of the successful response with three APIs, including their operations.", "summary": "List of Available APIs", "value": { "__apis": [ { "operation_types": [ { "max_credits": 20, "method": "POST", "min_credits": 20, "oauth_scope": "ZohoCRM.send_mail.quotes.CREATE" }, { "max_credits": 20, "method": "PUT", "min_credits": 20, "oauth_scope": "ZohoCRM.send_mail.quotes.CREATE" } ], "path": "/crm/v8/Quotes/{{id}}/actions/send_mail" }, { "operation_types": [ { "max_credits": 1, "method": "GET", "min_credits": 1, "oauth_scope": "ZohoCRM.modules.accounts.READ" }, { "max_credits": 1, "method": "DELETE", "min_credits": 1, "oauth_scope": "ZohoCRM.modules.accounts.DELETE" }, { "max_credits": 1, "method": "POST", "min_credits": 1, "oauth_scope": "ZohoCRM.modules.accounts.CREATE" } ], "path": "/crm/v8/Accounts/{{id}}/photo" }, { "operation_types": [ { "max_credits": 1, "method": "POST", "min_credits": 1, "oauth_scope": "ZohoCRM.modules.deals.CREATE" }, { "max_credits": 1, "method": "GET", "min_credits": 1, "oauth_scope": "ZohoCRM.modules.deals.READ" }, { "max_credits": 1, "method": "PUT", "min_credits": 1, "oauth_scope": "ZohoCRM.modules.deals.UPDATE" }, { "max_credits": 1, "method": "DELETE", "min_credits": 1, "oauth_scope": "ZohoCRM.modules.deals.DELETE" } ], "path": "/crm/v8/Deals/{{id}}/Attachments" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the list of available REST APIs and their operation types.", "properties": { "__apis": { "description": "Contains the details of all the supported APIs in the API version given in the request URL.", "items": { "additionalProperties": false, "description": "Each object represents an API with its path and supported HTTP operations.", "properties": { "operation_types": { "description": "Contains the supported HTTP operations for that API in that version.\n", "items": { "additionalProperties": false, "description": "Each object represents the details of a single HTTP operation supported by that API.", "properties": { "max_credits": { "description": "Represents the maximum credits that the API consumes.\n\n", "format": "int32", "minimum": 0, "type": "integer" }, "method": { "description": "Represents the supported request method for\nthat API. \n\nPossible values:\n\n**GET** - Retrieve data.\n\n**POST** - Create data.\n\n**PUT** - Update data.\n\n**PATCH** - Partially update data.\n\n**DELETE** - Remove data.\n", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "type": "string" }, "min_credits": { "description": "Represents the minimum credits that the API consumes.", "format": "int32", "minimum": 0, "type": "integer" }, "oauth_scope": { "description": "Represents the OAuth scope required to perform this operation.", "maxLength": 128, "type": "string" } }, "required": [ "method", "oauth_scope", "max_credits", "min_credits" ], "type": "object" }, "maxItems": 10, "type": "array" }, "path": { "description": "Represents the API endpoint for the API version in the request URL.", "maxLength": 512, "type": "string" } }, "required": [ "path", "operation_types" ], "type": "object" }, "maxItems": 2000, "type": "array" } }, "required": [ "__apis" ], "type": "object", "x-zs-$id": "AvailableApisResponse" } } }, "description": "Returns the list of available REST APIs with their paths, HTTP methods, OAuth scopes, and credit consumption details." }, "400": { "$ref": "#/components/responses/ApisBadRequest" }, "401": { "$ref": "#/components/responses/ApisUnauthorized" }, "403": { "$ref": "#/components/responses/ApisForbidden" }, "404": { "$ref": "#/components/responses/ApisNotFound" }, "429": { "$ref": "#/components/responses/ApisTooManyRequests" }, "500": { "$ref": "#/components/responses/ApisInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.apis.READ" ] } ], "summary": "List available REST APIs", "tags": [ "apis" ], "x-zoho-document": "apis" } }, "/crm/v8/__composite_requests": { "post": { "description": "To bundle multiple Zoho CRM API requests into a single HTTP call, reducing network round-trips and enabling request chaining. You can reference the output of one sub-request in another using the format **@{sub_request_id:JSONPath}** to build dependent workflows. When **rollback_on_fail** is enabled, all successful sub-requests are rolled back if any subsequent sub-request fails.\n", "operationId": "createCompositeRequest", "requestBody": { "content": { "application/json": { "examples": { "LeadRecordOperations": { "description": "Demonstrates a composite request that performs multiple Lead record operations in sequence. The example creates a lead and then updates it using the record ID returned in the first sub-request response, accessed via @{sub_request_id:JSONPath} chaining.\n", "summary": "Create and update Leads using chained sub-requests", "value": { "__composite_requests": [ { "body": { "data": [ { "Last_Name": "Boyle" } ] }, "headers": {}, "method": "POST", "sub_request_id": "1", "uri": "/crm/v3/Leads" }, { "body": { "data": [ { "Company": "Zylker" } ] }, "headers": {}, "method": "PUT", "sub_request_id": "2", "uri": "/crm/v3/Leads/@{1:$.data[0].details.id}" } ], "parallel_execution": false, "rollback_on_fail": false } } }, "schema": { "additionalProperties": false, "description": "Specify the composite request configuration, including execution options and the array of sub-requests to process.", "properties": { "__composite_requests": { "description": "Specify the API requests to execute as sub-requests within the composite call.", "items": { "additionalProperties": false, "description": "Each object represents an individual API sub-request, including the HTTP method, URI, and optional headers, parameters, and body.", "properties": { "body": { "additionalProperties": true, "description": "Specify the request body for the sub-request.\n\n> **Note**\n> - **Using References in Composite API Requests**: You can reference the output of one sub-request in another within the same API call.\n> - **Reference Structure**: `@{sub_request_id:JSONPath}`\n> Where,\n> - `sub_request_id` is the ID of the sub-request whose response you want to reference.\n> - `JSONPath` is the path to the specific field in that response.\n> For example, if you create a Lead in one sub-request (sub_request_id : 1) and need to update it in another, you can use `@{1:$.data[0].details.id}` to dynamically fetch the Lead ID from sub-request 1 and use it in sub-request 2 to modify the same record. \n> - The `rollback_on_fail` and `parallel_execution` keys cannot both be set to `true`. If both are enabled, the API returns the `AMBIGUITY_DURING_PROCESSING` error.\n> - All Delete APIs (except Notification APIs) support only record IDs in the URL. Bulk delete operations are not supported.\n> - When `rollback_on_fail` is `false`:\n> - Workflows, approvals, and other automation actions are triggered as intended.\n> - The Composite API consumes one API credit.\n> - When `rollback_on_fail` is `true`:\n> - **Workflows**\n> - Automation actions execute only after all sub-requests complete successfully and no rollback occurs. If one or more sub-requests fail and a rollback happens, the automation actions are not triggered.\n> - For example, consider the case where a workflow is triggered every time a lead is created with the company name starting with 'S'. In sub-request 1, a lead is created, whose Company name starts with 'S', and sub-request 2 edits the newly created record's company name so that it does not start with 'S'. Only after executing both the sub-requests the workflow will be executed. But in this case, the workflow will not be triggered because the newly created Lead's company name is already updated in sub-request 2, and the criterion for the workflow is not met. Consider another case, where in sub-request 1, a lead is created, whose Company name is 'Silicon Solutions', and sub-request 2 edits this newly created record's website. If none of the other sub-requests change the company name of this newly created record, after executing all the sub-requests successfully, the workflow will be triggered.\n> - When a rollback occurs, the Composite API consumes one API credit.\n> - When all sub-requests succeed, the Composite API consumes two API credits.\n> - Each Composite API request consumes **five concurrency credits**, regardless of the number of sub-requests.\n> - Each composite API reduces the sub-concurrency by one, while the sub-requests consume their respective sub-concurrencies.\n\n### Allowed APIs\nThe following table gives the list of APIs allowed in a composite request. For these APIs, there are restrictions on the number of records that you can create, update, or delete in a composite request.\n\n| API | No. of records allowed |\n| --- | --- |\n| Get Org, Get Metadata, Convert a Lead, Get Layout Rules, Get Validation Rules, Get Custom Links, Get/Add/Update Roles, Get Profiles, Get Records' Count, Get/Update Blueprint, Get Variables/Variable Groups, Get Tags, Add/Remove Tags for a record, Get List of Attachments, Delete Photo, Get Currencies, Get Shared Record Details, Get Assignment Rules, Get/Add/Update Pipeline, Get Wizards, Get List of From Addresses, Delete Notifications | No Restriction | \n| Add/Update/Delete Users, Update/Delink Related Records, Add/Delete Variables, Create/Update/Delete Notes, Create/Update/Merge Tags, Add/Update Currency, Add/Update/PATCH Notifications, Create/Update/Upsert/Delete Records | 1 |\n| Get Territories, Get Notes, Get Email/Inventory Templates, Get Notifications, Get/Search Records, Get Related Records, Get records through a COQL query, Get Deleted Records, Get Users | 25 |\n", "type": "object" }, "headers": { "additionalProperties": true, "description": "Specify the HTTP headers for the sub-request. The **authorization** and **x-crm-org** headers are restricted and cannot be used.", "type": "object" }, "method": { "description": "Specify the HTTP method for the corresponding sub-request.\nPossible values:\n**GET** - Retrieve data from the API.\n**POST** - Create a new resource.\n**PUT** - Update an existing resource.\n**DELETE** - Remove a resource.\n**PATCH** - Partially update a resource.\n", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH" ], "type": "string" }, "params": { "additionalProperties": true, "description": "Specify the parameters for the sub-request.", "type": "object" }, "sub_request_id": { "description": "Specify a unique identifier for the sub-request. Use this ID to reference the output of this sub-request. The accepted regex is `[a-zA-Z0-9][a-zA-Z0-9_]*`.", "maxLength": 100, "pattern": "[a-zA-Z0-9][a-zA-Z0-9_]*", "type": "string" }, "uri": { "description": "Specify the URI path of the corresponding sub-request. The URI must follow the pattern **/crm/{version}/{endpoint}** with the regex `/crm(/.*)?/v[0-9]+([.][0-9]+)?/.*`.", "maxLength": 2048, "pattern": "/crm(/.*)?/v[0-9]+([.][0-9]+)?/.*", "type": "string" } }, "required": [ "method", "uri" ], "type": "object" }, "maxItems": 5, "type": "array" }, "parallel_execution": { "default": true, "description": "Specify whether to process all independent sub-requests (sub-requests with no dependencies/references) in parallel. The default value is true. If \"rollback_on_fail\" is true, then the default value of this key is false.\nPossible values:\n**true** - Execute independent sub-requests in parallel.\n**false** - Execute sub-requests sequentially.\nThis key cannot be **true** when **rollback_on_fail** is **true**.\n", "type": "boolean" }, "rollback_on_fail": { "default": false, "description": "Specify whether to rollback the composite API request if any of the sub-requests fail. The default value is false.\nPossible values:\n**true** - Rollback all operations if any sub-request fails. Workflow automation actions execute only after all sub-requests succeed.\n**false** - Process each sub-request independently without rollback.\nThis key cannot be **true** when **parallel_execution** is **true**.\n", "type": "boolean" } }, "required": [ "__composite_requests" ], "type": "object" } } }, "description": "Specify the data that the API requires to process the request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the response when all sub-requests in the composite batch execute successfully. Each element in the **__composite_requests** array contains the HTTP status code and response body from its corresponding sub-request.", "summary": "Response of a successful Composite Request.", "value": { "__composite_requests": [ { "code": "SUCCESS", "details": { "response": { "body": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "2284048000000471001", "name": "User" }, "Created_Time": "2025-11-24T22:55:30-12:00", "Modified_By": { "id": "2284048000000471001", "name": "User" }, "Modified_Time": "2025-11-24T22:55:30-12:00", "id": "2284048000005238359" }, "message": "record added", "status": "success" } ] }, "headers": { "content-type": "application/json;charset=UTF-8", "date": "Tue, 25 Nov 2025 10:55:31 GMT", "server": "ZGS" }, "status_code": 201 } }, "message": "composite sub request executed successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the successful response for a composite request where all sub-requests were executed successfully.", "properties": { "__composite_requests": { "description": "Contains the response for each sub-request in the composite call. ", "items": { "additionalProperties": false, "description": "Each object represents the response details for an individual sub-request, including the status code, headers, and body from the wrapped API call.", "properties": { "code": { "description": "Represents the response code for the sub-request. \nPossible values:\n**SUCCESS** - The sub-request was executed successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the detailed response information for the sub-request, including the HTTP response from the wrapped API call. ", "properties": { "response": { "additionalProperties": false, "description": "Contains the response details from the wrapped API call, including the status code, headers, and body. ", "properties": { "body": { "additionalProperties": true, "description": "Contains the response body from the wrapped API call. ", "type": "object" }, "headers": { "additionalProperties": true, "description": "Contains the response headers from the wrapped API call. ", "type": "object" }, "status_code": { "description": "Represents the status code from the wrapped API call. ", "format": "int32", "type": "integer" } }, "required": [ "headers", "body", "status_code" ], "type": "object" } }, "required": [ "response" ], "type": "object" }, "message": { "description": "Represents the response message for the sub-request. ", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the sub-request execution. \nPossible values:\n**success** - The sub-request was processed successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 5, "type": "array" } }, "required": [ "__composite_requests" ], "type": "object", "x-zs-$id": "CompositeSuccessResponse" } } }, "description": "Returns the response when all sub-requests in the composite call are executed successfully." }, "207": { "content": { "application/json": { "examples": { "PartialSuccessResponse": { "description": "Shows the response when some sub-requests succeed and others fail. Each element in the sub_requests array contains the status, error code, and details for its corresponding sub-request. This response occurs when rollback_on_fail is false or unset.", "summary": "Response of a partial success composite request.\n\n", "value": { "__composite_requests": [ { "code": "SUCCESS", "details": { "response": { "body": { "data": "response data" }, "headers": { "Content-Type": "application/json" }, "status_code": 200 } }, "message": "Request processed successfully", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "sub_request_2", "expected_data_type": "string", "json_path": "$.body.data[0].field" }, "message": "Invalid input data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the partial success response when some sub-requests succeed and others fail in the composite call.", "properties": { "__composite_requests": { "description": "Contains the mixed success and error responses for individual sub-requests. Each item corresponds to a sub-request and indicates whether it succeeded or failed. ", "items": { "additionalProperties": true, "description": "Each object represents the response for an individual sub-request, which may indicate either success or error based on the execution result.", "type": "object" }, "maxItems": 5, "type": "array" } }, "required": [ "__composite_requests" ], "type": "object", "x-zs-$id": "CompositePartialSuccessResponse" } } }, "description": "Returns a multi-status response when some sub-requests succeed and others fail. Each item in the response array independently indicates success or failure for the corresponding sub-request." }, "400": { "content": { "application/json": { "examples": { "CompositeRequestError": { "description": "Shows the error response when the composite request itself is invalid. Common errors include exceeding the maximum of 5 sub-requests, invalid reference expressions, circular dependencies between sub-requests, or restricted headers and parameters.", "summary": "Error response for composite request with invalid data.", "value": { "__composite_requests": [ { "code": "INVALID_DATA", "details": { "api_name": "uri", "expected_data_type": "text", "json_path": "$.__composite_requests[0].uri", "regex": "/crm(/.*)?/v[0-9]+([.][0-9]+)?/.*" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response object with detailed error information.", "properties": { "code": { "description": "Represents the error code for the failed request. \nPossible values:\n**DUPLICATE_DATA** - Duplicate data detected.\n**NOT_SUPPORTED** - The requested operation is not supported.\n**REQUEST_TIMEOUT** - The request timed out.\n**LOOPING_FOUND** - Circular dependency detected among sub-requests.\n**INVALID_DATA** - The input data is invalid.\n**PROCESSING_STOPPED** - Processing was stopped due to an error.\n**INVALID_REFERENCE** - An invalid reference was used.\n**ROLLBACK_PERFORMED** - A rollback was performed due to a sub-request failure.\n**MANDATORY_NOT_FOUND** - A required field is missing.\n**AMBIGUITY_DURING_PROCESSING** - Ambiguous configuration detected.\n", "enum": [ "DUPLICATE_DATA", "NOT_SUPPORTED", "REQUEST_TIMEOUT", "LOOPING_FOUND", "INVALID_DATA", "PROCESSING_STOPPED", "INVALID_REFERENCE", "ROLLBACK_PERFORMED", "MANDATORY_NOT_FOUND", "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Error details for invalid data type.", "properties": { "api_name": { "description": "Represents the API name or key that caused the validation error. ", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that failed validation. ", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path to the key that caused the error within the request body. ", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidDataTypeErrorDetails" }, { "additionalProperties": false, "description": "Error details for missing mandatory fields.", "properties": { "api_name": { "description": "Represents the API name or key for the missing mandatory field. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory key within the request body. ", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "MissingMandatoryFieldsErrorDetails" }, { "additionalProperties": false, "description": "Error details for ambiguous references.\n\n", "properties": { "ambiguity_due_to": { "description": "Contains the list of ambiguous references that caused the processing error. ", "items": { "additionalProperties": false, "description": "Each object represents a single ambiguous reference that contributed to the processing error.", "properties": { "api_name": { "description": "Represents the API name or key that has the ambiguous reference.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the ambiguous reference within the request body. ", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object", "x-zs-$id": "AmbiguousReferencesErrorDetails" }, { "additionalProperties": false, "description": "Error details for exceeding maximum length.\n\n", "properties": { "api_name": { "description": "Represents the API name or key that exceeded the maximum allowed length. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that exceeded the maximum allowed length. ", "maxLength": 500, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field. For the composite requests array, this value is **five**. ", "enum": [ 5 ], "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "ExceedingMaximumLengthErrorDetails" }, { "additionalProperties": false, "description": "Error details for unsupported services.\n\n", "properties": { "allowed_services": { "description": "Contains the list of allowed API services that can be invoked in composite sub-requests. ", "items": { "description": "Each string represents an allowed API service name that can be used in composite sub-requests.", "maxLength": 100, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "allowed_services" ], "type": "object", "x-zs-$id": "UnsupportedServicesErrorDetails" }, { "additionalProperties": false, "description": "Error details for regex validation failure.", "properties": { "api_name": { "description": "Represents the API name or key that failed the regular expression validation. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that failed the regular expression validation. ", "maxLength": 500, "type": "string" }, "regex": { "description": "Represents the regular expression pattern that the field value failed to match. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "regex" ], "type": "object", "x-zs-$id": "RegexValidationFailureErrorDetails" }, { "additionalProperties": false, "description": "Error details for restricted parameters.\n", "properties": { "api_name": { "description": "Represents the API name or key that contains restricted parameters. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the sub-request containing restricted parameters.", "maxLength": 500, "type": "string" }, "restricted_params": { "description": "Contains the list of query parameters that are restricted and cannot be used in composite sub-requests. ", "items": { "description": "Each string represents a restricted query parameter name that cannot be used in composite sub-requests.", "maxLength": 100, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "api_name", "json_path", "restricted_params" ], "type": "object", "x-zs-$id": "RestrictedParametersErrorDetails" }, { "additionalProperties": false, "description": "Error details for restricted headers.", "properties": { "api_name": { "description": "Represents the API name or key that contains restricted headers.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the sub-request containing restricted headers. ", "maxLength": 500, "type": "string" }, "restricted_headers": { "description": "Contains the list of HTTP headers that are restricted and cannot be used in composite sub-requests. ", "items": { "description": "Each string represents a restricted HTTP header name that cannot be used in composite sub-requests.", "maxLength": 100, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "api_name", "json_path", "restricted_headers" ], "type": "object", "x-zs-$id": "RestrictedHeadersErrorDetails" }, { "additionalProperties": false, "description": "Error details for invalid references.", "properties": { "api_name": { "description": "Represents the API name or key that contains an invalid reference expression.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field containing the invalid reference expression. ", "maxLength": 500, "type": "string" }, "reference": { "description": "Contains the invalid reference expression. Reference expressions use the format **@{sub_request_id:$.JSONPath}** to chain data between sub-requests. \n", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "reference" ], "type": "object", "x-zs-$id": "InvalidReferencesErrorDetails" }, { "additionalProperties": false, "description": "Error details for looping dependencies.", "properties": { "api_name": { "description": "Represents the API name or key that is part of a circular dependency. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the sub-request involved in the circular dependency. ", "maxLength": 500, "type": "string" }, "sub_request_indexes": { "description": "Contains the array indexes of sub-requests that form a circular dependency chain. ", "items": { "description": "Each integer represents a zero-based index of a sub-request involved in the circular dependency.", "format": "int32", "type": "integer" }, "maxItems": 10, "type": "array" } }, "required": [ "api_name", "json_path", "sub_request_indexes" ], "type": "object", "x-zs-$id": "LoopingDependenciesErrorDetails" }, { "additionalProperties": false, "description": "Error details for regex and data type validation.", "properties": { "api_name": { "description": "Represents the API name or key that caused the validation error. ", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that failed validation. ", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that caused the error within the request body. ", "maxLength": 500, "type": "string" }, "regex": { "description": "Represents the regular expression pattern that the field value failed to match. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "regex", "expected_data_type" ], "type": "object", "x-zs-$id": "RegexAndDataTypeValidationErrorDetails" }, { "additionalProperties": false, "description": "Error details for rollback operations.", "properties": { "rollbacked_by_sub_request_index": { "description": "Represents the index of the sub-request that triggered the rollback operation. ", "format": "int32", "type": "integer" } }, "required": [ "rollbacked_by_sub_request_index" ], "type": "object", "x-zs-$id": "RollbackErrorDetails" }, { "additionalProperties": false, "description": "Error details for version mismatches.", "properties": { "composite_request_version": { "description": "Represents the API version used for the composite request. ", "format": "int32", "type": "integer" }, "sub_request_version": { "description": "Represents the API version used in the sub-request that caused the version mismatch. ", "format": "int32", "type": "integer" } }, "required": [ "sub_request_version", "composite_request_version" ], "type": "object", "x-zs-$id": "VersionMismatchErrorDetails" }, { "additionalProperties": false, "description": "Error details for dependency issues.", "properties": { "dependent_data": { "description": "Contains information about sub-request dependencies when parallel execution is requested but sub-requests have interdependencies. ", "items": { "additionalProperties": false, "description": "Each object represents the dependency information for a single sub-request, including its ID and the IDs of sub-requests it depends on.", "properties": { "referred_sub_request_ids": { "description": "Contains the IDs of sub-requests that this sub-request depends on through references. ", "items": { "description": "Each object represents the ID of a sub-request that is referenced by the dependent sub-request.", "maxLength": 100, "type": "string" }, "maxItems": 5, "type": "array" }, "sub_request_id": { "description": "Represents the ID of the sub-request that has dependencies on other sub-requests. ", "maxLength": 100, "type": "string" } }, "required": [ "sub_request_id", "referred_sub_request_ids" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "dependent_data" ], "type": "object", "x-zs-$id": "DependencyIssuesErrorDetails" }, { "additionalProperties": false, "description": "Contains details of the generic errors. ", "maxProperties": 0, "properties": {}, "type": "object", "x-zs-$id": "GenericErrorDetails" } ], "description": "Contains contextual information about the error, including the JSON path to the problematic field and the specific validation failure details. " }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the request.\nPossible values:\n**error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RootLevelError" }, { "additionalProperties": false, "description": "Response object for composite request with multiple sub-request errors.", "properties": { "__composite_requests": { "description": "Provides an array of error responses for individual sub-requests.", "items": { "additionalProperties": false, "description": "Contains the individual sub-request error response.", "properties": { "code": { "description": "Represents the error code indicating the type of error. ", "enum": [ "DUPLICATE_DATA", "NOT_SUPPORTED", "REQUEST_TIMEOUT", "LOOPING_FOUND", "INVALID_DATA", "PROCESSING_STOPPED", "INVALID_REFERENCE", "ROLLBACK_PERFORMED", "MANDATORY_NOT_FOUND", "AMBIGUITY_DURING_PROCESSING", "NOT_ALLOWED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Error details for invalid data type.", "properties": { "api_name": { "description": "Represents the API name of the key that has invalid data type.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Provides the expected data type for the field. ", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that has invalid data type.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "SubRequesInvalidDataTypeErrorDetails" }, { "additionalProperties": false, "description": "Provides the error details for missing mandatory fields.", "properties": { "api_name": { "description": "Represents the API name of the mandatory key that is missing.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the mandatory key that is missing.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "MandatoryFieldMissingErrorDetails" }, { "additionalProperties": false, "description": "Error details for ambiguous references.", "properties": { "ambiguity_due_to": { "description": "List of ambiguous references causing the error.", "items": { "additionalProperties": false, "description": "Each object represents the individual ambiguous reference.", "properties": { "api_name": { "description": "Represents the API name of the key that caused ambiguity.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the key that caused ambiguity.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object", "x-zs-$id": "SubRequestAmbiguousReferencesErrorDetails" }, { "additionalProperties": false, "description": "Error details for exceeding maximum length.", "properties": { "api_name": { "description": "Represents the API name of the key that exceeds the maximum length.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the key that exceeds the maximum length.", "maxLength": 500, "type": "string" }, "maximum_length": { "description": "The allowed maximum length is **five**. ", "enum": [ 5 ], "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "SubRequestMaximumLengthExceededErrorDetails" }, { "additionalProperties": false, "description": "Error details for unsupported services.", "properties": { "allowed_services": { "description": "Provides the list of allowed services.", "items": { "description": "Each string represents a service.", "maxLength": 100, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "allowed_services" ], "type": "object", "x-zs-$id": "SubRequestUnsupportedServicesErrorDetails" }, { "additionalProperties": false, "description": "Error details for regex validation failure.", "properties": { "api_name": { "description": "Represents the API name of the key that has invalid regex.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the key that has invalid regex.", "maxLength": 500, "type": "string" }, "regex": { "description": "Represents the regular expression pattern that the field value failed to match.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "regex" ], "type": "object", "x-zs-$id": "RegexValidationErrorDetails" }, { "additionalProperties": false, "description": "Provides the error details for restricted parameters. ", "properties": { "api_name": { "description": "Represents the API name of the restricted parameter. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON Path of the restricted parameter. ", "maxLength": 500, "type": "string" }, "restricted_params": { "description": "Provides the list of restricted parameters. \n\n", "items": { "description": "Each string provides the details of a restricted parameter. ", "maxLength": 100, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "api_name", "json_path", "restricted_params" ], "type": "object", "x-zs-$id": "SubRequestRestrictedParametersErrorDetails" }, { "additionalProperties": false, "description": "Provides the error details for restricted headers.", "properties": { "api_name": { "description": "Provides the API name of the restricted header.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Provides the JSON path of the restricted header.", "maxLength": 500, "type": "string" }, "restricted_headers": { "description": "Provides the list of restricted headers.", "items": { "description": "Each object provides a restricted header name.", "maxLength": 100, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "api_name", "json_path", "restricted_headers" ], "type": "object", "x-zs-$id": "SubRequestRestrictedHeadersErrorDetails" }, { "additionalProperties": false, "description": "Provides the error details for invalid references.", "properties": { "api_name": { "description": "Provides the API name of the key with invalid reference. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Provides the JSON path of the key with invalid reference. ", "maxLength": 500, "type": "string" }, "reference": { "description": "Contains the invalid reference expression. Reference expressions use the format @{sub_request_id:$.JSONPath} to chain data between sub-requests.\n", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "reference" ], "type": "object", "x-zs-$id": "SubRequestInvalidReferencesErrorDetails" }, { "additionalProperties": false, "description": "Provides the error details for looping dependencies. ", "properties": { "api_name": { "description": "Provides the API name of the keys that involved in dependencies.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Provides the JSON path of the keys that involved in dependencies.", "maxLength": 500, "type": "string" }, "sub_request_indexes": { "description": "Represents the indexes of sub-requests involved in the loop.", "items": { "description": "Each object represents a sub-request index. ", "format": "int32", "type": "integer" }, "maxItems": 10, "type": "array" } }, "required": [ "api_name", "json_path", "sub_request_indexes" ], "type": "object", "x-zs-$id": "SubRequestLoopingDependenciesErrorDetails" }, { "additionalProperties": false, "description": "Provides error details for regex and data type validation.", "properties": { "api_name": { "description": "Represents the API name of the key with invalid data.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Provides the expected data type for the key. ", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the key with invalid data.", "maxLength": 500, "type": "string" }, "regex": { "description": "Represents the regular expression pattern that the field value failed to match.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "regex", "expected_data_type" ], "type": "object", "x-zs-$id": "SubRequestRegexAndDataTypeValidationErrorDetails" }, { "additionalProperties": false, "description": "Provides the error details for rollback operations.", "properties": { "rollbacked_by_sub_request_index": { "description": "Represents the index of the sub-request that triggered the rollback.", "format": "int32", "type": "integer" } }, "required": [ "rollbacked_by_sub_request_index" ], "type": "object", "x-zs-$id": "SubRequestRollbackErrorDetails" }, { "additionalProperties": false, "description": "Contains the error details for version mismatches.", "properties": { "composite_request_version": { "description": "Provides the version of the composite request.", "format": "int32", "type": "integer" }, "sub_request_version": { "description": "Represents the version of the sub-request.", "format": "int32", "type": "integer" } }, "required": [ "sub_request_version", "composite_request_version" ], "type": "object", "x-zs-$id": "SubRequestVersionMismatchErrorDetails" }, { "additionalProperties": false, "description": "Provides the error details for dependency issues.", "properties": { "dependent_data": { "description": "Contains the information about dependent sub-requests.", "items": { "additionalProperties": false, "description": "Provides the dependency information about dependent sub-requests.\n\n\n", "properties": { "referred_sub_request_ids": { "description": "Provides the IDs of sub-requests the error depends on.", "items": { "description": "Each item represents the referenced sub-request ID.", "maxLength": 100, "type": "string" }, "maxItems": 5, "type": "array" }, "sub_request_id": { "description": "Provides the ID of the dependent sub-request.", "maxLength": 100, "type": "string" } }, "required": [ "sub_request_id", "referred_sub_request_ids" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "dependent_data" ], "type": "object", "x-zs-$id": "SubRequestDependencyErrorDetails" } ], "description": "Contains the detailed response information for the sub-request, including the HTTP response from the wrapped API call. " }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the request.\nPossible values:\n**error** - The request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 5, "type": "array" } }, "required": [ "__composite_requests" ], "type": "object", "x-zs-$id": "CompositeRequestMultipleErrorsResponse" } ], "description": "Contains the error response for composite request failures due to invalid input data or configuration.", "x-zs-$id": "CompositeErrorResponse" } } }, "description": "The request failed due to invalid input.\n**Resolution:** Validate the request body structure, ensure all the field values are valid, and verify that **rollback_on_fail** and **parallel_execution** are not both set to **true**.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.composite_requests.CUSTOM" ] } ], "summary": "Process multiple API requests in a single call", "tags": [ "composite_requests" ], "x-zoho-document": "composite_requests" } }, "/crm/v8/__features": { "get": { "description": "To retrieve the list of all features available in your Zoho CRM organization for the current subscription edition, along with their usage limits and component details.", "operationId": "getFeatureDetails", "parameters": [ { "$ref": "#/components/parameters/FeaturesModule" }, { "$ref": "#/components/parameters/ApiNames" }, { "$ref": "#/components/parameters/FeaturesPerPage" }, { "$ref": "#/components/parameters/FeaturesPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "List all features with usage limits and component details", "value": { "__features": [ { "api_name": "global_picklists", "components": [ { "api_name": "global_picklist_per_module", "details": { "limits": { "edition_limit": 15, "total": 15 } }, "feature_label": "Global Picklist Per Module", "module_supported": false } ], "details": { "available_count": { "total": 3 }, "limits": { "edition_limit": 30, "total": 30 }, "used_count": { "total": 0 } }, "feature_label": "Global Picklists", "module_supported": false, "parent_feature": null }, { "api_name": "team_spaces", "components": null, "details": { "limits": { "edition_limit": 25, "total": 25 } }, "feature_label": "Teamspace", "module_supported": false, "parent_feature": null } ], "info": { "count": 200, "more_records": true, "page": 1, "per_page": 200 } } } }, "schema": { "additionalProperties": true, "description": "Represents the response structure for a successful feature list retrieval, containing the array of available features and pagination metadata.", "properties": { "__features": { "description": "Represents the list of feature objects available for the current edition. Always returned in the response.", "items": { "additionalProperties": true, "description": "Represents a single feature object, including its API name, module support status, usage limits, consumption details, and sub-feature components.", "properties": { "api_name": { "description": "Represents the unique API identifier for the feature, such as **custom_field** or **encrypt_field**. Always returned in the response.", "maxLength": 255, "type": [ "string", "null" ] }, "components": { "description": "Represents the list of sub-feature components for the feature. Each component includes its own API name, module support flag, and usage limit details. Always returned in the response.", "items": { "additionalProperties": true, "description": "Represents a single component of the feature, including its API name, per-module support status, and usage limit details.", "properties": { "api_name": { "description": "Represents the API name of the component within the feature. Always returned in the response.", "maxLength": 255, "type": "string" }, "details": { "description": "Represents the usage limits and consumption details for the component. Always returned in the response.", "properties": { "limits": { "additionalProperties": true, "description": "Represents the usage limits configured for the component. Always returned in the response.", "properties": { "edition_limit": { "description": "Represents the maximum count for the component allowed by the current subscription edition.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the absolute maximum count for the component, independent of the subscription edition. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "used_count": { "anyOf": [ { "additionalProperties": true, "description": "Represents the used count of the feature", "properties": { "total": { "description": "Represents the total count", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object", "x-zs-$id": "UsedCountObject3" }, { "description": "Represents the used count of the feature", "format": "int32", "type": "integer", "x-zs-$id": "UsedCountInteger3" } ], "description": "Represents theused count of the feature" } }, "type": [ "object", "null" ] }, "feature_label": { "description": "Represents the display label of the component for presentation in the CRM interface. Always returned in the response.", "maxLength": 255, "type": "string" }, "module_supported": { "description": "Indicates whether the component is supported for the specified module. Possible values: true - The component is supported for the module. false - The component is not supported for the module. Always returned in the response.", "type": "boolean" } }, "required": [ "api_name", "module_supported", "details", "feature_label" ], "type": "object" }, "maxItems": 200, "type": [ "array", "null" ] }, "details": { "description": "Represents the limits and usage details for the feature, including available count, usage limits, and current consumption. Always returned in the response.", "properties": { "available_count": { "additionalProperties": false, "description": "Represents the number of feature instances available for use in the organization.", "properties": { "total": { "description": "Represents the total number of available instances for the feature. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "limits": { "additionalProperties": false, "description": "Represents the maximum usage limits for the feature, including the absolute total limit and the edition-level ceiling.", "properties": { "edition_limit": { "description": "Represents the maximum count for the feature allowed by the current subscription edition.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the absolute maximum count for the feature across all editions. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "used_count": { "anyOf": [ { "additionalProperties": true, "description": "Represents the used count of the feature", "properties": { "total": { "description": "Represents the total count", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object", "x-zs-$id": "UsedCountObject" }, { "description": "Represents the used count of the feature", "format": "int32", "type": "integer", "x-zs-$id": "UsedCountInteger" } ], "description": "Represents the used count of the feature" } }, "type": [ "object", "null" ] }, "feature_label": { "description": "Represents the display label of the feature for presentation in the CRM interface. Always returned in the response.", "maxLength": 255, "type": [ "string", "null" ] }, "module_supported": { "description": "Indicates whether the feature is supported for the CRM module specified in the request. Possible values: true - The feature is supported for the specified module. false - The feature is not supported for the specified module. Always returned in the response.", "type": "boolean" }, "parent_feature": { "description": "Represents the parent feature of the current feature, when applicable. Always returned in the response.", "properties": { "api_name": { "description": "Represents the API name of the parent feature. Always returned in the response.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": [ "object", "null" ] } }, "required": [ "api_name", "parent_feature", "details", "components", "module_supported", "feature_label" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": true, "description": "Represents the pagination metadata for the response, including the current page number, page size, total feature count, and whether more records are available.", "properties": { "count": { "description": "Represents the number of feature records returned in the current page. Always returned in the response.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional feature records are available beyond the current page. Possible values: true - More feature records are available on subsequent pages. false - The current page contains the last set of feature records. Always returned in the response.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response. Always returned in the response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of feature records included per page in the response. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "__features" ], "type": "object", "x-zs-$id": "FeatureDetailsResponse" }, "x-zs-llm-examples": [ "SuccessResponse" ] } }, "description": "Returns the list of features available for the current organization's edition." }, "204": { "description": "Indicates that no features are available for the current organization's edition, or the specified feature does not exist." }, "400": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Invalid module API name in the request", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": true, "description": "Represents the error response structure returned when the request contains an invalid module name or invalid data.", "properties": { "code": { "description": "Represents the error code indicating the type of validation failure. Possible values: INVALID_MODULE - The module API name in the request is not valid. INVALID_DATA - The request contains invalid data. Always returned in the response.", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the validation error. Always returned in the response.", "properties": { "param_name": { "description": "Represents the name of the parameter that caused the validation error.", "maxLength": 25, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. Always returned in the response.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request. Possible values: error - The request resulted in a validation error. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataErrorResponse" } } }, "description": "The module API name in the request is invalid, or the request contains invalid data. **Resolution**: The request parameters must include a valid module API name and properly formatted values." } }, "security": [ { "OAuth2": [ "ZohoCRM.features.READ" ] } ], "summary": "Features", "tags": [ "features" ], "x-zoho-document": "features", "x-zs-llm-description": "Retrieves all available features for the current edition with their limits and usage details. Supports filtering by module and api_names." } }, "/crm/v8/__features/user_licenses": { "get": { "description": "To get the user licenses feature details for the current edition", "operationId": "getUserLicenseFeatureDetails", "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Get User License Feature Details", "value": { "__features": [ { "api_name": "user_licenses", "components": null, "details": { "available_count": { "total": 3 }, "limits": { "total": 10 }, "used_count": { "total": 7 } }, "feature_label": "UserLicenses", "module_supported": false, "parent_feature": null } ] } } }, "schema": { "additionalProperties": true, "description": "User licenses feature details for the current edition", "properties": { "__features": { "description": "User licenses feature details for the current edition", "items": { "additionalProperties": true, "description": "User licenses feature details", "properties": { "api_name": { "description": "API name of the feature", "maxLength": 255, "type": "string" }, "components": { "description": "Components of the feature", "type": "null" }, "details": { "description": "This object will have limits and usage details", "properties": { "available_count": { "additionalProperties": false, "description": "Available count details for the feature", "properties": { "total": { "description": "Total available count", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "limits": { "additionalProperties": false, "description": "Limit details for the feature", "properties": { "total": { "description": "Total limit", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "used_count": { "anyOf": [ { "additionalProperties": true, "description": "used count of the feature", "properties": { "total": { "description": "total count", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object", "x-zs-$id": "UsedCountObject1" }, { "description": "used count of the feature", "format": "int32", "type": "integer", "x-zs-$id": "UsedCountInteger1" } ], "description": "used count of the feature" } }, "required": [ "limits" ], "type": [ "object", "null" ] }, "feature_label": { "description": "Label of the feature", "maxLength": 255, "type": "string" }, "module_supported": { "description": "Module wise feature supported or not", "type": "boolean" }, "parent_feature": { "description": "Parent feature details", "type": [ "object", "null" ] } }, "required": [ "api_name", "parent_feature", "details", "components", "module_supported", "feature_label" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__features" ], "type": "object", "x-zs-$id": "UserLicenseFeatureDetailsResponse" }, "x-zs-llm-examples": [ "SuccessResponse" ] } }, "description": "Response of user licenses feature details for the current edition" }, "204": { "description": "User licenses feature not available for the current edition" }, "400": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Error response", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": true, "description": "Invalid request error response schema", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Extra details", "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Status of request", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserLicenseFeatureDetailsInvalidDataErrorResponse" } } }, "description": "Invalid request error response" } }, "security": [ { "OAuth2": [ "ZohoCRM.features.READ" ] } ], "summary": "User Licenses Feature", "tags": [ "features" ], "x-zoho-document": "features", "x-zs-llm-description": "Retrieves user license feature details including available count, used count, and limits for the current edition." } }, "/crm/v8/__features/{feature}": { "get": { "description": "To retrieve the detailed information for a specific feature in your Zoho CRM organization, including its usage limits, consumption details, and sub-feature components.", "operationId": "getFeatureSpecificDetails", "parameters": [ { "$ref": "#/components/parameters/Feature" }, { "$ref": "#/components/parameters/FeaturesModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Retrieve a specific feature with its limits and component details", "value": { "__features": [ { "api_name": "global_picklists", "components": [ { "api_name": "global_picklist_per_module", "details": { "limits": { "edition_limit": 15, "total": 15 } }, "feature_label": "Global Picklist Per Module", "module_supported": false }, { "api_name": "association_per_global_field", "details": { "limits": { "edition_limit": 30, "total": 30 } }, "feature_label": "Association Per Global Set", "module_supported": false }, { "api_name": "used_option_count", "details": { "limits": { "edition_limit": 1000, "total": 1000 } }, "feature_label": "Used Option Count", "module_supported": false }, { "api_name": "inc_used_option_count", "details": null, "feature_label": "Increased Used Option Count", "module_supported": false }, { "api_name": "unused_option_count", "details": { "limits": { "edition_limit": 500, "total": 500 } }, "feature_label": "Unused Option Count", "module_supported": false }, { "api_name": "large_global_set", "details": null, "feature_label": "Large Global Set", "module_supported": false }, { "api_name": "colourcode_option_count", "details": { "limits": { "edition_limit": 100, "total": 100 } }, "feature_label": "colourcode Option Count", "module_supported": false } ], "details": { "limits": { "edition_limit": 50, "total": 50 } }, "feature_label": "Global Picklists", "module_supported": false, "parent_feature": null } ] } } }, "schema": { "additionalProperties": true, "description": "Represents the response structure for a successful single feature retrieval, containing the detailed information for the requested feature.", "properties": { "__features": { "description": "Represents the list containing the detailed information for the requested feature. Always returned in the response.", "items": { "additionalProperties": true, "description": "Represents the detailed information for a single feature, including its API name, module support status, usage limits, consumption details, and sub-feature components.", "properties": { "api_name": { "description": "Represents the unique API identifier for the feature, such as **custom_field** or **encrypt_field**. Always returned in the response.", "maxLength": 255, "type": "string" }, "components": { "description": "Represents the list of sub-feature components for the feature. Each component includes its own API name, module support flag, and usage limit details. Always returned in the response.", "items": { "additionalProperties": true, "description": "Represents a single component of the feature, including its API name, per-module support status, and usage limit details.", "properties": { "api_name": { "description": "Represents the API name of the component within the feature. Always returned in the response.", "maxLength": 255, "type": "string" }, "details": { "description": "Represents the usage limits and consumption details for the component. Always returned in the response.", "properties": { "limits": { "additionalProperties": true, "description": "Represents the usage limits configured for the component. Always returned in the response.", "properties": { "edition_limit": { "description": "Represents the maximum count for the component allowed by the current subscription edition.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the absolute maximum count for the component, independent of the subscription edition. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "used_count": { "anyOf": [ { "additionalProperties": true, "description": "Represents the total count of component instances currently in use.", "properties": { "total": { "description": "total count", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object", "x-zs-$id": "UsedCountObject2" }, { "description": "used count of the feature", "format": "int32", "type": "integer", "x-zs-$id": "UsedCountInteger2" } ], "description": "Represents the current usage counts for the component." } }, "type": [ "object", "null" ] }, "feature_label": { "description": "Represents the display label of the component for presentation in the CRM interface. Always returned in the response.", "maxLength": 255, "type": "string" }, "module_supported": { "description": "Indicates whether the component is supported for the specified module. Possible values: true - The component is supported for the module. false - The component is not supported for the module. Always returned in the response.", "type": "boolean" } }, "required": [ "api_name", "module_supported", "details", "feature_label" ], "type": "object" }, "maxItems": 200, "type": [ "array", "null" ] }, "details": { "description": "Represents the limits and usage details for the feature, including available count, usage limits, and current consumption. Always returned in the response.", "properties": { "available_count": { "additionalProperties": false, "description": "Represents the number of feature instances available for use in the organization.", "properties": { "total": { "description": "Represents the total number of available instances for the feature. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "limits": { "additionalProperties": false, "description": "Represents the maximum usage limits for the feature, including the absolute total limit and the edition-level ceiling. Always returned in the response.", "properties": { "edition_limit": { "description": "Represents the maximum count for the feature allowed by the current subscription edition.", "format": "int32", "type": "integer" }, "total": { "description": "Represents the absolute maximum count for the feature across all editions. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" }, "used_count": { "additionalProperties": true, "description": "Represents the current usage counts for the feature in the organization.", "properties": { "total": { "description": "Represents the total number of feature instances currently in use. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "total" ], "type": "object" } }, "required": [ "limits" ], "type": [ "object", "null" ] }, "feature_label": { "description": "Represents the display label of the feature for presentation in the CRM interface. Always returned in the response.", "maxLength": 255, "type": [ "string", "null" ] }, "module_supported": { "description": "Indicates whether the feature is supported for the CRM module specified in the request. Possible values: true - The feature is supported for the specified module. false - The feature is not supported for the specified module. Always returned in the response.", "type": "boolean" }, "parent_feature": { "description": "Represents the parent feature of the current feature, when applicable. Always returned in the response.", "properties": { "api_name": { "description": "Represents the API name of the parent feature. Always returned in the response.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": [ "object", "null" ] } }, "required": [ "api_name", "parent_feature", "details", "components", "module_supported", "feature_label" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__features" ], "type": "object", "x-zs-$id": "FeatureSpecificDetailsResponse" }, "x-zs-llm-examples": [ "SuccessResponse" ] } }, "description": "Returns the detailed information for the requested feature, including its usage limits, consumption details, and sub-feature components." }, "204": { "description": "Indicates that the specified feature is not available for the current organization's edition." }, "400": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Invalid module API name for specific feature request", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": true, "description": "Represents the error response structure returned when the request contains an invalid module name or invalid data.", "properties": { "code": { "description": "Represents the error code indicating the type of validation failure. Possible values: INVALID_MODULE - The module API name in the request is not valid. INVALID_DATA - The request contains invalid data. Always returned in the response.", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the validation error. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. Always returned in the response.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request. Possible values: error - The request resulted in a validation error. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "FeatureSpecificDetailsInvalidModuleErrorResponse" } } }, "description": "The module API name in the request is invalid, or the request contains invalid data. Resolution: The request parameters must include a valid module API name and properly formatted values." } }, "security": [ { "OAuth2": [ "ZohoCRM.features.READ" ] } ], "summary": "Specific Feature", "tags": [ "features" ], "x-zoho-document": "features", "x-zs-llm-description": "Retrieves specific feature details including components, usage counts, and limits for the current edition. Supports module filtering." } }, "/crm/v8/__zia_org_enrichment": { "get": { "description": "To retrieve the paginated list of Zia organization enrichment jobs that have been scheduled in your Zoho CRM organization. Each entry includes the job identifier, current status, creation timestamp, and the user who triggered the job.", "operationId": "getZiaOrgEnrichment", "parameters": [ { "$ref": "#/components/parameters/ZiaOrgEnrichmentPage" }, { "$ref": "#/components/parameters/Perpage" }, { "$ref": "#/components/parameters/Sortby" }, { "$ref": "#/components/parameters/Sortorder" }, { "$ref": "#/components/parameters/ZiaOrgEnrichmentStatus" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Example1": { "description": "Demonstrates a response that lists scheduled organization enrichment jobs along with pagination metadata.", "summary": "Enrichment jobs returned", "value": { "__zia_org_enrichment": [ { "created_by": { "id": "111111000000050755", "name": "Krishna Prakash" }, "created_time": "2023-07-31T01:00:26Z", "id": "111111000000075013", "status": "SCHEDULED" }, { "created_by": { "id": "111111000000050755", "name": "Krishna Prakash" }, "created_time": "2023-07-31T01:05:15Z", "id": "111111000000075024", "status": "SCHEDULED" }, { "created_by": { "id": "111111000000050755", "name": "Krishna Prakash" }, "created_time": "2023-07-31T01:05:50Z", "id": "111111000000075026", "status": "SCHEDULED" }, { "created_by": { "id": "111111000000050755", "name": "Krishna Prakash" }, "created_time": "2023-07-28T05:06:40Z", "id": "111111000000072009", "status": "DATA_NOT_FOUND" } ], "info": { "count": 15, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "additionalProperties": false, "description": "Defines the response body returned when the list of organization enrichment jobs is retrieved successfully.", "properties": { "__zia_org_enrichment": { "description": "Contains the list of organization enrichment jobs for the current page.", "items": { "additionalProperties": false, "description": "Represents a single organization enrichment job and its scheduling metadata.", "properties": { "created_by": { "additionalProperties": false, "description": "Identifies the CRM user who triggered the enrichment job.", "properties": { "id": { "description": "Shows the unique identifier of the CRM user who triggered the enrichment job.", "maxLength": 19, "type": "string" }, "name": { "description": "Shows the display name of the CRM user who triggered the enrichment job.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "created_time": { "description": "Shows the timestamp at which the enrichment job was scheduled, in ISO 8601 format.", "format": "date-time", "type": "string" }, "id": { "description": "Shows the unique identifier of the organization enrichment job. Use this identifier with GET `/__zia_org_enrichment/{id}` to retrieve the enriched data of the job.", "maxLength": 19, "type": "string", "x-zs-$id": "ZiaOrgEnrichmentId" }, "status": { "description": "Indicates the current execution status of the enrichment job.\n\nPossible values:\n**SCHEDULED** - The job is queued and yet to run.\n**COMPLETED** - The job has finished and enriched data is available.\n**FAILED** - The job ended in a failure.\n**DATA_NOT_FOUND** - The job completed but Zia could not locate public data to enrich.", "enum": [ "SCHEDULED", "COMPLETED", "DATA_NOT_FOUND", "FAILED", "RUNNING" ], "type": "string" } }, "required": [ "id", "status", "created_time", "created_by" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Contains pagination metadata for the current page of enrichment jobs.", "properties": { "count": { "description": "Shows the number of enrichment jobs returned in the current page.", "format": "int32", "maximum": 200, "type": "integer" }, "more_records": { "description": "Indicates whether additional enrichment jobs exist beyond the current page. When the value is `true`, fetch the next page using the `page` parameter.", "type": "boolean" }, "page": { "description": "Shows the page number that this response corresponds to.", "format": "int32", "type": "integer" }, "per_page": { "description": "Shows the configured number of enrichment jobs per page.", "format": "int32", "maximum": 200, "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "__zia_org_enrichment", "info" ], "type": "object", "x-zs-$id": "GetOrgEnrichmentResponse" } } }, "description": "Returns the paginated list of organization enrichment jobs along with pagination metadata." }, "204": { "description": "Returned when no organization enrichment jobs exist for the authenticated CRM organization." }, "400": { "content": { "application/json": { "examples": { "Example1": { "description": "Demonstrates the response returned when the data enrichment feature is not supported by the CRM license of the organization.", "summary": "Feature not supported", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Your License does not support this feature", "status": "error" } }, "Example2": { "description": "Demonstrates the response returned when the supplied `status` query parameter does not match one of the supported values.", "summary": "Invalid query parameter value", "value": { "code": "INVALID_DATA", "details": { "param": "status", "supported_values": [ "COMPLETED", "SCHEDULED", "FAILED", "RUNNING", "DATA_NOT_FOUND", "UPDATED" ] }, "message": "status value invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FeatureNotEnableOrNotSupported" }, { "$ref": "#/components/schemas/ZiaOrgEnrichmentInvalidParam" } ], "description": "Defines the set of bad-request error envelopes that the GET `/__zia_org_enrichment` endpoint can return. Exactly one variant matches the failure condition.", "x-zs-$id": "GetOrgEnrichmentErrorResponses" } } }, "description": "Returned when the data enrichment feature is not enabled or supported for the organization, or when a supplied query parameter such as `status`, `sort_by`, or `sort_order` is invalid. Resolution: review the returned `code` and `details` to identify the offending input and resend the request after correcting it." }, "403": { "content": { "application/json": { "examples": { "Example": { "description": "Demonstrates the response returned when the authenticated user does not have permission to access the data enrichment feature.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": {}, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermission" } } }, "description": "Returned when the authenticated user does not have the required permission to access the data enrichment feature. Resolution: contact the system administrator to be granted the Manage or View Data Enrichment profile permission." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.intelligence.READ" ] } ], "summary": "Get Zia Org Enrichment", "tags": [ "zia_org_enrichment" ], "x-zoho-document": "zia_org_enrichment", "x-zs-llm-description": "Lists Zia organization enrichment records with pagination and filter support." }, "post": { "description": "To submit a request that schedules a Zia organization enrichment job in your Zoho CRM organization. The job runs asynchronously and uses the supplied name, email, or website to retrieve publicly available details such as address, primary contact, industries, and social media handles, and to populate the configured fields of the target module or record.", "operationId": "submitOrgEnrichmentRequest", "parameters": [ { "description": "Specify the API name of the CRM module for which enrichment is to be triggered. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the list of valid module API names.", "in": "query", "name": "module", "required": true, "schema": { "description": "CRM module name from which enrichment is triggered.", "maxLength": 255, "type": "string" } }, { "description": "Specify the unique identifier of the record for which enrichment is to be triggered. When omitted, the job runs at the module level. Use the records API of the target module to retrieve record identifiers.", "in": "query", "name": "record_id", "required": false, "schema": { "description": "Unique CRM record ID for which enrichment is requested.", "maxLength": 19, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Example1": { "description": "Demonstrates a request that triggers organization enrichment for the Accounts module by supplying all three trigger fields.", "summary": "Schedule enrichment with name, email, and website", "value": { "__zia_org_enrichment": [ { "enrich_based_on": { "email": "sales@zohocorp.com", "name": "zoho", "website": "www.zoho.com" } } ] } } }, "schema": { "additionalProperties": false, "description": "Defines the body of a Zia organization enrichment request. Wraps the list of enrichment inputs under the `__zia_org_enrichment` key.", "properties": { "__zia_org_enrichment": { "description": "Specify the list of enrichment requests to schedule. You can supply up to 50 entries in a single call.", "items": { "additionalProperties": false, "description": "Represents a single Zia organization enrichment request that defines the trigger fields used to identify the organization.", "properties": { "enrich_based_on": { "additionalProperties": false, "description": "Specify the details of the fields on whose values you want to trigger enrichment. Note that you must provide at least one of the following values in the input. Based on these values, Zia will look for information on the web and enrich fields as per [Enrichment Configuration.](zia_enrichment.yaml#$.paths./settings/zia/data_enrichment.get)) Note that the values of these keys must be at least three characters long and only in English.", "properties": { "email": { "description": "Specify the email address of the organization that Zia uses as a trigger value to look up enrichment data.", "format": "email", "type": "string" }, "name": { "description": "Specify the name of the organization that Zia uses as a trigger value to look up enrichment data.", "maxLength": 255, "type": "string" }, "website": { "description": "Specify the website domain of the organization that Zia uses as a trigger value to look up enrichment data.", "format": "website", "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "enrich_based_on" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "__zia_org_enrichment" ], "type": "object" } } }, "description": "Specify the payload that contains the list of enrichment requests. Each request supplies trigger values that Zia uses to look up public information about the organization.", "required": true }, "responses": { "202": { "content": { "application/json": { "examples": { "Example": { "description": "Demonstrates the response returned when the enrichment request is accepted and a job identifier is issued.", "summary": "Enrichment job scheduled", "value": { "__zia_org_enrichment": [ { "code": "SCHEDULED", "details": { "id": "917992000008742464" }, "message": "Org Enrichment scheduled successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Defines the response body returned when a Zia organization enrichment job is successfully scheduled.", "properties": { "__zia_org_enrichment": { "description": "Contains the list of scheduling results, one entry per submitted enrichment request.", "items": { "additionalProperties": false, "description": "Represents the scheduling result of a single enrichment request.", "properties": { "code": { "description": "Indicates the scheduling outcome of the enrichment request.\n\nPossible values:\n**SCHEDULED** - The enrichment job has been queued for asynchronous execution.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains identifying information about the scheduled enrichment job.", "properties": { "id": { "description": "Shows the unique identifier assigned to the scheduled enrichment job. Use this identifier with GET `/__zia_org_enrichment/{id}` to retrieve job status and enriched data.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Provides a message that describes the outcome of the scheduling request.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates whether the scheduling request succeeded.\n\nPossible values:\n**success** - The enrichment job was successfully accepted and queued.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "__zia_org_enrichment" ], "type": "object", "x-zs-$id": "CreateOrgEnrichmentResponse" } } }, "description": "Returns a confirmation that the enrichment job has been accepted and queued for asynchronous execution." }, "400": { "content": { "application/json": { "examples": { "Example": { "description": "Demonstrates the response returned when a value supplied inside `enrich_based_on` is not valid.", "summary": "Invalid value in enrich_based_on", "value": { "__zia_org_enrichment": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.__zia_org_enrichment[0].enrich_based_on.name" }, "message": "invalid data", "status": "error" } ] } }, "Example2": { "description": "Demonstrates the response returned when the organization has used up its enrichment quota.", "summary": "Enrichment limit exceeded", "value": { "__zia_org_enrichment": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1500, "limit_due_to": [ { "api_name": "enrich_based_on", "json_path": "$.__zia_org_enrichment[0].enrich_based_on" } ] }, "message": "enrichment data limit exceeded", "status": "error" } ] } }, "Example3": { "description": "Demonstrates the response returned when the `enrich_based_on` object does not contain any of the expected trigger fields.", "summary": "Expected trigger fields missing", "value": { "__zia_org_enrichment": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "name", "json_path": "$.__zia_org_enrichment[0].enrich_based_on.name" }, { "api_name": "email", "json_path": "$.__zia_org_enrichment[0].enrich_based_on.email" }, { "api_name": "website", "json_path": "$.__zia_org_enrichment[0].enrich_based_on.website" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "Example4": { "description": "Demonstrates the response returned when the supplied `module` value is not supported for organization enrichment.", "summary": "Module not supported", "value": { "code": "INVALID_DATA", "details": { "param_name": "module" }, "message": "The given module is not supported for Org Enrichment", "status": "error" } }, "Example5": { "description": "Demonstrates the response returned when the data enrichment feature is not enabled for the organization.", "summary": "Data enrichment feature not enabled", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Data Enrichment feature not enabled", "status": "error" } }, "Example6": { "description": "Demonstrates the response returned when the top-level `__zia_org_enrichment` array contains more entries than the allowed maximum.", "summary": "Array cardinality exceeded", "value": { "code": "INVALID_DATA", "details": { "api_name": "__zia_org_enrichment", "json_path": "$.__zia_org_enrichment", "maximum_length": 1 }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when one or more values inside `enrich_based_on` are invalid or when the mandatory `enrich_based_on` key itself is missing.", "properties": { "__zia_org_enrichment": { "description": "Contains the list of validation errors detected in the submitted enrichment requests.", "items": { "additionalProperties": false, "description": "Represents a single validation error related to the `enrich_based_on` input.", "properties": { "code": { "description": "Identifies the validation failure that was raised.\n\nPossible values:\n**INVALID_DATA** - A value supplied in `enrich_based_on` is incorrect, shorter than three characters, in a non-English language, or has the wrong data type.\n**MANDATORY_NOT_FOUND** - The mandatory key `enrich_based_on` was not supplied in the input.", "enum": [ "INVALID_DATA", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context that identifies the invalid or missing input field.", "properties": { "api_name": { "description": "Identifies the field whose value failed validation.\n\nPossible values:\n**name** - The organization name in `enrich_based_on`.\n**email** - The organization email in `enrich_based_on`.\n**website** - The organization website in `enrich_based_on`.\n**enrich_based_on** - The `enrich_based_on` object itself.", "enum": [ "name", "email", "website", "enrich_based_on" ], "type": "string" }, "expected_data_type": { "description": "Indicates the data type that the field expects when the supplied value uses an incorrect type.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Shows the JSON path that points to the exact field in the request payload that failed validation.", "enum": [ "$.__zia_org_enrichment[0].enrich_based_on.name", "$.__zia_org_enrichment[0].enrich_based_on.email", "$.__zia_org_enrichment[0].enrich_based_on.website", "$.__zia_org_enrichment[0].enrich_based_on" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Provides a message that explains the validation failure like \"You have not specified the key \"enrich_based_on\" in the input\".", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because of a validation error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "__zia_org_enrichment" ], "type": "object", "x-zs-$id": "OrgEnrichmentValidationErrorResponse" }, { "additionalProperties": false, "description": "Returned when the organization has reached its allowed enrichment quota and the new request cannot be accepted.", "properties": { "__zia_org_enrichment": { "description": "Contains the list of enrichment requests that breached the configured limit.", "items": { "additionalProperties": false, "description": "Represents a single limit-exceeded error for an enrichment request.", "properties": { "code": { "description": "Identifies the limit violation that was raised.\n\nPossible values:\n**LIMIT_EXCEEDED** - The organization has used up its enrichment quota for the current edition.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the enrichment limit that was breached.", "properties": { "limit": { "description": "Shows the maximum number of enrichments allowed for the organization based on its CRM edition and user count.", "format": "int32", "type": "integer" }, "limit_due_to": { "description": "Lists the input fields that contributed to the limit breach.", "items": { "additionalProperties": false, "description": "Identifies a single input field that contributed to the enrichment limit breach.", "properties": { "api_name": { "description": "Identifies the API name of the field that contributed to the limit breach.", "enum": [ "enrich_based_on" ], "type": "string" }, "json_path": { "description": "Shows the JSON path that points to the field in the request payload that contributed to the limit breach.", "enum": [ "$.__zia_org_enrichment[0].enrich_based_on" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "limit", "limit_due_to" ], "type": "object" }, "message": { "description": "Provides a message that explains the limit violation like, \"You have created more than the allowed enrichments for your org.\"", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because the enrichment limit was breached.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__zia_org_enrichment" ], "type": "object", "x-zs-$id": "OrgEnrichmentLimitExceededErrorResponse" }, { "additionalProperties": false, "description": "Returned when the `enrich_based_on` object was supplied but does not include any of the expected trigger fields.", "properties": { "__zia_org_enrichment": { "description": "Contains the list of errors identifying the missing expected fields.", "items": { "additionalProperties": false, "description": "Represents a single error reporting the absence of expected trigger fields.", "properties": { "code": { "description": "Identifies the missing-input failure that was raised.\n\nPossible values:\n**EXPECTED_FIELD_MISSING** - None of the trigger fields expected inside `enrich_based_on` were supplied.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the list of trigger fields that the request was expected to include.", "properties": { "expected_fields": { "description": "Lists the trigger fields that the request must include inside `enrich_based_on`.", "items": { "additionalProperties": false, "description": "Identifies a single trigger field that the request was expected to include.", "properties": { "api_name": { "description": "Shows the API name of the expected trigger field.", "enum": [ "name", "email", "website" ], "type": "string" }, "json_path": { "description": "Shows the JSON path at which the expected trigger field should appear in the request payload.", "enum": [ "$.__zia_org_enrichment[0].enrich_based_on.name", "$.__zia_org_enrichment[0].enrich_based_on.email", "$.__zia_org_enrichment[0].enrich_based_on.website" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Provides a message that explains which trigger fields are expected like, \"You have not specified any key in the \"enrich_based_on\" JSON object.\"", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because no expected trigger field was supplied.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "__zia_org_enrichment" ], "type": "object", "x-zs-$id": "CreateOrgEnrichmentExpectedFieldsMissingResponse" }, { "additionalProperties": false, "description": "Returned when a required query parameter is missing or when the supplied `module` value is not supported for organization enrichment.", "properties": { "code": { "description": "Identifies the parameter-level failure that was raised.\n\nPossible values:\n**REQUIRED_PARAM_MISSING** - The required `module` query parameter was not supplied.\n**INVALID_DATA** - The supplied `module` value is not supported for organization enrichment.", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_DATA", "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context that identifies the offending query parameter.", "properties": { "param_name": { "description": "Shows the name of the query parameter that triggered the failure.", "enum": [ "module", "record_id" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Provides a message that explains the parameter-level failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because of a parameter-level failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "OrgEnrichmentInvalidParamErrorResponse" }, { "$ref": "#/components/schemas/FeatureNotEnableOrNotSupported" }, { "additionalProperties": false, "description": "Returned when the top-level `__zia_org_enrichment` array exceeds its allowed cardinality.", "properties": { "code": { "description": "Identifies the array-level validation failure that was raised.\n\nPossible values:\n**INVALID_DATA** - The submitted `__zia_org_enrichment` array contains more entries than the allowed maximum.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the array-level validation failure.", "properties": { "api_name": { "description": "Identifies the array field whose cardinality was exceeded.", "enum": [ "__zia_org_enrichment" ], "type": "string" }, "json_path": { "description": "Shows the JSON path that points to the array field whose cardinality was exceeded.", "enum": [ "$.__zia_org_enrichment" ], "type": "string" }, "maximum_length": { "description": "Shows the maximum number of entries allowed in the array.", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Provides a message that explains the array cardinality violation.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the request ended in failure.\n\nPossible values:\n**error** - The request could not be processed because the array exceeded its allowed cardinality.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "OrgEnrichmentInvalidDataErrorResponse" } ], "description": "Defines the set of bad-request error envelopes that the POST `/__zia_org_enrichment` endpoint can return. Exactly one variant matches the failure condition.", "x-zs-$id": "OrgEnrichmentErrorResponse" } } }, "description": "Returned when the request cannot be processed because of validation failures, missing inputs, exceeded enrichment limits, an unsupported module, or because the data enrichment feature is not enabled or not supported. Resolution: review the returned `code` and `details` to identify the offending input and resend the request after correcting it." }, "403": { "content": { "application/json": { "examples": { "Example": { "description": "Demonstrates the response returned when the authenticated user does not have permission to access the data enrichment feature.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": {}, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermission" } } }, "description": "Returned when the authenticated user does not have the required permission to access the data enrichment feature. Resolution: contact the system administrator to be granted the Manage or View Data Enrichment profile permission." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.intelligence.CREATE" ] } ], "summary": "Trigger organization-level enrichment for a CRM record", "tags": [ "zia_org_enrichment" ], "x-zoho-document": "zia_org_enrichment", "x-zs-llm-description": "Triggers Zia organization enrichment for a CRM record by module and record ID." } }, "/crm/v8/__zia_org_enrichment/{id}": { "get": { "description": "Fetches the enrichment status and enriched organization data for a specific enrichment job using its unique ID. Returns completed, scheduled, or failed enrichment information along with enriched fields such as name, website, email, address, CEO, revenue, employees, social media, and industries.", "operationId": "getOrgEnrichmentById", "parameters": [ { "$ref": "#/components/parameters/ZiaOrgEnrichmentId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Example1": { "description": "Demonstrates a response that returns the trigger fields and the full set of enriched data for a completed organization enrichment job.", "summary": "Completed enrichment with enriched data", "value": { "__zia_org_enrichment": [ { "enrich_based_on": { "email": "sales@zoho.com", "name": "zoho", "website": "www.zoho.com" }, "enriched_data": { "address": [ { "city": "Chengalpattu District", "country": "India", "fill_address": "Estancia IT Park, Plot no. 140, 151, GST Road, Vallancheri", "pin_code": "603202", "state": "Tamil Nadu" } ], "business_model": [ "Business to Business" ], "ceo": "Sridhar Vembu", "description": [ { "description": "Zoho Corporation offers web-based business apps, network and IT infrastructure management applications. Run your entire business with Zoho's suite of online productivity tools and SaaS applications. Over 45 million users trust us worldwide.", "title": "Meta_Description" }, { "description": "Software is Zoho's passion. Zoho creates great software to solve business problems. We believe that software is the ultimate product created by human hearts and hands.", "title": "Schema_Description" } ], "head_quarters": [ { "country": "India" } ], "id": "jRsJ7grCwzJfs4B384k4zY3OFsLIE+EGt9AwDDtb4j4=", "industries": [ { "description": "Includes information and data processing services, computer programming, systems design, consultancy, hosting and other computer related services.", "name": "Computer Programming Services" } ], "logo": "data:image/jpg;base64,/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCABkAGQDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD3+iiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKQkAEkgAdSaAForkZPiR4djvjbGadlBwZ1izH/ifyrprO/tNRtxPZ3EU8R/ijYEf/WpKSexlTr0qjtCSZYooopmoUUUUAFFFFABRRRQBw174p1/U9bvNN8M2EEiWbeXPcTngN045HcH16U3+xPHt9/x9+Iba1Q/w26cj8lH86PCX+hePvFGnnjzHFwB9ST/AO1BXd1zwjzq8mz18RXWFkqdKEbWTu1du6T6nCf8K3a651XxHqd2e+Gx/wChFq5m61fUfDq614TFxNdF2SK0Z+WVXHI/FSB9a9hrytLyx1X4xxvsDRo5jVs8M6IcH8xx9BROnGNnHQ4MVmFevRlhpe85qy0WltW9O0Uzu9H8O2en+HYNKmt4ZlCDzg6Bg7nqeffp+FYd58P47e4N54dv5tMuf7gYmNvb1A/Me1drRWzimcEsNSlFRa227/eeRz/EDxTZpcWzQ2kptJTDNdiJiu7JHUEDse3Nb0OneO9UgjnbxDZQQSqHQwIDkEZB+6P51y2oXr6dfeKdDijMk2o3qLCmOmWZj/NR+NetaRYnTNHs7EtuMEKxlvUgc11zqeynyQirJLW13scWH5qlRwlJtLz63f6HIP4E1GWNpNS8W6jKqgsVTIA/Nj/Kk8NahqEckujW1+17NCvmk3PLKpIAGfy4yetdte/8eFx/1yb+Rrznw7/oXxJi7fbbFvxwT/8AG64a06uKr+wc2kouWllqml282epCEKEPaRjdtpa3e9/M7Pd4g/uW1IX8QKC3l27Y5wO/61t0VzfUn/z9l9//AADo9v8A3F9xS0zUF1CzExXY4JVl9DRWb4f/AOPOf/ru38hRRg8ROpQjKWrsFamo1GlsYc3+gfGKBui39kQT6kA//GxXd1yHjLRdSuL3Tdb0eNZb2wY5hY48xT/k8e9U/wC2/Ht7xa+Hra1Xu078j82H8q3UuRtNPc7qlH61TpzjKKtGzu0tm/0sd0RkEZxnuK8NaG58J+ItLTULZovs160jXOCRNGSoJHrgA/8AfVdx/Y/j++/4+tetLND/AAwJkj8lH86saf8AD+NdQS91vU7jWJUBCJcD5Bn2JOfp0pT5qlklYxp4ejh6yryqpuKkrK7vdWteyR1VjqNnqduJ7K5injP8UbZx9fSrNcXffD63juDeaBezaXdDoEYlD7eo/Ue1VJdQ8e21vJp0mmQ3UzqUjvYmAAzxuPIGfqBWvM1ujw/rFSnpVg/Var/NGZpslhq/xguJ1G5E3GP0Z0ULn9CR9BXqVeY/8IZq3ho6Tq+kRR3d9bKwuoc/f3Z6euAxH4A1p/2349vP+PXw7a26nvO/I/Nh/KuqNDmipJrXe7/roZ4VypRftIvmbvou/wDkdpe/8eFx/wBcm/ka84uP9E8WeEbwdZTJB/48R/7PWk+mfELUEZJ9V0+0jcYZEUE4P/AT/Oqml+FNU0vWor/UTLqctuCIBu+RM9x+Z445rmmqeFrrEVJXXK42SbetuyO5Oden7KEbO6d3ZbfM9HorF/tTVP8AoEt/31SHU9WIIXSiGPQlq4/7Qo9pf+Ay/wAjq+rT8vvRH4f/AOPOf/ru38hRV3SNPezstkxzK7F2APTPb9KKnBUZxw8FJWdh15xdRtGlRRRXoHMFQ3T+VZzSZlG2Nm/cpufgfwjByfQYNTUUAYXhKe+udDWfUZ7yS5kkZit3beS8QPKpjYm7AxlgME5wcdM+K814+KFiY3fl/bXSSA2wFstr5ZKSCXbkuW2cbickjbgZHW0UAY+uz6vDNpP9kwpMXvCtykjFU8ryZT8zBWKjeE5A64HepfD0t/P4c06XVFZb97dDcBl2kPjnIwMc+wrTooA5Lwzea9cahEuom8ZTaM16lxbCJILncuEhYKN6YMnOW4VTnJOetoooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAz/t0v8AdT8jR9ul/up+RoooAPt0v91PyNH26X+6n5GiigA+3S/3U/I0fbpf7qfkaKKAD7dL/dT8jR9ul/up+RoooAPt0v8AdT8jR9ul/up+RoooAPt0v91PyNH26X+6n5GiigA+3S/3U/I0UUUAf//Z", "name": "ZOHO", "no_of_employees": "12000", "org_status": "Large Enterprise", "org_type": "Private Limited Company", "primary_contact": "844-316-5544", "primary_email": "sales@zohocorp.com", "revenue": "$1B", "secondary_contact": "0800-085-6099", "secondary_email": "press@zohocorp.com", "social_media": [ { "media_type": "LINKEDIN", "media_url": [ "linkedin.com/company/zohocorp" ] }, { "media_type": "TWITTER", "media_url": [ "twitter.com" ] } ], "territory_list": [ "India", "United States of America", "South Africa", "Canada", "Nigeria" ], "website": "https://www.zoho.com", "years_in_industry": 27 }, "id": "1941874000003442020", "status": "COMPLETED" } ] } } }, "schema": { "additionalProperties": false, "description": "Defines the response body returned when the requested organization enrichment job is retrieved successfully.", "properties": { "__zia_org_enrichment": { "description": "Contains the details of the requested organization enrichment job.", "items": { "additionalProperties": false, "description": "Represents the full record of a single organization enrichment job, including its trigger fields and enriched output.", "properties": { "enrich_based_on": { "additionalProperties": false, "description": "Shows the trigger values that were supplied when the enrichment job was scheduled.", "properties": { "email": { "description": "Shows the email address that was used as a trigger value.", "format": "email", "maxLength": 255, "type": "string" }, "name": { "description": "Shows the organization name that was used as a trigger value.", "maxLength": 255, "type": "string" }, "website": { "description": "Shows the website domain that was used as a trigger value.", "maxLength": 255, "type": "string" } }, "type": "object" }, "enriched_data": { "additionalProperties": true, "description": "Contains the data retrieved by Zia for the organization. The keys present in this object depend on the fields configured in the enrichment configuration of the organization. Returns `null` when the job has not yet completed or when no public data could be retrieved.", "type": [ "object", "null" ] }, "id": { "description": "Shows the unique identifier of the organization enrichment job.", "maxLength": 19, "type": "string", "x-zs-$id": "ZiaOrgEnrichmentByIdId" }, "status": { "description": "Indicates the current execution status of the enrichment job.\n\nPossible values:\n**COMPLETED** - The job has finished and enriched data is available.\n**SCHEDULED** - The job is queued and yet to run.\n**FAILED** - The job ended in a failure.\n**DATA_NOT_FOUND** - The job completed but Zia could not locate public data to enrich.", "enum": [ "COMPLETED", "SCHEDULED", "FAILED", "DATA_NOT_FOUND", "RUNNING" ], "type": "string" } }, "required": [ "id", "status", "enrich_based_on", "enriched_data" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__zia_org_enrichment" ], "type": "object", "x-zs-$id": "GetSpecificOrgEnrichmentResponse" } } }, "description": "Returns the details and enriched data of the requested organization enrichment job." }, "204": { "description": "Returned when no enrichment job exists for the supplied identifier or when the identifier is invalid." }, "400": { "content": { "application/json": { "examples": { "Example": { "description": "Demonstrates the response returned when the data enrichment feature is not enabled for the organization.", "summary": "Data enrichment feature not enabled", "value": { "__zia_org_enrichment": [ { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Data Enrichment feature not enabled", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Defines the response body returned when the data enrichment feature is not enabled or not supported.", "properties": { "__zia_org_enrichment": { "description": "Contains the list of error envelopes returned by the endpoint.", "items": { "$ref": "#/components/schemas/FeatureNotEnableOrNotSupported" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "GetSpecificOrgEnrichmentErrorResponse" } } }, "description": "Returned when the data enrichment feature is not enabled or supported for the organization. Resolution: enable the data enrichment feature or upgrade to a CRM edition that supports it." }, "403": { "content": { "application/json": { "examples": { "Example": { "description": "Demonstrates the response returned when the authenticated user does not have permission to access the data enrichment feature.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": {}, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermission" } } }, "description": "Returned when the authenticated user does not have the required permission to access the data enrichment feature. Resolution: contact the system administrator to be granted the Manage or View Data Enrichment profile permission." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.intelligence.READ" ] } ], "summary": "Org Enrichment Details", "tags": [ "zia_org_enrichment" ], "x-zoho-document": "zia_org_enrichment", "x-zs-llm-description": "Fetches enrichment status and enriched org data for a specific enrichment job ID." } }, "/crm/v8/actions/watch": { "delete": { "description": "To disable one or more notification channels in your Zoho CRM organization.", "operationId": "disableNotifications", "parameters": [ { "$ref": "#/components/parameters/ChannelIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "summary": "Successful notification channel disable response", "value": { "watch": [ { "code": "SUCCESS", "details": { "channel_id": "10000", "resource_id": "554023000000000129", "resource_uri": "https://www.zohoapis.com/crm/v8/Contacts" }, "message": "Successfully un-subscribed from actions-watch", "status": "success" }, { "code": "SUCCESS", "details": { "channel_id": "10000", "resource_id": "554023000000000131", "resource_uri": "https://www.zohoapis.com/crm/v8/Deals" }, "message": "Successfully un-subscribed from actions-watch", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the disable results for each notification channel processed in the request.", "properties": { "watch": { "description": "Represents the list of results for each disabled notification channel.", "items": { "additionalProperties": false, "description": "Represents the result for a single notification channel disable operation.", "properties": { "code": { "description": "Represents the result code for the channel disable operation.", "maxLength": 32, "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the resource details of the disabled notification channel.", "properties": { "channel_id": { "description": "Represents the identifier of the notification channel that was disabled.", "maxLength": 64, "type": "string" }, "resource_id": { "description": "Represents the unique identifier of the CRM resource associated with the disabled notification channel.", "maxLength": 64, "type": "string" }, "resource_uri": { "description": "Represents the URI of the CRM resource associated with the disabled notification channel.", "maxLength": 255, "type": "string" } }, "required": [ "resource_uri", "resource_id", "channel_id" ], "type": "object" }, "message": { "description": "Represents the status message for the channel disable result.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the channel disable result.", "maxLength": 32, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "watch" ], "type": "object", "x-zs-$id": "DisableNotificationsResponse" } } }, "description": "Returns the disable results for each notification channel processed in the request." }, "207": { "$ref": "#/components/responses/NotificationsMultiStatus" }, "400": { "$ref": "#/components/responses/NotificationsBadRequest" }, "401": { "$ref": "#/components/responses/NotificationsUnauthorized" }, "429": { "$ref": "#/components/responses/NotificationsTooManyRequests" }, "500": { "$ref": "#/components/responses/NotificationsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.notifications.DELETE" ] }, { "OAuth2": [ "ZohoCRM.notifications.ALL" ] } ], "summary": "Disable notification channels", "tags": [ "notifications" ], "x-zoho-document": "notifications" }, "get": { "description": "To retrieve the list of active notification channels configured for your Zoho CRM organization.", "operationId": "getNotifications", "parameters": [ { "$ref": "#/components/parameters/NotificationsModule" }, { "$ref": "#/components/parameters/ChannelId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the response for a successful GET request, including active notification channel details and pagination information.", "summary": "Successful response listing active notification channels", "value": { "info": { "count": 3, "more_records": false, "page": 1, "per_page": 200 }, "watch": [ { "channel_expiry": "2023-08-02 16:51:03-11:00", "channel_id": "1000000068001", "events": [ "Leads.edit", "Leads.create", "Leads.delete" ], "fields": null, "notification_condition": [ { "field_selection": { "group": [ { "field": { "api_name": "Last_Name", "id": "554023000000000559" }, "group": null, "group_operator": null }, { "field": { "api_name": "Full_Name", "id": "554023000000000597" }, "group": null, "group_operator": null } ], "group_operator": "and" }, "module": { "api_name": "Leads", "id": "554023000000000125" }, "type": "field_selection" } ], "notify_on_related_action": false, "notify_url": "https://webhook.site/2c9xxx0fa9", "resource_id": "554023000000000125", "resource_name": "Leads", "resource_uri": "https://www.zohoapis.com/crm/v8/Leads", "return_affected_field_values": false, "token": "xyz" }, { "channel_expiry": "2023-08-11 02:12:33-11:00", "channel_id": "10000", "events": [ "Contacts.create" ], "fields": null, "notification_condition": null, "notify_on_related_action": false, "notify_url": "https://webhook.site/2c9axx20fa9", "resource_id": "554023000000000129", "resource_name": "Contacts", "resource_uri": "https://www.zohoapis.com/crm/v8/Contacts", "return_affected_field_values": false, "token": "deals.all.notif" }, { "channel_expiry": "2023-08-11 02:13:01-11:00", "channel_id": "10000", "events": [ "Deals.edit", "Deals.create", "Deals.delete" ], "fields": null, "notification_condition": [ { "field_selection": { "group": [ { "field": { "api_name": "Stage", "id": "554023000000000525" }, "group": null, "group_operator": null }, { "group": [ { "field": { "api_name": "Account_Name", "id": "554023000000000523" }, "group": null, "group_operator": null }, { "field": { "api_name": "Lead_Source", "id": "554023000000000535" }, "group": null, "group_operator": null } ], "group_operator": "or" } ], "group_operator": "or" }, "module": { "api_name": "Deals", "id": "554023000000000131" }, "type": "field_selection" } ], "notify_on_related_action": false, "notify_url": "https://webhook.site/2c9a0xx20fa9", "resource_id": "554023000000000131", "resource_name": "Deals", "resource_uri": "https://www.zohoapis.com/crm/v8/Deals", "return_affected_field_values": false, "token": "deals.all.notif" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the list of active notification channels and pagination information for the response.", "properties": { "info": { "additionalProperties": false, "description": "Represents the pagination metadata for the notification channel list, including the current page, record count per page, and whether additional pages are available.", "properties": { "count": { "description": "Represents the number of notification channel records included in the current response.", "format": "int32", "maximum": 100, "type": "integer" }, "more_records": { "description": "Indicates whether more notification channel records are available beyond the current page.\nPossible values:\ntrue - Additional notification channels are available.\nfalse - No additional notification channels are available.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.\n\n**Note**\nUse the page and per_page parameter to fetch records according to their position in the CRM. Let's assume that the user has to fetch 400 records. The maximum number of records that one can get for an API call is 200. So, for records above the 200th position, they cannot be fetched. By using the page (1, 2, 3 and 4) and per_page (100) parameter, the user can fetch all 400 records using 4 API calls.", "format": "int32", "maximum": 100, "type": "integer" }, "per_page": { "description": "Represents the number of notification channel records returned per page.", "format": "int32", "maximum": 200, "type": "integer" } }, "type": "object" }, "watch": { "description": "Represents the list of active notification channels for the authenticated user.", "items": { "additionalProperties": false, "description": "Represents the details of a single active notification channel.", "properties": { "channel_expiry": { "description": "Represents the expiry date and time of the notification channel.", "format": "date-time", "type": "string" }, "channel_id": { "description": "Represents the unique identifier of the notification channel.", "maxLength": 64, "type": "string" }, "events": { "description": "Represents the list of CRM module events for which notifications are triggered on this channel.", "items": { "description": "Represents a CRM module event name that triggers a notification on this channel.", "maxLength": 128, "type": "string" }, "maxItems": 10, "type": "array" }, "fields": { "description": "Represents the list of record fields included in the notification payload.", "items": {}, "maxItems": 100, "type": [ "array", "null" ] }, "notification_condition": { "description": "Represents the list of field-selection conditions that determine which record changes trigger a notification on this channel.", "items": { "additionalProperties": false, "description": "Represents a single field-selection condition associated with the notification channel.", "properties": { "field_selection": { "additionalProperties": false, "description": "Represents the field selection configuration, including the grouping operator and the list of field criteria.", "properties": { "group": { "description": "Represents the list of field condition groups used to filter which record field changes trigger the notification.", "items": { "additionalProperties": false, "description": "Represents a single field condition entry, including the field reference, grouping operator, and optional sub-groups.", "properties": { "field": { "additionalProperties": false, "description": "Represents the CRM field that the condition monitors for changes.", "properties": { "api_name": { "description": "Represents the API name of the CRM field being monitored in the condition.", "maxLength": 128, "type": "string", "x-zs-$id": "NotificationsFieldApiName" }, "id": { "description": "Represents the unique identifier of the CRM field being monitored in the condition.", "maxLength": 64, "type": "string" } }, "type": "object" }, "group": { "description": "Represents an optional nested sub-group of field conditions within the parent group.", "items": {}, "maxItems": 10, "type": [ "array", "null" ] }, "group_operator": { "description": "Represents the logical operator applied to the conditions within this sub-group.\nPossible values:\nand - All conditions in the sub-group must be satisfied.\nor - Any condition in the sub-group must be satisfied.\nnull - No grouping operator is applied.", "enum": [ "and", "or", null ], "type": [ "string", "null" ] } }, "type": "object" }, "maxItems": 2, "type": "array" }, "group_operator": { "description": "Represents the logical operator applied to the field condition groups within the field selection configuration.", "maxLength": 3, "type": "string" } }, "type": "object" }, "module": { "additionalProperties": false, "description": "Represents the CRM module context associated with the field-selection condition.", "properties": { "api_name": { "description": "Represents the API name of the CRM module associated with the condition.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the CRM module associated with the condition.", "maxLength": 64, "type": "string" } }, "type": "object" }, "type": { "description": "Represents the type of notification condition.", "maxLength": 32, "type": "string" } }, "type": "object" }, "maxItems": 2, "type": [ "array", "null" ] }, "notify_on_related_action": { "description": "Indicates whether the notification channel is triggered by actions on records related to the subscribed module.\nPossible values:\ntrue - Notifications are sent for related record actions.\nfalse - Notifications are sent only for direct record actions.", "type": "boolean" }, "notify_url": { "description": "Represents the callback URL to which notifications are delivered when subscribed events occur.", "maxLength": 255, "type": "string" }, "resource_id": { "description": "Represents the unique identifier of the CRM resource associated with the notification channel.", "maxLength": 64, "type": "string" }, "resource_name": { "description": "Represents the name of the CRM resource associated with the notification channel.", "maxLength": 128, "type": "string" }, "resource_uri": { "description": "Represents the URI of the CRM resource associated with the notification channel.", "maxLength": 255, "type": "string" }, "return_affected_field_values": { "description": "Indicates whether the notification payload includes the changed field values from the affected record.\nPossible values:\ntrue - The notification payload includes the updated field values.\nfalse - The notification payload does not include field values.", "type": "boolean" }, "token": { "description": "Represents the verification token used to authenticate notifications sent to the callback URL.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": "object" }, "maxItems": 200, "type": "array" } }, "type": "object", "x-zs-$id": "GetNotificationsResponse" } } }, "description": "Returns the list of active notification channels configured for the user." }, "400": { "$ref": "#/components/responses/NotificationsBadRequest" }, "401": { "$ref": "#/components/responses/NotificationsUnauthorized" }, "429": { "$ref": "#/components/responses/NotificationsTooManyRequests" }, "500": { "$ref": "#/components/responses/NotificationsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.notifications.READ" ] } ], "summary": "List active notification channels", "tags": [ "notifications" ], "x-zoho-document": "notifications", "x-zs-llm-description": "This tool is used to get the notification details that are subscribed" }, "patch": { "description": "To partially update the properties of a notification channel in your Zoho CRM organization.", "operationId": "updateNotificationInfo", "parameters": [ { "$ref": "#/components/parameters/ChannelId" } ], "requestBody": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows a PATCH request body updating the callback URL, event subscriptions, and field-selection conditions for a notification channel.", "summary": "Update a notification channel URL, events, and field-selection conditions", "value": { "channel_expiry": "2025-11-25 12:00:00+00:00", "channel_id": "1000000068001", "events": [ "Leads.create", "Contacts.edit", "Deals.delete" ], "notification_condition": [ { "field_selection": { "group": [ { "api_name": "Company" }, { "api_name": "Email" } ], "group_operator": "and" }, "module": { "api_name": "Leads" }, "type": "field_selection" } ], "notify_on_related_action": true, "notify_url": "https://www.example.com/callback", "return_affected_field_values": false, "token": "TOKEN_FOR_VERIFICATION_OF_1000000068001" } } }, "schema": { "additionalProperties": false, "description": "Contains the notification channel fields to be partially updated.", "properties": { "channel_expiry": { "description": "Specify the new expiry date and time for the notification channel.", "format": "date-time", "type": "string" }, "channel_id": { "description": "Specify the identifier of the notification channel to update.", "maxLength": 64, "type": "string" }, "events": { "description": "Specify the updated list of CRM module events to subscribe to on this channel.", "items": { "description": "Specify a CRM module event name (for example, Leads.create or Contacts.edit).", "maxLength": 128, "type": "string" }, "maxItems": 50, "type": "array" }, "notification_condition": { "description": "Specify the field selection conditions that determine which record field changes trigger a notification.", "items": { "additionalProperties": false, "description": "Specify the configuration for a single field-selection notification condition.", "properties": { "field_selection": { "additionalProperties": false, "description": "Specify the field selection criteria, including the grouping operator and field references.", "properties": { "group": { "description": "Specify the list of field references to use as notification conditions.", "items": { "additionalProperties": false, "description": "Specify a single CRM field reference to include as a notification condition.", "properties": { "api_name": { "description": "Specify the API name of the CRM field to monitor for changes.", "maxLength": 64, "type": "string" }, "id": { "description": "Specify the unique identifier of the CRM field to monitor for changes.", "maxLength": 32, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 10, "type": "array" }, "group_operator": { "description": "Specify the logical operator to apply to the field condition groups.\nPossible values:\nand - All conditions in the group must be satisfied.\nor - Any condition in the group must be satisfied.", "enum": [ "and", "or" ], "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object" }, "module": { "additionalProperties": false, "description": "Specify the CRM module context for the field-selection condition.", "properties": { "api_name": { "description": "Specify the API name of the CRM module. Refer to the [Get Modules](modules.json#$.paths./settings/modules.get) resource for valid values.", "maxLength": 64, "type": "string" }, "id": { "description": "Specify the unique identifier of the CRM module.", "maxLength": 32, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "type": { "description": "Specify the condition type.", "enum": [ "field_selection" ], "type": "string" } }, "required": [ "type", "module", "field_selection" ], "type": "object" }, "maxItems": 2, "type": "array" }, "notify_on_related_action": { "description": "Indicate whether the notification channel should be triggered by actions on records related to the subscribed module.\nPossible values:\ntrue - Notifications are sent for related record actions.\nfalse - Notifications are sent only for direct record actions.\n\n**Note**\n\nOn trigger of any notification-enabled event in a module, Zoho CRM sends a notification to the user through the notify URL", "type": "boolean" }, "notify_url": { "description": "Specify the destination callback URL for the notification channel.", "maxLength": 255, "type": "string" }, "return_affected_field_values": { "description": "Indicate whether the notification payload should include the changed field values from the affected record.\nPossible values:\ntrue - The notification payload includes updated field values.\nfalse - The notification payload does not include field values.", "type": "boolean" }, "token": { "description": "Specify the verification token to be included in notification callbacks.", "maxLength": 256, "type": "string" } }, "required": [ "channel_id", "notify_url", "events" ], "type": "object" } } }, "description": "The request body must contain the notification channel fields to update.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "summary": "Successful notification channel partial update response", "value": { "watch": [ { "code": "SUCCESS", "details": { "events": [ { "channel_expiry": "2023-08-02 16:59:50-11:00", "channel_id": "10000", "resource_id": "554023000000000131", "resource_name": "Deals", "resource_uri": "https://www.zohoapis.com.com/crm/v2/Deals" } ] }, "message": "Successfully updated the subscribe details", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the results of the partial notification channel update.", "properties": { "watch": { "description": "Represents the list of update results, one entry per channel updated.", "items": { "additionalProperties": false, "description": "Represents the update result for a single notification channel.", "properties": { "code": { "description": "Represents the result code for the channel update operation.", "maxLength": 32, "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the event channel details for the updated notification channel.", "properties": { "events": { "description": "Represents the list of event-channel subscriptions for the updated notification channel.", "items": { "additionalProperties": false, "description": "Represents the details of a single event-channel subscription after the update.", "properties": { "channel_expiry": { "description": "Represents the expiry date and time of the updated notification channel. Always returned in the response.", "format": "date-time", "type": "string" }, "channel_id": { "description": "Represents the identifier of the updated notification channel. Always returned in the response.", "maxLength": 64, "type": "string" }, "resource_id": { "description": "Represents the unique identifier of the CRM resource for the updated event channel subscription. Always returned in the response.", "maxLength": 64, "type": "string" }, "resource_name": { "description": "Represents the name of the CRM resource for the updated event channel subscription. Always returned in the response.", "maxLength": 128, "type": "string" }, "resource_uri": { "description": "Represents the URI of the CRM resource for the updated event channel subscription. Always returned in the response.", "maxLength": 255, "type": "string" } }, "required": [ "channel_expiry", "resource_uri", "resource_id", "resource_name", "channel_id" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "events" ], "type": "object" }, "message": { "description": "Represents the status message for the channel update result.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the channel update result.", "maxLength": 32, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "watch" ], "type": "object", "x-zs-$id": "UpdateNotificationInfoResponse" } } }, "description": "Returns the update results for each notification channel modified in the request." }, "207": { "$ref": "#/components/responses/NotificationsMultiStatus" }, "400": { "$ref": "#/components/responses/NotificationsBadRequest" }, "401": { "$ref": "#/components/responses/NotificationsUnauthorized" }, "429": { "$ref": "#/components/responses/NotificationsTooManyRequests" }, "500": { "$ref": "#/components/responses/NotificationsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.notifications.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.notifications.ALL" ] } ], "summary": "Update notification channel information", "tags": [ "notifications" ], "x-zoho-document": "notifications" }, "post": { "description": "To create one or more notification channels in your Zoho CRM organization.", "operationId": "createNotifications", "requestBody": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows a request body with two notification channel configurations, each including a callback URL, channel ID, event list, and verification token.", "summary": "Create two notification channels with event subscriptions", "value": { "watch": [ { "channel_expiry": "2024-12-31 23:59:59+00:00", "channel_id": "1000000068001", "events": [ "Leads.create", "Contacts.edit" ], "notify_url": "https://www.example.com/notify", "token": "TOKEN_FOR_VERIFICATION_1" }, { "channel_expiry": "2024-12-31 23:59:59+00:00", "channel_id": "1000000068002", "events": [ "Deals.delete" ], "notify_url": "https://www.example.com/notify2", "token": "TOKEN_FOR_VERIFICATION_2" } ] } } }, "schema": { "additionalProperties": false, "description": "The request body must contain a watch array. You can include a maximum of **50** objects per request.", "properties": { "watch": { "description": "Specify the list of notification channels to create.", "items": { "additionalProperties": false, "description": "Specify the configuration for a single notification channel.", "properties": { "channel_expiry": { "description": "Specify the expiry date and time for the notification channel.", "format": "date-time", "type": "string" }, "channel_id": { "description": "Specify a client-defined identifier for the notification channel.", "maxLength": 64, "type": "string" }, "events": { "description": "Specify the list of CRM module events to subscribe to on this channel.", "items": { "description": "Specify a CRM module event name (for example, Leads.create or Contacts.edit).", "maxLength": 128, "type": "string" }, "maxItems": 50, "type": "array" }, "notify_url": { "description": "Specify the callback URL to which notifications are delivered when subscribed events occur.", "maxLength": 255, "type": "string" }, "token": { "description": "Specify an optional verification token that is included in notification callbacks.", "maxLength": 256, "type": "string" } }, "required": [ "notify_url", "events" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "watch" ], "type": "object" } } }, "description": "The request body must contain a watch array. You can include a maximum of 50 objects per request.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the successful creation result for a notification channel, including the subscribed event details, resource information, and status.", "summary": "Successful notification channel creation response", "value": { "watch": [ { "code": "SUCCESS", "details": { "events": [ { "channel_expiry": "2023-08-02 16:59:50-11:00", "channel_id": "10000", "resource_id": "554023000000000131", "resource_name": "Deals", "resource_uri": "https://www.zohoapis.com/crm/v8/Deals" } ] }, "message": "Successfully subscribed for actions-watch of the given module", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the creation results for each submitted notification channel.", "properties": { "watch": { "description": "Represents the list of creation results, one entry per channel submitted in the request.", "items": { "additionalProperties": false, "description": "Represents the creation result for a single notification channel.", "properties": { "code": { "description": "Represents the result code for the channel creation attempt.", "maxLength": 32, "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the event channel details for the successfully created notification channel.", "properties": { "events": { "description": "Represents the list of event-channel subscriptions created for the notification channel.", "items": { "additionalProperties": false, "description": "Represents the details of a single event-channel subscription for the notification channel.", "properties": { "channel_expiry": { "description": "Represents the expiry date and time of the created notification channel. Always returned in the response.", "format": "date-time", "type": "string" }, "channel_id": { "description": "Represents the identifier of the notification channel. Always returned in the response.", "maxLength": 64, "type": "string" }, "resource_id": { "description": "Represents the unique identifier of the CRM resource subscribed to in this event channel. Always returned in the response.", "maxLength": 64, "type": "string" }, "resource_name": { "description": "Represents the name of the CRM resource subscribed to in this event channel. Always returned in the response.", "maxLength": 128, "type": "string" }, "resource_uri": { "description": "Represents the URI of the CRM resource subscribed to in this event channel. Always returned in the response.", "maxLength": 255, "type": "string" } }, "required": [ "channel_expiry", "resource_uri", "resource_id", "resource_name", "channel_id" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "events" ], "type": "object" }, "message": { "description": "Represents the status message for the channel creation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the channel creation result.", "maxLength": 32, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "watch" ], "type": "object", "x-zs-$id": "CreateNotificationsResponse" } } }, "description": "Returns the creation results for each notification channel submitted in the request." }, "207": { "$ref": "#/components/responses/NotificationsMultiStatus" }, "400": { "$ref": "#/components/responses/NotificationsBadRequest" }, "401": { "$ref": "#/components/responses/NotificationsUnauthorized" }, "429": { "$ref": "#/components/responses/NotificationsTooManyRequests" }, "500": { "$ref": "#/components/responses/NotificationsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.notifications.CREATE" ] }, { "OAuth2": [ "ZohoCRM.notifications.ALL" ] } ], "summary": "Create notification channels", "tags": [ "notifications" ], "x-zoho-document": "notifications" }, "put": { "description": "To replace all properties of an existing notification channel in your Zoho CRM organization.", "operationId": "updateNotificationDetails", "requestBody": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows a PUT request body that replaces all properties of a notification channel, including the callback URL, event list, conditions, and verification token.", "summary": "Replace all details of a notification channel", "value": { "watch": [ { "channel_expiry": "2025-11-25 12:00:00+00:00", "channel_id": "1000000068001", "events": [ "Leads.create", "Contacts.edit", "Deals.delete" ], "notification_condition": [ { "type": "field_selection" } ], "notify_on_related_action": true, "notify_url": "https://www.example.com/callback", "token": "TOKEN_FOR_VERIFICATION_OF_1000000068001" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the complete notification channel configurations that will replace the existing settings.", "properties": { "watch": { "description": "Specify the list of notification channel replacements.", "items": { "additionalProperties": false, "description": "Specify the complete replacement configuration for a single notification channel.", "properties": { "channel_expiry": { "description": "Specify the expiry date and time for the notification channel.", "format": "date-time", "type": "string" }, "channel_id": { "description": "Specify the identifier of the notification channel to update. Always returned in the response.", "maxLength": 64, "type": "string" }, "events": { "description": "Specify the complete list of CRM module events to subscribe to, replacing the current event list.", "items": { "description": "Specify a CRM module event name (for example, Leads.create or Contacts.edit).", "maxLength": 128, "type": "string" }, "maxItems": 50, "type": "array" }, "notification_condition": { "description": "Specify the field-selection conditions to replace the existing conditions for the notification channel.", "items": { "additionalProperties": false, "description": "Specify the configuration for a single field-selection condition.", "properties": { "type": { "description": "Specify the condition type.\nPossible values:\nfield_selection - The condition uses field selection criteria.", "enum": [ "field_selection" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "maxItems": 2, "type": "array" }, "notify_on_related_action": { "description": "Indicate whether the notification channel should be triggered by actions on records related to the subscribed module.\nPossible values:\ntrue - Notifications are sent for related record actions.\nfalse - Notifications are sent only for direct record actions.", "type": "boolean" }, "notify_url": { "description": "Specify the callback URL for the notification channel.", "maxLength": 255, "type": "string" }, "return_affected_field_values": { "description": "Indicate whether the notification payload should include the changed field values from the affected record.\nPossible values:\ntrue - The notification payload includes updated field values.\nfalse - The notification payload does not include field values.", "type": "boolean" }, "token": { "description": "Specify the verification token to be included in notification callbacks.", "maxLength": 256, "type": "string" } }, "required": [ "channel_id", "notify_url", "events" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object" } } }, "description": "The request body must contain a watch array. You can include a maximum of 50 objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the successful replacement result for a notification channel, including the event subscriptions, resource details, and status.", "summary": "Successful notification channel full replacement response", "value": { "watch": [ { "code": "SUCCESS", "details": { "events": [ { "channel_expiry": "2023-08-11 02:04:14-11:00", "channel_id": "10000", "resource_id": "554023000000000129", "resource_name": "Contacts", "resource_uri": "https://www.zohoapis.com/crm/v8/Contacts" }, { "channel_expiry": "2023-08-11 02:04:14-11:00", "channel_id": "10000", "resource_id": "554023000000000131", "resource_name": "Deals", "resource_uri": "https://www.zohoapis.com/crm/v8/Deals" } ] }, "message": "Successfully subscribed for actions-watch of the given module", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the results of the full notification channel replacement.", "properties": { "watch": { "description": "Represents the list of replacement results, one entry per channel submitted in the request.", "items": { "additionalProperties": false, "description": "Represents the replacement result for a single notification channel.", "properties": { "code": { "description": "Represents the result code for the channel replacement operation.", "maxLength": 32, "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the event channel details for the replaced notification channel.", "properties": { "events": { "description": "Represents the list of event-channel subscriptions for the replaced notification channel.", "items": { "additionalProperties": false, "description": "Represents the details of a single event-channel subscription after the replacement.", "properties": { "channel_expiry": { "description": "Represents the expiry date and time of the replaced notification channel. Always returned in the response.", "format": "date-time", "type": "string" }, "channel_id": { "description": "Represents the identifier of the notification channel after replacement. Always returned in the response.", "maxLength": 64, "type": "string" }, "resource_id": { "description": "Represents the unique identifier of the CRM resource for the replaced event channel subscription. Always returned in the response.", "maxLength": 64, "type": "string" }, "resource_name": { "description": "Represents the name of the CRM resource for the replaced event channel subscription. Always returned in the response.", "maxLength": 128, "type": "string" }, "resource_uri": { "description": "Represents the URI of the CRM resource for the replaced event channel subscription. Always returned in the response.", "maxLength": 255, "type": "string" } }, "required": [ "channel_expiry", "resource_uri", "resource_id", "resource_name", "channel_id" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "events" ], "type": "object" }, "message": { "description": "Represents the status message for the channel replacement result.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the channel replacement result.", "maxLength": 32, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "watch" ], "type": "object", "x-zs-$id": "UpdateNotificationDetailsResponse" } } }, "description": "Returns the replacement results for each notification channel submitted in the request." }, "207": { "$ref": "#/components/responses/NotificationsMultiStatus" }, "400": { "$ref": "#/components/responses/NotificationsBadRequest" }, "401": { "$ref": "#/components/responses/NotificationsUnauthorized" }, "429": { "$ref": "#/components/responses/NotificationsTooManyRequests" }, "500": { "$ref": "#/components/responses/NotificationsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.notifications.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.notifications.ALL" ] } ], "summary": "Update full notification details", "tags": [ "notifications" ], "x-zoho-document": "notifications" } }, "/crm/v8/coql": { "post": { "description": "To retrieve records from one or more Zoho CRM modules using a COQL SELECT query, with support for cross-module joins, aggregate functions, and flexible filtering.", "operationId": "executeCOQLQuery", "requestBody": { "content": { "application/json": { "examples": { "GetLeads": { "description": "Shows a COQL query request to retrieve the Last_Name and First_Name fields from the Leads module with a WHERE condition.", "summary": "COQL query to retrieve Leads records", "value": { "select_query": "select Last_Name, First_Name from Leads where Last_Name = 'Smith'" } }, "GetLeadsWithFieldMetadata": { "description": "Shows a COQL query request with the include_meta parameter set to fields to retrieve field metadata for each SELECT column.", "summary": "COQL query to retrieve Leads records with field metadata", "value": { "include_meta": [ "fields" ], "select_query": "select Last_Name from Leads where Last_Name = 'TestLead'" } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for the COQL query execution.", "properties": { "include_meta": { "description": "Specify the list of metadata types to include in the response.\nPossible values:\n**fields** - Includes field metadata for the SELECT columns in the response.", "items": { "description": "Specifies a metadata type to include in the response.\nPossible values:\n**fields** - Includes field metadata for the SELECT columns in the response.", "enum": [ "fields" ], "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array" }, "select_query": { "description": "Specify the COQL SELECT query to retrieve records. The query must reference module and field API names.", "maxLength": 2147483647, "type": "string" } }, "required": [ "select_query" ], "type": "object" } } }, "description": "The request body must contain a **select_query** field with a valid COQL SELECT statement.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful response with the data array containing matching records and the info object with pagination details.", "summary": "Successful response with matching records and pagination metadata", "value": { "data": [ { "First_Name": "John", "Last_Name": "Smith" } ], "info": { "count": 1, "more_records": false } } }, "SuccessResponseWithFieldsMeta": { "description": "Shows a successful response with matching records and the fields object containing metadata for each SELECT column.", "summary": "Successful response with records and field metadata for SELECT columns", "value": { "data": [ { "Last_Name": "TestLead", "id": "4413054000000682520" } ], "fields": { "Last_Name": { "additional_column": null, "address": null, "api_name": "Last_Name", "association_details": null, "auto_number": {}, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LASTNAME", "convert_mapping": { "Accounts": null, "Contacts": "Last_Name", "Deals": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": null, "data_type": "text", "decimal_place": null, "default_value": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Last Name", "display_type": -1, "email_parser": { "fields_update_supported": false, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Last Name", "field_read_only": false, "filterable": true, "formula": {}, "generated_type": 1, "global_picklist": null, "history_tracking": null, "history_tracking_enabled": false, "id": "4413054000000000559", "json_type": "string", "layout_associations": [ { "api_name": "Standard__s", "id": "4413054000000095055", "name": "Standard" } ], "length": 80, "lookup": {}, "lucene_colname": "LASTNAME", "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "public": false, "quick_sequence_number": "3", "range": null, "read_only": false, "refer_from_field": null, "required": true, "rollup_summary": {}, "searchable": true, "separator": false, "sortable": true, "system_mandatory": true, "table_name": "CrmLeadDetails", "tooltip": null, "type": "used", "ui_type": 127, "unique": {}, "view_type": { "create": true, "edit": true, "quick_create": true, "view": false }, "virtual_field": false, "visible": true, "webhook": true } }, "info": { "count": 1, "more_records": false } } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for a successful COQL query, containing the matching records and pagination metadata.", "properties": { "data": { "description": "Represents the list of records returned by the COQL query. Always returned in the response.", "items": { "additionalProperties": true, "description": "Represents a single record returned by the COQL query, with field API names as keys and their corresponding values as values.", "type": "object" }, "maxItems": 200, "minItems": 1, "type": "array" }, "fields": { "additionalProperties": { "$ref": "#/components/schemas/CoqlFieldSchema" }, "description": "Represents the field metadata for each column specified in the SELECT clause. Keys are field API names and values are field configuration objects. Returned only when **fields** is specified in the **include_meta** request body parameter.", "type": "object" }, "info": { "additionalProperties": false, "description": "Represents the pagination metadata for the query result. Always returned in the response.", "properties": { "count": { "description": "Represents the number of records returned in the current response. Always returned in the response.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional records matching the query are available beyond the current page. Always returned in the response.\nPossible values:\n**true** - More records are available. Use LIMIT and OFFSET to paginate.\n**false** - All matching records are included in this response.", "type": "boolean" } }, "required": [ "count", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "COQLSuccessResponse" } } }, "description": "Returns the matching records for the COQL query, along with pagination details." }, "204": { "description": "Indicates that the COQL query executed successfully but returned no matching records." }, "400": { "content": { "application/json": { "examples": { "DuplicateAlias": { "description": "Shows a DUPLICATE_ALIAS error response with the alias and referred_columns details.", "summary": "Duplicate alias error response", "value": { "code": "DUPLICATE_ALIAS", "details": { "alias": "Name", "referred_columns": [ "First_Name", "Last_Name" ] }, "message": "same alias cannot refer more than one column", "status": "error" } }, "DuplicateData": { "description": "Shows a DUPLICATE_DATA error response with the column_name detail.", "summary": "Duplicate data error response", "value": { "code": "DUPLICATE_DATA", "details": { "column_name": "First_Name" }, "message": "duplicate select column", "status": "error" } }, "DuplicateDataAggregate": { "description": "Shows a DUPLICATE_DATA error response with the column_name and aggregate function details.", "summary": "Duplicate data error with aggregate function", "value": { "code": "DUPLICATE_DATA", "details": { "aggregate": "MAX", "column_name": "Annual_Revenue" }, "message": "duplicate aggregate function", "status": "error" } }, "InvalidAlias": { "description": "Shows an INVALID_ALIAS error response with the alias and column_name details.", "summary": "Invalid alias error response", "value": { "code": "INVALID_ALIAS", "details": { "alias": "", "column_name": "First_Name" }, "message": "alias name cannot be an empty string", "status": "error" } }, "InvalidData": { "description": "Shows an INVALID_DATA error response with the api_name, json_path, and expected_data_type details.", "summary": "Invalid data error response", "value": { "code": "INVALID_DATA", "details": { "api_name": "include_meta", "expected_data_type": "jsonarray", "json_path": "$.include_meta" }, "message": "invalid data", "status": "error" } }, "InvalidDataExpectedTypeWithSupportedValues": { "description": "Shows an INVALID_DATA error response with the expected_data_type and supported_values details.", "summary": "Invalid data error with expected type and supported values", "value": { "code": "INVALID_DATA", "details": { "api_name": "include_meta", "expected_data_type": "text", "json_path": "$.include_meta[0]", "supported_values": [ "fields" ] }, "message": "invalid data", "status": "error" } }, "InvalidDataLimitZero": { "description": "Shows an INVALID_DATA error response for a LIMIT value of zero or less.", "summary": "Invalid data error for a limit of zero or less", "value": { "code": "INVALID_DATA", "details": {}, "message": "limit should be greater than 0", "status": "error" } }, "InvalidDataSupportedValues": { "description": "Shows an INVALID_DATA error response with the api_name, json_path, and supported_values details.", "summary": "Invalid data error with supported values list", "value": { "code": "INVALID_DATA", "details": { "api_name": "include_meta", "json_path": "$.include_meta[0]", "supported_values": [ "fields" ] }, "message": "invalid data", "status": "error" } }, "InvalidDataUnsupportedFunction": { "description": "Shows an INVALID_DATA error response with the column and reason details for an unsupported aggregate function.", "summary": "Invalid data error for unsupported aggregate function", "value": { "code": "INVALID_DATA", "details": { "column": "TestFunction(Last_Name)", "reason": "unsupported aggregate function" }, "message": "invalid data", "status": "error" } }, "InvalidModule": { "description": "Shows an INVALID_MODULE error response for an unrecognized module name in the COQL query.", "summary": "Invalid module error response", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported in api", "status": "error" } }, "InvalidQueryEmptyDetails": { "description": "Shows an INVALID_QUERY error response with an empty details object.", "summary": "Invalid query error with no additional details", "value": { "code": "INVALID_QUERY", "details": {}, "message": "Invalid query formed", "status": "error" } }, "InvalidQueryInvalidAlias": { "description": "Shows an INVALID_QUERY error response with the column_name and alias details for an invalid alias usage.", "summary": "Invalid query error for invalid alias", "value": { "code": "INVALID_QUERY", "details": { "alias": "Last_Name", "column_name": "First_Name" }, "message": "column name or property name given in select columns without alias name cannot be an alias name for other select columns", "status": "error" } }, "InvalidQueryInvalidLimit": { "description": "Shows an INVALID_QUERY error response for an invalid LIMIT value in the query.", "summary": "Invalid query error for invalid limit", "value": { "code": "INVALID_QUERY", "details": { "limit": "s" }, "message": "limit given seems to be invalid", "status": "error" } }, "InvalidQueryInvalidOperator": { "description": "Shows an INVALID_QUERY error response with the column_name and operator details for an invalid operator.", "summary": "Invalid query error for invalid operator", "value": { "code": "INVALID_QUERY", "details": { "column_name": "First_Name", "operator": ">", "reason": "invalid operator found" }, "message": "Invalid query formed", "status": "error" } }, "InvalidQueryIsNotNullOperator": { "description": "Shows an INVALID_QUERY error response for an is not null operator on a field that does not support it.", "summary": "Invalid query error with is not null operator", "value": { "code": "INVALID_QUERY", "details": { "column_name": "textj8", "operator": "is not null", "reason": "invalid operator found" }, "message": "Invalid query formed", "status": "error" } }, "InvalidQueryIsNullOperator": { "description": "Shows an INVALID_QUERY error response for an is null operator on a field that does not support it.", "summary": "Invalid query error with is null operator", "value": { "code": "INVALID_QUERY", "details": { "column_name": "textj8", "operator": "is null", "reason": "invalid operator found" }, "message": "Invalid query formed", "status": "error" } }, "InvalidQuerySubQueryMultipleColumns": { "description": "Shows an INVALID_QUERY error response with the column_name list and sub_query_sequence details for a multi-column subquery.", "summary": "Invalid query error for subquery with multiple columns", "value": { "code": "INVALID_QUERY", "details": { "column_name": [ "Last_Name", "Annual_Revenue" ], "sub_query_sequence": 0 }, "message": "subquery should contains only one column", "status": "error" } }, "InvalidQuerySubQueryOperator": { "description": "Shows an INVALID_QUERY error response for a subquery operator that is incompatible with multiple return values.", "summary": "Invalid query error for subquery with incompatible operator", "value": { "code": "INVALID_QUERY", "details": { "operator": ">", "sub_query_sequence": 0 }, "message": "subquery return more than one values which is incompatible for the operator", "status": "error" } }, "InvalidQueryUnsupportedColumn": { "description": "Shows an INVALID_QUERY error response with the column_name detail for an unsupported column.", "summary": "Invalid query error for unsupported column", "value": { "code": "INVALID_QUERY", "details": { "column_name": "Last_Name" }, "message": "unsupported column", "status": "error" } }, "InvalidQueryUnsupportedCriteria": { "description": "Shows an INVALID_QUERY error response with the column_name and cv_criteria details for unsupported criteria.", "summary": "Invalid query error for unsupported criteria column", "value": { "code": "INVALID_QUERY", "details": { "column_name": "Participants", "cv_criteria": false, "operator": "!=", "value": "${EMPTY}" }, "message": "unsupported column in criteria", "status": "error" } }, "MandatoryNotFound": { "description": "Shows a MANDATORY_NOT_FOUND error response with the api_name of the missing mandatory field.", "summary": "Mandatory field not found error response", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "select_query" }, "message": "mandatory key not found", "status": "error" } }, "SyntaxErrorInvalidClause": { "description": "Shows a SYNTAX_ERROR error response with the clause detail.", "summary": "Syntax error response for invalid clause", "value": { "code": "SYNTAX_ERROR", "details": { "clause": "where" }, "message": "missing clause", "status": "error" } }, "SyntaxErrorLocation": { "description": "Shows a SYNTAX_ERROR error response with the line, column, and near text location details.", "summary": "Syntax error response with location details", "value": { "code": "SYNTAX_ERROR", "details": { "column": 15, "line": 1, "near": "FROM" }, "message": "unexpected token", "status": "error" } }, "SyntaxErrorNear": { "description": "Shows a SYNTAX_ERROR error response with only the near text context.", "summary": "Syntax error response with near text context", "value": { "code": "SYNTAX_ERROR", "details": { "near": "where" }, "message": "error occured while parsing the query", "status": "error" } }, "SyntaxErrorOperator": { "description": "Shows a SYNTAX_ERROR error response with the operator detail for an unsupported operator.", "summary": "Syntax error response for unsupported operator", "value": { "code": "SYNTAX_ERROR", "details": { "operator": "not" }, "message": "operator not supported", "status": "error" } }, "SyntaxErrorQueryNotSupported": { "description": "Shows a SYNTAX_ERROR error response for a COQL query that is not supported.", "summary": "Syntax error response for unsupported query", "value": { "code": "SYNTAX_ERROR", "details": {}, "message": "given coql query not supported", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents a syntax error response returned when the COQL query contains invalid syntax.", "properties": { "code": { "description": "Represents the error code for a syntax error in the COQL query. Always returned in the response.\nPossible values:\n**SYNTAX_ERROR** - A syntax error was detected in the COQL query.", "enum": [ "SYNTAX_ERROR" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents an empty details object returned when no additional context is available for the syntax error.", "type": "object", "x-zs-$id": "COQLSyntaxErrorDetailsEmpty" }, { "additionalProperties": false, "description": "Represents the syntax error details when the error occurred in a specific COQL clause.", "properties": { "clause": { "description": "Represents the COQL clause where the syntax error occurred.", "maxLength": 1000, "type": "string" } }, "required": [ "clause" ], "type": "object", "x-zs-$id": "COQLSyntaxErrorDetailsClause" }, { "additionalProperties": false, "description": "Represents the syntax error details with the exact location (line and column) and nearby context.", "properties": { "column": { "description": "Represents the column number in the query where the syntax error occurred.", "format": "int32", "type": "integer" }, "line": { "description": "Represents the line number in the query where the syntax error occurred.", "format": "int32", "type": "integer" }, "near": { "description": "Represents the text fragment near the syntax error location.", "maxLength": 1000, "type": "string" } }, "required": [ "line", "column", "near" ], "type": "object", "x-zs-$id": "COQLSyntaxErrorDetailsLocation" }, { "additionalProperties": false, "description": "Represents the syntax error details for an unsupported operator in the COQL query.", "properties": { "operator": { "description": "Represents the unsupported operator used in the COQL query.", "maxLength": 100, "type": "string" } }, "required": [ "operator" ], "type": "object", "x-zs-$id": "COQLSyntaxErrorDetailsOperator" }, { "additionalProperties": false, "description": "Represents the syntax error details when only the surrounding text context is available.", "properties": { "near": { "description": "Represents the text fragment near the syntax error in the query.", "maxLength": 1000, "type": "string" } }, "required": [ "near" ], "type": "object", "x-zs-$id": "COQLSyntaxErrorDetailsNear" } ], "description": "Represents the details of the syntax error, including the location or context of the error." }, "message": { "description": "Represents the error message describing the syntax error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "SyntaxError", "type": "object", "x-zs-$id": "COQLSyntaxErrorResponse" }, { "additionalProperties": false, "description": "Represents a limit exceeded error response returned when the COQL query exceeds a permitted limit.", "properties": { "code": { "description": "Represents the error code for a limit exceeded error. Always returned in the response.\nPossible values:\n**LIMIT_EXCEEDED** - The query exceeds the permitted limit.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the limit exceeded error.", "type": "object" }, "message": { "description": "Represents the error message describing the limit exceeded error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "LimitExceeded", "type": "object", "x-zs-$id": "COQLLimitExceededResponse" }, { "additionalProperties": false, "description": "Represents an invalid query error response returned when the COQL query is structurally invalid.", "properties": { "code": { "description": "Represents the error code for an invalid query error. Always returned in the response.\nPossible values:\n**INVALID_QUERY** - The COQL query is structurally invalid.", "enum": [ "INVALID_QUERY" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the invalid query error details for an invalid column reference.", "properties": { "column_name": { "description": "Represents the API name of the field with an invalid column reference.", "maxLength": 150, "type": "string" } }, "required": [ "column_name" ], "type": "object", "x-zs-$id": "COQLInvalidColumnDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details when a column exceeds its allowed limit.", "properties": { "limit": { "description": "Represents the maximum allowed limit for the column in the COQL query, if applicable.", "maxLength": 150, "type": "string" } }, "required": [ "limit" ], "type": "object", "x-zs-$id": "COQLInvalidColumnLimitDetails" }, { "additionalProperties": false, "description": "Invalid offset details", "properties": { "offset": { "description": "The invalid offset value used in the query", "maxLength": 150, "type": "string" } }, "required": [ "offset" ], "type": "object", "x-zs-$id": "COQLInvalidOffsetDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details for an invalid column in a specific clause.", "properties": { "clause": { "description": "Represents the COQL clause associated with the invalid column.", "maxLength": 150, "type": "string" }, "column_name": { "description": "Represents the API name of the field with invalid data in the query.", "maxLength": 150, "type": "string" } }, "required": [ "column_name", "clause" ], "type": "object", "x-zs-$id": "COQLInvalidColumnClauseDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details for an invalid module reference.", "properties": { "module": { "description": "Represents the API name of the module referenced in an invalid module context.", "maxLength": 150, "type": "string" } }, "required": [ "module" ], "type": "object", "x-zs-$id": "COQLInvalidModuleDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details for an invalid Custom View ID.", "properties": { "cvid": { "description": "Represents the invalid Custom View ID referenced in the COQL query.", "maxLength": 150, "type": "string" } }, "required": [ "cvid" ], "type": "object", "x-zs-$id": "COQLInvalidCVIDDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details for an unsupported operator used with a field.", "properties": { "column_name": { "description": "Represents the API name of the column involved in the invalid operator error.", "maxLength": 500, "type": "string" }, "operator": { "description": "Represents the operator that is invalid for the specified column in the COQL query.\nPossible values:\n**>** - Greater than.\n**<** - Less than.\n**>=** - Greater than or equal to.\n**<=** - Less than or equal to.\n**=** - Equal to.\n**!=** - Not equal to.\n**is null** - Checks if the value is null.\n**is not null** - Checks if the value is not null.", "enum": [ ">", "<", ">=", "<=", "=", "!=", "is null", "is not null" ], "type": "string" }, "reason": { "description": "Represents a description of the reason the operator is invalid for the column.", "maxLength": 1000, "type": "string" } }, "required": [ "reason", "column_name", "operator" ], "type": "object", "x-zs-$id": "COQLInvalidOperatorDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details for an invalid column alias.", "properties": { "alias": { "description": "Represents the invalid alias name used in the COQL query.", "maxLength": 1000, "type": "string" }, "column_name": { "description": "Represents the API name of the column with an invalid alias.", "maxLength": 150, "type": "string" } }, "required": [ "alias", "column_name" ], "type": "object", "x-zs-$id": "COQLInvalidAliasDetails" }, { "additionalProperties": false, "description": "Represents an empty details object returned when no additional context is available for the invalid query error.", "type": "object", "x-zs-$id": "COQLInvalidQueryEmptyDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details for unsupported criteria.", "properties": { "column_name": { "description": "Represents the API name of the field with invalid criteria in the query.", "maxLength": 150, "type": "string" }, "cv_criteria": { "description": "Indicates whether the invalid query involves Custom View criteria.\nPossible values:\n**true** - Custom View criteria are involved in the error.\n**false** - Custom View criteria are not involved.", "type": "boolean" }, "operator": { "description": "Represents the operator used in the unsupported criteria.\nPossible values:\n**=** - Equal to.\n**!=** - Not equal to.\n**>** - Greater than.\n**<** - Less than.\n**>=** - Greater than or equal to.\n**<=** - Less than or equal to.\n**like** - Matches a pattern.\n**not like** - Does not match a pattern.\n**in** - Matches any value in a list.\n**not in** - Does not match any value in a list.\n**between** - Matches values within a range.\n**is null** - Checks if the value is null.\n**is not null** - Checks if the value is not null.", "enum": [ "=", "!=", ">", "<", ">=", "<=", "like", "not like", "in", "not in", "between", "is null", "is not null" ], "type": "string" }, "value": { "description": "Represents the value used in the unsupported criteria that caused the error.", "maxLength": 500, "type": "string" } }, "required": [ "cv_criteria", "column_name", "value", "operator" ], "type": "object", "x-zs-$id": "COQLInvalidQueryCriteriaDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details when a subquery returns incompatible values for the operator used.", "properties": { "operator": { "description": "Represents the operator that is incompatible with subqueries that return multiple values.\nPossible values:\n**=** - Equal to.\n**!=** - Not equal to.\n**>** - Greater than.\n**<** - Less than.\n**>=** - Greater than or equal to.\n**<=** - Less than or equal to.", "enum": [ "=", "!=", ">", "<", ">=", "<=" ], "type": "string" }, "sub_query_sequence": { "description": "Represents the sequence number of the subquery that returned incompatible values.", "format": "int32", "type": "integer" } }, "required": [ "sub_query_sequence", "operator" ], "type": "object", "x-zs-$id": "COQLInvalidQuerySubQueryDetails" }, { "additionalProperties": false, "description": "Represents the invalid query error details when a subquery specifies multiple columns.", "properties": { "column_name": { "description": "Represents the list of columns specified in the subquery that caused the error.", "items": { "description": "Represents a column name specified in the multi-column subquery.", "maxLength": 150, "type": "string" }, "maxItems": 500, "minItems": 2, "type": "array" }, "sub_query_sequence": { "description": "Represents the sequence number of the subquery in the COQL query.", "format": "int32", "type": "integer" } }, "required": [ "sub_query_sequence", "column_name" ], "type": "object", "x-zs-$id": "COQLInvalidQuerySubQueryColumnsDetails" } ], "description": "Represents the details of the invalid query error, including the column, module, alias, operator, or criteria involved." }, "message": { "description": "Represents the error message describing the invalid query error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "InvalidQuery", "type": "object", "x-zs-$id": "COQLInvalidQueryResponse" }, { "additionalProperties": false, "description": "Represents an invalid alias error response returned when a column alias in the query is invalid.", "properties": { "code": { "description": "Represents the error code for an invalid alias error. Always returned in the response.\nPossible values:\n**INVALID_ALIAS** - A column alias in the query is invalid.", "enum": [ "INVALID_ALIAS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the invalid alias error.", "properties": { "alias": { "description": "Represents the invalid alias name used in the COQL query.", "enum": [ "" ], "type": "string" }, "column_name": { "description": "Represents the API name of the column with the invalid alias.", "maxLength": 150, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid alias error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "InvalidAlias", "type": "object", "x-zs-$id": "COQLInvalidAliasResponse" }, { "additionalProperties": false, "description": "Represents a duplicate data error response returned when a column or aggregate function is duplicated in the SELECT clause.", "properties": { "code": { "description": "Represents the error code for a duplicate data error. Always returned in the response.\nPossible values:\n**DUPLICATE_DATA** - A column or aggregate function is duplicated in the SELECT clause.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the duplicate data error details when a field is duplicated in the SELECT clause.", "properties": { "column_name": { "description": "Represents the API name of the field that is duplicated in the SELECT clause.", "maxLength": 150, "type": "string" } }, "required": [ "column_name" ], "type": "object", "x-zs-$id": "COQLDuplicateDataColumnDetails" }, { "additionalProperties": false, "description": "Represents the duplicate data error details when an aggregate function is duplicated on the same column.", "properties": { "aggregate": { "description": "Represents the duplicate aggregate function used on the same column.\nPossible values:\n**MAX** - Maximum value.\n**MIN** - Minimum value.\n**AVG** - Average value.\n**SUM** - Sum of values.\n**COUNT** - Count of records.", "enum": [ "MAX", "MIN", "AVG", "SUM", "COUNT" ], "type": "string" }, "column_name": { "description": "Represents the API name of the field on which the aggregate function is duplicated.", "maxLength": 150, "type": "string" } }, "required": [ "column_name", "aggregate" ], "type": "object", "x-zs-$id": "COQLDuplicateDataAggregateDetails" } ], "description": "Represents the details of the duplicate data error, including the field API name or aggregate function that is duplicated." }, "message": { "description": "Represents the error message describing the duplicate data error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "DuplicateData", "type": "object", "x-zs-$id": "COQLDuplicateDataResponse" }, { "additionalProperties": false, "description": "Represents a duplicate alias error response returned when an alias in the SELECT clause appears more than once.", "properties": { "code": { "description": "Represents the error code for a duplicate alias error. Always returned in the response.\nPossible values:\n**DUPLICATE_ALIAS** - An alias in the SELECT clause appears more than once.", "enum": [ "DUPLICATE_ALIAS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the duplicate alias error, including the alias and the columns using it.", "properties": { "alias": { "description": "Represents the alias that appears more than once in the SELECT clause.", "maxLength": 150, "type": "string" }, "referred_columns": { "description": "Represents the list of SELECT columns that use the duplicate alias.", "items": { "description": "Represents the API name of a column in the SELECT clause that references the duplicate alias.", "maxLength": 150, "type": "string" }, "maxItems": 500, "minItems": 2, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the duplicate alias error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "DuplicateAlias", "type": "object", "x-zs-$id": "COQLDuplicateAliasResponse" }, { "additionalProperties": false, "description": "Represents a mandatory field not found error response returned when a required field is missing from the request.", "properties": { "code": { "description": "Represents the error code for a missing mandatory field error. Always returned in the response.\nPossible values:\n**MANDATORY_NOT_FOUND** - A mandatory field was not found in the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing mandatory field error.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field that is missing from the request.", "maxLength": 500, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing mandatory field. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "MandatoryNotFound", "type": "object", "x-zs-$id": "COQLMandatoryNotFoundResponse" }, { "additionalProperties": false, "description": "Represents an invalid data error response returned when the request contains invalid data for one or more fields.", "properties": { "code": { "description": "Represents the error code for an invalid data error. Always returned in the response.\nPossible values:\n**INVALID_DATA** - The request contains invalid data for one or more fields.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the invalid data error details including the expected data type.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 500, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with invalid data.", "maxLength": 500, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object", "x-zs-$id": "COQLInvalidDataExpectedTypeDetails" }, { "additionalProperties": false, "description": "Represents the invalid data error details including the list of supported values.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 500, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with invalid data.", "maxLength": 500, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the field.", "items": { "description": "Represents a supported value for the field.\nPossible values:\n**fields** - The only supported option for the **include_meta** parameter.", "enum": [ "fields" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "COQLInvalidDataSupportedValuesDetails" }, { "additionalProperties": false, "description": "Represents the invalid data error details for an unsupported aggregate function in the query.", "properties": { "column": { "description": "Represents the API name of the column using an unsupported aggregate function.", "maxLength": 500, "type": "string" }, "reason": { "description": "Represents the reason why the data is invalid.", "maxLength": 500, "type": "string" } }, "required": [ "reason", "column" ], "type": "object", "x-zs-$id": "COQLInvalidDataUnsupportedFunctionDetails" }, { "additionalProperties": false, "description": "Represents the invalid data error details including both the expected data type and the supported values.", "properties": { "api_name": { "description": "Represents the API name of the field with invalid data.", "maxLength": 500, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with invalid data.", "maxLength": 500, "type": "string" }, "supported_values": { "description": "Represents the list of supported values for the field.", "items": { "description": "Represents a supported value for the field.\nPossible values:\n**fields** - The only supported option for the **include_meta** parameter.", "enum": [ "fields" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "expected_data_type", "api_name", "json_path", "supported_values" ], "type": "object", "x-zs-$id": "COQLInvalidDataExpectedTypeWithSupportedValuesDetails" }, { "additionalProperties": false, "description": "Represents an empty details object returned when no additional context is available for the invalid data error.", "properties": {}, "type": "object", "x-zs-$id": "COQLInvalidDataEmptyDetails" } ], "description": "Represents the details of the invalid data error, including the affected field and the expected data type." }, "message": { "description": "Represents the error message describing the invalid data error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "InvalidData", "type": "object", "x-zs-$id": "COQLInvalidDataResponse" }, { "additionalProperties": false, "description": "Represents an invalid module error response returned when the module specified in the COQL query does not exist or is inaccessible.", "properties": { "code": { "description": "Represents the error code for an invalid module error. Always returned in the response.\nPossible values:\n**INVALID_MODULE** - The module specified in the COQL query does not exist or is inaccessible.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the invalid module error.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the invalid module error. Always returned in the response.", "maxLength": 2000, "type": "string" }, "status": { "description": "Represents the status of the response. Always returned in the response.\nPossible values:\n**error** - The request failed due to an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "InvalidModule", "type": "object", "x-zs-$id": "COQLInvalidModuleResponse" } ], "description": "Represents one of the possible 400 error responses for the COQL query, each corresponding to a specific error condition.", "x-zs-$id": "COQLErrorResponse" } } }, "description": "The COQL query is invalid, contains syntax errors, or references unsupported data. Resolution: Ensure the query uses valid module and field API names, supported operators, and correct COQL syntax." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.coql.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.coql.READ", "ZohoCRM.settings.fields.READ" ] } ], "summary": "Retrieve records using a COQL query", "tags": [ "coql" ], "x-zoho-document": "coql" } }, "/crm/v8/files": { "get": { "description": "To retrieve the binary content of a file stored in Zoho File System (ZFS) using its unique file ID. The file ID is provided as a required query parameter 'id'. If the file exists, the API returns the file's binary data along with appropriate headers indicating the MIME type and content disposition for download. If the file ID does not correspond to any file in ZFS, a 204 No Content response is returned. This endpoint is used to download files that have been previously uploaded to ZFS and associated with Zoho CRM records.", "operationId": "getFile", "parameters": [ { "description": "Specify the encrypted file ID received in the response when uploading files to the Zoho File System. Use the [ZFC API](files.yaml#$.paths./files.get) to retrieve the File IDs.", "in": "query", "name": "id", "required": false, "schema": { "maxLength": 150, "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "description": "Binary content of the requested file, returned with the appropriate MIME type header.", "format": "binary", "type": "string", "x-zs-$id": "FileBinaryContentResponse" } } }, "description": "Successfully uploaded file to Zoho File System. Returns the uploaded file as binary content with appropriate headers indicating the file type and disposition", "headers": { "Content-Disposition": { "description": "Indicates how the content should be displayed. Includes the original filename for download purposes.", "example": "attachment;filename*=UTF-8''image %282%29.png", "schema": { "description": "Content disposition with original filename", "maxLength": 500, "type": "string" } }, "Content-Type": { "description": "MIME type of the uploaded file (e.g., application/pdf, image/png, text/plain).", "example": "image/png;charset=UTF-8", "schema": { "description": "MIME type of the file including charset if applicable", "maxLength": 500, "type": "string" } } } }, "204": { "description": "The specified file ID does not match any file in the Zoho File System. No Content - Returned when the provided file ID does not match any file in the Zoho File System. This occurs when the 'id' parameter contains an invalid file identifier, an empty string, or references a file that has been deleted or never existed. **Resolution:** Verify that the **id** parameter contains a valid encrypted file ID from a previous upload response." }, "400": { "content": { "application/json": { "examples": { "MissingEmailTemplateAttachId": { "description": "Sample error response when `type=email_template` but the **attach_id** parameter is missing.", "summary": "Missing attach_id parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "attach_id" }, "message": "required attachment id param not found", "status": "error" } }, "MissingEmailTemplateFileId": { "description": "Sample error response when `type=email_template` but the **file_id** parameter is missing.", "summary": "Missing file_id parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "file_id" }, "message": "required file id param not found", "status": "error" } }, "MissingEmailTemplateTemplateId": { "description": "Sample error response when `type=email_template` but the **template_id** parameter is missing.", "summary": "Missing template_id parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "template_id" }, "message": "required template id param not found", "status": "error" } }, "MissingIdParameter": { "description": "Sample error response when the **id** parameter is missing for regular file retrieval.", "summary": "Missing id parameter (regular mode)", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "id" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequiredParamMissingResponse" } ], "x-zs-$id": "UploadFile400ErrorResponses" } } }, "description": "The request is missing required parameters. **For regular file mode**: The **id** parameter is missing. **For email template mode** (when `type=email_template`): One or more of the required parameters (`file_id`, `template_id`, `attach_id`) are missing. **Resolution:** For regular file retrieval, include the **id** query parameter. For email template attachments, ensure all required parameters are present: `type=email_template`, `file_id`, `template_id`, and `attach_id`." } }, "security": [ { "OAuth2": [ "ZohoCRM.files.READ" ] } ], "summary": "Retrieve a file from ZFS", "tags": [ "files" ], "x-zoho-document": "files" }, "post": { "description": "To upload one or more files to the Zoho File System (ZFS) in your Zoho CRM account. The API returns an encrypted file ID for each uploaded file, which you can use to attach the file to a file upload field, image upload field, or record image field through the Create or Update Records API. The file is uploaded using multipart/form-data with a required 'file' field containing the binary data of the file to be uploaded. The response includes the file ID, name, status, and other details. Can upload 10 files in a single request by repeating the 'file' field. Maximum file size is 20 MB.", "operationId": "uploadFiles", "parameters": [ { "description": "Specify the upload type for inline images. Possible values: **inline** - Upload the file as an inline image for use in email templates or rich-text fields.", "in": "query", "name": "inline", "required": false, "schema": { "enum": [ "inline" ], "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "description": "Multipart form data for uploading one or more files to the Zoho File System.", "properties": { "file": { "description": "Upload one or more files using repeated **file** keys in the multipart form data.", "items": { "description": "Specify the binary content of the file to upload.", "format": "binary", "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "MultiFileUpload": { "summary": "Multiple files upload", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "ae9c6cd994aa55a0fda90faaff4a2f472b1c94e7", "name": "contract.pdf" }, "message": "contract.pdf uploaded successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "bf8d7de885bb66b1feb91fbbgg5b3g583c2d85f8", "name": "signature.png" }, "message": "signature.png uploaded successfully", "status": "success" } ] } }, "SingleFileUpload": { "summary": "Single file upload", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "ae9c6cd994aa55a0fda90faaff4a2f472b1c94e7", "name": "invoice_2024_Q4.pdf" }, "message": "invoice_2024_Q4.pdf uploaded successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response schema for a successful file upload to the Zoho File System.", "properties": { "data": { "description": "Contains the array of upload results, one object per file submitted in the request. The order corresponds to the order of files in the multipart request.", "items": { "additionalProperties": false, "description": "Represents the upload result for a single file, including its status, success code, and file metadata.", "properties": { "code": { "description": "Represents the success code for the upload operation. Possible values: **SUCCESS** - The file uploaded to ZFS without errors.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the file metadata for the uploaded file, including the unique identifier for CRM record association.", "properties": { "id": { "description": "Unique file identifier in ZFS. Use this ID to attach the file to CRM records or retrieve it via GET /files", "examples": [ "ae9c6cd994aa55a0fda90faaff4a2f472b1c94e7", "bjbiuwg467q8t3uhbnfubf2yg4t4h7gfbijbkwqe" ], "maxLength": 150, "minLength": 1, "type": "string", "x-zs-$id": "UploadedFileId", "x-zs-llm-description": "The file ID returned is single-use. Once it is associated with a CRM record, email template, or any other entity via their respective APIs, the file ID is consumed and becomes unavailable. To reuse the same file content, upload the file again to obtain a new file ID." }, "name": { "description": "Represents the original filename as provided in the upload request.", "examples": [ "contract_2024.pdf", "profile_photo.jpg" ], "maxLength": 500, "minLength": 1, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "message": { "description": "Represents the success message confirming the file upload.", "examples": [ "connections.txt uploaded successfully", "profile_photo.jpg uploaded successfully" ], "maxLength": 500, "type": "string" }, "status": { "description": "Represents the upload result status. Possible values: **success** - The file uploaded to ZFS without errors.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UploadFilesResponse" } } }, "description": "Returns an array of upload results, one per file, containing the encrypted file ID for CRM record association and the upload status confirmation." }, "400": { "content": { "application/json": { "examples": { "EmptyFileField": { "description": "Sample error response for the failure_in_attachment_handling error: problem in uploading attachment. Occurs when a 'file' field exists but contains no actual file data", "summary": "Empty 'file' field with no data", "value": { "code": "failure_in_attachment_handling", "details": {}, "message": "Problem in uploading attachment. kindly upload the file properly", "status": "error" } }, "MissingFileField": { "description": "Sample error response for the failure_in_attachment_handling error: problem in uploading attachment. Occurs when the multipart/form-data request does not include any 'file' field", "summary": "Missing 'file' field in request", "value": { "code": "failure_in_attachment_handling", "details": {}, "message": "Problem in uploading attachment. kindly upload the file properly", "status": "error" } }, "TooManyFiles": { "description": "Sample error response for the INVALID_REQUEST error: unable to process your request.", "summary": "Exceeds ten-file limit", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the **file** field is missing from the multipart/form-data request or when a **file** field is present but contains no actual file data.", "properties": { "code": { "description": "Represents the error code for the upload failure. Possible values: **failure_in_attachment_handling** - The **file** field is missing or contains no file data.", "enum": [ "failure_in_attachment_handling" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional error context. Typically empty for this error type.", "type": "object" }, "message": { "description": "Represents the error message prompting proper file upload.", "enum": [ "Problem in uploading attachment. kindly upload the file properly" ], "type": "string" }, "status": { "description": "Represents the overall result status of the API request. Possible values: **error** - The request failed due to a validation or processing issue.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RequiredParamMissingResponseCode" }, { "additionalProperties": false, "description": "Returned when the request violates API constraints, most commonly when more than ten files are included in a single upload request.", "properties": { "code": { "description": "Represents the error code for the request violation. Possible values: **INVALID_REQUEST** - The request violates API constraints such as exceeding the ten-file limit.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional error context. Typically empty for this error type.", "type": "object" }, "message": { "description": "Represents the error message requesting verification of request parameters.", "enum": [ "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values." ], "type": "string" }, "status": { "description": "Represents the overall result status of the API request. Possible values: **error** - The request failed due to a validation or processing issue.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidRequestResponse" } ], "x-zs-$id": "MultipleErrorResponses" } } }, "description": "The file upload request is malformed or invalid.Bad Request - The file upload request is malformed or invalid. Returns `failure_in_attachment_handling` when the 'file' field is missing or contains no file data. Returns `INVALID_REQUEST` when request constraints are violated, such as exceeding the 10-file limit per request. **Resolution:** Verify that the request includes a **file** field with valid binary file data in multipart/form-data format, and that the request does not exceed ten files." }, "415": { "content": { "application/json": { "examples": { "FileTooLarge": { "description": "Sample error response for the FILE_SIZE_MORE_THAN_ALLOWED_SIZE error: please check if the size of the file is in the correct range. Occurs when any file in the multipart upload request exceeds the maximum allowed size of 20 MB", "summary": "File exceeds size limit", "value": { "code": "FILE_SIZE_MORE_THAN_ALLOWED_SIZE", "details": {}, "message": "Please check if the size of the file is in the correct range", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when any file in the upload request exceeds the 20 MB size limit. The entire upload is rejected, even if other files are within the allowed size.", "properties": { "code": { "description": "Represents the error code for the file size violation. Possible values: **FILE_SIZE_MORE_THAN_ALLOWED_SIZE** - One or more files exceed the 20 MB maximum file size limit.", "enum": [ "FILE_SIZE_MORE_THAN_ALLOWED_SIZE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional error context. Typically empty for this error type.", "type": "object" }, "message": { "description": "Represents the error message prompting file size verification.", "enum": [ "Please check if the size of the file is in the correct range" ], "type": "string" }, "status": { "description": "Represents the overall result status of the API request. Possible values: **error** - The request failed due to a validation or processing issue.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "FileSizeMoreThanAllowedSizeResponse" } ], "x-zs-$id": "MultipleErrorResponses415" } } }, "description": "Unsupported Media Type / File Size Exceeded - Returned when one or more uploaded files exceed the maximum allowed size of 20 MB per file. The API rejects the entire request if any single file violates this constraint. **Resolution:** Verify that each file in the request is within the 20 MB size limit before uploading and that it is of a supported media type." } }, "security": [ { "OAuth2": [ "ZohoCRM.files.CREATE" ] } ], "summary": "Upload files to ZFS", "tags": [ "files" ], "x-zoho-document": "files", "x-zs-llm-description": "The file ID returned is single-use. Once it is associated with a CRM record, email template, or any other entity via their respective APIs, the file ID is consumed and becomes unavailable. To reuse the same file content, upload the file again to obtain a new file ID." } }, "/crm/v8/org": { "get": { "description": "To retrieve the organization details associated with your Zoho CRM account.", "operationId": "getOrganization", "responses": { "200": { "content": { "application/json": { "examples": { "OrgGetResponse": { "description": "Shows a successful response containing the details of a production organization, including company address, currency settings, and license information.", "summary": "Successful retrieval of organization details", "value": { "org": [ { "alias": "acme", "call_icon": "show", "checkin_preferences": { "restricted_event_types": null }, "city": "Austin", "company_name": "Acme Inc.", "country": "US", "country_code": "US", "created_time": "2023-01-01T12:00:00Z", "currency": "US Dollar - USD", "currency_locale": "USD", "currency_symbol": "$", "deletable_org_account": false, "description": "Main office", "domain_name": "acmeinc", "employee_count": "100", "ezgid": "ezgid123", "fax": null, "gapps_enabled": false, "hierarchy_preferences": { "strictly_reporting": false, "type": "Role_Hierarchy" }, "hipaa_compliance_enabled": false, "id": "1234567890", "iso_code": "US", "license_details": { "paid": false, "paid_expiry": null, "paid_type": "free", "portal_users_license_purchased": 0, "trial_action": "Update Evaluation", "trial_expiry": "2025-12-04T17:26:17+05:30", "trial_type": "enterprise", "users_license_purchased": 3 }, "lite_users_enabled": false, "max_per_page": 200, "mc_status": true, "mobile": null, "oauth_presence": true, "phone": "+915551234", "photo_id": null, "primary_email": "acmeadmin@acmei.com", "primary_zuid": "zuid123", "privacy_settings": true, "state": "TX", "street": "123 Main St", "time_zone": "America/Chicago", "translation_enabled": false, "type": "production", "website": "www.acmeinc.com", "zgid": "zgid123", "zia_portal_id": null, "zia_zgid": 12345, "zip": "78701" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the organization details returned by the Get Organization operation.", "properties": { "org": { "description": "Represents the list of organization details.", "items": { "allOf": [ { "$ref": "#/components/schemas/OrgDetails" } ], "description": "Represents the organization details for the Zoho CRM account, including company information, operational settings, and license details.", "required": [ "country", "photo_id", "city", "description", "type", "created_time", "mc_status", "gapps_enabled", "translation_enabled", "street", "domain_name", "alias", "currency", "id", "employee_count", "state", "fax", "zip", "website", "currency_symbol", "mobile", "currency_locale", "primary_zuid", "zia_portal_id", "time_zone", "zgid", "country_code", "deletable_org_account", "license_details", "hierarchy_preferences", "phone", "company_name", "privacy_settings", "primary_email", "iso_code", "hipaa_compliance_enabled", "lite_users_enabled" ] }, "maxItems": 1, "type": "array" } }, "required": [ "org" ], "type": "object", "x-zs-$id": "OrgGetResponse" } } }, "description": "Returns the organization details for the CRM account." } }, "security": [ { "OAuth2": [ "ZohoCRM.org.READ" ] } ], "summary": "Get organization details", "tags": [ "org" ], "x-zoho-document": "org" } }, "/crm/v8/org/currencies": { "get": { "description": "Retrieves all added currencies in the organization.", "operationId": "getCurrencies", "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "description": "Provides a sample 200 response for the sample scenario.", "summary": "Sample list response", "value": { "currencies": [ { "created_by": { "id": "11111300000001", "name": "Admin" }, "created_time": "2025-01-01T00:00:00Z", "exchange_rate": "1.000000000", "exchange_rate_auto_update": true, "exchange_rate_updated_time": "2019-05-31T15:10:33+05:30", "format": { "decimal_places": "2", "decimal_separator": "Period", "numeral_system": "International", "thousand_separator": "Comma" }, "id": "111113000000038990", "is_active": true, "is_base": true, "iso_code": "USD", "modified_by": { "id": "11111300000001", "name": "Admin" }, "modified_time": "2025-01-01T00:00:00Z", "name": "US Dollar - USD", "prefix_symbol": true, "symbol": "$" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing a list of currencies.", "properties": { "currencies": { "description": "JSON array indicating the list of currencies configured for the organization.", "items": { "additionalProperties": false, "description": "Represents a currency object that includes metadata and formatting configuration such as symbol, decimal precision, and display rules.", "properties": { "created_by": { "additionalProperties": false, "description": "Indicates the user who created the currency record.", "properties": { "id": { "description": "The unique identifier of the record creator.", "format": "int64", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the user who created the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Timestamp when the currency was first created.", "format": "date-time", "type": "string" }, "exchange_rate": { "description": "Exchange rate relative to the base currency (supports up to 9 digits and 9 decimal places).", "maxLength": 18, "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$", "type": "string" }, "exchange_rate_auto_update": { "description": "Indicates whether the currency has the automated exchange rate option enabled or not.", "type": "boolean" }, "exchange_rate_updated_time": { "description": "Timestamp when the exchange rate was last modified.", "format": "date-time", "type": "string" }, "format": { "additionalProperties": false, "description": "Currency formatting rules including numeral style, decimals and separators.", "properties": { "decimal_places": { "description": "Represents the number of decimal places allowed for the currency. It can be **0, 2, and 3.**", "enum": [ "0", "2", "3", "4", "5", "6" ], "type": "string" }, "decimal_separator": { "description": "The decimal separator separates the integer part of the currency from its fractional part. It can be a **Period or Comma,** depending on the currency.", "enum": [ "Comma", "Period" ], "type": "string" }, "numeral_system": { "default": "International", "description": "Number formatting style: Indian (1,00,000) vs International (100,000).", "enum": [ "Indian", "International" ], "type": "string" }, "thousand_separator": { "description": "The thousand separator separates groups of thousands in a currency. It can be a **Period, Comma, or Space**, depending on the currency.", "enum": [ "Comma", "Period", "Space" ], "type": "string" } }, "required": [ "numeral_system", "decimal_places", "decimal_separator", "thousand_separator" ], "type": "object" }, "id": { "description": "Unique identifier of the currency.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$id": "CurrencyId" }, "is_active": { "description": "Represents the status of the currency.\n**Possible Values:**\n**true** - The currency is active. This is the default value.\n**false** - The currency is inactive.", "type": "boolean" }, "is_base": { "description": "Indicates whether this currency is the organization's base currency.", "type": "boolean" }, "iso_code": { "description": "Represents the ISO code of the currency. You can get the currency code from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 3, "type": "string" }, "modified_by": { "additionalProperties": false, "description": "Indicates the user who last updated the currency record.", "properties": { "id": { "description": "The unique identifier of the user who modified the record. ", "format": "int64", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the user who modified the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "modified_time": { "description": "Timestamp when the currency was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "Name of the currency. Example: Indian Rupee.", "maxLength": 255, "type": "string" }, "prefix_symbol": { "description": "Represents the position of the currency symbol.\n**Possible Values:**\n**true** - Display the currency symbol before the currency value. This is the default value.\n**false** - Display the currency symbol after the currency value.", "type": "boolean" }, "symbol": { "description": "Symbol used to represent the currency.", "maxLength": 50, "type": "string" } }, "required": [ "prefix_symbol", "format", "exchange_rate", "is_active", "iso_code", "symbol", "name", "is_base", "id", "created_by", "modified_by", "modified_time", "created_time" ], "type": "object" }, "maxItems": 180, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "GetCurrenciesResponse" } } }, "description": "Successfully retrieved currency data." }, "204": { "description": "No content - occurs if no currencies are available." }, "403": { "content": { "application/json": { "examples": { "CurrenciesNotEnabled": { "summary": "Multi-currency is not enabled", "value": { "code": "CURRENCIES_NOT_ENABLED", "details": {}, "message": "Multi currency is not enabled", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when multi-currency is not enabled.", "properties": { "code": { "description": "Error code indicating the type of error.", "enum": [ "CURRENCIES_NOT_ENABLED" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "Human-readable message indicating that the multi-currency feature is not enabled for the organization.", "maxLength": 255, "type": "string" }, "status": { "description": "Response status indicator.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetCurrenciesErrorResponse" } } }, "description": "Forbidden. Multi-currency feature is not enabled for the organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.currencies.READ" ] } ], "summary": "List currencies", "tags": [ "currencies" ], "x-zoho-document": "currencies" }, "post": { "description": "Creates one or more new currencies for the organization.", "operationId": "createCurrencies", "requestBody": { "content": { "application/json": { "examples": { "SampleCreate": { "description": "Provides a sample request payload for the sample create scenario.", "summary": "Create one currency", "value": { "currencies": [ { "exchange_rate": "1.000000000", "exchange_rate_auto_update": true, "format": { "decimal_places": "2", "decimal_separator": "Period", "numeral_system": "International", "thousand_separator": "Comma" }, "is_active": true, "iso_code": "SAR", "name": "Saudi Riyal - SAR", "symbol": "SR" } ] } } }, "schema": { "additionalProperties": false, "description": "Request object containing a list of currencies to create.", "properties": { "currencies": { "description": "List of currencies to add to the organization. Supports up to 180 currencies per request.", "items": { "additionalProperties": false, "description": "Currency definition object.", "properties": { "exchange_rate": { "description": "Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to **nine** digits and nine decimal places. Example: 123456789.123456789.", "maxLength": 18, "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$", "type": "string" }, "exchange_rate_auto_update": { "description": "Indicates whether the currency has the automated exchange rate option enabled or not.", "type": "boolean" }, "format": { "additionalProperties": false, "description": "Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places.", "properties": { "decimal_places": { "description": "\nRepresents the number of decimal places allowed for the currency. It can be **0, 2, and 3.**", "enum": [ "0", "2", "3", "4", "5", "6" ], "type": "string" }, "decimal_separator": { "description": "The decimal separator separates the integer part of the currency from its fractional part. It can be a **Period** or **Comma**, depending on the currency.", "enum": [ "Comma", "Period" ], "type": "string" }, "numeral_system": { "default": "International", "description": "Numbering system used for grouping digits.", "enum": [ "Indian", "International" ], "type": "string" }, "thousand_separator": { "description": "The thousand separator separates groups of thousands in a currency. It can be a **Period**, **Comma**, or **Space**, depending on the currency.", "enum": [ "Comma", "Period", "Space" ], "type": "string" } }, "type": "object" }, "is_active": { "description": "Indicates whether the currency is active.\n**Possible Values:**\n**true** - The currency is active. This is the default value.\n**false** - The currency is inactive.", "type": "boolean" }, "iso_code": { "description": "Represents the ISO code of the currency. You can get the currency code from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 3, "type": "string" }, "name": { "description": "Represents the name of the currency. You can get the available currencies from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 255, "type": "string" }, "symbol": { "description": "Indicates the currency symbol used for display.", "maxLength": 50, "type": "string" } }, "required": [ "exchange_rate", "iso_code" ], "type": "object" }, "maxItems": 180, "type": "array" } }, "required": [ "currencies" ], "type": "object" } } }, "description": "Specifies the request payload structure for this operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "CreateSuccess": { "description": "Provides a sample 200 response for the create success scenario.", "summary": "Successful create response", "value": { "currencies": [ { "code": "SUCCESS", "details": { "id": "111111000000129264" }, "message": "The currency created successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful creation response wrapper.", "properties": { "currencies": { "description": "List of results for each currency creation attempt. Returns one entry per submitted currency.", "items": { "additionalProperties": false, "description": "successfully created currency responses", "properties": { "code": { "description": "The code representing success", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains currency identifier.", "properties": { "id": { "description": "The unique identifier for currency.", "format": "int64", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Success message for the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 180, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "CreateCurrenciesResponse" } } }, "description": "Currencies successfully created." }, "207": { "content": { "application/json": { "examples": { "MultiStatusExample": { "description": "Provides a sample 207 response for the multi-status scenario.", "summary": "Mixed create results", "value": { "currencies": [ { "code": "SUCCESS", "details": { "id": "111111000000129264" }, "message": "The currency created successfully.", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "iso_code", "json_path": "$.currencies[1].iso_code" }, "message": "Currency isocode given seems to be invalid", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Bulk create response containing mixed success and error results.", "properties": { "currencies": { "allOf": [ { "description": "Constraint requiring at least one success item in the result array." }, { "description": "Constraint requiring at least one error item in the result array." } ], "description": "List of per-item results; each entry reflects one submitted currency.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful currency creation result.", "properties": { "code": { "description": "SUCCESS code for this item.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the created currency identifier.", "properties": { "id": { "description": "Unique identifier of the newly created currency.", "format": "int64", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Result message for this item.", "maxLength": 255, "type": "string" }, "status": { "description": "Outcome of this item.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "CreateCurrenciesItemSuccessResponse" }, { "additionalProperties": false, "description": "Failed currency creation result.", "properties": { "code": { "description": "Error code for this item.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details for this error item.", "properties": { "api_name": { "description": "Field or API parameter related to the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the invalid field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSON path pointing to the error field.", "maxLength": 255, "type": "string" }, "limit": { "description": "Maximum allowed count relevant to the error.", "type": "number" } }, "type": "object" }, "message": { "description": "Result message for this item.", "maxLength": 255, "type": "string" }, "status": { "description": "Outcome of this item.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "CreateCurrenciesItemErrorResponse" } ] }, "maxItems": 180, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "CreateCurrenciesMultiStatusResponse" } } }, "description": "Multi-status. Returned when bulk currency creation has a mix of successes and failures. Each entry in the response array carries its own code and status." }, "400": { "content": { "application/json": { "examples": { "ActiveCurrencyLimitExceeded": { "description": "Provides a sample 400 error response for the active currency limit exceeded scenario.", "summary": "Maximum allowed active currencies reached", "value": { "currencies": [ { "code": "ACTIVE_STATE_LIMIT_EXCEEDED", "details": { "limit": 5 }, "message": "Allowed active currency limit reached. Please deactivate any one of the existing active currencies to create this currency.", "status": "error" } ] } }, "DuplicateISO": { "description": "Provides a sample 400 error response for the duplicate iso scenario.", "summary": "ISO code already exists", "value": { "currencies": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "iso_code", "json_path": "$.currencies[0].iso_code" }, "message": "Duplicate value given for Isocode parameter", "status": "error" } ] } }, "FeatureNotEnabled": { "description": "Provides a sample 400 error response for the feature not enabled scenario.", "summary": "Multi-currency not enabled", "value": { "currencies": [ { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "The multi-currency feature is not yet enabled. Please enable it before doing this action.", "status": "error" } ] } }, "IndianFormatSeparatorRules": { "description": "Provides a sample 400 error response for the indian format separator rules scenario.", "summary": "Indian numeral system separator restrictions", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.currencies[0].format.numeral_system" }, "message": "The only supported thousand and decimal separators in the Indian numeral system are the comma and the period", "status": "error" } ] } }, "InvalidDecimalPlaces": { "description": "Provides a sample 400 error response for the invalid decimal places scenario.", "summary": "Wrong decimal places", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_places", "json_path": "$.currencies[0].format.decimal_places" }, "message": "Decimal places given seems to be invalid", "status": "error" } ] } }, "InvalidDecimalSeparator": { "description": "Provides a sample 400 error response for the invalid decimal separator scenario.", "summary": "Wrong decimal separator", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.currencies[0].format.decimal_separator" }, "message": "Decimal separator given seems to be invalid", "status": "error" } ] } }, "InvalidExchangeRateAutoUpdate": { "description": "Provides a sample 400 error response for the invalid exchange rate auto update scenario.", "summary": "Invalid exchange rate auto update", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate_auto_update", "expected_data_type": "boolean", "json_path": "$.currencies[0].exchange_rate_auto_update" }, "message": "invalid data", "status": "error" } ] } }, "InvalidExchangeRateType": { "description": "Provides a sample 400 error response for the invalid exchange rate type scenario.", "summary": "Exchange rate invalid datatype", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate", "expected_data_type": "string", "json_path": "$.currencies[0].exchange_rate" }, "message": "Exchange rate given seems to be invalid", "status": "error" } ] } }, "InvalidISO": { "description": "Provides a sample 400 error response for the invalid iso scenario.", "summary": "Invalid ISO code", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "iso_code", "json_path": "$.currencies[0].iso_code" }, "message": "Currency isocode given seems to be invalid", "status": "error" } ] } }, "InvalidISODataType": { "description": "Provides a sample 400 error response for the invalid isodata type scenario.", "summary": "ISO datatype incorrect", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "iso_code", "expected_data_type": "string", "json_path": "$.currencies[0].iso_code" }, "message": "Currency isocode given seems to be invalid", "status": "error" } ] } }, "InvalidName": { "description": "Provides a sample 400 error response for the invalid name scenario.", "summary": "Invalid currency name", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.currencies[0].name" }, "message": "Currency name given seems to be invalid", "status": "error" } ] } }, "InvalidNumeralSystem": { "description": "Provides a sample 400 error response for the invalid numeral system scenario.", "summary": "Invalid numeral system", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.currencies[0].format.numeral_system" }, "message": "Numeral system given seems to be invalid", "status": "error" } ] } }, "InvalidSymbol": { "description": "Provides a sample 400 error response for the invalid symbol scenario.", "summary": "Invalid currency symbol", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.currencies[0].symbol" }, "message": "Currency symbol given seems to be invalid", "status": "error" } ] } }, "InvalidThousandSeparator": { "description": "Provides a sample 400 error response for the invalid thousand separator scenario.", "summary": "Wrong thousand separator", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "thousand_separator", "json_path": "$.currencies[0].format.thousand_separator" }, "message": "Thousand separator given seems to be invalid", "status": "error" } ] } }, "NoPermission": { "description": "Provides a sample 400 error response for the no permission scenario.", "summary": "User lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Currencies" ] }, "message": "permission denied", "status": "error" } }, "NotAllowedSameSeparators": { "description": "Provides a sample 400 error response for the not allowed same separators scenario.", "summary": "Thousand and decimal separator conflict", "value": { "currencies": [ { "code": "NOT_ALLOWED", "details": { "api_name": "decimal_places", "json_path": "$.currencies[0].format.decimal_places" }, "message": "Thousand separator and Decimal separator should not be equal", "status": "error" } ] } }, "SymbolAlreadyUsed": { "description": "Provides a sample 400 error response for the symbol already used scenario.", "summary": "Symbol already assigned", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.currencies[0].symbol" }, "message": "Currency symbol is already used", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Single permission-level error response.", "properties": { "code": { "description": "Indicates the error code which implies the type of error.", "enum": [ "NO_PERMISSION" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional information related to permission error.", "properties": { "permissions": { "description": "List of required permissions that were missing.", "items": { "description": "Indicates required permission details", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Error message describing the failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\n**Possible values:**\n**error**", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateCurrenciesErrorResponse" }, { "additionalProperties": false, "description": "Represents the currency validation errors for bulk operations", "properties": { "currencies": { "description": "An array of currency errors returned when bulk operations fail, including details of each failure.", "items": { "additionalProperties": false, "description": "The response returns validation error details for a single currency record when the request fails validation.", "properties": { "code": { "description": "An error code representing the category or type of error returned.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional information related to validation error.", "properties": { "api_name": { "description": "Indicates the name of the parameter causing validation error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Required datatype for the field when applicable.", "maxLength": 50, "type": "string" }, "json_path": { "description": "A JSON pointer specifying the exact path to the property that failed validation.", "maxLength": 255, "type": "string" }, "limit": { "description": "Specifies the maximum allowed count of active currencies.", "type": "number" } }, "type": "object" }, "message": { "description": "Error message describing the failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicate the status of the response.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "WrappedCreateCurrenciesErrorResponse" } ], "description": "Possible error responses for currency creation operation.", "x-zs-$id": "CreateCurrenciesErrorResponses" } } }, "description": "Bad request. The input data is invalid or missing required values." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.currencies.CREATE" ] } ], "summary": "Create currencies", "tags": [ "currencies" ], "x-zoho-document": "currencies" }, "put": { "description": "Updates one or more currencies other than the base currency.", "operationId": "updateCurrencies", "requestBody": { "content": { "application/json": { "examples": { "UpdateSample": { "description": "Provides a sample request payload for the update sample scenario.", "summary": "Update one currency", "value": { "currencies": [ { "exchange_rate": "85.000000000", "exchange_rate_auto_update": true, "id": "3652397000007472080", "is_active": false, "symbol": "$" } ] } } }, "schema": { "additionalProperties": false, "description": "Request body to update currency values in the organization.", "properties": { "currencies": { "description": "List of currencies to be updated.", "items": { "additionalProperties": false, "description": "Currency update request object.", "properties": { "exchange_rate": { "description": "Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to **nine** digits and nine decimal places. Example: 123456789.123456789.", "maxLength": 18, "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$", "type": "string" }, "exchange_rate_auto_update": { "description": "Indicates whether the currency has the automated exchange rate option enabled or not.", "type": "boolean" }, "format": { "additionalProperties": false, "description": "Currency formatting properties.", "properties": { "decimal_places": { "description": "Represents the number of decimal places allowed for the currency. It can be **0, 2, and 3.**", "enum": [ "0", "2", "3", "4", "5", "6" ], "type": "string" }, "decimal_separator": { "description": "The decimal separator separates the integer part of the currency from its fractional part. It can be a **Period or Comma,** depending on the currency.", "enum": [ "Comma", "Period" ], "type": "string" }, "numeral_system": { "default": "International", "description": "Specifies whether the currency uses the Indian numbering format (1,00,000) or International format (100,000).", "enum": [ "Indian", "International" ], "type": "string" }, "thousand_separator": { "description": "The thousand separator separates groups of thousands in a currency. It can be a **Period**, **Comma**, or **Space**, depending on the currency.", "enum": [ "Comma", "Period", "Space" ], "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "Unique ID of the currency to update. Obtainable from GET /org/currencies.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getCurrencies", "propertyId": "CurrencyId" }, { "operationId": "getCurrencyById", "propertyId": "CurrencyByIdId" } ], "resource": "currencies" } }, "is_active": { "description": "Indicates whether the currency is active in the organization.", "type": "boolean" }, "iso_code": { "description": "ISO code of the currency. NOTE: During update, ISO code cannot be modified.", "maxLength": 3, "type": "string" }, "name": { "description": "Name of the currency. NOTE: During update, currency name cannot be modified.", "maxLength": 255, "type": "string" }, "symbol": { "description": "Symbol used to display the currency", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object" } } }, "description": "Specifies the request payload structure for this operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "UpdateSuccess": { "description": "Provides a sample 200 response for the update success scenario.", "summary": "Update success example", "value": { "currencies": [ { "code": "SUCCESS", "details": { "id": "111111000000129300" }, "message": "The currency updated successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response returned for a successful update operation.", "properties": { "currencies": { "description": "List of updated currency responses.", "items": { "additionalProperties": false, "description": "Currency update result object.", "properties": { "code": { "description": "Specifies the response code.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional response details", "properties": { "id": { "description": "The unique identifier of the currency.", "format": "int64", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Indicates the response message", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "UpdateCurrenciesResponse" } } }, "description": "Successfully updated the currency properties." }, "207": { "content": { "application/json": { "examples": { "MultiStatusExample": { "description": "Provides a sample 207 response for the multi-status scenario.", "summary": "Mixed update results", "value": { "currencies": [ { "code": "SUCCESS", "details": { "id": "111111000000129300" }, "message": "The currency updated successfully.", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate", "json_path": "$.currencies[1].exchange_rate" }, "message": "Exchange rate given seems to be invalid", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Bulk update response containing mixed success and error results.", "properties": { "currencies": { "allOf": [ { "description": "Constraint requiring at least one success item in the result array." }, { "description": "Constraint requiring at least one error item in the result array." } ], "description": "List of per-item results; each entry reflects one submitted currency.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful currency update result.", "properties": { "code": { "description": "SUCCESS code for this item.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the updated currency identifier.", "properties": { "id": { "description": "Unique identifier of the updated currency.", "format": "int64", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Result message for this item.", "maxLength": 255, "type": "string" }, "status": { "description": "Outcome of this item.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "UpdateCurrenciesItemSuccessResponse" }, { "additionalProperties": false, "description": "Failed currency update result.", "properties": { "code": { "description": "Error code for this item.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details for this error item.", "properties": { "api_name": { "description": "Field or API parameter related to the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the invalid field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSON path pointing to the error field.", "maxLength": 255, "type": "string" }, "limit": { "description": "Maximum allowed count relevant to the error.", "type": "number" } }, "type": "object" }, "message": { "description": "Result message for this item.", "maxLength": 255, "type": "string" }, "status": { "description": "Outcome of this item.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "UpdateCurrenciesItemErrorResponse" } ] }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "UpdateCurrenciesMultiStatusResponse" } } }, "description": "Multi-status. Returned when bulk currency update has a mix of successes and failures." }, "400": { "content": { "application/json": { "examples": { "ActiveCurrencyLimitExceeded": { "description": "Provides a sample 400 error response for the active currency limit exceeded scenario.", "summary": "Maximum allowed active currencies reached", "value": { "currencies": [ { "code": "ACTIVE_STATE_LIMIT_EXCEEDED", "details": { "limit": 5 }, "message": "Allowed active currency limit reached. Please deactivate any one of the existing active currencies to create this currency.", "status": "error" } ] } }, "IndianFormatSeparatorRules": { "description": "Provides a sample 400 error response for the indian format separator rules scenario.", "summary": "Indian numeral system separator restrictions", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.currencies[0].format.numeral_system" }, "message": "The only supported thousand and decimal separators in the Indian numeral system are the comma and the period", "status": "error" } ] } }, "InvalidDecimalPlaces": { "description": "Provides a sample 400 error response for the invalid decimal places scenario.", "summary": "Wrong decimal places", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_places", "json_path": "$.currencies[0].format.decimal_places" }, "message": "Decimal places given seems to be invalid", "status": "error" } ] } }, "InvalidDecimalSeparator": { "description": "Provides a sample 400 error response for the invalid decimal separator scenario.", "summary": "Wrong decimal separator", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.currencies[0].format.decimal_separator" }, "message": "Decimal separator given seems to be invalid", "status": "error" } ] } }, "InvalidExchangeRateAutoUpdate": { "description": "Provides a sample 400 error response for the invalid exchange rate auto update scenario.", "summary": "Invalid exchange rate auto update", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate_auto_update", "expected_data_type": "boolean", "json_path": "$.currencies[0].exchange_rate_auto_update" }, "message": "invalid data", "status": "error" } ] } }, "InvalidExchangeRateType": { "description": "Provides a sample 400 error response for the invalid exchange rate type scenario.", "summary": "Exchange rate invalid datatype", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate", "expected_data_type": "string", "json_path": "$.currencies[0].exchange_rate" }, "message": "Exchange rate given seems to be invalid", "status": "error" } ] } }, "InvalidISO": { "description": "Provides a sample 400 error response for the invalid iso scenario.", "summary": "Invalid ISO code", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "iso_code", "json_path": "$.currencies[0].iso_code" }, "message": "Currency isocode given seems to be invalid", "status": "error" } ] } }, "InvalidNumeralSystem": { "description": "Provides a sample 400 error response for the invalid numeral system scenario.", "summary": "Invalid numeral system", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.currencies[0].format.numeral_system" }, "message": "Numeral system given seems to be invalid", "status": "error" } ] } }, "InvalidSymbol": { "description": "Provides a sample 400 error response for the invalid symbol scenario.", "summary": "Invalid currency symbol", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.currencies[0].symbol" }, "message": "Currency symbol given seems to be invalid", "status": "error" } ] } }, "InvalidThousandSeparator": { "description": "Provides a sample 400 error response for the invalid thousand separator scenario.", "summary": "Wrong thousand separator", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "thousand_separator", "json_path": "$.currencies[0].format.thousand_separator" }, "message": "Thousand separator given seems to be invalid", "status": "error" } ] } }, "NoPermission": { "description": "Provides a sample 400 error response for the no permission scenario.", "summary": "User lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Currencies" ] }, "message": "permission denied", "status": "error" } }, "NotAllowedSameSeparators": { "description": "Provides a sample 400 error response for the not allowed same separators scenario.", "summary": "Thousand and decimal separator conflict", "value": { "currencies": [ { "code": "NOT_ALLOWED", "details": { "api_name": "decimal_places", "json_path": "$.currencies[0].format.decimal_places" }, "message": "Thousand separator and Decimal separator should not be equal", "status": "error" } ] } }, "SymbolAlreadyUsed": { "description": "Provides a sample 400 error response for the symbol already used scenario.", "summary": "Symbol already assigned", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.currencies[0].symbol" }, "message": "Currency symbol is already used", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Permission-level or single validation error.", "properties": { "code": { "description": "Error identifier representing the failure type.", "enum": [ "NO_PERMISSION" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional information about the error.", "properties": { "permissions": { "description": "List of required permissions missing for the current user.", "items": { "description": "Specifies the required permission details.", "maxLength": 100, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Message describing the error condition.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the response represents an error condition.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateCurrenciesErrorResponse" }, { "additionalProperties": false, "description": "Currency validation errors.", "properties": { "currencies": { "description": "Array of currency error objects representing individual validation or permission errors.", "items": { "additionalProperties": false, "description": "An object representing a single currency-related error.", "properties": { "code": { "description": "Error identifier representing the validation failure type.", "enum": [ "INVALID_DATA", "ACTIVE_STATE_LIMIT_EXCEEDED", "NOT_ALLOWED", "MANDATORY_NOT_FOUND" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional debugging metadata for the error. Provides field-level or permission-level details.", "properties": { "api_name": { "description": "The field name, API parameter, or array index related to the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the invalid field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSON path pointing to the field that caused the error.", "maxLength": 255, "type": "string" }, "limit": { "description": "Maximum allowed limit relevant to the error, for example, max active currencies.", "format": "int32", "type": "integer" }, "maximum_decimal_place": { "description": "Maximum allowed decimal places for currency values.", "format": "int32", "type": "number" } }, "type": "object" }, "message": { "description": "Message describing the error condition.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the response represents an error condition.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "WrappedUpdateCurrenciesErrorResponse" } ], "description": "Possible error responses for currency update operation.", "x-zs-$id": "UpdateCurrenciesErrorResponses" } } }, "description": "Bad request. Input validation errors or disallowed update field." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.currencies.UPDATE" ] } ], "summary": "Update currencies", "tags": [ "currencies" ], "x-zoho-document": "currencies" } }, "/crm/v8/org/currencies/actions/enable": { "post": { "description": "Enable multi-currency for the organization and set the base currency.", "operationId": "enableCurrency", "requestBody": { "content": { "application/json": { "examples": { "EnableSample": { "description": "Provides a sample request payload for the enable sample scenario.", "summary": "Enable multi-currency sample", "value": { "base_currency": { "exchange_rate": "1.000000000", "format": { "decimal_places": "2", "decimal_separator": "Period", "numeral_system": "International", "thousand_separator": "Comma" }, "iso_code": "DZD", "name": "Algerian Dinar - DZD", "symbol": "DA" } } } }, "schema": { "additionalProperties": false, "description": "Payload for creating and enabling base currency.", "properties": { "base_currency": { "additionalProperties": false, "description": "Represents the base currency information required for initializing multi-currency settings in the CRM.", "properties": { "exchange_rate": { "description": "Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to **nine** digits and nine decimal places. Example: 123456789.123456789.", "maxLength": 50, "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$", "type": "string" }, "format": { "additionalProperties": false, "description": "Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places.", "properties": { "decimal_places": { "description": "Represents the number of decimal places allowed for the currency. It can be **0, 2, and 3.**", "enum": [ "0", "2", "3", "4", "5", "6" ], "type": "string" }, "decimal_separator": { "description": "The decimal separator separates the integer part of the currency from its fractional part. It can be a Period or Comma, depending on the currency.", "enum": [ "Comma", "Period" ], "type": "string" }, "numeral_system": { "default": "International", "description": "Indicates whether the currency should use the Indian or International numbering format.", "enum": [ "Indian", "International" ], "type": "string" }, "thousand_separator": { "description": "The thousand separator separates groups of thousands in a currency. It can be a Period, Comma, or Space, depending on the currency.", "enum": [ "Comma", "Period", "Space" ], "type": "string" } }, "type": "object" }, "iso_code": { "description": "Represents the ISO code of the currency. You can get the currency code from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 3, "type": "string" }, "name": { "description": "Full name of the currency (for example, US Dollar - USD).", "maxLength": 255, "type": "string" }, "prefix_symbol": { "description": "Represents the position of the currency symbol.\n**Possible Values:**\n**true** - Display the currency symbol before the currency value. This is the default value.\n**false** - Display the currency symbol after the currency value.", "type": "boolean" }, "symbol": { "description": "Represents the symbol of the currency.", "maxLength": 50, "type": "string" } }, "required": [ "iso_code", "exchange_rate" ], "type": "object" } }, "required": [ "base_currency" ], "type": "object" } } }, "description": "Specifies the request payload structure for this operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "EnableSuccess": { "description": "Provides a sample 200 response for the enable success scenario.", "summary": "Enable success example", "value": { "base_currency": { "code": "SUCCESS", "details": { "id": "111113000000038990" }, "message": "The multi-currency feature is enabled and given currency is created as the base currency.", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Successful enable response", "properties": { "base_currency": { "additionalProperties": false, "description": "Success response object.", "properties": { "code": { "description": "Result code, for example, SUCCESS.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional response details.", "properties": { "id": { "description": "ID of the created base currency.", "format": "int64", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Success message for the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Operation status, for example, success.", "maxLength": 50, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "base_currency" ], "type": "object", "x-zs-$id": "EnableCurrencyResponse" } } }, "description": "Successfully enabled and created base currency." }, "400": { "content": { "application/json": { "examples": { "EnableAlreadyEnabled": { "description": "Provides a sample 400 error response for the enable already enabled scenario.", "summary": "Multi-currency already enabled", "value": { "base_currency": { "code": "ALREADY_ENABLED", "details": {}, "message": "The base currency is already added", "status": "error" } } }, "EnableIndianNumberFormatViolation": { "description": "Provides a sample 400 error response for the enable indian number format violation scenario.", "summary": "Indian numeral system separator rule violation", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.base_currency.format.numeral_system" }, "message": "The only supported thousand and decimal separators in the Indian numeral system are the comma and the period", "status": "error" } } }, "EnableInvalidDecimalPlaces": { "description": "Provides a sample 400 error response for the enable invalid decimal places scenario.", "summary": "Invalid decimal places", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "decimal_places", "json_path": "$.base_currency.format.decimal_places" }, "message": "Decimal places given seems to be invalid", "status": "error" } } }, "EnableInvalidDecimalSeparator": { "description": "Provides a sample 400 error response for the enable invalid decimal separator scenario.", "summary": "Invalid decimal separator", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.base_currency.format.decimal_separator" }, "message": "Decimal separator given seems to be invalid", "status": "error" } } }, "EnableInvalidExchangeRate": { "description": "Provides a sample 400 error response for the enable invalid exchange rate scenario.", "summary": "Invalid exchange rate", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate", "json_path": "$.base_currency.exchange_rate", "maximum_decimal_place": 9 }, "message": "Exchange rate given seems to be invalid", "status": "error" } } }, "EnableInvalidISOCode": { "description": "Provides a sample 400 error response for the enable invalid isocode scenario.", "summary": "Invalid currency iso code", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "iso_code", "json_path": "$.base_currency.iso_code" }, "message": "Currency isocode given seems to be invalid", "status": "error" } } }, "EnableInvalidName": { "description": "Provides a sample 400 error response for the enable invalid name scenario.", "summary": "Invalid currency name", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.base_currency.name" }, "message": "Currency name given seems to be invalid", "status": "error" } } }, "EnableInvalidNumeralSystem": { "description": "Provides a sample 400 error response for the enable invalid numeral system scenario.", "summary": "Invalid numeral system", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.base_currency.format.numeral_system" }, "message": "Numeral system given seems to be invalid", "status": "error" } } }, "EnableInvalidSymbol": { "description": "Provides a sample 400 error response for the enable invalid symbol scenario.", "summary": "Invalid currency symbol", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.base_currency.symbol" }, "message": "Currency symbol given seems to be invalid", "status": "error" } } }, "EnableInvalidThousandSeparator": { "description": "Provides a sample 400 error response for the enable invalid thousand separator scenario.", "summary": "Invalid thousand separator", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "thousand_separator", "json_path": "$.base_currency.format.thousand_separator" }, "message": "Thousand separator given seems to be invalid", "status": "error" } } }, "EnableNoPermission": { "description": "Provides a sample 400 error response for the enable no permission scenario.", "summary": "No permission to enable multi-currency", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Currencies" ] }, "message": "Permission denied", "status": "error" } }, "EnableSeparatorsCannotBeEqual": { "description": "Provides a sample 400 error response for the enable separators cannot be equal scenario.", "summary": "Thousand and decimal separator cannot be equal", "value": { "base_currency": { "code": "NOT_ALLOWED", "details": { "api_name": "decimal_places", "json_path": "$.base_currency.format.decimal_places" }, "message": "Thousand separator and Decimal separator should not be equal", "status": "error" } } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Permission error response for enableCurrency.", "properties": { "code": { "description": "Error code indicating no permission.", "enum": [ "NO_PERMISSION" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Permission error details.", "properties": { "permissions": { "description": "List of missing permissions.", "items": { "description": "Needed permission details", "maxLength": 100, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Descriptive error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates error status.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "EnableCurrencyNoPermissionError" }, { "additionalProperties": false, "description": "Base-currency validation error response for enableCurrency.", "properties": { "base_currency": { "additionalProperties": false, "description": "base_currency-level error object for currency-specific validation errors.", "properties": { "code": { "description": "Error code for base_currency validation.", "enum": [ "ALREADY_ENABLED", "INVALID_DATA", "MANDATORY_NOT_FOUND", "NOT_ALLOWED" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details for base_currency error (field name, JSON path).", "properties": { "api_name": { "description": "Field or API parameter related to the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path pointing to the error field.", "maxLength": 255, "type": "string" }, "maximum_decimal_place": { "description": "Maximum allowed decimal places for the field, returned when the value exceeds the limit.", "format": "int32", "maximum": 9, "type": "integer" } }, "type": "object" }, "message": { "description": "Error message for the base currency validation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Status for the base_currency error.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" } }, "required": [ "base_currency" ], "type": "object", "x-zs-$id": "EnableCurrencyBaseCurrencyValidationError" } ], "description": "Possible error responses for multi-currency enablement.", "x-zs-$id": "EnableCurrencyErrorResponses" } } }, "description": "Invalid request or validation errors." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.currencies.CREATE" ] } ], "summary": "Enable multi-currency", "tags": [ "currencies" ], "x-zoho-document": "currencies" }, "put": { "description": "Update existing base currency details.", "operationId": "updateBaseCurrency", "requestBody": { "content": { "application/json": { "examples": { "UpdateBaseSample": { "description": "Provides a sample request payload for the update base sample scenario.", "summary": "Update base currency sample", "value": { "base_currency": { "exchange_rate": "1.000000000", "format": { "decimal_places": "2", "decimal_separator": "Period", "numeral_system": "International", "thousand_separator": "Comma" }, "id": "111113000000038990", "iso_code": "USD", "name": "US Dollar - USD", "symbol": "$" } } } }, "schema": { "additionalProperties": false, "description": "Payload for modifying existing base currency.", "properties": { "base_currency": { "additionalProperties": false, "description": "JSON object containing the updated base currency values.", "properties": { "exchange_rate": { "description": "Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to nine digits and nine decimal places. Example: 123456789.123456789.", "maxLength": 50, "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$", "type": "string" }, "format": { "additionalProperties": false, "description": "Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places.", "properties": { "decimal_places": { "description": "Represents the number of decimal places allowed for the currency. It can be **0, 2, and 3**.", "enum": [ "0", "2", "3", "4", "5", "6" ], "type": "string" }, "decimal_separator": { "description": "The decimal separator separates the integer part of the currency from its fractional part. It can be a **Period or Comma,** depending on the currency.", "enum": [ "Comma", "Period" ], "type": "string" }, "numeral_system": { "default": "International", "description": "Numbering system used for grouping digits.", "enum": [ "Indian", "International" ], "type": "string" }, "thousand_separator": { "description": "The thousand separator separates groups of thousands in a currency. It can be a **Period**, **Comma**, or **Space**, depending on the currency.", "enum": [ "Comma", "Period", "Space" ], "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "The unique identifier of the currency.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getCurrencies", "propertyId": "CurrencyId" }, { "operationId": "getCurrencyById", "propertyId": "CurrencyByIdId" } ], "resource": "currencies" } }, "iso_code": { "description": "Represents the ISO code of the currency. You can get the currency code from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 3, "type": "string" }, "name": { "description": "Represents the name of the currency. You can get the available currencies from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 255, "type": "string" }, "symbol": { "description": "Represents the symbol of the currency.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "base_currency" ], "type": "object" } } }, "description": "Specifies the request payload structure for this operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "UpdateBaseSuccess": { "description": "Provides a sample 200 response for the update base success scenario.", "summary": "Update base success", "value": { "base_currency": { "code": "SUCCESS", "details": { "id": "111111000000129290" }, "message": "The currency updated successfully.", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Successful update response", "properties": { "base_currency": { "additionalProperties": false, "description": "Result of base currency update", "properties": { "code": { "description": "Indicating the code of the result.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details of the response.", "properties": { "id": { "description": "The unique identifier of the base currency created.", "format": "int64", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Message describing the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation.", "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" } }, "required": [ "base_currency" ], "type": "object", "x-zs-$id": "UpdateBaseCurrencyResponse" } } }, "description": "Currency updated successfully." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "description": "Provides a sample 400 error response when id and rid are both provided but refer to different currencies.", "summary": "Both id and rid refer to different currencies", "value": { "base_currency": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.base_currency.id" }, { "api_name": "rid", "json_path": "$.base_currency.rid" } ] }, "message": "Ambiguity while processing the request", "status": "error" } } }, "EnableIndianNumberFormatViolation": { "description": "Provides a sample 400 error response for the enable indian number format violation scenario.", "summary": "Indian numeral system separator rule violation", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.base_currency.format.numeral_system" }, "message": "The only supported thousand and decimal separators in the Indian numeral system are the comma and the period", "status": "error" } } }, "EnableInvalidDecimalPlaces": { "description": "Provides a sample 400 error response for the enable invalid decimal places scenario.", "summary": "Invalid decimal places", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "decimal_places", "json_path": "$.base_currency.format.decimal_places" }, "message": "Decimal places given seems to be invalid", "status": "error" } } }, "EnableInvalidDecimalSeparator": { "description": "Provides a sample 400 error response for the enable invalid decimal separator scenario.", "summary": "Invalid decimal separator", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.base_currency.format.decimal_separator" }, "message": "Decimal separator given seems to be invalid", "status": "error" } } }, "EnableInvalidISOCode": { "description": "Provides a sample 400 error response for the enable invalid isocode scenario.", "summary": "Invalid currency iso code", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "iso_code", "json_path": "$.base_currency.iso_code" }, "message": "Currency isocode given seems to be invalid", "status": "error" } } }, "EnableInvalidNumeralSystem": { "description": "Provides a sample 400 error response for the enable invalid numeral system scenario.", "summary": "Invalid numeral system", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.base_currency.format.numeral_system" }, "message": "Numeral system given seems to be invalid", "status": "error" } } }, "EnableInvalidSymbol": { "description": "Provides a sample 400 error response for the enable invalid symbol scenario.", "summary": "Invalid currency symbol", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.base_currency.symbol" }, "message": "Currency symbol given seems to be invalid", "status": "error" } } }, "EnableInvalidThousandSeparator": { "description": "Provides a sample 400 error response for the enable invalid thousand separator scenario.", "summary": "Invalid thousand separator", "value": { "base_currency": { "code": "INVALID_DATA", "details": { "api_name": "thousand_separator", "json_path": "$.base_currency.format.thousand_separator" }, "message": "Thousand separator given seems to be invalid", "status": "error" } } }, "EnableNoPermission": { "description": "Provides a sample 400 error response for the enable no permission scenario.", "summary": "No permission to enable multi-currency", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Currencies" ] }, "message": "Permission denied", "status": "error" } }, "EnableSeparatorsCannotBeEqual": { "description": "Provides a sample 400 error response for the enable separators cannot be equal scenario.", "summary": "Thousand and decimal separator cannot be equal", "value": { "base_currency": { "code": "NOT_ALLOWED", "details": { "api_name": "decimal_places", "json_path": "$.base_currency.format.decimal_places" }, "message": "Thousand separator and Decimal separator should not be equal", "status": "error" } } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Permission error response for updateBaseCurrency.", "properties": { "code": { "description": "Error code indicating no permission.", "enum": [ "NO_PERMISSION" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Permission error details.", "properties": { "permissions": { "description": "List of missing permissions.", "items": { "description": "Needed permission details", "maxLength": 100, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Descriptive error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates error status.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateBaseCurrencyNoPermissionError" }, { "additionalProperties": false, "description": "Base-currency validation error response for updateBaseCurrency.", "properties": { "base_currency": { "additionalProperties": false, "description": "base_currency-level error object for currency-specific validation errors.", "properties": { "code": { "description": "Error code for base_currency validation.", "enum": [ "ALREADY_ENABLED", "AMBIGUITY_DURING_PROCESSING", "INVALID_DATA", "MANDATORY_NOT_FOUND", "NOT_ALLOWED" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Specifies the additional details for base_currency error (field name, JSON path, or ambiguity details).", "properties": { "ambiguity_due_to": { "description": "List of conflicting identifiers when both id and rid are provided but refer to different currencies.", "items": { "additionalProperties": false, "description": "A conflicting identifier pair showing which fields caused the ambiguity.", "properties": { "api_name": { "description": "The conflicting field name.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the conflicting field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 100, "type": "array" }, "api_name": { "description": "Field or API parameter related to the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "A JSON pointer specifying the exact path to the property that failed validation.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Error message for the base currency validation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Status for the base_currency error.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" } }, "required": [ "base_currency" ], "type": "object", "x-zs-$id": "UpdateBaseCurrencyBaseCurrencyValidationError" } ], "description": "Possible error responses for update base currency operation.", "x-zs-$id": "UpdateBaseCurrencyErrorResponses" } } }, "description": "Invalid request or validation errors." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.currencies.UPDATE" ] } ], "summary": "Update base currency", "tags": [ "currencies" ], "x-zoho-document": "currencies" } }, "/crm/v8/org/currencies/{currency}": { "get": { "description": "Retrieves details of a specific currency via its unique currency ID.", "operationId": "getCurrencyById", "parameters": [ { "$ref": "#/components/parameters/Currency", "description": "Unique identifier of the currency to retrieve." } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetByIdSample": { "description": "Provides a sample 200 response for the get by ID sample scenario.", "summary": "Single currency response", "value": { "currencies": [ { "created_by": { "id": "11111300000001", "name": "Admin" }, "created_time": "2025-01-01T00:00:00Z", "exchange_rate": "85.000000000", "exchange_rate_auto_update": true, "exchange_rate_updated_time": "2019-05-31T15:10:33+05:30", "format": { "decimal_places": "2", "decimal_separator": "Period", "numeral_system": "International", "thousand_separator": "Comma" }, "id": "3652397000007472080", "is_active": true, "is_base": false, "iso_code": "INR", "modified_by": { "id": "11111300000001", "name": "Admin" }, "modified_time": "2025-01-01T00:00:00Z", "name": "Indian Rupee - INR", "prefix_symbol": true, "symbol": "₹" } ] } } }, "schema": { "additionalProperties": false, "description": "Currency response object.", "properties": { "currencies": { "description": "JSON array containing the requested currency object.", "items": { "additionalProperties": false, "description": "JSON object with currency formatting, exchange info and settings.", "properties": { "created_by": { "additionalProperties": false, "description": "User who created the currency record.", "properties": { "id": { "description": "The unique identifier of the user who created the currency record.", "format": "int64", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the user who created this currency.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Timestamp when the currency was initially created.", "format": "date-time", "type": "string" }, "exchange_rate": { "description": "Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to nine digits and nine decimal places. Example: 123456789.123456789.", "maxLength": 18, "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$", "type": "string" }, "exchange_rate_auto_update": { "description": "Indicates whether the currency has the automated exchange rate option enabled or not.", "type": "boolean" }, "exchange_rate_updated_time": { "description": "Timestamp when the exchange rate was last modified.", "format": "date-time", "type": "string" }, "format": { "additionalProperties": false, "description": "Represents the format of the base currency with details like decimal_separator, thousand_separator, and decimal_places.", "properties": { "decimal_places": { "description": "Represents the number of decimal places allowed for the currency. It can be **0, 2, and 3.**", "enum": [ "0", "2", "3", "4", "5", "6" ], "type": "string" }, "decimal_separator": { "description": "The decimal separator separates the integer part of the currency from its fractional part. It can be a **Period or Comma,** depending on the currency.", "enum": [ "Comma", "Period" ], "type": "string" }, "numeral_system": { "default": "International", "description": "Numeral grouping system used for formatting.", "enum": [ "Indian", "International" ], "type": "string" }, "thousand_separator": { "description": "The thousand separator separates groups of thousands in a currency. It can be a **Period**, **Comma**, or **Space**, depending on the currency.", "enum": [ "Comma", "Period", "Space" ], "type": "string" } }, "required": [ "numeral_system", "decimal_places", "decimal_separator", "thousand_separator" ], "type": "object" }, "id": { "description": "Unique ID associated with this currency.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$id": "CurrencyByIdId" }, "is_active": { "description": "Indicates whether the currency is active and available for use.", "type": "boolean" }, "is_base": { "description": "Indicates whether this is the base currency of the organization.", "type": "boolean" }, "iso_code": { "description": "Represents the ISO code of the currency. You can get the currency code from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 3, "type": "string" }, "modified_by": { "additionalProperties": false, "description": "User who last modified the currency record.", "properties": { "id": { "description": "The unique identifier of the user who last modified the currency record.", "format": "int64", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the user who last updated this currency.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "modified_time": { "description": "Timestamp when the currency was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "Represents the name of the currency. You can get the available currencies from the CRM UI at **Setup > General > Company Settings > Currencies.**", "maxLength": 255, "type": "string" }, "prefix_symbol": { "description": "Represents the position of the currency symbol.\n**Possible Values:**\n**true** - Display the currency symbol before the currency value. This is the default value.\n**false** - Display the currency symbol after the currency value.", "type": "boolean" }, "symbol": { "description": "Indicates the currency symbol used for display.", "maxLength": 50, "type": "string" } }, "required": [ "prefix_symbol", "format", "exchange_rate", "is_active", "iso_code", "symbol", "name", "is_base", "id", "created_by", "modified_by", "modified_time", "created_time" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "GetCurrencyByIdResponse" } } }, "description": "Successfully retrieved the currency details." }, "204": { "description": "No content - currency not found or nothing to return." }, "403": { "content": { "application/json": { "examples": { "CurrenciesNotEnabled": { "summary": "Multi-currency is not enabled", "value": { "code": "CURRENCIES_NOT_ENABLED", "details": {}, "message": "Multi currency is not enabled", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when multi-currency is not enabled.", "properties": { "code": { "description": "Error code indicating the type of error.", "enum": [ "CURRENCIES_NOT_ENABLED" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "Human-readable message indicating that the multi-currency feature is not enabled for the organization.", "maxLength": 255, "type": "string" }, "status": { "description": "Response status indicator.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetCurrencyByIdErrorResponse" } } }, "description": "Forbidden. Multi-currency feature is not enabled for the organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.currencies.READ" ] } ], "summary": "Specific Currency", "tags": [ "currencies" ], "x-zoho-document": "currencies" }, "put": { "description": "Update a specific currency by its unique ID.", "operationId": "updateCurrencyById", "parameters": [ { "$ref": "#/components/parameters/Currency" } ], "requestBody": { "content": { "application/json": { "examples": { "PutByIdSample": { "description": "Provides a sample request payload for the put by ID sample scenario.", "summary": "Update currency example", "value": { "currencies": [ { "exchange_rate": "85.000000000", "exchange_rate_auto_update": true, "is_active": false } ] } } }, "schema": { "additionalProperties": false, "description": "Payload for updating a specific currency by ID.", "properties": { "currencies": { "description": "List of currencies to update (single-element array expected).", "items": { "additionalProperties": false, "description": "Currency object containing update fields.", "properties": { "exchange_rate": { "description": "Represents the rate at which the currency has to be exchanged with home currency. Accepts positive decimal numbers up to **nine** digits and nine decimal places. Example: 123456789.123456789.", "maxLength": 18, "pattern": "^[0-9]{1,9}(\\.[0-9]{1,9})?$", "type": "string" }, "exchange_rate_auto_update": { "description": "Indicates whether the currency has the automated exchange rate option enabled or not.", "type": "boolean" }, "format": { "additionalProperties": false, "description": "Configuration for currency formatting rules.", "properties": { "decimal_places": { "description": "\nRepresents the number of decimal places allowed for the currency. It can be **0, 2, and 3.**", "enum": [ "0", "2", "3", "4", "5", "6" ], "type": "string" }, "decimal_separator": { "description": "The decimal separator separates the integer part of the currency from its fractional part. It can be a **Period or Comma,** depending on the currency.", "enum": [ "Comma", "Period" ], "type": "string" }, "numeral_system": { "default": "International", "description": "Defines the numbering system used for digit grouping.", "enum": [ "Indian", "International" ], "type": "string" }, "thousand_separator": { "description": "The thousand separator separates groups of thousands in a currency. It can be a **Period**, **Comma**, or **Space**, depending on the currency.", "enum": [ "Comma", "Period", "Space" ], "type": "string" } }, "type": "object" }, "is_active": { "description": "Indicates whether the currency is active and available for use.", "type": "boolean" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object" } } }, "description": "Specifies the request payload structure for this operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "UpdateSuccess": { "description": "Provides a sample 200 response for the update success scenario.", "summary": "Update success example", "value": { "currencies": [ { "code": "SUCCESS", "details": { "id": "111111000000129300" }, "message": "The currency updated successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing updated currency data.", "properties": { "currencies": { "description": "List of updated currency responses.", "items": { "additionalProperties": false, "description": "JSON object for an update operation on an individual currency, including status and updated currency details.", "properties": { "code": { "description": "Specifies the response code", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Detailed information about the currency update", "properties": { "id": { "description": "The unique identifier of the currency.", "format": "int64", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Indicates the response message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "UpdateCurrencyResponse" } } }, "description": "Successfully updated the specified currency record(s)." }, "400": { "content": { "application/json": { "examples": { "ActiveCurrencyLimitExceeded": { "description": "Provides a sample 400 error response for the active currency limit exceeded scenario.", "summary": "Maximum allowed active currencies reached", "value": { "currencies": [ { "code": "ACTIVE_STATE_LIMIT_EXCEEDED", "details": { "limit": 5 }, "message": "Allowed active currency limit reached. Please deactivate any one of the existing active currencies to create this currency.", "status": "error" } ] } }, "IndianFormatSeparatorRules": { "description": "Provides a sample 400 error response for the indian format separator rules scenario.", "summary": "Indian numeral system separator restrictions", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.currencies[0].format.numeral_system" }, "message": "The only supported thousand and decimal separators in the Indian numeral system are the comma and the period", "status": "error" } ] } }, "InvalidDecimalPlaces": { "description": "Provides a sample 400 error response for the invalid decimal places scenario.", "summary": "Wrong decimal places", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_places", "json_path": "$.currencies[0].format.decimal_places" }, "message": "Decimal places given seems to be invalid", "status": "error" } ] } }, "InvalidDecimalSeparator": { "description": "Provides a sample 400 error response for the invalid decimal separator scenario.", "summary": "Wrong decimal separator", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.currencies[0].format.decimal_separator" }, "message": "Decimal separator given seems to be invalid", "status": "error" } ] } }, "InvalidExchangeRateAutoUpdate": { "description": "Provides a sample 400 error response for the invalid exchange rate auto update scenario.", "summary": "Invalid exchange rate auto update", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate_auto_update", "expected_data_type": "boolean", "json_path": "$.currencies[0].exchange_rate_auto_update" }, "message": "invalid data", "status": "error" } ] } }, "InvalidExchangeRateType": { "description": "Provides a sample 400 error response for the invalid exchange rate type scenario.", "summary": "Exchange rate invalid datatype", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "exchange_rate", "expected_data_type": "string", "json_path": "$.currencies[0].exchange_rate" }, "message": "Exchange rate given seems to be invalid", "status": "error" } ] } }, "InvalidISO": { "description": "Provides a sample 400 error response for the invalid iso scenario.", "summary": "Invalid ISO code", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "iso_code", "json_path": "$.currencies[0].iso_code" }, "message": "Currency isocode given seems to be invalid", "status": "error" } ] } }, "InvalidNumeralSystem": { "description": "Provides a sample 400 error response for the invalid numeral system scenario.", "summary": "Invalid numeral system", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "numeral_system", "json_path": "$.currencies[0].format.numeral_system" }, "message": "Numeral system given seems to be invalid", "status": "error" } ] } }, "InvalidSymbol": { "description": "Provides a sample 400 error response for the invalid symbol scenario.", "summary": "Invalid currency symbol", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.currencies[0].symbol" }, "message": "Currency symbol given seems to be invalid", "status": "error" } ] } }, "InvalidThousandSeparator": { "description": "Provides a sample 400 error response for the invalid thousand separator scenario.", "summary": "Wrong thousand separator", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "thousand_separator", "json_path": "$.currencies[0].format.thousand_separator" }, "message": "Thousand separator given seems to be invalid", "status": "error" } ] } }, "NoPermission": { "description": "Provides a sample 400 error response for the no permission scenario.", "summary": "User lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Currencies" ] }, "message": "permission denied", "status": "error" } }, "NotAllowedSameSeparators": { "description": "Provides a sample 400 error response for the not allowed same separators scenario.", "summary": "Thousand and decimal separator conflict", "value": { "currencies": [ { "code": "NOT_ALLOWED", "details": { "api_name": "decimal_places", "json_path": "$.currencies[0].format.decimal_places" }, "message": "Thousand separator and Decimal separator should not be equal", "status": "error" } ] } }, "SymbolAlreadyUsed": { "description": "Provides a sample 400 error response for the symbol already used scenario.", "summary": "Symbol already assigned", "value": { "currencies": [ { "code": "INVALID_DATA", "details": { "api_name": "symbol", "json_path": "$.currencies[0].symbol" }, "message": "Currency symbol is already used", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Permission-level or single validation error.", "properties": { "code": { "description": "Error identifier representing the failure type.", "enum": [ "NO_PERMISSION", "INVALID_DATA" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Specifies the additional information about the error.", "properties": { "permissions": { "description": "List of required permissions missing for the current user.", "items": { "description": "Indicates the required permission details.", "maxLength": 100, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Specify the error message describing the error condition.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the response represents an error condition.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateCurrencyErrorResponse" }, { "additionalProperties": false, "description": "Currency validation errors.", "properties": { "currencies": { "description": "Array of currency error objects representing individual validation or permission errors.", "items": { "additionalProperties": false, "description": "An object representing a single currency-related error.", "properties": { "code": { "description": "Error identifier representing the validation failure type.", "enum": [ "INVALID_DATA", "ACTIVE_STATE_LIMIT_EXCEEDED", "NOT_ALLOWED" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional debugging metadata for the error. Provides field-level or permission-level details.", "properties": { "api_name": { "description": "The field name, API parameter, or array index related to the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the invalid field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSON path pointing to the field that caused the error.", "maxLength": 255, "type": "string" }, "limit": { "description": "Maximum allowed limit relevant to the error, for example, max active currencies.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Specify the error message describing the error condition.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the response represents an error condition.", "enum": [ "error" ], "maxLength": 20, "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "currencies" ], "type": "object", "x-zs-$id": "WrappedUpdateCurrencyErrorResponse" } ], "description": "Possible error responses for currency update operation.", "x-zs-$id": "UpdateCurrencyErrorResponses" } } }, "description": "Bad request. The input contains malformed or invalid values." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "summary": "UUID passed in URL where numeric ID is expected", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the URL pattern does not match expected format.", "properties": { "code": { "description": "Error code identifying the type of error.", "enum": [ "INVALID_URL_PATTERN" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error details.", "properties": {}, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status.", "enum": [ "error" ], "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateCurrencyById404ErrorResponse" } } }, "description": "Not Found. The URL pattern is invalid, typically when a non-numeric identifier is used where a numeric ID is expected." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.currencies.UPDATE" ] } ], "summary": "Currency", "tags": [ "currencies" ], "x-zoho-document": "currencies" } }, "/crm/v8/org/photo": { "delete": { "description": "To delete the organization photo from your Zoho CRM organization.", "operationId": "deleteOrgPhoto", "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful deletion response with a SUCCESS code.", "summary": "Success response for status 200", "value": { "code": "SUCCESS", "details": {}, "message": "Organization photo deleted successfully", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Response schema for a successful organization photo deletion.", "properties": { "code": { "description": "Response code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Success response containing the deletion status for the organization photo.", "properties": { "code": { "description": "The result code for this operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the operation result.", "type": "object" }, "message": { "description": "The success message for this operation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "success" ], "type": "string" } }, "type": "object", "x-zs-$id": "OrgPhotoDeleteSuccessResponse" }, "message": { "description": "Success message", "maxLength": 1000, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "type": "object", "x-zs-$id": "OrgPhotoDeleteSuccessResponse" } } }, "description": "Returns the deletion status for the organization photo." }, "400": { "content": { "application/json": { "examples": { "BadRequestError": { "description": "Shows an INVALID_DATA error when the request contains invalid data.", "summary": "INVALID_DATA error: request data is invalid", "value": { "code": "INVALID_DATA", "details": {}, "message": "Invalid data provided", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 400 bad request errors.", "properties": { "code": { "description": "The error code for this response.", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_REQUEST_METHOD", "INVALID_REQUEST", "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Indicates the error message for this response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "BadRequestInvalidRequestParamError" } } }, "description": "The request is invalid. Resolution: Verify that the request URL, token, and data are valid." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a NO_PERMISSION error when the user lacks permission to delete the organization photo.", "summary": "NO_PERMISSION error: insufficient permissions to delete organization photo", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "org.photo.delete" ] }, "message": "Permission denied to delete organization photo", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 403 permission-denied errors.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the permission error.", "properties": { "permissions": { "description": "Represents the list of required permissions for this operation.", "items": { "description": "Represents a required permission name.", "maxLength": 500, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the status of the response.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "ForbiddenDeleteOrgPhotoErrorResponse" } } }, "description": "The user does not have permission to delete the organization photo. Resolution: Verify that the OAuth token includes the ZohoCRM.org.DELETE scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.org.DELETE" ] } ], "summary": "Delete the organization photo", "tags": [ "org_photo" ], "x-zoho-document": "org_photo" }, "get": { "description": "To retrieve the organization photo for your Zoho CRM organization.", "operationId": "getOrgPhoto", "responses": { "200": { "content": { "image/png": { "schema": { "description": "Represents the organization photo as PNG binary image data.", "format": "binary", "type": "string", "x-zs-$id": "OrganizationPhoto" } } }, "description": "Returns the organization photo as PNG binary image data." }, "204": { "description": "No organization photo is available for this organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.org.READ" ] } ], "summary": "Organization photo", "tags": [ "org_photo" ], "x-zoho-document": "org_photo" }, "post": { "description": "To upload a photo for your Zoho CRM organization.", "operationId": "uploadOrganizationPhoto", "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "description": "Request body schema for uploading the organization photo.", "properties": { "file": { "description": "Specify the image file to upload as the organization photo. ", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "description": "The request body must include the image file in multipart/form-data format.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful upload response with a SUCCESS code.", "summary": "Success response for status code 200", "value": { "code": "SUCCESS", "details": {}, "message": "Organization photo uploaded successfully", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Response schema for a successful organization photo upload.", "properties": { "code": { "description": "Response code", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Success response containing the upload status for the organization photo.", "properties": { "code": { "description": "Represents the result code for this operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the operation result.", "properties": {}, "type": "object" }, "message": { "description": "Indicates the success message for this operation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Specifies the status of the response.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "message": { "description": "Success message", "maxLength": 1000, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "type": "object", "x-zs-$id": "OrgPhotoUploadSuccessResponse" } } }, "description": "Returns the upload status for the organization photo." }, "400": { "content": { "application/json": { "examples": { "BadRequestError": { "description": "Shows an INVALID_DATA error when the request contains invalid data.", "summary": "INVALID_DATA error: request data is invalid", "value": { "code": "INVALID_DATA", "details": {}, "message": "Invalid data provided", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 400 bad request errors.", "properties": { "code": { "description": "Specifies the error code for this response.", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_REQUEST_METHOD", "INVALID_REQUEST", "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error.", "properties": { "expected_type": { "description": "Expected data type for the file field when INVALID_DATA error occurs", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "BadRequestErrorResponse" } } }, "description": "The request is invalid. Resolution: Verify that the request URL, token, and data are valid." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a NO_PERMISSION error when the user lacks permission to upload the organization photo.", "summary": "NO_PERMISSION error: insufficient permissions to upload organization photo", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "org.photo.upload" ] }, "message": "Permission denied to upload organization photo", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 403 permission-denied errors.", "properties": { "code": { "description": "Indicates the error code for this response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the permission error.", "properties": { "permissions": { "description": "Specifies the permission items required for this operation.", "items": { "description": "Permission name", "maxLength": 50, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "ForbiddenErrorResponse" } } }, "description": "The user does not have permission to upload the organization photo. Resolution: Verify that the OAuth token includes the ZohoCRM.org.CREATE scope." }, "413": { "content": { "application/json": { "examples": { "FileSizeExceedsError": { "description": "Shows a FILE_SIZE_EXCEEDS error when the uploaded file exceeds the maximum allowed size.", "summary": "FILE_SIZE_EXCEEDS error: uploaded file exceeds the maximum allowed size", "value": { "code": "FILE_SIZE_EXCEEDS", "details": { "size": 5242880 }, "message": "File size exceeds the maximum allowed limit", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response schema for 413 file size exceeded errors.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "FILE_SIZE_EXCEEDS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the file size error.", "properties": { "size": { "description": "Represents the maximum allowed file size in bytes.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "FileSizeExceedsErrorResponse" } } }, "description": "The file size exceeds the maximum allowed limit. Resolution: Upload a file within the maximum allowed size." }, "415": { "content": { "application/json": { "examples": { "FileResolutionExceedsError": { "description": "Shows a FILE_RESOLUTION_EXCEEDS error when the uploaded image resolution exceeds the allowed limit.", "summary": "FILE_RESOLUTION_EXCEEDS error: image resolution exceeds the allowed limit", "value": { "code": "FILE_RESOLUTION_EXCEEDS", "details": { "resolution": 10000000 }, "message": "File resolution exceeds the maximum allowed limit", "status": "error" } }, "InvalidDataError": { "description": "Shows an INVALID_DATA error when the uploaded file format is not a supported image type.", "summary": "INVALID_DATA error: uploaded file is not a supported image format", "value": { "code": "INVALID_DATA", "details": {}, "message": "Invalid file format. Only image files are allowed", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response for uploading an image that exceeds the maximum allowed resolution.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "FILE_RESOLUTION_EXCEEDS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the resolution error.", "properties": { "resolution": { "description": "Represents the maximum allowed image resolution in pixels.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message for this response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "FileResolutionExceedsErrorResponse" }, { "additionalProperties": false, "description": "Error response for uploading a file with an unsupported image format.", "properties": { "code": { "description": "Specifies the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Indicates the error message for this response.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataErrorResponse" } ], "description": "Error response schema for 415 unsupported media type errors.", "x-zs-$id": "UnsupportedMediaTypeErrorResponse" } } }, "description": "The file type is unsupported or the image resolution exceeds the allowed limit. Resolution: Upload an image file with a supported format and resolution." } }, "security": [ { "OAuth2": [ "ZohoCRM.org.CREATE" ] } ], "summary": "Upload Organization Photo", "tags": [ "org_photo" ], "x-zoho-document": "org_photo" } }, "/crm/v8/settings/appointment_preferences": { "get": { "description": "Fetches the existing configuration for appointment preferences, including rules for deal creation, job sheet visibility, and mark as complete configurations.", "operationId": "getAppointmentPreference", "parameters": [ { "$ref": "#/components/parameters/AppointmentPreferenceInclude" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a complete appointment preferences response including deal record configuration with layout and field mappings.", "summary": "Example of successful retrieval of appointment preferences with deal record configuration.", "value": { "appointment_preferences": { "allow_booking_outside_businesshours": true, "allow_booking_outside_service_availability": true, "deal_record_configuration": { "field_mappings": [ { "field": { "api_name": "Owner", "id": "4838129000000000515" }, "type": "merge_field", "value": "${!Appointments__s.Owner}" }, { "field": { "api_name": "Amount", "id": "4838129000000000517" }, "type": "merge_field", "value": "${!Appointments__s.Service_Name.Price}" }, { "field": { "api_name": "Deal_Name", "id": "4838129000000000519" }, "type": "merge_field", "value": "${!Appointments__s.Appointment_Name}" }, { "field": { "api_name": "Closing_Date", "id": "4838129000000000521" }, "type": "merge_field", "value": "${!Appointments__s.Appointment_Start_Time}" }, { "field": { "api_name": "Account_Name", "id": "4838129000000000523" }, "type": "static", "value": { "id": "4838129000000659698", "name": "Printing Dimensions (Sample)" } }, { "field": { "api_name": "Stage", "id": "4838129000000000525" }, "type": "static", "value": "Closed Won" } ], "id": "4838129000000718001", "layout": { "id": "4838129000000095023", "name": "Standard" } }, "sharing_details": { "permission": "read_only", "sharing_computation_status": false }, "sharing_enabled": true, "show_job_sheet": true, "when_appointment_completed": "create_deal", "when_duration_exceeds": "ask_appointment_provider_to_complete" } } } }, "schema": { "additionalProperties": false, "description": "Returns the appointment preferences configured for the Zoho CRM organization.", "properties": { "appointment_preferences": { "additionalProperties": false, "description": "Represents the complete set of appointment preferences configured in the CRM organization. ", "properties": { "allow_booking_outside_businesshours": { "description": "Denotes if you can create appointments outside business hours.\nPossible values:\n**true** - You can create appointments outside business hours.\n**false** - You can not create appointments outside business hours.\n", "type": "boolean" }, "allow_booking_outside_service_availability": { "description": "Denotes if you can create appointments outside service availability.\nPossible values:\n**true** - You can create appointments outside service availability.\n**false** - You can not create appointments outside service availability.\n", "type": "boolean" }, "deal_record_configuration": { "additionalProperties": false, "description": "Contains the field mappings and layout details for record configuration in Deals from the Appointments module.", "properties": { "field_mappings": { "description": "Contains the field mappings that define how appointment and service data populates deal fields when Zoho CRM creates a deal automatically after the appointment completion.", "items": { "additionalProperties": false, "description": "Represents a single field mapping entry, containing the target Deals module field, mapping type, and mapped value. ", "properties": { "field": { "additionalProperties": false, "description": "Represents the Deals module field to which the appointment data is mapped. ", "properties": { "api_name": { "description": "Represents the API name of the Deals module field. ", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the Deals module field. ", "maxLength": 20, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Indicates the type of field mapping applied to populate the deal field. \nPossible values:\n**static** - A fixed value applies to the deal field regardless of appointment data.\n**merge_field** - The field value maps from the appointment or service module data.\n", "enum": [ "static", "merge_field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Represents a merge-field expression that maps data from the Appointments or Services module to the deal field.", "maxLength": 1000, "type": "string", "x-zs-$id": "MergeFieldExpression" }, { "additionalProperties": true, "description": "Represents a structured static value for lookup or complex deal fields, provided as an object with a name and an identifier.", "type": "object", "x-zs-$id": "StructuredStaticValue" } ], "description": "Represents the value assigned to the Deals module field during deal creation. " } }, "required": [ "type", "value", "field" ], "type": "object" }, "maxItems": 100, "type": "array" }, "id": { "description": "Represents the unique identifier of the deal record configuration. ", "maxLength": 20, "type": "string" }, "layout": { "additionalProperties": false, "description": "Represents the Deals module layout used when creating deal records after an appointment is completed. ", "properties": { "id": { "description": "Represents the unique identifier of the Deals module layout.", "maxLength": 64, "type": "string" }, "name": { "description": "Represents the display name of the Deals module layout as shown in the Zoho CRM interface. ", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "layout", "field_mappings", "id" ], "type": "object" }, "sharing_details": { "additionalProperties": false, "description": "Details about the sharing configuration for appointment-associated records. When sharing is enabled, the record associated in the appointment field is shared with the appointment owner with the configured permission level.", "properties": { "permission": { "description": "The permission level granted to the appointment owner for the associated record.", "enum": [ "read_only", "read_write", "full_access" ], "type": "string" }, "sharing_computation_status": { "description": "Indicates whether the sharing computation is currently in progress or completed.", "type": "boolean" } }, "type": "object" }, "sharing_enabled": { "description": "Indicates whether sharing of the associated record in appointments with the appointment owner is enabled.", "type": "boolean" }, "show_job_sheet": { "description": "Represents whether filling out the job sheet is mandatory for marking an appointment as 'completed'.\nPossible values:\n**true** - Job sheet is mandatory for appointment completion.\n**false** - Job sheet is not mandatory for appointment completion.\n", "type": "boolean" }, "when_appointment_completed": { "description": "Represents whether a deal has to be created when an appointment is completed.\nPossible values:\n**create_deal** - Deal is created when any appointment is marked 'Completed'.\n**do_not_create_deal** - Deal is not created when any appointment is marked 'Completed'.\n", "enum": [ "do_not_create_deal", "create_deal" ], "type": "string" }, "when_duration_exceeds": { "description": "Represents who has to mark the appointment as 'Completed' when the service duration gets over.\nPossible values:\n**mark_as_complete** - The appointment is automatically marked as 'completed'.\n**ask_appointment_provider_to_complete** - User has to manually mark the appointment as 'completed'.\n", "enum": [ "mark_as_complete", "ask_appointment_provider_to_complete" ], "type": "string" } }, "required": [ "show_job_sheet", "when_appointment_completed", "allow_booking_outside_service_availability", "allow_booking_outside_businesshours", "deal_record_configuration" ], "type": "object" } }, "required": [ "appointment_preferences" ], "type": "object", "x-zs-$id": "GetAppointmentPreferenceResponse" } } }, "description": "Contains the details of the requested resource. " } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.READ" ] } ], "summary": "Get Appointment Preferences", "tags": [ "appointment_preference" ], "x-zoho-document": "appointment_preference", "x-zs-llm-description": "Use this API to fetch the current org appointment preference configuration before sending updates." }, "put": { "description": "To update the appointment preference settings in your Zoho CRM organization, including booking constraints, job sheet requirements, deal creation configuration, and record-sharing settings.", "operationId": "updateAppointmentPreference", "requestBody": { "content": { "application/json": { "examples": { "ExpectedRequest": { "description": "Shows a complete appointment preferences update request with deal record configuration, sharing settings, and field mappings.", "summary": "Example of appointment preferences update with deal record configuration and sharing settings.", "value": { "appointment_preferences": { "allow_booking_outside_businesshours": true, "allow_booking_outside_service_availability": true, "deal_record_configuration": { "field_mappings": [ { "field": { "api_name": "Owner", "id": "4838717000000000515" }, "type": "merge_field", "value": "${!Appointments__s.Created_By}" }, { "field": { "api_name": "Amount", "id": "4838717000000000517" }, "type": "merge_field", "value": "${!Appointments__s.Service_Name.Price}" }, { "field": { "api_name": "Deal_Name", "id": "4838717000000000519" }, "type": "merge_field", "value": "${!Appointments__s.Appointment_Name}" }, { "field": { "api_name": "Closing_Date", "id": "4838717000000000521" }, "type": "merge_field", "value": "${!Appointments__s.Appointment_Start_Time}" }, { "field": { "api_name": "Account_Name", "id": "4838717000000000523" }, "type": "static", "value": { "id": "4838717000000659093", "name": "Chapman (Sample)" } }, { "field": { "api_name": "Stage", "id": "4838717000000000525" }, "type": "static", "value": "Closed Won" } ], "layout": { "id": "4838717000000095023", "name": "Standard" } }, "sharing_details": { "permission": "full_access" }, "sharing_enabled": true, "show_job_sheet": true, "when_appointment_completed": "create_deal", "when_duration_exceeds": "ask_appointment_provider_to_complete" } } } }, "schema": { "additionalProperties": false, "description": "Contains the appointment preference settings to update in the Zoho CRM organization.", "properties": { "appointment_preferences": { "additionalProperties": false, "description": "Specify the appointment preferences to configure for the Zoho CRM organization.", "properties": { "allow_booking_outside_businesshours": { "description": "Denotes if you can create appointments outside business hours. You can configure this preference only when **allow_booking_outside_service_availability:true**.\nPossible values:\n**true** - You can create appointments outside business hours.\n**false** - You cannot create appointments outside business hours.\n", "type": "boolean" }, "allow_booking_outside_service_availability": { "description": "Denotes if you can create appointments outside service availability.\nPossible values:\n**true** - You can create appointments outside service availability.\n**false** - You cannot create appointments outside service availability.\n", "type": "boolean" }, "deal_record_configuration": { "additionalProperties": false, "description": "Specify the configuration for creating Deal records when an appointment is completed, including the layout and field mappings.", "properties": { "field_mappings": { "description": "Specify the field mappings that define how appointment and service data populates the Deals module fields when a deal is created.", "items": { "additionalProperties": false, "description": "Each object specifies the details for each field mapping, including the target Deals module field, the mapping type, and the corresponding value.", "properties": { "field": { "additionalProperties": false, "description": "Specify the Deals module field to which the appointment data is mapped. Use the [Get Fields API](fields.yaml#$.paths./settings/fields.get) call to fetch the API name and ID of the field. ", "properties": { "api_name": { "description": "Provide the API name of the Deals module field.", "example": "api_name30", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsApiName" }, { "operationId": "getFieldsWithID", "propertyId": "FieldsApiName" } ], "resource": "fields" } }, "id": { "description": "Provide the Unique ID of the Deals module field. Use the [Get Fields API](fields.yaml$#.paths./settings/fields.get) to get the valid API name and ID of the field.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" }, { "operationId": "getFieldsWithID", "propertyId": "FieldsId" } ], "resource": "fields" } } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Specify the type of field mapping to use.\nPossible values:\n**static** - Set a fixed value for the deal field regardless of appointment data.\n**merge_field** - Map the deal field value from appointment or service module data.\n", "enum": [ "static", "merge_field" ], "type": "string" }, "value": { "anyOf": [ { "description": "Specify a merge-field expression that references appointment or service module data using the format **${!module_api_name.field_api_name}**.", "maxLength": 1000, "type": "string", "x-zs-$id": "MergeFieldExpressions" }, { "additionalProperties": true, "description": "Specify a structured static value for lookup and complex deal fields, provided as an object with a **name** and an **ID**.", "type": "object", "x-zs-$id": "StructuredStaticValues" } ], "description": "Denotes the value of the Deals fields. The format of this key's value depends on the mapping **type**.\n\n**Value for merge_field**: The datatype of this value is a string. To merge any field from a module, it should be specified like this **${module_api_name.field_api_name}**.\nExample: ${Appointments__s.Appointment_Name}\n\n**Value for static**: The datatype of this value is a JSON object. It contains the name and ID of the entity.\n\nWhen you want to give static values that look up to a different module, make a GET API call of the specific module and provide the relevant ID and name of the record. You can also give standard text values enclosed in a string.\n", "x-zs-llm-description": "Use a merge-field expression for merge_field mappings and a static value or object for static mappings." } }, "required": [ "value", "field", "type" ], "type": "object" }, "maxItems": 100, "type": "array" }, "layout": { "additionalProperties": false, "description": "Specify the Deals module layout to use when creating deal records from completed appointments.", "properties": { "id": { "description": "Specify the unique identifier of the Deals module layout. You can get the ID using the [Get Layouts API](layouts.yaml#$.paths./settings/layouts.get).", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getLayouts", "propertyId": "LayoutId" }, { "operationId": "getLayoutById", "propertyId": "LayoutId" } ], "resource": "layouts" } }, "name": { "description": "Specify the name of the Deals module layout.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "layout", "field_mappings" ], "type": "object" }, "sharing_details": { "additionalProperties": false, "description": "Sharing configuration for appointment-associated records. Defines the permission level granted to the appointment owner for the associated record. Required when sharing_enabled is set to true.", "properties": { "permission": { "description": "The permission level granted to the appointment owner for the associated record.", "enum": [ "read_only", "read_write", "full_access" ], "type": "string" } }, "required": [ "permission" ], "type": "object" }, "sharing_enabled": { "description": "Set to true to enable sharing of the associated record in appointments with the appointment owner. When set to true, sharing_details must also be provided.", "type": "boolean" }, "show_job_sheet": { "description": "Represents whether filling out the job sheet is mandatory for marking an appointment as 'completed'. You can mandate job sheets only when **when_duration_exceeds: ask_appointment_provider_to_complete**.\nPossible values:\n**true** - Job sheet is mandatory for appointment completion.\n**false** - Job sheet is not mandatory for appointment completion.\n", "type": "boolean" }, "when_appointment_completed": { "description": "Represents whether a deal has to be created, when an appointment is completed.\nPossible values:\n**create_deal** - Deal is created when any appointment is marked 'Completed'.\n**do_not_create_deal** - Deal is not created when any appointment is marked 'Completed'.\n", "enum": [ "do_not_create_deal", "create_deal" ], "type": "string" }, "when_duration_exceeds": { "description": "Represents who has to mark the appointment as 'Completed' when the service duration gets over.\nPossible values:\n**mark_as_complete** - The appointment is automatically marked as 'completed'.\n**ask_appointment_provider_to_complete** - User have to manually mark the appointment as 'completed'.\n", "enum": [ "mark_as_complete", "ask_appointment_provider_to_complete" ], "type": "string" } }, "required": [ "allow_booking_outside_service_availability", "allow_booking_outside_businesshours", "deal_record_configuration" ], "type": "object" } }, "type": "object" } } }, "description": "Contains the input data required to process the request. ", "required": true, "x-zs-llm-examples": [ "ExpectedRequest" ] }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the success response returned after updating appointment preferences, with status, code, and message fields.", "summary": "Example of a successful appointment preferences update response.", "value": { "appointment_preferences": { "code": "SUCCESS", "details": {}, "message": "Appointments preferences updated successfully", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Returns the status information confirming the outcome of the appointment preferences update.", "properties": { "appointment_preferences": { "additionalProperties": false, "description": "Represents the response details confirming the outcome of the update operation. ", "properties": { "code": { "description": "Represents the response code for the update operation. \nPossible values:\n**SUCCESS** - The appointment preferences were updated successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional metadata about the update operation. ", "type": "object" }, "message": { "description": "Represents the success message for the update operation. \nPossible values:\n**Appointments preferences updated successfully**\n", "enum": [ "Appointments preferences updated successfully" ], "type": "string" }, "status": { "description": "Indicates whether the appointment preferences update was successful. \nPossible values:\n**success** - The appointment preferences were updated successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" } }, "required": [ "appointment_preferences" ], "type": "object", "x-zs-$id": "UpdateAppointmentPreferenceResponse" } } }, "description": "Returns the status confirmation after successfully updating the appointment preferences." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissing": { "description": "Shows the error response when **sharing_details** is included in the request body without setting **sharing_enabled** to **true**.", "summary": "Example of dependent field missing error when sharing_enabled is set but sharing_details is absent.", "value": { "appointment_preferences": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "sharing_details", "dependee": { "api_name": "sharing_enabled", "json_path": "$.appointment_preferences.sharing_enabled" }, "json_path": "$.appointment_preferences.sharing_details" }, "message": "Dependent Field missing", "status": "error" } } }, "DependentMismatch": { "description": "Shows the error response when **allow_booking_outside_businesshours** is set to **true** while **allow_booking_outside_service_availability** is **false**.", "summary": "Example of an error due to dependent mismatch - a conflicting booking preference setting.", "value": { "appointment_preferences": { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "allow_booking_outside_businesshours", "dependee": { "api_name": "allow_booking_outside_service_availability", "json_path": "$.appointment_preferences.allow_booking_outside_service_availability" }, "json_path": "$.appointment_preferences.allow_booking_outside_businesshours" }, "message": "allow_booking_outside_service_availability must be enabled to set allow_booking_outside_businesshours to true", "status": "error" } } }, "InvalidData": { "description": "Shows the error response when **show_job_sheet** is provided with a non-Boolean value.", "summary": "Example of an error when a field receives a value of the wrong data type.", "value": { "appointment_preferences": { "code": "INVALID_DATA", "details": { "api_name": "show_job_sheet", "expected_data_type": "boolean", "json_path": "$.appointment_preferences.show_job_sheet" }, "message": "invalid data", "status": "error" } } }, "MandatoryFieldMissing": { "description": "Shows the error response when **allow_booking_outside_service_availability**, a required field, is missing from the request.", "summary": "Example of an error when a required field is absent from the request.", "value": { "appointment_preferences": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "allow_booking_outside_service_availability", "json_path": "appointment_preferences.allow_booking_outside_service_availability" }, "message": "Mandatory fields are missing", "status": "error" } } }, "MandatoryNotFoundSharingEnabled": { "description": "Shows the error response when **sharing_details** is included in the request body without the required **sharing_enabled** field.", "summary": "Example of an error when sharing_details is present but sharing_enabled is missing.", "value": { "appointment_preferences": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "sharing_enabled", "json_path": "$.appointment_preferences.sharing_enabled" }, "message": "required field not found", "status": "error" } } } }, "schema": { "additionalProperties": false, "description": "Returns the error details when the appointment preferences update request is invalid or incomplete.", "properties": { "appointment_preferences": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response returned when a mandatory field is missing from the update request.", "properties": { "code": { "description": "Represents the error code returned when a required field is missing from the request.\nPossible values:\n**MANDATORY_NOT_FOUND** - A required field is absent from the request body.\n", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details identifying the missing mandatory field, including its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory field in the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing mandatory field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the outcome of the request.\nPossible values:\n**error** - The request failed due to a validation error.\n", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "MandatoryFieldMissingError" }, { "additionalProperties": false, "description": "Represents an error response returned when a field value has an invalid data type or unsupported value.", "properties": { "code": { "description": "Represents the error code returned when an invalid value is provided in the request.\nPossible values:\n**INVALID_DATA** - The request contains a field with an invalid value or unsupported data type.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details identifying the field with invalid data, including the expected data type and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that received invalid data.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with invalid data in the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid data issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the outcome of the request.\nPossible values:\n**error** - The request failed due to invalid data.\n", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidDataError" }, { "additionalProperties": false, "description": "Represents an error response returned when a field value conflicts with the value of a dependent field.", "properties": { "code": { "description": "Represents the error code returned when a field value conflicts with the value of a dependent field.\nPossible values:\n**DEPENDENT_MISMATCH** - The submitted value for a field is incompatible with the current value of a field it depends on.\n", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details identifying the field with the conflicting value and the dependee field, including their API names and JSON paths.", "properties": { "api_name": { "description": "Represents the API name of the field with the conflicting value.", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of the dependee field whose value conflicts with the submitted request.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependee field in the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the field with the conflicting value in the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the dependent field conflict.", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the outcome of the request.\nPossible values:\n**error** - The request failed due to a dependent field mismatch.\n", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "DependentMismatchError" }, { "additionalProperties": false, "description": "Represents an error response returned when a required dependent field is absent from the request. For example, **sharing_details** requires **sharing_enabled** to be present.", "properties": { "code": { "description": "Represents the error code returned when a required dependent field is absent from the request.\nPossible values:\n**DEPENDENT_FIELD_MISSING** - A field that depends on another field being present is missing from the request body.\n", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details identifying the missing dependent field and the dependee field that requires it.", "properties": { "api_name": { "description": "Represents the API name of the field that is missing from the request.", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of the dependee field whose presence requires the missing dependent field.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the dependee field in the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path to the missing dependent field in the request body.", "maxLength": 1000, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing dependent field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Indicates the outcome of the request.\nPossible values:\n**error** - The request failed due to a missing dependent field.\n", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "DependentFieldMissingError" } ], "description": "Represents the error details returned when the appointment preference update fails validation. " } }, "required": [ "appointment_preferences" ], "type": "object", "x-zs-$id": "AppointmentPreferenceErrorResponse" } } }, "description": "The request contains missing mandatory fields or invalid data.\n**Resolution:** The request body must include all required fields with valid values. Refer to the details key in the error response for the specific field and JSON path.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.UPDATE" ] } ], "summary": "Update Appointment Preferences", "tags": [ "appointment_preference" ], "x-zoho-document": "appointment_preference", "x-zs-llm-description": "Use this API to update org appointment preferences. Prefer fetching current values first for nested or dependent settings." } }, "/crm/v8/settings/audit_log_export": { "get": { "description": "To retrieve the list of all audit log export jobs in your Zoho CRM organization, along with their status, filter criteria, and download links.", "operationId": "getAuditLogExports", "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a completed audit log export job with status, filter criteria, created_by user, and a download link.", "summary": "Successful retrieval of audit log export jobs", "value": { "audit_log_export": [ { "created_by": { "id": "123456", "name": "John Doe" }, "criteria": { "group": [ { "comparator": "in", "field": { "api_name": "module" }, "value": [ { "api_name": "Leads" }, { "api_name": "Contacts" } ] }, { "comparator": "in", "field": { "api_name": "action" }, "value": [ "added", "updated" ] } ], "group_operator": "and" }, "download_links": [ "https://example.com/download/1234567890" ], "expiry_date": "2023-01-08T00:00:00Z", "id": "1234567890", "job_end_time": "2023-01-01T01:00:00Z", "job_start_time": "2023-01-01T00:00:00Z", "status": "finished" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response for retrieving audit log export jobs.", "properties": { "audit_log_export": { "description": "Represents the list of audit log export jobs.", "items": { "additionalProperties": false, "description": "Represents the details of a single audit log export job.", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who created the export job.", "properties": { "id": { "description": "Represents the unique ID of the user who created the export job.", "maxLength": 64, "type": "string" }, "name": { "description": "Represents the name of the user who created the export job.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "criteria": { "$ref": "#/components/schemas/AuditLogCriterionNullable" }, "download_links": { "description": "Download links for exported audit logs. Null until the job completes and produces at least one file.", "items": { "description": "Represents a URL for downloading the exported audit log result.", "maxLength": 2048, "type": "string" }, "maxItems": 1000, "type": [ "array", "null" ] }, "expiry_date": { "description": "Expiry date for download links. Null until download links are generated.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the audit log export job.", "maxLength": 64, "type": "string", "x-zs-$id": "AuditLogExportId" }, "job_end_time": { "description": "Represents the date and time when the export job was completed.", "format": "date-time", "type": "string" }, "job_start_time": { "description": "Represents the date and time when the export job started.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the export job.", "enum": [ "queued", "scheduled", "running", "suspended", "failed", "finished", "deleted" ], "type": "string" } }, "required": [ "criteria", "download_links" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "GetAuditLogExportsSuccessResponse" } } }, "description": "Returns the list of audit log export jobs along with their status, filter criteria, and download links." }, "204": { "description": "Returns an empty response when no audit log export jobs are available." }, "403": { "$ref": "#/components/responses/AuditLogExportForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.audit_logs.READ" ] } ], "summary": "Get audit log export jobs", "tags": [ "audit_log_export" ], "x-zoho-document": "audit_log_export", "x-zs-llm-description": "Lists all audit log export jobs with their status, criteria, and download links. Returns 204 when no export jobs exist." }, "post": { "description": "To create an asynchronous audit log export job in your Zoho CRM organization. The system schedules the job and returns a unique job ID with a SCHEDULED status code. Use the[Get Audit Log Export API](audit_log_export.yaml#.$./paths./settings/audit_log_export.get) to poll for completion and retrieve the download links.", "operationId": "createAuditLogExport", "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Shows an audit log export request with group filter criteria combining module and action filters.", "summary": "Create audit log export with criteria filters.", "value": { "audit_log_export": [ { "criteria": { "group": [ { "comparator": "in", "field": { "api_name": "module" }, "value": [ { "api_name": "Leads" }, { "api_name": "Contacts" } ] }, { "comparator": "in", "field": { "api_name": "action" }, "value": [ "added", "updated" ] } ], "group_operator": "and" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for creating an audit log export job.", "properties": { "audit_log_export": { "description": "Specify the list of audit log export job configurations.", "items": { "additionalProperties": false, "description": "Specify the details for each audit log export job, including the filter criteria.", "properties": { "criteria": { "$ref": "#/components/schemas/AuditLogCriterion" } }, "required": [ "criteria" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "audit_log_export" ], "type": "object" } } }, "description": "The request body must contain an audit_log_export array. You can include a maximum of 100 objects per request." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a success response with a SCHEDULED status code and unique job ID for the created export job.", "summary": "Successful audit log export job creation", "value": { "audit_log_export": [ { "code": "SCHEDULED", "details": { "id": "1234567890" }, "message": "Audit log export job scheduled successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response for creating an audit log export job.", "properties": { "audit_log_export": { "description": "Represents the list of audit log export job responses.", "items": { "additionalProperties": false, "description": "Represents the response details of a single audit log export job.", "properties": { "code": { "description": "Specifies the status code of the export job creation.\nPossible values:\nSCHEDULED - The audit log export job has been successfully scheduled.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details for the scheduled audit log export job.", "properties": { "id": { "description": "Represents the unique ID of the scheduled audit log export job.", "maxLength": 64, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message describing the audit log export job status.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the export job creation request.\nPossible values:\nsuccess - The audit log export job creation completed successfully.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "CreateAuditLogExportResponse" } } }, "description": "Returns the scheduled status and unique job ID for each submitted audit log export request." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduled": { "summary": "An export job is already scheduled", "value": { "audit_log_export": [ { "code": "ALREADY_SCHEDULED", "details": { "id": "4670092000004613003" }, "message": "Export is already scheduled", "status": "error" } ] } }, "LimitExceeded": { "summary": "More than one audit_log_export item supplied", "value": { "audit_log_export": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "audit_log_export", "json_path": "$.audit_log_export[1]", "limit": "1" }, "message": "The audit_log_export jsonarray size should not exceed one", "status": "error" } ] } }, "MandatoryNotFound": { "summary": "Request body is missing the audit_log_export key", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "audit_log_export", "json_path": "$.audit_log_export[0]" }, "message": "Required field missing", "status": "error" } }, "NotAllowed": { "summary": "Audited time range exceeds 6 months", "value": { "audit_log_export": [ { "code": "NOT_ALLOWED", "details": { "api_name": "value", "json_path": "$.audit_log_export[0].criteria.value" }, "message": "Logs only within 6 month intervals are allowed to be fetched", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CreateAuditLogExportDirectError" }, { "$ref": "#/components/schemas/CreateAuditLogExportWrappedError" } ], "description": "Bad request response for Create Audit Log Export.", "x-zs-$id": "CreateAuditLogExportBadRequestResponseWrapper" } } }, "description": "The audit log export request is invalid. Resolution: Verify the request body structure, filter criteria, and field values are correctly formatted." }, "403": { "$ref": "#/components/responses/AuditLogExportForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.audit_logs.CREATE" ] } ], "summary": "Create an audit log export job", "tags": [ "audit_log_export" ], "x-zoho-document": "audit_log_export", "x-zs-llm-description": "Creates an asynchronous audit log export job based on filter criteria (module, action, etc.). Returns a job ID with SCHEDULED status. Use getAuditLogExports or getAuditLogExportsById to poll for completion and retrieve download links. Only one active export job is allowed at a time.", "x-zs-llm-examples": [ "Default" ] } }, "/crm/v8/settings/audit_log_export/{id}": { "get": { "description": "Retrieves the details of a specific audit log export job in your Zoho CRM organization by its ID, including its status, filter criteria, and download link(s).", "operationId": "getAuditLogExportsById", "parameters": [ { "$ref": "#/components/parameters/AuditLogExportId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a completed audit log export job retrieved by ID, with status, download link, and timing details.", "summary": "Successful retrieval of an audit log export job by ID", "value": { "audit_log_export": [ { "created_by": { "id": "123456", "name": "John Doe" }, "criteria": { "comparator": "equal", "field": { "api_name": "done_by" }, "value": [ { "id": "123456", "name": "John Doe" } ] }, "download_links": [ "https://example.com/download/1234567890" ], "expiry_date": "2023-01-08T00:00:00Z", "id": "1234567890", "job_end_time": "2023-01-01T01:00:00Z", "job_start_time": "2023-01-01T00:00:00Z", "status": "finished" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response for retrieving an audit log export job by ID.", "properties": { "audit_log_export": { "description": "Represents the list containing the requested audit log export job.", "items": { "additionalProperties": false, "description": "Represents the details of the specified audit log export job.", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who created the export job.", "properties": { "id": { "description": "Represents the unique ID of the user who created the export job.", "maxLength": 64, "type": "string" }, "name": { "description": "Represents the name of the user who created the export job.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "criteria": { "$ref": "#/components/schemas/AuditLogCriterionNullable" }, "download_links": { "description": "Download links for exported audit logs. Null until the job completes and produces at least one file.", "items": { "description": "Represents a URL for downloading the exported audit log result.", "maxLength": 2048, "type": "string" }, "maxItems": 1000, "type": [ "array", "null" ] }, "expiry_date": { "description": "Expiry date for download links. Null until download links are generated.", "format": "date-time", "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the audit log export job.", "maxLength": 64, "type": "string" }, "job_end_time": { "description": "Represents the date and time when the export job was completed.", "format": "date-time", "type": "string" }, "job_start_time": { "description": "Represents the date and time when the export job started.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the export job.", "enum": [ "queued", "scheduled", "running", "suspended", "failed", "finished", "deleted" ], "type": "string" } }, "required": [ "criteria", "download_links" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "GetAuditLogExportsByIdSuccessResponse" } } }, "description": "Returns the details of the specified audit log export job." }, "204": { "description": "Returns an empty response when no export job data is available for the specified ID." }, "403": { "$ref": "#/components/responses/AuditLogExportForbidden" }, "404": { "content": { "application/json": { "examples": { "NotFound": { "description": "Shows an error response when the specified audit log export job ID is not found.", "summary": "Export job ID not found", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the not found error response when the specified export job ID does not exist.", "properties": { "code": { "description": "Represents the error code.\nPossible values:\nINVALID_URL_PATTERN - The specified audit log export job ID does not exist.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional error details.", "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the request status.\nPossible values:\nerror - The request was unsuccessful.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "GetAuditLogExportsByIdNotFoundResponse" } } }, "description": "The specified audit log export job ID does not exist. Resolution: A valid export job ID obtained from the Create Audit Log Export API must be provided." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.audit_logs.READ" ] } ], "summary": "Get the Status of the Export Audit Log Job", "tags": [ "audit_log_export" ], "x-zoho-document": "audit_log_export", "x-zs-llm-description": "Retrieves a specific audit log export job by ID. Returns job status, criteria, and download links when complete. Returns 404 with INVALID_URL_PATTERN if the ID does not exist." } }, "/crm/v8/settings/automation/assignment_rules": { "get": { "description": "To retrieve all Assignment Rules configured in your Zoho CRM organization.", "operationId": "getAssignmentRules", "parameters": [ { "$ref": "#/components/parameters/AssignmentRulesParamQueryModuleSchema" }, { "$ref": "#/components/parameters/AssignmentRulesParamQueryIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "api_name": "OrderAssignment", "created_by": { "id": "5264350000141324329", "name": "Nivedha" }, "created_time": "2025-01-23T00:00:00+05:30", "default_assignee": { "id": "5264350000141111111", "name": "Ravivarma", "resource": { "id": "5264350000141111111", "name": "Ravivarma" }, "type": "user" }, "description": "Assignment rule to assign owners for order records", "id": "5264350000141324328", "modified_by": { "id": "5264350000141111111", "name": "Ravivarma" }, "modified_time": "2025-01-01T16:43:11+05:30", "module": { "api_name": "Orders", "id": "5264350000312423443", "name": "Orders" }, "name": "Order owner assignment rule" }, { "api_name": "OrderAssignment", "created_by": { "id": "5264350000141324329", "name": "Nivedha" }, "created_time": "2025-01-23T00:00:00+05:30", "default_assignee": { "id": "526435000014111111", "name": "Ravivarma", "resource": { "id": "5264350000141111111", "name": "Ravivarma" }, "type": "user" }, "description": "Assignment rule to assign owners for order records", "id": "5264350000141324329", "modified_by": { "id": "5264350000141111111", "name": "Ravivarma" }, "modified_time": "2025-01-01T16:43:11+05:30", "module": { "api_name": "Orders", "id": "5264350000312423443", "name": "Orders" }, "name": "Order owner assignment rule" } ] } } }, "schema": { "$ref": "#/components/schemas/GetAllAssignmentRulesSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "204": { "description": "Indicates that no Assignment Rule records are available for the request." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" } ], "description": "Get All AR Possible 400 Error Response Schema.", "x-zs-$id": "Possible400ErrorResponsesGetAllAR" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseNoPermissionToAccessAPI" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.READ" ] } ], "summary": "Assignment Rules", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules" }, "post": { "description": "To create a single Assignment Rule in your Zoho CRM organization.", "operationId": "postAssignmentRules", "parameters": [ { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows an Assignment Rule request payload with the fields required for this operation.", "summary": "Sample request body", "value": { "assignment_rules": [ { "api_name": "Lead_Assignment_Rule_US", "default_assignee": { "resource": { "id": "32425678" }, "type": "user" }, "description": "Rule to assign owners for US leads", "name": "Lead owner assignment rule - US", "rule_entries": [ { "assign_to": { "resources": [ { "id": "526435000000670072" }, { "id": "526435000000227013" } ], "type": "users" }, "criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue" }, "value": "123" }, "followup_actions": [ { "resources": [ { "id": "526435000014344004" } ], "type": "tasks" } ], "user_availability_based_on": [ "online_status", "shift_timing" ] } ] } ] } } }, "schema": { "$ref": "#/components/schemas/RequestBodySchemaForCreate" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain an **assignment_rules** array with one object. Specify the Assignment Rule details, rule entries, and default assignee configuration." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "code": "SUCCESS", "details": { "id": "123456789", "rule_entries": [ { "id": "123456789" } ] }, "message": "created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/AssignmentRulesSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent field is missing (Field: criteria)", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.criteria" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent field is missing (Field: resource)", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resource", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.resource" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent field is missing (Field: resources)", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resources", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.resources" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent field is missing (Field: resources)", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resources", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].assignment_rules.rule_entries.followup_actions.resources" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_MISMATCH: Invalid data (Field: ID)", "value": { "assignment_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "param_name": "module" }, "json_path": "$.assignment_rules[0].default_assignee.id" }, "message": "dependent mismatch", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_MISMATCH: Invalid data (Field: type)", "value": { "assignment_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "param_name": "module" }, "json_path": "$.assignment_rules[0].rule_entries[*].assign_to.resources[*].type" }, "message": "dependent mismatch", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_MISMATCH: Invalid data (Field: type)", "value": { "assignment_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "param_name": "module" }, "json_path": "$.assignment_rules[0].rule_entries[*].assign_to.resources[*].type" }, "message": "dependent mismatch", "status": "error" } ] } }, "DependentMismatchResponse4": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_MISMATCH: Invalid data (Field: ID)", "value": { "assignment_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "param_name": "module" }, "json_path": "$.assignment_rules[0].rule_entries[*].assign_to.resources[*].id" }, "message": "dependent mismatch", "status": "error" } ] } }, "DependentMismatchResponse5": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_MISMATCH: A Requester profile user is not allowed to be the owner of a record. (Field: ID)", "value": { "assignment_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "param_name": "module" }, "json_path": "$.assignment_rules[0].rule_entries[*].assign_to.resources[*].id" }, "message": "dependent mismatch", "status": "error" } ] } }, "DependentMismatchResponse6": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_MISMATCH: A Requester profile users are not allowed to be the owner of a record. (Field: ID)", "value": { "assignment_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "param_name": "module" }, "json_path": "$.assignment_rules[0].rule_entries[i].assign_to.resources[i].id" }, "message": "dependent mismatch", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows the error response returned when the Assignment Rule request contains duplicate data for a unique field.", "summary": "DUPLICATE_DATA error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[0].api_name" }, "message": "The data is already given in the api_name", "status": "error" } ] } }, "DuplicateDataResponse2": { "description": "Shows the error response returned when the Assignment Rule request contains duplicate data for a unique field.", "summary": "DUPLICATE_DATA error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[0].name" }, "message": "The data is already given in the name", "status": "error" } ] } }, "DuplicateDataResponse3": { "description": "Shows the error response returned when the Assignment Rule request contains duplicate data for a unique field.", "summary": "DUPLICATE_DATA error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[0].name" }, "message": "The data is already given in the name", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code EXPECTED_FIELD_MISSING: One of the required fields is missing", "value": { "assignment_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.assignment_rules[*].default_assignee.id" }, { "api_name": "api_name", "json_path": "$.assignment_rules[*].default_assignee.assignment_rules.default_assignee.api_name" } ] }, "message": "One of the required fields is missing", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "code": "INVALID_DATA", "details": { "api_name": "assignment_rules", "json_path": "$.assignment_rules", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse10": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[*].api_name", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.assignment_rules[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.assignment_rules[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.assignment_rules[*].description", "maximum_length": 250 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "default_assignee", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].default_assignee" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].default_assignee.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.assignment_rules[*].default_assignee.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[*].default_assignee.api_name", "supported_values": [ "${CURRENTUSER}" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[0].rule_entries", "maximum_length": 10 }, "message": "{error_message}", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "maximum_length": 200 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "assign_to", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type", "minimum_length": -2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type", "supported_values": [ "users", "role", "group", "profile", "criteria", "zia_suggested_users" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse28": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse29": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resource", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resource" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[0].rule_entries", "maximum_length": 10 }, "message": "{error_message}", "status": "error" } ] } }, "InvalidDataResponse30": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resource.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse31": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse32": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse33": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse34": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse35": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "user_availability_based_on", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].user_availability_based_on" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse36": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "user_availability_based_on", "json_path": "$.assignment_rules[*].rule_entries[*].user_availability_based_on", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse37": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "user_availability_based_on", "json_path": "$.assignment_rules[*].rule_entries[*].user_availability_based_on", "supported_values": [ "online_status", "shift_timing" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse38": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse39": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.assignment_rules[0].rule_entries[*].id" }, "message": "", "status": "error" } ] } }, "InvalidDataResponse40": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse41": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse42": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type", "supported_values": [ "tasks" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse43": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse44": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse45": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse46": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.assignment_rules[0].rule_entries[*].assign_to.resource.id" }, "message": "", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.assignment_rules[0].rule_entries[*].assign_to.resources[*].id" }, "message": "", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.assignment_rules[0].rule_entries[*].followup_actions[*].resources[*].id" }, "message": "", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.assignment_rules[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[*].api_name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows the error response returned when the Assignment Rule limit is exceeded for the specified module.", "summary": "LIMIT_EXCEEDED error for Assignment Rules", "value": { "assignment_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 10 }, "message": "limit exceeded", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "default_assignee", "json_path": "$.assignment_rules[*].default_assignee" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "assign_to", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resource.id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected param is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected param is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "additionalProperties": false, "description": "Wrapped error response with assignment_rules.", "properties": { "assignment_rules": { "description": "Array of error objects. ", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseLimitExceeded" }, { "$ref": "#/components/schemas/ErrorResponseDuplicateData" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "$ref": "#/components/schemas/ErrorResponseDependentMismatch" }, { "$ref": "#/components/schemas/AssignmentRulesErrorResponseMandatoryNotFound" }, { "$ref": "#/components/schemas/ErrorResponseExpectedFieldsMissing" }, { "$ref": "#/components/schemas/ErrorResponseDependentFieldMissing" } ], "description": "Represents each Assignment Rules entry returned for the Assignment Rule operation." }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "assignment_rules" ], "type": "object", "x-zs-$id": "CreateAssignmentRuleRequestBodyErrorCases" } ], "description": "Error response for invalid data.", "x-zs-$id": "Possible400ErrorResponsesCreateAR" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Possible403ErrorResponsesInManagingAR" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.CREATE" ] } ], "summary": "Create an Assignment Rule", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules", "x-zs-llm-description": "To create an assignment rule" } }, "/crm/v8/settings/automation/assignment_rules/actions/count": { "get": { "description": "To retrieve the count of Assignment Rules configured for a module in your Zoho CRM organization.", "operationId": "getAssignmentRulesCount", "parameters": [ { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "count": 100 } } }, "schema": { "$ref": "#/components/schemas/CountSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" } ], "description": "AssignmentRuleCountErrorResponse.", "x-zs-$id": "Possible400ErrorResponsesGetCount" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseNoPermissionToAccessAPI" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.READ" ] } ], "summary": "Assignment Rules Count", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules" } }, "/crm/v8/settings/automation/assignment_rules/{id}": { "delete": { "description": "To delete a single Assignment Rule from your Zoho CRM organization.", "operationId": "deleteAssignmentRuleById", "parameters": [ { "$ref": "#/components/parameters/RequestPathParamId" }, { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "code": "SUCCESS", "details": { "id": "1234567890098765432" }, "message": "{proper success message}", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/AssignmentRulesSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "400": { "content": { "application/json": { "examples": { "ErrorResponseFeatureNotSupportedExample": { "description": "Shows the error response returned when Assignment Rules are not supported for the current edition.", "summary": "FEATURE_NOT_SUPPORTED error for Assignment Rules", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Assignment rules not supported for current edition", "status": "error" } }, "ErrorResponseInvalidModuleExample": { "description": "Shows the error response returned when the **module** query parameter does not contain a valid CRM module API name.", "summary": "INVALID_MODULE error for module parameter", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "ErrorResponseInvalidRequestPathParamIdExample": { "description": "Shows the error response returned when the Assignment Rule ID in the request path is invalid.", "summary": "INVALID_DATA error for Assignment Rule ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "Invalid assignment rule id", "status": "error" } }, "ErrorResponseModuleNotSupportedExample": { "description": "Shows the error response returned when the specified CRM module does not support Assignment Rules.", "summary": "NOT_SUPPORTED error for Assignment Rules module", "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "Module not supported in assignment rules", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "$ref": "#/components/schemas/AssignmentRulesErrorResponseNotAllowed" } ], "description": "Error response for invalid module.", "x-zs-$id": "Possible400ErrorResponsesDeleteARById" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermissionToManageARErrorResponseExample": { "description": "Shows the error response returned when the user does not have permission to access or manage Assignment Rules for the specified module.", "summary": "NO_PERMISSION error for Assignment Rule access", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_AR_{moduleName}" ] }, "message": "User does not have sufficient permission to manage assignment rules of given module", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/Possible403ErrorResponsesInManagingAR" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.DELETE" ] } ], "summary": "Delete an Assignment Rule", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules" }, "get": { "description": "To retrieve the details of a single Assignment Rule in your Zoho CRM organization.", "operationId": "getAssignmentRuleById", "parameters": [ { "$ref": "#/components/parameters/RequestPathParamId" }, { "$ref": "#/components/parameters/AssignmentRulesParamQueryIncludeInnerDetails" }, { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "api_name": "OrderAssignment", "created_by": { "id": "5264350000141324329", "name": "Nivedha" }, "created_time": "2025-01-23T00:00:00+05:30", "default_assignee": { "id": "5264350000141111111", "name": "Ravivarma", "resource": { "id": "5264350000141111111", "name": "Ravivarma" }, "type": "user" }, "description": "Assignment rule to assign owners for order records", "id": "5264350000141324329", "modified_by": { "id": "5264350000141111111", "name": "Ravivarma" }, "modified_time": "2025-01-01T16:43:11+05:30", "module": { "api_name": "Orders", "id": "5264350000312423443", "name": "Orders" }, "name": "Order owner assignment rule", "rule_entries": [ { "assign_to": { "resources": [ { "id": "526435000000670072", "name": "Ted Mosby" }, { "id": "526435000000227013", "name": "Nivedha" } ], "type": "users" }, "criteria": { "group": [ { "comparator": "equal", "field": { "api_name": "Annual_Revenue", "id": "526435000000000581" }, "type": "value", "value": "1000" }, { "comparator": "contains", "field": { "api_name": "Email", "id": "526435000000000563" }, "type": "field", "value": { "api_name": "Lookup_3.Full_Name", "id": "526435000000000597" } } ], "group_operator": "AND" }, "followup_actions": [ { "resources": [ { "id": "526435000014344004", "name": "Test task" } ], "type": "tasks" } ], "id": "526435000014296015", "sequence_number": 0, "user_availability_based_on": [ "online_status", "shift_timing" ] }, { "assign_to": { "resource": { "id": "526435000000670072", "name": "Participants" }, "type": "profile" }, "criteria": null, "followup_actions": null, "id": "526435000014296016", "sequence_number": 1, "user_availability_based_on": null }, { "assign_to": { "resource": { "id": "526435000000670072", "name": "Chennai Branch Managers" }, "type": "group" }, "criteria": { "comparator": "equal", "field": { "api_name": "City", "id": "526435000000000581" }, "type": "value", "value": "Chennai" }, "followup_actions": [ { "resources": [ { "id": "526435000014344004", "name": "Test task" } ], "type": "tasks" } ], "id": "526435000014296015", "sequence_number": 2, "user_availability_based_on": [ "shift_timing" ] }, { "assign_to": { "resource": { "id": "526435000000670072", "name": "CEO" }, "type": "role" }, "criteria": null, "followup_actions": null, "id": "526435000014296016", "sequence_number": 3, "user_availability_based_on": null }, { "assign_to": { "type": "zia_suggested_users" }, "criteria": null, "followup_actions": null, "id": "526435000014296016", "sequence_number": 4, "user_availability_based_on": null } ] } ] } } }, "schema": { "$ref": "#/components/schemas/GetSpecificAssignmentRuleSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "204": { "description": "Indicates that no Assignment Rule records are available for the request." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" } ], "description": "Error response for invalid module.", "x-zs-$id": "Possible400ErrorResponsesGetARById" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermissionToManageARErrorResponseExample": { "description": "Shows the error response returned when the user does not have permission to access or manage Assignment Rules for the specified module.", "summary": "NO_PERMISSION error for Assignment Rule access", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_AR_{moduleName}" ] }, "message": "User does not have sufficient permission to manage assignment rules of given module", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/Possible403ErrorResponsesInManagingAR" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.READ" ] } ], "summary": "Specific Assignment Rule details", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules" }, "put": { "description": "To update a single Assignment Rule in your Zoho CRM organization.", "operationId": "updateAssignmentRuleById", "parameters": [ { "$ref": "#/components/parameters/RequestPathParamId" }, { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows an Assignment Rule request payload with the fields required for this operation.", "summary": "Sample request body", "value": { "assignment_rules": [ { "api_name": "Lead_Assignment_Rule_US", "default_assignee": { "resource": { "api_name": "${CURRENTUSER}" }, "type": "user" }, "description": "Rule to assign owners for US leads", "name": "Lead owner assignment rule - US", "rule_entries": [ { "_delete": null, "id": "526435000000001111" }, { "assign_to": { "resources": [ { "id": "526435000000670072" }, { "id": "526435000000227013" } ], "type": "users" }, "criteria": null, "id": "526435000000001112", "user_availability_based_on": [ "online_status", "shift_timing" ] }, { "assign_to": { "criteria": { "comparator": "equal", "field": { "api_name": "City" }, "value": "Chennai" }, "type": "criteria" }, "followup_actions": [ { "resources": [ { "id": "526435000014344004" } ], "type": "tasks" } ], "user_availability_based_on": [ "online_status", "shift_timing" ] } ] } ] } } }, "schema": { "$ref": "#/components/schemas/RequestBodySchemaForUpdate" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain an **assignment_rules** array with one object. Specify the Assignment Rule fields or rule entries to update." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "code": "SUCCESS", "details": { "id": "123456", "rule_entries": [ { "id": "2134567" } ] }, "message": "updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/AssignmentRulesSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent field is missing (Field: resources)", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resources", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].assignment_rules.rule_entries.followup_actions.resources" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows the error response returned when the Assignment Rule request contains duplicate data for a unique field.", "summary": "DUPLICATE_DATA error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[0].api_name" }, "message": "The data is already given in the api_name", "status": "error" } ] } }, "Error400Response1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].default_assignee.id" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response10": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resources", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.resources" }, "message": "Dependent field is missing", "status": "error" } ] } }, "Error400Response11": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response12": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resource", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resource" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response13": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resource.id" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response14": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response15": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "Error400Response16": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "Error400Response2": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.assignment_rules[*].default_assignee.id" }, { "api_name": "api_name", "json_path": "$.assignment_rules[*].default_assignee.assignment_rules.default_assignee.api_name" } ] }, "message": "One of the required fields is missing", "status": "error" } ] } }, "Error400Response3": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.assignment_rules[*].default_assignee.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response4": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[*].default_assignee.api_name", "supported_values": [ "${CURRENTUSER}" ] }, "message": "Invalid data", "status": "error" } ] } }, "Error400Response5": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "message": "Required field is missing", "status": "error" } ] } }, "Error400Response6": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response7": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type", "supported_values": [ "users", "role", "group", "profile", "criteria", "zia_suggested_users" ] }, "message": "Invalid data", "status": "error" } ] } }, "Error400Response8": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.criteria" }, "message": "Dependent field is missing", "status": "error" } ] } }, "Error400Response9": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resource", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.resource" }, "message": "Dependent field is missing", "status": "error" } ] } }, "ErrorResponseInvalidRequestPathParamIdExample": { "description": "Shows the error response returned when the Assignment Rule ID in the request path is invalid.", "summary": "INVALID_DATA error for Assignment Rule ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "Invalid assignment rule id", "status": "error" } }, "ExpectedFieldMissingResponse1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code EXPECTED_FIELD_MISSING: One of the required fields is missing", "value": { "assignment_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].id" }, { "api_name": "assign_to", "json_path": "$.assignment_rules[*].rule_entries[*].assignment_rules.rule_entries.assign_to" } ] }, "message": "One of the required fields is missing", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "code": "INVALID_DATA", "details": { "api_name": "assignment_rules", "json_path": "$.assignment_rules", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse10": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "default_assignee", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].default_assignee" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "maximum_length": 200 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "delete", "expected_data_type": "null", "json_path": "$.assignment_rules[*].rule_entries[*].delete" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "assign_to", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "user_availability_based_on", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].user_availability_based_on" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.assignment_rules[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "user_availability_based_on", "json_path": "$.assignment_rules[*].rule_entries[*].user_availability_based_on", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type", "supported_values": [ "tasks" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse28": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse29": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[*].api_name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.assignment_rules[*].api_name", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.assignment_rules[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.assignment_rules[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.assignment_rules[*].description", "maximum_length": 250 }, "message": "Invalid data", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources[*].id" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "additionalProperties": false, "description": "Wrapped error response with assignment_rules.", "properties": { "assignment_rules": { "description": "Array of error objects. ", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseCannotRemove" }, { "$ref": "#/components/schemas/ErrorResponseLimitExceeded" }, { "$ref": "#/components/schemas/ErrorResponseDuplicateData" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "$ref": "#/components/schemas/ErrorResponseDependentMismatch" }, { "$ref": "#/components/schemas/AssignmentRulesErrorResponseMandatoryNotFound" }, { "$ref": "#/components/schemas/ErrorResponseExpectedFieldsMissing" }, { "$ref": "#/components/schemas/ErrorResponseDependentFieldMissing" } ], "description": "Represents each Assignment Rules entry returned for the Assignment Rule operation." }, "maxItems": 25, "type": "array" } }, "required": [ "assignment_rules" ], "type": "object", "x-zs-$id": "UpdateAssignmentRuleEntryRequestBodyErrorCases" } ], "description": "Error response for invalid data.", "x-zs-$id": "Possible400ErrorResponsesPutARById" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermissionToManageARErrorResponseExample": { "description": "Shows the error response returned when the user does not have permission to access or manage Assignment Rules for the specified module.", "summary": "NO_PERMISSION error for Assignment Rule access", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_AR_{moduleName}" ] }, "message": "User does not have sufficient permission to manage assignment rules of given module", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/Possible403ErrorResponsesInManagingAR" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.UPDATE" ] } ], "summary": "Update a Specific Assignment Rule", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules", "x-zs-llm-description": "To update an assignment rule" } }, "/crm/v8/settings/automation/assignment_rules/{id}/actions/associations": { "get": { "description": "To retrieve the CRM features associated with a single Assignment Rule in your Zoho CRM organization.", "operationId": "getAssignmentRuleAssociations", "parameters": [ { "$ref": "#/components/parameters/RequestPathParamId" }, { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "associations": [ { "resources": [ { "_details": {}, "id": "234356789", "name": "Lead create workflow flow" } ], "type": "workflow_rules" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponseAssociations" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "204": { "description": "Indicates that no Assignment Rule records are available for the request." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" } ], "description": "400 error cases for associations.", "x-zs-$id": "Possible400ErrorResponsesGetAssociations" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseNoPermissionToAccessAPI" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.READ" ] } ], "summary": "Assignment Rule Associations", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules" } }, "/crm/v8/settings/automation/assignment_rules/{id}/actions/clone": { "post": { "description": "To clone a single Assignment Rule in your Zoho CRM organization.", "operationId": "cloneAssignmentRule", "parameters": [ { "$ref": "#/components/parameters/RequestPathParamId" }, { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows an Assignment Rule request payload with the fields required for this operation.", "summary": "Sample request body", "value": { "assignment_rules": [ { "name": "Clone of assignment rule" } ] } } }, "schema": { "$ref": "#/components/schemas/RequestBodySchemaForActionClone" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain an **assignment_rules** array with one object. Specify the name to assign to the cloned Assignment Rule." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "code": "SUCCESS", "details": { "id": "123456" }, "message": "", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/AssignmentRulesSuccessResponse" } } }, "description": "Returns the success details for the cloned Assignment Rule, including the new Assignment Rule ID." }, "400": { "content": { "application/json": { "examples": { "DuplicateDataResponse1": { "description": "Shows the error response returned when the Assignment Rule request contains duplicate data for a unique field.", "summary": "DUPLICATE_DATA error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[0].name" }, "message": "The data is already given in the name", "status": "error" } ] } }, "ErrorResponseFeatureNotSupportedExample": { "description": "Shows the error response returned when Assignment Rules are not supported for the current edition.", "summary": "FEATURE_NOT_SUPPORTED error for Assignment Rules", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Assignment rules not supported for current edition", "status": "error" } }, "ErrorResponseInvalidModuleExample": { "description": "Shows the error response returned when the **module** query parameter does not contain a valid CRM module API name.", "summary": "INVALID_MODULE error for module parameter", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "ErrorResponseInvalidRequestPathParamIdExample": { "description": "Shows the error response returned when the Assignment Rule ID in the request path is invalid.", "summary": "INVALID_DATA error for Assignment Rule ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "Invalid assignment rule id", "status": "error" } }, "ErrorResponseModuleNotSupportedExample": { "description": "Shows the error response returned when the specified CRM module does not support Assignment Rules.", "summary": "NOT_SUPPORTED error for Assignment Rules module", "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "Module not supported in assignment rules", "status": "error" } }, "InvalidDataResponse2": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "code": "INVALID_DATA", "details": { "api_name": "assignment_rules", "json_path": "$.assignment_rules", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse3": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.assignment_rules[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows the error response returned when the Assignment Rule limit is exceeded for the specified module.", "summary": "LIMIT_EXCEEDED error for Assignment Rules", "value": { "assignment_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 10 }, "message": "limit exceeded", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.assignment_rules[*].name" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "additionalProperties": false, "description": "Represents a per-rule error response where each Assignment Rule in the request is associated with its own validation error details.", "properties": { "assignment_rules": { "description": "Represents the list of per-rule error objects for the Assignment Rules that encountered validation failures during the clone operation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseLimitExceeded" }, { "$ref": "#/components/schemas/ErrorResponseDuplicateData" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "$ref": "#/components/schemas/AssignmentRulesErrorResponseMandatoryNotFound" } ], "description": "Represents a validation error object for a single Assignment Rule, indicating the type of failure encountered during the clone operation." }, "maxItems": 25, "type": "array" } }, "required": [ "assignment_rules" ], "type": "object", "x-zs-$id": "CloneAssignmentRuleRequestBodyErrorCases" } ], "description": "Represents the possible error responses when the clone Assignment Rule request contains invalid or missing data.", "x-zs-$id": "Possible400ErrorResponsesCloneARById" } } }, "description": "Invalid request error cases.\\n**Resolution:** The request must include a valid **module** query parameter, a valid Assignment Rule ID in the path, and a valid **assignment_rules** array with the required **name** field." }, "403": { "content": { "application/json": { "examples": { "NoPermissionToManageARErrorResponseExample": { "description": "Shows the error response returned when the user does not have permission to access or manage Assignment Rules for the specified module.", "summary": "NO_PERMISSION error for Assignment Rule access", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_AR_{moduleName}" ] }, "message": "User does not have sufficient permission to manage assignment rules of given module", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/Possible403ErrorResponsesInManagingAR" } } }, "description": "Forbidden request error cases.\\n**Resolution:** The CRM administrator must grant the required Assignment Rule management permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.CREATE" ] } ], "summary": "Clone Assignment Rule", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules", "x-zs-llm-description": "To clone an existing assignment rule" } }, "/crm/v8/settings/automation/assignment_rules/{id}/actions/clone_entries": { "put": { "description": "To clone rule entries for a single Assignment Rule in your Zoho CRM organization.", "operationId": "putCloneEntries", "parameters": [ { "$ref": "#/components/parameters/RequestPathParamId" }, { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows an Assignment Rule request payload with the fields required for this operation.", "summary": "Sample request body", "value": { "assignment_rules": [ { "rule_entries": [ { "assign_to": { "resources": [ { "id": "526435000000670072" }, { "id": "526435000000227013" } ], "type": "users" }, "criteria": null, "followup_actions": [ { "resources": [ { "id": "526435000014344004" } ], "type": "tasks" } ], "id": "526435000000001111", "user_availability_based_on": [ "online_status", "shift_timing" ] } ] } ] } } }, "schema": { "$ref": "#/components/schemas/RequestBodySchemaForActionCloneEntries" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain an **assignment_rules** array with one object. Specify the rule entries to clone into the target Assignment Rule." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "code": "SUCCESS", "details": { "id": "123456", "rule_entries": [ { "id": "1234567890098765432" } ] }, "message": "", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/AssignmentRulesSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent field is missing (Field: resources)", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resources", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].assignment_rules.rule_entries.followup_actions.resources" }, "message": "Dependent field is missing", "status": "error" } ] } }, "Error400Response1": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "message": "Required field is missing", "status": "error" } ] } }, "Error400Response10": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response11": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "Error400Response12": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "Error400Response2": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response3": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type", "supported_values": [ "users", "role", "group", "profile", "criteria", "zia_suggested_users" ] }, "message": "Invalid data", "status": "error" } ] } }, "Error400Response4": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.criteria" }, "message": "Dependent field is missing", "status": "error" } ] } }, "Error400Response5": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resource", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.resource" }, "message": "Dependent field is missing", "status": "error" } ] } }, "Error400Response6": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "resources", "dependee": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.type" }, "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.assignment_rules.rule_entries.assign_to.resources" }, "message": "Dependent field is missing", "status": "error" } ] } }, "Error400Response7": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response8": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resource", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resource" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response9": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resource.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "user_availability_based_on", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].user_availability_based_on" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "user_availability_based_on", "json_path": "$.assignment_rules[*].rule_entries[*].user_availability_based_on", "maximum_length": 8 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "followup_actions", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type", "supported_values": [ "tasks" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "code": "INVALID_DATA", "details": { "api_name": "assignment_rules", "json_path": "$.assignment_rules", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse20": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "resources", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "maximum_length": 200 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "assign_to", "expected_data_type": "jsonobject", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows the error response returned when the Assignment Rule request contains invalid field data.", "summary": "INVALID_DATA error for Assignment Rule data", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].assign_to.resources[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows the error response returned when the Assignment Rule request does not include a required field.", "summary": "MANDATORY_NOT_FOUND error for Assignment Rule name", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[*].rule_entries[*].followup_actions[*].resources[*].id" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "additionalProperties": false, "description": "Wrapped error response with assignment_rules.", "properties": { "assignment_rules": { "description": "Array of error objects. ", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseLimitExceeded" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "$ref": "#/components/schemas/ErrorResponseDependentMismatch" }, { "$ref": "#/components/schemas/AssignmentRulesErrorResponseMandatoryNotFound" }, { "$ref": "#/components/schemas/ErrorResponseExpectedFieldsMissing" }, { "$ref": "#/components/schemas/ErrorResponseDependentFieldMissing" } ], "description": "Represents each Assignment Rules entry returned for the Assignment Rule operation." }, "maxItems": 25, "type": "array" } }, "required": [ "assignment_rules" ], "type": "object", "x-zs-$id": "CloneAssignmentRuleEntryRequestBodyErrorCases" } ], "description": "Error response for invalid data.", "x-zs-$id": "Possible400ErrorResponsesCloneEntryOfARById" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Possible403ErrorResponsesInManagingAR" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.UPDATE" ] } ], "summary": "Clone Assignment Rule Entries", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules", "x-zs-llm-description": "To clone an existing assignment rule entry" } }, "/crm/v8/settings/automation/assignment_rules/{id}/actions/reorder_entries": { "put": { "description": "To reorder rule entries for a single Assignment Rule in your Zoho CRM organization.", "operationId": "putReorderEntries", "parameters": [ { "$ref": "#/components/parameters/RequestPathParamId" }, { "$ref": "#/components/parameters/ParamQueryModuleRequiredSchema" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows an Assignment Rule request payload with the fields required for this operation.", "summary": "Sample request body", "value": { "assignment_rules": [ { "rule_entries": [ { "id": "543219876547653", "sequence_number": 2 }, { "id": "543219876547654", "sequence_number": 5 }, { "id": "543219876547655", "sequence_number": 10 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/RequestBodySchemaForActionReorderEntries" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain an **assignment_rules** array with one object. Specify the rule entry IDs and their sequence numbers." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful Assignment Rule response with the status, message, and Assignment Rule ID details.", "summary": "Successful Assignment Rule operation", "value": { "assignment_rules": [ { "code": "SUCCESS", "details": { "id": "123456" }, "message": "", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/AssignmentRulesSuccessResponse" } } }, "description": "Returns the Assignment Rule response details for the completed operation." }, "400": { "content": { "application/json": { "examples": { "ErrAssignmentRulesMaxLenExceedsInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code INVALID_DATA: invalid data (Field: assignment_rules)", "value": { "code": "INVALID_DATA", "details": { "api_name": "assignment_rules", "json_path": "$.assignment_rules", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "ErrInvalidSequenceNumberInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code INVALID_DATA: Invalid sequence number (Field: sequence_number)", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "sequence_number", "json_path": "$.assignment_rules[0].rule_entries[*].sequence_number" }, "message": "Invalid sequence number", "status": "error" } ] } }, "ErrMandatoryRuleEntriesNotFoundInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: rule_entries)", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[0].rule_entries" }, "message": "Required field is missing", "status": "error" } ] } }, "ErrMandatoryRuleEntryIdNotFoundInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: ID)", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.assignment_rules[0].rule_entries[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "ErrMandatoryRuleEntrySequenceNumberNotFoundInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: sequence_number)", "value": { "assignment_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "sequence_number", "json_path": "$.assignment_rules[0].rule_entries[*].sequence_number" }, "message": "Required field is missing", "status": "error" } ] } }, "ErrRuleEntriesExpectedDatatypeMismatchInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: rule_entries)", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "expected_data_type": "jsonarray", "json_path": "$.assignment_rules[*].rule_entries" }, "message": "Invalid data type", "status": "error" } ] } }, "ErrRuleEntriesMaxLenExceedsInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: rule_entries)", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "maximum_length": 200 }, "message": "Invalid data", "status": "error" } ] } }, "ErrRuleEntriesMinLenNotMetInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: rule_entries)", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "rule_entries", "json_path": "$.assignment_rules[*].rule_entries", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "ErrRuleEntryIdExpectedDatatypeMismatchInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: ID)", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.assignment_rules[0].rule_entries[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "ErrRuleEntrySequenceNumberExpectedDatatypeMismatchInReqBodyExample": { "description": "Shows an Assignment Rule response payload for this scenario.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: sequence_number)", "value": { "assignment_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "sequence_number", "expected_data_type": "integer", "json_path": "$.assignment_rules[0].rule_entries[*].sequence_number" }, "message": "Invalid data type", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseRequiredParamMissing" }, { "$ref": "#/components/schemas/ErrorResponseFeatureNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseInvalidModule" }, { "$ref": "#/components/schemas/ErrorResponseModuleNotSupported" }, { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "additionalProperties": false, "description": "Wrapped error response with assignment_rules.", "properties": { "assignment_rules": { "description": "Array of error objects. ", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseInvalidData" }, { "$ref": "#/components/schemas/AssignmentRulesErrorResponseMandatoryNotFound" } ], "description": "Represents each Assignment Rules entry returned for the Assignment Rule operation." }, "maxItems": 1, "type": "array" } }, "required": [ "assignment_rules" ], "type": "object", "x-zs-$id": "ReorderEntriesAssignmentRuleObjectRelatedErrorResponses" } ], "description": "Error response for invalid data.", "x-zs-$id": "Possible400ErrorResponsesReorderEntriesOfARById" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The request must include valid Assignment Rule data and valid parameter values for this operation." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Possible403ErrorResponsesInManagingAR" } } }, "description": "Permission denied for the Assignment Rule operation.\n**Resolution:** The CRM administrator must grant the required Assignment Rule permission for the specified module, and the OAuth token must include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.assignment_rules.UPDATE" ] } ], "summary": "Reorder Assignment Rule entries", "tags": [ "assignment_rules" ], "x-zoho-document": "assignment_rules", "x-zs-llm-description": "To reorder assignment rule entries" } }, "/crm/v8/settings/automation/cadences": { "get": { "description": "To retrieve the list of Cadences in your Zoho CRM organization.", "operationId": "getCadences", "parameters": [ { "description": "Specify the API name of the CRM module to filter Cadences.\nRefer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "in": "query", "name": "module", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Specify the name of the Cadence to filter the results. Supported comparators: `equal`, `not_equal`, `contains`, `not_contains`, `starts_with`, `ends_with`. The filter value must be URL-encoded before being sent in the query parameter. Non-encoded example: ```json { \"field\": { \"api_name\": \"name\" }, \"comparator\": \"contains\", \"value\": \"qwerty\" }", "in": "query", "name": "name", "schema": { "maxLength": 100, "type": "string" } }, { "description": "Specify whether to filter Cadences by their active status.\nPossible values: **true** - Retrieve only active Cadences. **false** - Retrieve only inactive Cadences.", "in": "query", "name": "active", "schema": { "type": "boolean" } }, { "description": "Specify the field to include in the Cadence response.\nPossible values: **name** - Include only the name field in the response.", "in": "query", "name": "fields", "schema": { "enum": [ "name" ], "type": "string" } }, { "$ref": "#/components/parameters/CadencesParamQueryPage" }, { "$ref": "#/components/parameters/CadencesParamQueryPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulList": { "description": "Shows a successful response listing multiple Cadences with their follow-up summaries.", "summary": "Successful Cadence list response", "value": { "cadences": [ { "active": true, "created_by": { "id": "111111000000057812", "name": "Nish test" }, "created_time": "2025-10-30T08:46:14+00:00", "custom_view": { "id": "111111000000051423", "name": "All Contacts" }, "description": "Cadence for leads", "execution_details": { "automatic_unenroll": false, "end_date": "2025-12-31", "execute_every": { "period": "days", "unit": 1 }, "type": "automatic_unenroll", "unenroll_properties": { "end_date": "2025-12-31", "type": "date" } }, "id": "2001", "modified_by": { "id": "111111000000057812", "name": "Nish test" }, "modified_time": "2025-01-01T16:43:11+05:30", "module": { "api_name": "Leads", "id": "111111000000002648" }, "name": "Onboard Leads", "published": true, "status": "active", "summary": { "call_follow_up_count": 1, "email_follow_up_count": 3, "task_follow_up_count": 2 }, "type": "Custom view" } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 20 } } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for the Cadence list request.", "properties": { "cadences": { "description": "Represents the list of Cadences retrieved from Zoho CRM.", "items": { "additionalProperties": false, "description": "Each object represents a Cadence configured in Zoho CRM, including its schedule, execution details, and status.", "properties": { "active": { "description": "Represents whether the Cadence is currently active. Possible values: **true**, **false**.", "type": "boolean" }, "created_by": { "$ref": "#/components/schemas/CreatorInfo" }, "created_time": { "$ref": "#/components/schemas/CadencesCreatedTime" }, "custom_view": { "$ref": "#/components/schemas/CadencesCustomViewInfo" }, "description": { "$ref": "#/components/schemas/CadenceDescription" }, "execution_details": { "additionalProperties": false, "description": "Represents the execution configuration for the Cadence, including the schedule type, end date, and unenrollment settings.", "properties": { "automatic_unenroll": { "description": "Indicates whether records enrolled in the Cadence are automatically unenrolled when the scheduled execution period ends. Possible values: **true**, **false**.", "type": "boolean" }, "end_date": { "description": "Represents the date on which the Cadence execution ends.", "maxLength": 50, "type": "string" }, "execute_every": { "$ref": "#/components/schemas/ExecuteEvery" }, "type": { "description": "Represents the execution schedule type for the Cadence.", "maxLength": 255, "type": [ "string", "null" ] }, "unenroll_properties": { "additionalProperties": false, "description": "Represents the automatic unenrollment configuration applied when records are removed from the Cadence.", "properties": { "end_date": { "description": "Represents the date on which the automatic unenrollment of records from the Cadence takes effect.", "maxLength": 50, "type": "string" }, "type": { "description": "Represents the type of automatic unenrollment applied to the Cadence.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": "object" } }, "type": [ "object", "null" ] }, "id": { "$ref": "#/components/schemas/CadenceID", "x-zs-$id": "CadenceId" }, "modified_by": { "$ref": "#/components/schemas/ModifierInfo" }, "modified_time": { "description": "Represents the date and time when the Cadence was last modified, in ISO 8601 format.", "format": "date-time", "type": [ "string", "null" ] }, "module": { "$ref": "#/components/schemas/ModuleInformation" }, "name": { "$ref": "#/components/schemas/CadenceName" }, "published": { "description": "Represents whether the Cadence has been published. Possible values: **true**, **false**.", "type": "boolean" }, "status": { "description": "Cadence lifecycle status. **Possible values** **draft** = not yet published; **active** = published and enrolling records; **inactive** = published but currently deactivated.", "enum": [ "active", "inactive", "draft" ], "type": "string" }, "summary": { "$ref": "#/components/schemas/FollowUpSummary" }, "type": { "description": "Indicates the enrollment type of the Cadence. Possible values: **Custom view**, **Manual enrollment**.", "enum": [ "Custom view", "Manual enrollment" ], "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "maxItems": 400, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents the pagination details for the list of Cadences.", "properties": { "count": { "description": "Represents the total number of Cadences retrieved in the current response.", "format": "int32", "type": "integer" }, "more_records": { "description": "Represents whether additional Cadences are available beyond the current page.", "type": "boolean" }, "page": { "description": "Represents the current page number of the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of Cadences returned per page.", "format": "int32", "type": "integer" } }, "type": "object" } }, "required": [ "cadences", "info" ], "type": "object", "x-zs-$id": "GetAllCadencesResponse" } } }, "description": "Returns the list of Cadences matching the specified filters." }, "204": { "description": "No Cadences found matching the specified filters. The response body is empty." }, "400": { "content": { "application/json": { "examples": { "ErrorResponse1": { "description": "Shows an error response when the provided module name is invalid or not supported.", "summary": "Invalid module name error", "value": { "code": "INVALID_DATA", "details": { "param_name": "module" }, "message": "the given module doesn't exist", "status": "error" } }, "ErrorResponse3": { "description": "Shows an error response when a query parameter value cannot be parsed to the expected data type.", "summary": "Invalid data type error", "value": { "code": "UNABLE_TO_PARSE_DATA_TYPE", "details": {}, "message": "either the request body or parameters is in wrong format", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response for the Cadence list request.", "properties": { "code": { "description": "Represents the error code for the failed request.\nPossible values:\n**INVALID_DATA** - The request contains invalid data.\n**PATTERN_NOT_MATCHED** - The request value does not match the expected pattern.\n**UNABLE_TO_PARSE** - The value could not be parsed.", "enum": [ "INVALID_DATA", "PATTERN_NOT_MATCHED", "UNABLE_TO_PARSE_DATA_TYPE", "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the failed request.", "properties": { "param_name": { "description": "Represents the parameter name that caused the error.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the cause of the failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the failed request.\nPossible values: **error** - Indicates that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseInvalidModuleName" } } }, "description": "The request contains invalid data or an unsupported module name.\n**Resolution:** The query parameters must be correct, and the **module** parameter must specify a valid CRM module API name." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to retrieve Cadences.", "summary": "No permission to retrieve Cadences error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to access Cadences, or the API is not supported for the selected domain.\n**Resolution:** The CRM administrator must grant the required Cadence read permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.READ" ] } ], "summary": "List Cadences", "tags": [ "cadences" ], "x-zoho-document": "cadences" }, "post": { "description": "Creates a new cadence (initially in draft status) with its follow-up tree and optional un-enrollment rules in a single call. custom_view cadences require a custom_view.id; manual_enrollment cadences must omit custom_view. Follow-ups reference each other via reference_id (a client-chosen string) so that parent/child links can be expressed in a single request before server ids are assigned. The cadence must be published and activated before it will enroll records.", "operationId": "postCadences", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample create Cadence request body", "value": { "cadences": [ { "custom_view": { "id": "111112000000051112" }, "description": "description", "execution_details": { "execute_every": { "period": "hours", "unit": 1 }, "unenroll_properties": [ { "details": {}, "type": "end_date" }, { "type": "automatic_unenroll" }, { "details": { "unenroll_date": "2025-11-30" }, "type": "end_date" }, { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue" }, "value": 123 } }, "type": "criteria" }, { "details": { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Subject", "id": "111112000000004066" }, "value": "teste" }, "specific": false, "state": null }, "type": "Tasks" }, "type": "followup_criteria" } ] }, "follow_ups": [ { "action": { "details": { "field_mappings": [ { "field": { "api_name": "Call_Type", "id": "111112000000004208" }, "type": "static", "value": "Outbound" } ], "layout": { "id": "111112000000003660", "name": "Standard" }, "module": { "api_name": "Calls", "id": "111112000000002654" } }, "id": "111112000000003660", "type": "schedule_call" }, "execute_after": { "period": "minutes", "unit": 10 }, "parent_follow_up": { "reference_id": "{{Followup_1}}" }, "reference_id": "{{Followup_2}}", "triggers": [ "Completed" ] }, { "action": { "id": "111112000000003661", "type": "email_notifications" }, "execute_after": { "period": "days", "unit": 1 }, "parent_follow_up": { "reference_id": "{{Followup_2}}" }, "reference_id": "{{Followup_3}}", "triggers": [ "Completed" ] } ], "module": { "api_name": "Leads", "id": "111112000000002628" }, "name": "cadence", "type": "custom_view" } ] } } }, "schema": { "$ref": "#/components/schemas/CadencesCreateRequestBody" } } }, "description": "The request body must contain a Cadences array with the configuration details for the new Cadence, including follow-up steps and action assignments.", "x-zs-llm-examples": [ "SamplePostRequest" ] }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Shows a successful response after creating a new Cadence, returning the unique identifier of the created Cadence.", "summary": "Successful Cadence creation response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "follow_ups": [ { "id": "111112000000092009" } ], "id": "111112000000092007" }, "message": "Cadences created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns the details of the newly created Cadence, including its unique identifier." }, "400": { "content": { "application/json": { "examples": { "AlreadyUsedResponse1": { "description": "Shows an error response when a field value is already in use by another Cadence.", "summary": "Field value already in use error", "value": { "cadences": [ { "code": "ALREADY_USED", "details": { "api_name": "triggers", "exists_in": { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, "json_path": "$.cadences[0].follow_ups[1].triggers[1]" }, "message": "trigger type is already given in the same request under different key", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse1": { "description": "Shows an error response when ambiguity occurs during request processing.", "summary": "Ambiguity during processing error", "value": { "cadences": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "specific", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.specific" }, { "api_name": "state", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.state" } ] }, "message": "invalid data", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse2": { "description": "Shows an error response when multiple conflicting values cause ambiguity during processing.", "summary": "Conflicting values ambiguity error", "value": { "cadences": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[1]" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentFieldMissingResponse10": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.type" }, "json_path": "$.cadences[0].follow_ups[1].action.details" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse11": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "execute_after", "dependee": { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, "json_path": "$.cadences[0].follow_ups[1].execute_after" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse12": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "unit", "dependee": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period" }, "json_path": "$.cadences[0].execution_details.execute_every.unit" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[0].details" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "unenroll_date", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[0].details.unenroll_date" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "id", "json_path": "$.cadences[0].execution_details.unenroll_properties[2].id" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[2].details.criteria" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse5": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.details" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse6": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "specific", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.specific" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse7": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "state", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.state" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse8": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.details.criteria" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse9": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type" }, "json_path": "$.cadences[0].follow_ups[0].action.id" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Shows an error response when a dependent field value does not match the expected configuration.", "summary": "Dependent field value mismatch error", "value": { "cadences": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.type", "supported_values": [ "Tasks", "Calls", "Email", "WhatsApp" ] }, "message": "Dependent Field is not matching", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Shows an error response when dependent field values are inconsistent with each other.", "summary": "Inconsistent dependent field values error", "value": { "cadences": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "triggers", "dependee": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, "json_path": "$.cadences[0].follow_ups[1].triggers[0]", "supported_values": [] }, "message": "dependent mismatch", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "description": "Shows an error response when an expected field is missing from the request body.", "summary": "Missing expected field error", "value": { "cadences": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, { "api_name": "id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "ExpectedFieldMissingResponse2": { "description": "Shows an error response when a second expected field is missing from the request body.", "summary": "Second expected field missing error", "value": { "cadences": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field.api_name" }, { "api_name": "id", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[0].reference_id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type", "supported_values": [ "tasks", "email_notifications", "schedule_call", "whatsapp_message_notification" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.cadences[0].FollowUp[0].action.id" }, "message": "the given actionid seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.cadences[0].FollowUp[0].action.id" }, "message": "Action is already associated with another rule", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].type", "supported_values": [ "static", "reference", "time_computed", "execution_time", "merge_field" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.cadences[0].follow_ups[1].execute_after.period", "supported_values": [ "minutes", "hours", "business_hours", "days", "business_days", "months" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.cadences[0].follow_ups[1].execute_after.unit" }, "message": "the value given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period", "supported_values": [ "immediately", "hours", "days", "weeks" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.cadences[0].execution_details.execute_every.unit" }, "message": "unit value must be between 1 to 99", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type", "supported_values": [ "automatic_unenroll", "end_date", "criteria", "followup_criteria" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unenroll_date", "json_path": "$.cadences[0].execution_details.unenroll_properties.unenroll_date" }, "message": "the given format is invalid please provide the value as MM/DD/YYYY", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataTypeResponse18": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse20": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse22": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse23": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse24": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse25": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse27": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_view", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.custom_view" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse28": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.custom_view.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse30": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execution_details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse32": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execute_every", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details.execute_every" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse33": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.execution_details.execute_every.period" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse35": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.cadences[*].cadences.execution_details.execute_every.unit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse36": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unenroll_properties", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse37": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse39": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties[*].details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse40": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "follow_ups", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse41": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "parent_follow_up", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].parent_follow_up" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse42": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].parent_follow_up.reference_id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse43": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].reference_id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse44": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "triggers", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups[*].triggers" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse46": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execute_after", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse47": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after.unit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse48": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after.period" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse52": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "action", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse53": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse55": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse56": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse57": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "layout", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse58": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse59": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout.name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse60": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse61": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse62": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse63": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse64": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse65": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse66": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse67": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows an error response when the number of Cadences in the module exceeds the allowed limit.", "summary": "Cadences per module limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 60 }, "message": "More than 60 Cadences cannot be created for module", "status": "error" } }, "LimitExceededResponse2": { "description": "Shows an error response when the total number of Cadences in the organization exceeds the allowed limit.", "summary": "Total Cadences limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 150 }, "message": "More than 150 Cadences cannot be created", "status": "error" } }, "LimitExceededResponse3": { "description": "Shows an error response when the number of follow-up steps in a Cadence exceeds the allowed limit.", "summary": "Follow-up steps limit exceeded error", "value": { "cadences": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[2].type", "limit": 1 }, "message": "Given unenroll type limit is exceeded", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse10": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].follow_ups[1].action.details.module" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse11": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_mappings", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse12": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse13": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse14": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "unit", "json_path": "$.cadences[0].follow_ups[1].execute_after.unit" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse15": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "period", "json_path": "$.cadences[0].follow_ups[1].execute_after.period" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].module" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[0].reference_id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "parent_follow_up", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "action", "json_path": "$.cadences[0].follow_ups[0].action" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].follow_ups[1].action.details.module" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseWithCadenceAsHead" }, { "$ref": "#/components/schemas/AllErrorResponse" } ], "description": "Represents the error response for the Cadence creation operation.", "x-zs-$id": "CadencesCreateErrorResponse" } } }, "description": "The request contains invalid or missing data.\n**Resolution:** All required fields must be provided, field values must conform to the expected format, and the Cadence count limits must not be exceeded." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to create Cadences.", "summary": "No permission to create Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to create Cadences.\n**Resolution:** The CRM administrator must grant the required Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.CREATE" ] } ], "summary": "Create cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences", "x-zs-llm-description": "Set reference_id to any client-chosen string on each follow-up to establish parent/child links before server ids are assigned; use the same string in parent_follow_up.reference_id on child follow-ups. After creation, the cadence is in draft - call POST .../publish, then POST .../activate to begin enrolling records." }, "put": { "description": "Partial-update form that takes the cadence id inside the request body (cadences[0].id). Updates only the provided fields; module / type / custom_view cannot be changed after creation. Editing a currently-published cadence creates a draft on the first save. Follow-up add/update is expressed inline via the follow_ups array.", "operationId": "putUpdateCadences", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample bulk Cadence update request body", "value": { "cadences": [ { "description": "description", "execution_details": { "unenroll_properties": [ { "type": "automatic_unenroll" }, { "details": { "unenroll_date": "2026-11-30" }, "type": "end_date" }, { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue" }, "value": 123 } }, "type": "criteria" }, { "details": { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Subject", "id": "111112000000004066" }, "value": "teste" }, "specific": false, "state": null }, "type": "Tasks" }, "type": "followup_criteria" } ] }, "follow_ups": [ { "action": { "details": { "field_mappings": [ { "field": { "api_name": "Call_Type", "id": "111112000000004208" }, "type": "static", "value": "Outbound" } ], "layout": { "id": "111112000000003660", "name": "Standard" }, "module": { "api_name": "Calls", "id": "111112000000002654" } }, "id": "111112000000003660", "type": "schedule_call" }, "execute_after": { "period": "minutes", "unit": 10 }, "id": "111112000000106723", "parent_follow_up": { "id": "111112000000106722" }, "triggers": [ "Completed" ] }, { "action": { "id": "111112000000003661", "type": "email_notifications" }, "execute_after": { "period": "days", "unit": 1 }, "parent_follow_up": { "id": "111112000000106723" }, "reference_id": "{{Followup_3}}", "triggers": [ "Completed" ] } ], "id": "111112000000069836", "name": "cadence" } ] } } }, "schema": { "$ref": "#/components/schemas/CadencesUpdateRequestBody" } } }, "description": "The request body must contain a Cadences array with updated configurations for one or more Cadences.", "x-zs-llm-examples": [ "SamplePutRequest" ] }, "responses": { "200": { "content": { "application/json": { "examples": { "DraftCadenceSuccess": { "description": "Shows a successful response after saving one or more Cadences in draft state.", "summary": "Successful bulk Cadence draft save response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "draft_cadence": { "id": "111111000000070063" }, "id": "111111000000070062" }, "message": "Cadences updated successfully", "status": "success" } ] } }, "Success200": { "description": "Shows a successful response after updating multiple Cadences.", "summary": "Successful bulk Cadence update response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "id": "111112000000092007" }, "message": "Cadences updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns the updated details of the Cadences, confirming that the updates were applied successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadyUsedResponse1": { "description": "Shows an error response when a field value is already in use by another resource.", "summary": "Field value already in use error", "value": { "cadences": [ { "code": "ALREADY_USED", "details": { "api_name": "triggers", "exists_in": { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, "json_path": "$.cadences[0].follow_ups[1].triggers[1]" }, "message": "trigger type is already given in the same request under different key", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse1": { "description": "Shows an error response when ambiguity occurs during request processing.", "summary": "Ambiguity during processing error", "value": { "cadences": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "specific", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.specific" }, { "api_name": "state", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.state" } ] }, "message": "invalid data", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse2": { "description": "Shows an error response when conflicting values cause ambiguity during processing.", "summary": "Conflicting values ambiguity error", "value": { "cadences": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[1]" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentFieldMissingResponse1": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "custom_view", "dependee": { "api_name": "type", "json_path": "$.cadences[0].type" }, "json_path": "$.cadences[0].custom_view" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse10": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.type" }, "json_path": "$.cadences[0].follow_ups[1].action.details" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse11": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "execute_after", "dependee": { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, "json_path": "$.cadences[0].follow_ups[1].execute_after" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse12": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "unit", "dependee": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period" }, "json_path": "$.cadences[0].execution_details.execute_every.unit" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[0].details" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "unenroll_date", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[0].details.unenroll_date" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "id", "json_path": "$.cadences[0].execution_details.unenroll_properties[2].id" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[2].details.criteria" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse5": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.details" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse6": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "specific", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.specific" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse7": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "state", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.state" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse8": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.details.criteria" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse9": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type" }, "json_path": "$.cadences[0].follow_ups[0].action.id" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Shows an error response when a dependent field value does not match the expected configuration.", "summary": "Dependent field value mismatch error", "value": { "cadences": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.type", "supported_values": [ "Tasks", "Calls", "Email", "WhatsApp" ] }, "message": "Dependent Field is not matching", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Shows an error response when dependent field values are inconsistent with each other.", "summary": "Inconsistent dependent field values error", "value": { "cadences": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "triggers", "dependee": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, "json_path": "$.cadences[0].follow_ups[1].triggers[0]", "supported_values": [] }, "message": "dependent mismatch", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows an error response when a Cadence with the same name already exists.", "summary": "Duplicate Cadence name error", "value": { "cadences": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "A Cadences with the same name already exists", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "description": "Shows an error response when an expected field is missing from the request body.", "summary": "Missing expected field error", "value": { "cadences": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, { "api_name": "id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "ExpectedFieldMissingResponse2": { "description": "Shows an error response when a second expected field is missing from the request body.", "summary": "Second expected field missing error", "value": { "cadences": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field.api_name" }, { "api_name": "id", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidDataResponse0": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "id": "111111000000070062", "json_path": "$.cadences[0].id" }, "message": "the given id seems to be invalid", "status": "error" } }, "InvalidDataResponse1": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "Name should not contain the following special character : #%^", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[0].reference_id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type", "supported_values": [ "tasks", "email_notifications", "schedule_call", "whatsapp_message_notification" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.cadences[0].FollowUp[0].action.id" }, "message": "the given actionid seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.cadences[0].FollowUp[0].action.id" }, "message": "Action is already associated with another rule", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].type", "supported_values": [ "static", "reference", "time_computed", "execution_time", "merge_field" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.cadences[0].follow_ups[1].execute_after.period", "supported_values": [ "minutes", "hours", "business_hours", "days", "business_days", "months" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.cadences[0].follow_ups[1].execute_after.unit" }, "message": "the value given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name", "maximum_length": 100 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.cadences[0].description", "maximum_length": 500 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].type", "supported_values": [ "custom_view", "manual_enrollment" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period", "supported_values": [ "immediately", "hours", "days", "weeks" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.cadences[0].execution_details.execute_every.unit" }, "message": "unit value must be between 1 to 99", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type", "supported_values": [ "automatic_unenroll", "end_date", "criteria", "followup_criteria" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unenroll_date", "json_path": "$.cadences[0].execution_details.unenroll_properties.unenroll_date" }, "message": "the given format is invalid please provide the value as MM/DD/YYYY", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataTypeResponse18": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse20": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse22": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse23": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse24": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse25": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse27": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_view", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.custom_view" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse28": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.custom_view.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse30": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execution_details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse32": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execute_every", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details.execute_every" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse33": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.execution_details.execute_every.period" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse35": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.cadences[*].cadences.execution_details.execute_every.unit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse36": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unenroll_properties", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse37": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse39": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties[*].details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse40": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "follow_ups", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse41": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "parent_follow_up", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].parent_follow_up" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse42": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].parent_follow_up.reference_id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse43": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].reference_id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse44": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "triggers", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups[*].triggers" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse46": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execute_after", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse47": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after.unit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse48": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after.period" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse52": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "action", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse53": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse55": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse56": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse57": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "layout", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse58": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse59": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout.name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse60": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse61": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse62": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse63": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse64": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse65": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse66": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse67": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "LimitExceededResponse3": { "description": "Shows an error response when the number of follow-up steps in a Cadence exceeds the allowed limit.", "summary": "Follow-up steps limit exceeded error", "value": { "cadences": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[2].type", "limit": 1 }, "message": "Given unenroll type limit is exceeded", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse10": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].follow_ups[1].action.details.module" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse11": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_mappings", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse12": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse13": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse14": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "unit", "json_path": "$.cadences[0].follow_ups[1].execute_after.unit" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse15": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "period", "json_path": "$.cadences[0].follow_ups[1].execute_after.period" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].module" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[0].reference_id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "parent_follow_up", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "action", "json_path": "$.cadences[0].follow_ups[0].action" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].follow_ups[1].action.details.module" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseWithCadenceAsHead" }, { "$ref": "#/components/schemas/AllErrorResponse" } ], "description": "Represents the error response for the bulk Cadence update operation.", "x-zs-$id": "CadencesCreateErrorResponseSchema" } } }, "description": "The request contains invalid or missing data.\n**Resolution:** All field values must be valid, required fields must be present, and the data types must be correct." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to update Cadences.", "summary": "No permission to update Cadences error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to update Cadences.\n**Resolution:** The CRM administrator must grant the required Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.UPDATE" ] } ], "summary": "Update multiple Cadences (bulk form)", "tags": [ "cadences" ], "x-zoho-document": "cadences", "x-zs-llm-description": "To remove a follow-up, include its id and set _delete to null. Editing a published cadence creates a draft on first save; the response returns a draft_cadence id - use that id for subsequent edits and call publish when changes are complete." } }, "/crm/v8/settings/automation/cadences/actions/count": { "get": { "description": "To retrieve the total number of follow-up actions configured for the specified CRM module across all Cadences in your Zoho CRM organization. The count includes tasks, emails, calls, and WhatsApp messages, and is used to enforce the edition-level per-module action count limit.", "operationId": "getCadenceModuleActionsCount", "parameters": [ { "description": "Specify the CRM module API name to retrieve the Cadence action count for.\nRefer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response returning the count of Cadence actions for the specified module.", "summary": "Successful Cadence module actions count response", "value": { "count": 15 } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for the count of Cadence module actions.", "properties": { "count": { "description": "Represents the total count of Cadence actions for the specified module.", "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "GetCadenceModuleActionsCountSuccessResp" } } }, "description": "Returns the total count of Cadence actions for the specified module." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleName": { "description": "Shows an error response when the provided module name is invalid or does not exist in Zoho CRM.", "summary": "Invalid module name error", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "RequiredModuleParamMissing": { "description": "Shows an error response when the required module query parameter is missing from the request.", "summary": "Missing module parameter error", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The request contains invalid data or the required **module** parameter is missing.\n**Resolution:** The **module** query parameter must be present and must specify a valid CRM module API name." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to access Cadence module actions.", "summary": "No permission to access Cadence module actions error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to access this resource, or the API is not supported for the selected domain.\n**Resolution:** The CRM administrator must grant the required Cadence permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.READ" ] } ], "summary": "Get Cadence module actions count", "tags": [ "cadences" ], "x-zoho-document": "cadences" } }, "/crm/v8/settings/automation/cadences/actions/records_count": { "get": { "description": "To retrieve the record counts for the specified Cadences from your Zoho CRM organization. For each Cadence ID supplied in the **ids** query parameter, the response returns the number of records currently associated with that Cadence. A maximum of 100 Cadence IDs can be supplied per request.", "operationId": "listCadencesRecordsCount", "parameters": [ { "$ref": "#/components/parameters/CadencesParamQueryIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response containing the record counts for the specified Cadences.", "summary": "Successful Cadence record counts response", "value": { "cadences_records_count": [ { "cadences": { "id": "111112000000092007", "name": "cadence" }, "count": 5 }, { "cadences": { "id": "111112000000092270", "name": "darft cadence" }, "count": 0 }, { "cadences": { "id": "111112000000094004", "name": "publish cadence" }, "count": 1 } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response containing a list of Cadence record count entries.", "properties": { "cadences_records_count": { "description": "Represents the list of Cadence record count entries in the success response.", "items": { "$ref": "#/components/schemas/CadencesRecordsCountSuccess" }, "maxItems": 100, "type": "array" } }, "required": [ "cadences_records_count" ], "type": "object", "x-zs-$id": "GetrecordscountResponse200" } } }, "description": "Returns the record counts for all specified Cadences." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Shows a partial success response where some Cadence record counts return successfully while others encounter errors.", "summary": "Partial Cadence record counts response", "value": { "cadences_records_count": [ { "cadences": { "id": "111112000000092007", "name": "cadence" }, "count": 5 }, { "code": "INVALID_DATA", "details": { "id": "111112000000092000" }, "message": "The id given seems to be invalid.", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/GetrecordscountResponse207" } } }, "description": "Returns a mixed response containing both successful and failed Cadence record count results." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows an error response when one or more provided Cadence IDs are invalid.", "summary": "Invalid Cadence ID error", "value": { "cadences_records_count": [ { "code": "INVALID_DATA", "details": { "id": "111112000000092001" }, "message": "The id given seems to be invalid.", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "111112000000092000" }, "message": "The id given seems to be invalid.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response when one or more Cadence record count retrievals fail.", "properties": { "cadences_records_count": { "description": "Represents the list of Cadence record operation results, including error details for failed entries.", "items": { "$ref": "#/components/schemas/AllErrorResponse" }, "maxItems": 25, "type": "array" } }, "required": [ "cadences_records_count" ], "type": "object", "x-zs-$id": "GetrecordscountResponse400Schema" } } }, "description": "The request contains an invalid Cadence ID.\n**Resolution:** All Cadence IDs provided in the **ids** parameter must be valid and must refer to existing Cadences in the Zoho CRM organization." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to retrieve Cadence record counts.", "summary": "No permission to retrieve Cadence record counts error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to access this resource, or the API is not supported for the selected domain.\n**Resolution:** The CRM administrator must grant the required Cadence permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.READ" ] } ], "summary": "Get Cadence records count", "tags": [ "cadences" ], "x-zoho-document": "cadences" } }, "/crm/v8/settings/automation/cadences/{id}": { "delete": { "description": "To delete a Cadence and its associated records from your Zoho CRM organization. Deleting a Cadence removes all related action records, including workflow tasks, email notifications, and WhatsApp notifications, as well as process states and flow transitions. Pending enrollment schedules are removed, but record-level enrollment history is retained.", "operationId": "deleteSingleCadence", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful deletion of a Cadence, returning the result code and the identifier of the deleted Cadence.", "summary": "Successful Cadence deletion response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "id": "111112000000092007" }, "message": "Cadences deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns a success response confirming the Cadence deletion." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows an error response when the provided Cadence ID is invalid, returning the INVALID_DATA code with the resource path index.", "summary": "Invalid Cadence ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the given id seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The request contains an invalid Cadence ID.\n**Resolution:** The Cadence ID in the URL path must be valid and must refer to an existing Cadence in the Zoho CRM organization." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to delete Cadences, specifying the missing permission.", "summary": "No permission to delete Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to delete Cadences.\n**Resolution:** The CRM administrator must grant the Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.DELETE" ] } ], "summary": "Delete a Cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences" }, "get": { "description": "To retrieve the configuration and details of a specific Cadence from your Zoho CRM organization. The response includes the follow-up action tree with server-resolved parent follow-up IDs, unenroll properties, Custom View configuration, and the current Cadence status.", "operationId": "getCadence", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response for retrieving a Cadence, returning its configuration details, follow-up action tree, and current status.", "summary": "Successful Cadence retrieval response", "value": { "cadences": [ { "created_by": { "id": "111112000000057662", "name": "Poongodi89 S" }, "created_time": "2025-11-07T14:52:24+00:00", "custom_view": { "id": "111112000000051112", "name": "All Leads" }, "description": "description", "draft_cadence": { "id": "111112000000092213", "name": "Draft Cadence" }, "execution_details": { "execute_every": { "period": "hours", "unit": 1 }, "unenroll_properties": [ { "details": null, "id": "111112000000092054", "type": "automatic_unenroll" }, { "details": { "unenroll_date": "2025-11-30" }, "id": "111112000000092056", "type": "end_date" }, { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue", "id": "111112000000004814" }, "type": "value", "value": "123" } }, "id": "111112000000092058", "type": "criteria" }, { "details": { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Subject", "id": "111112000000004066" }, "type": "value", "value": "teste" }, "specific": false, "state": null }, "type": "Tasks" }, "id": "111112000000092060", "type": "followup_criteria" }, { "details": { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Created_By", "id": "111112000000004224" }, "type": "value", "value": { "id": "111112000000057662", "name": "Poongodi89 S" } }, "specific": true, "state": { "id": "111112000000092010", "name": "FollowUp2" } }, "type": "Calls" }, "id": "111112000000092106", "type": "followup_criteria" } ] }, "follow_ups": [ { "action": { "associated": true, "created_by": { "id": "111112000000057662", "name": "Poongodi89 S" }, "created_time": "2025-11-07T15:10:47+05:30", "deletable": true, "editable": true, "feature_type": "cadences", "field_mappings": [ { "display_value": "task1", "field": { "api_name": "Subject", "id": "111112000000004066" }, "type": "static", "value": "task1" }, { "display_value": "Trigger Date plus 1 business day(s)", "field": { "api_name": "Due_Date", "id": "111112000000004068" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "1" } }, { "display_value": "Poongodi89 S", "field": { "api_name": "Owner", "id": "111112000000004064" }, "type": "static", "value": { "id": "111112000000057662", "name": "Poongodi89 S" } }, { "display_value": "Not Started", "field": { "api_name": "Status", "id": "111112000000004074" }, "type": "static", "value": "Not Started" }, { "display_value": "High", "field": { "api_name": "Priority", "id": "111112000000004076" }, "type": "static", "value": "High" } ], "id": "111112000000091250", "lock_status": { "locked": false }, "modified_by": { "id": "111112000000057662", "name": "Poongodi89 S" }, "modified_time": "2025-11-07T15:10:47+05:30", "module": { "api_name": "Leads", "id": "111112000000002628" }, "name": "task1", "notify": false, "related_details": null, "related_module": null, "source": "crm", "type": "tasks" }, "id": "111112000000092009", "parent_follow_up": null }, { "action": { "details": { "field_mappings": [ { "display_value": "Outbound", "field": { "api_name": "Call_Type", "id": "111112000000004208" }, "type": "static", "value": "Outbound" }, { "display_value": "Scheduled", "field": { "api_name": "Outgoing_Call_Status", "id": "111112000000004236" }, "type": "static", "value": "Scheduled" }, { "display_value": "Trigger Date plus 1 business day(s) 12:00 AM", "field": { "api_name": "Call_Start_Time", "id": "111112000000004216" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "time": "00:00", "trigger_field": "${CURRENTTIME}", "unit": "1" } }, { "display_value": "${CURRENTUSER}", "field": { "api_name": "Owner", "id": "111112000000004204" }, "type": "static", "value": { "name": "${CURRENTUSER}" } }, { "display_value": "Demo", "field": { "api_name": "Call_Purpose", "id": "111112000000004262" }, "type": "static", "value": "Demo" }, { "display_value": "test", "field": { "api_name": "Call_Agenda", "id": "111112000000004264" }, "type": "static", "value": "test" }, { "display_value": "test subject", "field": { "api_name": "Subject", "id": "111112000000004206" }, "type": "static", "value": "test subject" }, { "display_value": { "period": "minutes", "unit": "15" }, "field": { "api_name": "Reminder", "id": "111112000000004232" }, "type": "static", "value": { "period": "minutes", "unit": "15" } } ], "layout": { "id": "111112000000003660", "name": "Standard" }, "module": { "api_name": "Calls", "id": "111112000000002654" } }, "id": "111112000000092020", "name": "Calls", "type": "schedule_call" }, "execute_after": { "id": "111112000000092016", "period": "minutes", "unit": 10 }, "id": "111112000000092010", "parent_follow_up": { "id": "111112000000092009", "type": "tasks" }, "triggers": [ "Completed" ] } ], "id": "111112000000092007", "modified_by": { "id": "111112000000057662", "name": "Poongodi89 S" }, "modified_time": "2025-11-07T15:32:03+00:00", "module": { "api_name": "Leads", "id": "111112000000002628" }, "name": "cadence", "parent_cadence": { "id": "111112000000069836", "name": "Parent Cadence" }, "status": "inactive", "summary": { "call_follow_up_count": 1, "email_follow_up_count": 0, "task_follow_up_count": 1, "whatsapp_follow_up_count": 0 }, "type": "custom_view" } ] } } }, "schema": { "$ref": "#/components/schemas/GetByIdCadenceSuccessResp" } } }, "description": "Returns the details of the specified Cadence." }, "204": { "description": "Indicates no Cadence was found for the specified ID. The response body is empty." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to view Cadences, specifying the missing permission.", "summary": "No permission to retrieve Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to retrieve Cadences, or the API is not supported for the selected domain.\n**Resolution:** The CRM administrator must grant the required Cadence read permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.READ" ] } ], "summary": "Get a Cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences" }, "parameters": [ { "description": "Specify the unique identifier of the Cadence.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "put": { "description": "Partial-update form that takes the cadence id from the URL path. Same body shape and semantics as the bulk PUT variant (see PUT /settings/automation/cadences). module / type / custom_view cannot be changed after creation.", "operationId": "putUpdateCadence", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample Cadence update request body", "value": { "cadences": [ { "description": "description", "execution_details": { "unenroll_properties": [ { "details": {}, "type": "end_date" }, { "type": "automatic_unenroll" }, { "details": { "unenroll_date": "2025-11-30" }, "type": "end_date" }, { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue" }, "value": 123 } }, "type": "criteria" }, { "details": { "details": { "criteria": { "comparator": "equal", "field": { "api_name": "Subject", "id": "111112000000004066" }, "value": "teste" }, "specific": false, "state": null }, "type": "Tasks" }, "type": "followup_criteria" } ] }, "follow_ups": [ { "action": { "details": { "field_mappings": [ { "field": { "api_name": "Call_Type", "id": "111112000000004208" }, "type": "static", "value": "Outbound" } ], "layout": { "id": "111112000000003660", "name": "Standard" }, "module": { "api_name": "Calls", "id": "111112000000002654" } }, "id": "111112000000003660", "type": "schedule_call" }, "execute_after": { "period": "minutes", "unit": 10 }, "id": "111112000000106723", "parent_follow_up": { "id": "111112000000106722" }, "triggers": [ "Completed" ] }, { "action": { "id": "111112000000003661", "type": "email_notifications" }, "execute_after": { "period": "days", "unit": 1 }, "parent_follow_up": { "id": "111112000000106723" }, "reference_id": "{{Followup_3}}", "triggers": [ "Completed" ] } ], "id": "111112000000069836", "name": "cadence" } ] } } }, "schema": { "$ref": "#/components/schemas/CadencesUpdateRequestBody" } } }, "description": "The request body must contain a Cadences array with the updated configuration for the Cadence.", "x-zs-llm-examples": [ "SamplePutRequest" ] }, "responses": { "200": { "content": { "application/json": { "examples": { "DraftCadenceSuccess": { "description": "Shows a successful response after saving a Cadence in draft state.", "summary": "Successful Cadence draft save response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "draft_cadence": { "id": "111111000000070063" }, "id": "111111000000070062" }, "message": "Cadences updated successfully", "status": "success" } ] } }, "Success200": { "description": "Shows a successful response after updating a Cadence, returning the updated Cadence details.", "summary": "Successful Cadence update response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "id": "111112000000092007" }, "message": "Cadences updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns the updated Cadence details, confirming that the update was applied successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadyUsedResponse1": { "description": "Shows an error response when a field value is already in use by another resource.", "summary": "Field value already in use error", "value": { "cadences": [ { "code": "ALREADY_USED", "details": { "api_name": "triggers", "exists_in": { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, "json_path": "$.cadences[0].follow_ups[1].triggers[1]" }, "message": "trigger type is already given in the same request under different key", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse1": { "description": "Shows an error response when ambiguity occurs during request processing.", "summary": "Ambiguity during processing error", "value": { "cadences": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "specific", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.specific" }, { "api_name": "state", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.state" } ] }, "message": "invalid data", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse2": { "description": "Shows an error response when conflicting values cause ambiguity during processing.", "summary": "Conflicting values ambiguity error", "value": { "cadences": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[1]" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentFieldMissingResponse10": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.type" }, "json_path": "$.cadences[0].follow_ups[1].action.details" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse11": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "execute_after", "dependee": { "api_name": "triggers", "json_path": "$.cadences[0].follow_ups[1].triggers[0]" }, "json_path": "$.cadences[0].follow_ups[1].execute_after" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse12": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "unit", "dependee": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period" }, "json_path": "$.cadences[0].execution_details.execute_every.unit" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[0].details" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "unenroll_date", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[0].details.unenroll_date" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "id", "json_path": "$.cadences[0].execution_details.unenroll_properties[2].id" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[2].details.criteria" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse5": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.details" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse6": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "specific", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.specific" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse7": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "state", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.state" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse8": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "criteria", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.details.criteria" }, "message": "dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse9": { "description": "Shows an error response when a required dependent field is missing from the request body.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type" }, "json_path": "$.cadences[0].follow_ups[0].action.id" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Shows an error response when a dependent field value does not match the expected configuration.", "summary": "Dependent field value mismatch error", "value": { "cadences": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[3].type" }, "json_path": "$.cadences[0].execution_details.unenroll_properties[3].details.type", "supported_values": [ "tasks", "schedule_call", "email_notifications", "whatsapp_message_notification" ] }, "message": "Dependent Field is not matching", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Shows an error response when dependent field values are inconsistent with each other.", "summary": "Inconsistent dependent field values error", "value": { "cadences": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "triggers", "dependee": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, "json_path": "$.cadences[0].follow_ups[1].triggers[0]", "supported_values": [] }, "message": "dependent mismatch", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows an error response when a Cadence with the same name already exists.", "summary": "Duplicate Cadence name error", "value": { "cadences": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "A Cadences with the same name already exists", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "description": "Shows an error response when an expected field is missing from the request body.", "summary": "Missing expected field error", "value": { "cadences": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, { "api_name": "id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "ExpectedFieldMissingResponse2": { "description": "Shows an error response when a second expected field is missing from the request body.", "summary": "Second expected field missing error", "value": { "cadences": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field.api_name" }, { "api_name": "id", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidDataResponse0": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the given id seems to be invalid", "status": "error" } }, "InvalidDataResponse1": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "Name should not contain the following special character : #%^", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[0].reference_id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type", "supported_values": [ "tasks", "email_notifications", "schedule_call", "whatsapp_message_notification" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.cadences[0].FollowUp[0].action.id" }, "message": "the given actionid seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.cadences[0].FollowUp[0].action.id" }, "message": "Action is already associated with another rule", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].type", "supported_values": [ "static", "reference", "time_computed", "execution_time", "merge_field" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.cadences[0].follow_ups[1].execute_after.period", "supported_values": [ "minutes", "hours", "business_hours", "days", "business_days", "months" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.cadences[0].follow_ups[1].execute_after.unit" }, "message": "the value given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name", "maximum_length": 100 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.cadences[0].description", "maximum_length": 500 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period", "supported_values": [ "immediately", "hours", "days", "weeks" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.cadences[0].execution_details.execute_every.unit" }, "message": "unit value must be between 1 to 99", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[0].type", "supported_values": [ "automatic_unenroll", "end_date", "criteria", "followup_criteria" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unenroll_date", "json_path": "$.cadences[0].execution_details.unenroll_properties.unenroll_date" }, "message": "the given format is invalid please provide the value as MM/DD/YYYY", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows an error response when a field value does not conform to the expected format or constraints.", "summary": "Invalid field data value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up.reference_id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataTypeResponse18": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse20": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse22": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse23": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse24": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse25": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse27": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_view", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.custom_view" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse28": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.custom_view.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse30": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execution_details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse32": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execute_every", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details.execute_every" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse33": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.execution_details.execute_every.period" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse35": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.cadences[*].cadences.execution_details.execute_every.unit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse36": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unenroll_properties", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse37": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse39": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details.unenroll_properties[*].details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse40": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "follow_ups", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse41": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "parent_follow_up", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].parent_follow_up" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse42": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].parent_follow_up.reference_id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse43": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_id", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].reference_id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse44": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "triggers", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups[*].triggers" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse46": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execute_after", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse47": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after.unit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse48": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].execute_after.period" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse52": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "action", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse53": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse55": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse56": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse57": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "layout", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse58": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse59": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.layout.name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse60": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse61": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse62": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse63": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "expected_data_type": "jsonarray", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse64": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse65": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse66": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse67": { "description": "Shows an error response when a field contains a value of an invalid data type.", "summary": "Invalid field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.follow_ups[*].action.details.field_mappings[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "LimitExceededResponse3": { "description": "Shows an error response when the number of follow-up steps in a Cadence exceeds the allowed limit.", "summary": "Follow-up steps limit exceeded error", "value": { "cadences": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "type", "json_path": "$.cadences[0].execution_details.unenroll_properties[2].type", "limit": 1 }, "message": "Given unenroll type limit is exceeded", "status": "error" } ] } }, "MandatoryNotFoundResponse10": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "layout", "json_path": "$.cadences[0].follow_ups[1].action.details.layout" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse11": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_mappings", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse12": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].field" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse13": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[1].action.details.field_mappings[0].type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse14": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "unit", "json_path": "$.cadences[0].follow_ups[1].execute_after.unit" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse15": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "period", "json_path": "$.cadences[0].follow_ups[1].execute_after.period" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_id", "json_path": "$.cadences[0].follow_ups[0].reference_id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "parent_follow_up", "json_path": "$.cadences[0].follow_ups[1].parent_follow_up" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "action", "json_path": "$.cadences[0].follow_ups[0].action" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].follow_ups[0].action.type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Shows an error response when a required field is missing from the request body.", "summary": "Missing required field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].follow_ups[1].action.details.module" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseWithCadenceAsHead" }, { "$ref": "#/components/schemas/AllErrorResponse" } ], "description": "Represents the error response for the Cadence update operation.", "x-zs-$id": "CadencesUpdateErrorResponseSchema" } } }, "description": "The request contains invalid or missing data.\n**Resolution:** All field values must be valid, required fields must be present, and the data types must be correct." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to update Cadences.", "summary": "No permission to update Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to update Cadences.\n**Resolution:** The CRM administrator must grant the required Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.UPDATE" ] } ], "summary": "Cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences" } }, "/crm/v8/settings/automation/cadences/{id}/actions/activate": { "parameters": [ { "description": "Specify the unique identifier of the Cadence to activate.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "post": { "description": "Activates a published cadence so it begins enrolling records. The cadence must currently be inactive; otherwise, the ALREADY_ACTIVATED error is returned. Edition limits are enforced, including the maximum number of active cadences per module and the total number of active cadences. For custom_view cadences, activation subscribes to the email engagement triggers required for signal-based follow-ups.", "operationId": "postActivate", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample activate request body", "value": {} } }, "schema": { "$ref": "#/components/schemas/PutactivateRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body for this operation is optional and can be sent as an empty object." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful activation of a Cadence, returning the result code and identifier of the activated Cadence.", "summary": "Successful Cadence activation response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "id": "111112000000092007" }, "message": "Cadences activated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns a success response confirming the Cadence was activated." }, "400": { "content": { "application/json": { "examples": { "AlreadyActivatedResponse1": { "description": "Shows an error response when the Cadence is already in an activated state.", "summary": "Cadence already activated error", "value": { "code": "ALREADY_ACTIVATED", "details": { "resource_path_index": 3 }, "message": "The cadences is already activated", "status": "error" } }, "InvalidDataResponse1": { "description": "Shows an error response when the provided Cadence ID is invalid.", "summary": "Invalid Cadence ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the given id seems to be invalid", "status": "error" } }, "LimitExceededResponse1": { "description": "Shows an error response when the configured action count exceeds the allowed limit.", "summary": "Action count limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 70 }, "message": " action Configured more than allowed limit", "status": "error" } }, "LimitExceededResponse2": { "description": "Shows an error response when the number of activated Cadences for a module exceeds the allowed limit.", "summary": "Cadences per module activation limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 30 }, "message": "More than 30 Cadences cannot be activated for module", "status": "error" } }, "LimitExceededResponse3": { "description": "Shows an error response when the total number of activated Cadences exceeds the organization limit.", "summary": "Total Cadence activation limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 150 }, "message": "More than 150 Cadences cannot be activated", "status": "error" } }, "NotAllowedResponse1": { "description": "Shows an error response when the task action is not supported in the current edition.", "summary": "Task action not supported error", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Task Action Not Supported in this Edition", "status": "error" } }, "NotAllowedResponse2": { "description": "Shows an error response when the associated Custom View is not available.", "summary": "Custom view not available error", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Associated Custom View is not available", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The request contains invalid data, or the Cadence cannot be activated due to its current state, edition restrictions, or limit violations.\n**Resolution:** The Cadence ID must be valid, the Cadence must be in a valid state for activation, and activation limits must not be exceeded." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to activate Cadences.", "summary": "No permission to activate Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to activate Cadences.\n**Resolution:** The CRM administrator must grant the required Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.CREATE" ] } ], "summary": "Activate Cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences" } }, "/crm/v8/settings/automation/cadences/{id}/actions/analytics": { "get": { "description": "To retrieve per-follow-up execution statistics for the specified Cadence in your Zoho CRM organization. Each follow-up element returns an analytics payload whose structure depends on its action type: tasks (open, completed, and failed counts), schedule_call (created, scheduled, completed, missed, cancelled, overdue, and failed counts), email_notifications (sent, opened, clicked, replied, bounced, unsubscribed, and unsent counts), and whatsapp_message_notification (delivered and failed counts). Use the **filters** parameter to restrict results to a single action type, and the **follow_ups_executed_from** and **follow_ups_executed_till** parameters to restrict to a time range.", "operationId": "getCadenceAnalytics", "parameters": [ { "description": "Specify the unique identifier of the Cadence for which you want to retrieve analytics.", "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "string" } }, { "description": "Specifies the filter criteria to narrow the analytics results by follow-up action type and value.", "in": "query", "name": "filters", "schema": { "additionalProperties": false, "description": "Represents the filter criteria schema for retrieving Cadence analytics, including the field, comparator, and value to filter by.", "properties": { "comparator": { "description": "Specify the comparison operator for the filter.\nPossible values:\n**between** - Filters records within a specified range.", "enum": [ "between" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the filter condition, including the api_name and value fields.", "properties": { "api_name": { "description": "Specify the field name to filter analytics by.\nPossible values:\nfollow_ups.action.type - Filters analytics by the follow-up action type.", "enum": [ "follow_ups.action.type" ], "type": "string" } }, "type": "object" }, "value": { "description": "Specify the list of values to filter by.\nPossible values:\ntasks - Filters follow-ups with task actions.\nemail_notifications - Filters follow-ups with email notification actions.\nschedule_call - Filters follow-ups with scheduled call actions.\nwhatsapp_message_notification - Filters follow-ups with WhatsApp message actions.", "enum": [ "tasks", "email_notifications", "schedule_call", "whatsapp_message_notification" ], "maxLength": 500, "type": "string" } }, "type": "object" } }, { "description": "Specifies the start date from which to retrieve follow-up execution analytics, in ISO 8601 format.", "in": "query", "name": "follow_ups_executed_from", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Specifies the end date until which to retrieve follow-up execution analytics, in ISO 8601 format.", "in": "query", "name": "follow_ups_executed_till", "required": false, "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response containing Cadence analytics data with follow-up metrics for each step.", "summary": "Successful Cadence analytics response", "value": { "cadences": [ { "created_by": { "id": "111112000000057662", "name": "Poongodi89 S" }, "follow_ups": [ { "action": { "name": "task1", "type": "tasks" }, "analytics": { "completed_tasks_count": 0, "failed_tasks_count": 0, "open_tasks_count": 1, "subject": "task1", "tasks_count": 1 }, "id": "111112000000094014", "parent_follow_up": null }, { "action": { "name": "Demo", "type": "schedule_call" }, "analytics": { "calls_count": 1, "cancelled_calls_count": 0, "completed_calls_count": 0, "created_calls_count": 0, "failed_calls_count": 0, "missed_calls_count": 0, "overdue_calls_count": 0, "scheduled_calls_count": 1, "subject": "Call scheduled with test" }, "id": "111112000000094026", "parent_follow_up": { "id": "111112000000094014", "type": "tasks" } }, { "action": { "name": "1", "template": { "id": "111112000000080016", "name": "Template" }, "type": "email_notifications" }, "analytics": { "bounced_email_count": 0, "clicked_email_count": 0, "email_count": 0, "opened_email_count": 0, "replied_email_count": 0, "sent_email_count": 0, "unsent_email_count": 1 }, "id": "111112000000094048", "parent_follow_up": { "id": "111112000000094026", "type": "schedule_call" } }, { "action": { "id": "111111000000115279", "message_template": { "id": "111111000000115032", "title": "templatewhtsapp" }, "name": "cad whtsapp", "type": "whatsapp_message_notification" }, "analytics": { "delivered_whatsapp_count": 0, "failed_whatsapp_count": 0, "whatsapp_count": 0 }, "id": "111111000000115111", "parent_follow_up": { "id": "111111000000115093", "type": "email_notifications" } } ], "id": "111112000000094004", "module": { "api_name": "Leads", "id": "111112000000002628" }, "name": "publish cadence" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the analytics response for a Cadence, containing a list of Cadences and their follow-up analytics data.", "properties": { "cadences": { "description": "Represents the list of Cadences with their follow-up analytics data.", "items": { "additionalProperties": false, "description": "Represents the analytics data for a single Cadence, including follow-up details and metrics.", "properties": { "created_by": { "$ref": "#/components/schemas/CreatorInfo" }, "follow_ups": { "description": "Represents the list of follow-up steps in the Cadence, each containing action details and execution analytics.", "items": { "additionalProperties": false, "description": "Indicates a single follow-up step in the Cadence.", "properties": { "action": { "additionalProperties": false, "description": "Represents the action configured for the follow-up step.", "properties": { "id": { "description": "Represents the unique identifier of the action.", "maxLength": 255, "type": "string" }, "message_template": { "additionalProperties": false, "description": "Represents the message template associated with the email or WhatsApp action.", "properties": { "id": { "description": "Represents the unique identifier of the message template.", "maxLength": 255, "type": "string" }, "title": { "description": "Represents the title of the message template.", "maxLength": 255, "type": "string" } }, "type": "object" }, "name": { "description": "Represents the name of the action.", "maxLength": 255, "type": "string" }, "template": { "additionalProperties": false, "description": "Represents the Email Template configured for the action.", "properties": { "id": { "description": "Represents the unique identifier of the Email Template.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the Email Template.", "maxLength": 255, "type": "string" } }, "type": "object" }, "type": { "description": "Represents the type of action configured for the follow-up step.", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "type": "object" }, "analytics": { "anyOf": [ { "additionalProperties": false, "description": "Specifies the analytics data for a task-type follow-up action.", "properties": { "completed_tasks_count": { "description": "The number of tasks that were completed.", "format": "int32", "type": "integer" }, "failed_tasks_count": { "description": "Represents the number of tasks that failed to execute.", "format": "int32", "type": "integer" }, "open_tasks_count": { "description": "Represents the number of tasks that are currently open.", "format": "int32", "type": "integer" }, "subject": { "description": "Represents the subject of the task action.", "maxLength": 255, "type": "string" }, "tasks_count": { "description": "Represents the total number of tasks generated by the follow-up action.", "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "TasksAnalytics" }, { "additionalProperties": false, "description": "Represents the analytics data for a scheduled call-type follow-up action.", "properties": { "calls_count": { "description": "Represents the total number of calls generated by the follow-up action.", "format": "int32", "type": "integer" }, "cancelled_calls_count": { "description": "Represents the number of calls that were cancelled.", "format": "int32", "type": "integer" }, "completed_calls_count": { "description": "Represents the number of calls that were completed.", "format": "int32", "type": "integer" }, "created_calls_count": { "description": "Represents the number of calls that were created.", "format": "int32", "type": "integer" }, "failed_calls_count": { "description": "Represents the number of calls that failed to execute.", "format": "int32", "type": "integer" }, "missed_calls_count": { "description": "Represents the total number of missed calls.", "format": "int32", "type": "integer" }, "overdue_calls_count": { "description": "Represents the total number of calls that are overdue.", "format": "int32", "type": "integer" }, "scheduled_calls_count": { "description": "Represents the number of calls that are currently scheduled.", "format": "int32", "type": "integer" }, "subject": { "description": "Indicates the subject of the scheduled call action.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "CallsAnalytics" }, { "additionalProperties": false, "description": "The analytics metrics related to an email notification-type follow-up action.", "properties": { "bounced_email_count": { "description": "Represents the number of emails that bounced.", "format": "int32", "type": "integer" }, "clicked_email_count": { "description": "Represents the number of emails where at least one link was clicked.", "format": "int32", "type": "integer" }, "email_count": { "description": "Represents the total number of emails sent by the follow-up action.", "format": "int32", "type": "integer" }, "opened_email_count": { "description": "Represents the number of emails that were opened by recipients.", "format": "int32", "type": "integer" }, "replied_email_count": { "description": "Represents the number of emails that received a reply.", "format": "int32", "type": "integer" }, "sent_email_count": { "description": "Represents the number of emails that were successfully sent.", "format": "int32", "type": "integer" }, "unsent_email_count": { "description": "Represents the number of emails that were not sent.", "format": "int32", "type": "integer" }, "unsubscribed_email_count": { "description": "Represents the number of recipients who unsubscribed after receiving the email.", "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "EmailAnalytics" }, { "additionalProperties": false, "description": "Represents the analytics data for a WhatsApp message-type follow-up action.", "properties": { "delivered_whatsapp_count": { "description": "Represents the number of WhatsApp messages that were delivered.", "format": "int32", "type": "integer" }, "failed_whatsapp_count": { "description": "Represents the number of WhatsApp messages that failed to deliver.", "format": "int32", "type": "integer" }, "whatsapp_count": { "description": "Represents the total number of WhatsApp messages sent by the follow-up action.", "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "WhatsappAnalytics" } ], "description": "Represents the execution metrics for the follow-up action, including counts based on the action type." }, "follow_up_number": { "description": "Represents the sequential number of the follow-up step within the Cadence.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the follow-up step.", "maxLength": 255, "type": "string" }, "parent_follow_up": { "description": "Represents the identifier of the parent follow-up step, if this is a conditional branch.", "type": [ "object", "null" ] } }, "title": "Follow-Up Details", "type": "object" }, "maxItems": 100, "type": "array" }, "id": { "$ref": "#/components/schemas/CadenceID" }, "module": { "$ref": "#/components/schemas/ModuleInformation" }, "name": { "$ref": "#/components/schemas/CadenceName" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "title": "Cadence Analytics Response", "type": "object", "x-zs-$id": "GetAnalyticsResponse" } } }, "description": "Returns the analytics data for the specified Cadence, including follow-up metrics grouped by action type." }, "400": { "content": { "application/json": { "examples": { "ComparatorNotSupported": { "description": "Shows an error response when the specified comparator value is not supported.", "summary": "Unsupported comparator value error", "value": { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "comparator", "dependee": { "api_name": "api_name", "json_path": "$.field.api_name" }, "json_path": "$.comparator", "param_name": "filters", "supported_values": [ "equal" ] }, "message": "The value given seems to be invalid", "status": "error" } }, "FiltersApiNameInvalidDataType": { "description": "Shows an error response when the filters api_name field contains an invalid data type.", "summary": "Invalid data type for filters api_name error", "value": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field.api_name", "param_name": "filters", "supported_values": [ "follow_ups.action.type" ] }, "message": "invalid data", "status": "error" } }, "FiltersComparatorMissing": { "description": "Shows an error response when the required comparator field is missing from the filters parameter.", "summary": "Missing comparator in filters error", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.field" }, "json_path": "$.comparator", "param_name": "filters" }, "message": "dependent field is missing", "status": "error" } }, "FiltersFieldMissing": { "description": "Shows an error response when the required field object is missing from the filters parameter.", "summary": "Missing field in filters error", "value": { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "field", "json_path": "$.field" } ] }, "message": "Specify atleast one field", "status": "error" } }, "FiltersMandatorynotFound": { "description": "Shows an error response when a mandatory field in the filters parameter is not found.", "summary": "Mandatory field not found in filters error", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.field.api_name", "param_name": "filters" }, "message": "required field not found", "status": "error" } }, "FiltersValueMissing": { "description": "Shows an error response when the required value field is missing from the filters parameter.", "summary": "Missing value in filters error", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "value", "dependee": { "api_name": "field", "json_path": "$.field" }, "json_path": "$.value", "param_name": "filters" }, "message": "dependent field is missing", "status": "error" } }, "FiltersValueNotSupported": { "description": "Shows an error response when the specified filter value is not supported.", "summary": "Unsupported filter value error", "value": { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "api_name", "json_path": "$.field.api_name" }, "json_path": "$.value", "param_name": "filters", "supported_values": [ "tasks", "schedule_call", "email_notifications", "whatsapp_message_notification" ] }, "message": "The value given seems to be invalid", "status": "error" } }, "InvalidCadenceId": { "description": "Shows an error response when the provided Cadence ID is invalid or does not exist.", "summary": "Invalid Cadence ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the given id seems to be invalid", "status": "error" } }, "InvalidDataResponse1": { "description": "Shows an error response when the filters parameter contains invalid data.", "summary": "Invalid filter data error", "value": { "code": "INVALID_DATA", "details": { "param_name": "follow_ups_executed_from" }, "message": "The given from param is invalid", "status": "error" } }, "InvalidDataType": { "description": "Shows an error response when the filters parameter contains an invalid data type.", "summary": "Invalid data type in filters error", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "datetime", "param_name": "follow_ups_executed_from" }, "message": "invalid data type", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "Shows an error response when the required api_name field is missing from the filters field object.", "summary": "Missing api_name in field error", "value": { "code": "DEPENDENT_PARAM_MISSING", "details": { "dependee": { "param_name": "follow_ups_executed_till" }, "param_name": "follow_ups_executed_from" }, "message": "Dependent Param missing", "status": "error" } }, "MandatoryNotFoundResponse2": { "description": "Shows an error response when the required filters parameter itself is missing.", "summary": "Missing filters parameter error", "value": { "code": "DEPENDENT_PARAM_MISSING", "details": { "dependee": { "param_name": "follow_ups_executed_from" }, "param_name": "follow_ups_executed_till" }, "message": "Dependent Param missing", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The request contains invalid or missing filter parameters.\n**Resolution:** All required filter fields must be present and their values must conform to the supported options." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to view Cadence analytics.", "summary": "No permission to view Cadence analytics error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to view Cadence analytics.\n**Resolution:** The CRM administrator must grant the required Cadence read permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.READ" ] } ], "summary": "Get Cadence analytics", "tags": [ "cadences" ], "x-zoho-document": "cadences", "x-zs-llm-description": "Pass filters as a JSON object with field.api_name set to follow_ups.action.type and value set to the desired action type. Use follow_ups_executed_from and follow_ups_executed_till (ISO 8601 datetime strings) to scope the time window. The response follow_ups array contains one element per follow-up with an analytics object keyed to its action type." } }, "/crm/v8/settings/automation/cadences/{id}/actions/clone": { "parameters": [ { "description": "Specify the unique identifier of the Cadence to clone.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "post": { "description": "Creates a new cadence with the same follow-up tree as the source cadence (identified by path id) but with the name / description / custom_view supplied in the body. Every follow-up action is copied into a new action record - the clone has no shared rows with the source. The new cadence starts in draft status and must be published before it can enroll records.", "operationId": "postCloneCadences", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample clone Cadence request body", "value": { "cadences": [ { "custom_view": { "id": "111112000000051112" }, "description": "description", "execution_details": { "execute_every": { "period": "hours", "unit": 1 } }, "module": { "api_name": "Leads", "id": "111112000000002628" }, "name": "cadence", "type": "custom_view" } ] } } }, "schema": { "$ref": "#/components/schemas/CadencesCloneRequestBody" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain a Cadences array with the configuration details for the cloned Cadence." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Shows a successful response after cloning a Cadence, returning the identifier of the newly created Cadence.", "summary": "Successful Cadence clone response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "id": "111112000000092007" }, "message": "Cadences cloned successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns the details of the newly cloned Cadence, including its unique identifier." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows an error response when a required dependent field is missing from the request.", "summary": "Missing required dependent field error", "value": { "cadences": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "custom_view", "dependee": { "api_name": "type", "json_path": "$.cadences[0].type" }, "json_path": "$.cadences[0].custom_view" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows an error response when a Cadence with the same name already exists.", "summary": "Duplicate Cadence name error", "value": { "cadences": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "A Cadences with the same name already exists", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows an error response when the Cadence name contains invalid characters.", "summary": "Invalid Cadence name error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "Name should not contain the following special character : #%^", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an error response when the Cadence name exceeds the maximum allowed length.", "summary": "Cadence name too long error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.cadences[0].name", "maximum_length": 100 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an error response when the Cadence description exceeds the maximum allowed length.", "summary": "Cadence description too long error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.cadences[0].description", "maximum_length": 500 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows an error response when the Cadence type value is invalid.", "summary": "Invalid Cadence type value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.cadences[0].type", "supported_values": [ "custom_view", "manual_enrollment" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an error response when the execution period value is invalid.", "summary": "Invalid execution period value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period", "supported_values": [ "immediately", "hours", "days", "weeks" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an error response when the execution unit value is out of the allowed range.", "summary": "Invalid execution unit value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "json_path": "$.cadences[0].execution_details.execute_every.unit" }, "message": "unit value must be between 1 to 99", "status": "error" } ] } }, "InvalidDataTypeResponse18": { "description": "Shows an error response when the name field contains an invalid data type.", "summary": "Invalid name field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse20": { "description": "Shows an error response when the description field contains an invalid data type.", "summary": "Invalid description field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse22": { "description": "Shows an error response when the module field contains an invalid data type.", "summary": "Invalid module field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse23": { "description": "Shows an error response when the api_name field contains an invalid data type.", "summary": "Invalid api_name field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse24": { "description": "Shows an error response when the module ID field contains an invalid data type.", "summary": "Invalid module ID field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse25": { "description": "Shows an error response when the type field contains an invalid data type.", "summary": "Invalid type field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse27": { "description": "Shows an error response when the custom_view field contains an invalid data type.", "summary": "Invalid custom_view field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_view", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.custom_view" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse28": { "description": "Shows an error response when the custom_view ID field contains an invalid data type.", "summary": "Invalid Custom View ID data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.cadences[*].cadences.custom_view.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse30": { "description": "Shows an error response when the execute_every field contains an invalid data type.", "summary": "Invalid execute_every field data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execution_details", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse32": { "description": "Shows an error response when the execute_every period field contains an invalid data type.", "summary": "Invalid execute_every period data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "execute_every", "expected_data_type": "jsonobject", "json_path": "$.cadences[*].cadences.execution_details.execute_every" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse33": { "description": "Shows an error response when the execute_every period value contains an invalid data type.", "summary": "Invalid execute_every period value error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "expected_data_type": "text", "json_path": "$.cadences[*].cadences.execution_details.execute_every.period" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTypeResponse35": { "description": "Shows an error response when the execute_every unit field contains an invalid data type.", "summary": "Invalid execute_every unit data type error", "value": { "cadences": [ { "code": "INVALID_DATA", "details": { "api_name": "unit", "expected_data_type": "integer", "json_path": "$.cadences[*].cadences.execution_details.execute_every.unit" }, "message": "Invalid data type", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows an error response when the total number of Cadences in the module exceeds the allowed limit.", "summary": "Cadences per module limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "api_name": "id", "limit": 60 }, "message": "More than 60 Cadences cannot be created for module", "status": "error" } }, "LimitExceededResponse2": { "description": "Shows an error response when the total number of Cadences in the organization exceeds the allowed limit.", "summary": "Total Cadences limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "api_name": "id", "limit": 150 }, "message": "More than 150 Cadences cannot be created", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "Shows an error response when the required name field is missing from the request body.", "summary": "Missing required name field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.cadences[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows an error response when the required module field is missing from the request body.", "summary": "Missing required module field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.cadences[0].module" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows an error response when the required type field is missing from the request body.", "summary": "Missing required type field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.cadences[0].type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows an error response when the required period field is missing in the execution details.", "summary": "Missing required period field error", "value": { "cadences": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "period", "json_path": "$.cadences[0].execution_details.execute_every.period" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseWithCadenceAsHead" }, { "$ref": "#/components/schemas/AllErrorResponse" } ], "description": "Represents the error response for the Cadence clone operation.", "x-zs-$id": "CadencesCloneErrorResponse" } } }, "description": "The request contains invalid or missing data.\n**Resolution:** All required fields must be included in the request body, field values must conform to the expected format, and the Cadence count limits must not be exceeded." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to clone Cadences.", "summary": "No permission to clone Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to clone Cadences.\n**Resolution:** The CRM administrator must grant the required Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.CREATE" ] } ], "summary": "Clone a Cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences" } }, "/crm/v8/settings/automation/cadences/{id}/actions/deactivate": { "parameters": [ { "description": "Specify the unique identifier of the Cadence to deactivate.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "post": { "description": "To deactivate a Cadence in your Zoho CRM organization. The Cadence must currently be active; attempting to deactivate an already inactive Cadence returns the ALREADY_DEACTIVATED error.", "operationId": "postDeactivate", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful deactivation of a Cadence, returning the result code and identifier of the deactivated Cadence.", "summary": "Successful Cadence deactivation response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "id": "111112000000092007" }, "message": "Cadences deactivated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns a success response confirming the Cadence was deactivated." }, "400": { "content": { "application/json": { "examples": { "AlreadyDeactivatedResponse1": { "description": "Shows an error response when the Cadence is already in a deactivated state.", "summary": "Cadence already deactivated error", "value": { "code": "ALREADY_DEACTIVATED", "details": {}, "message": "The cadences is already deactivated", "status": "error" } }, "InvalidDataResponse1": { "description": "Shows an error response when the provided Cadence ID is invalid.", "summary": "Invalid Cadence ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the given id seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The request contains invalid data or the Cadence is already in a deactivated state.\n**Resolution:** The Cadence ID must be valid, and the Cadence must currently be in an active state before it can be deactivated." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to deactivate Cadences, specifying the missing permission.", "summary": "No permission to deactivate Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to deactivate Cadences.\n**Resolution:** The CRM administrator must grant the required Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.CREATE" ] } ], "summary": "Deactivate a Cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences" } }, "/crm/v8/settings/automation/cadences/{id}/actions/publish": { "parameters": [ { "description": "Specify the unique identifier of the Cadence to publish.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "post": { "description": "Publishes a draft cadence by merging its follow-up tree, transitions, and triggers into the live cadence, and then clears the draft. If the cadence is being published for the first time, it is promoted from a draft to an inactive published cadence. Call the Activate Cadence API separately to begin enrolling records. Before publishing, ensure the cadence contains at least one follow-up and complies with the action count and active cadence limits. When the enrollment type is `custom_view`, the `process_existing_records` parameter determines whether records that already match the custom view are enrolled at the time of publication.", "operationId": "postPublish", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequestCustomView": { "summary": "Sample publish request with process existing records", "value": { "cadences": [ { "process_existing_records": true } ] } }, "SamplePutRequestManualType": { "description": "Shows a minimal request body for publishing a Cadence without additional configuration.", "summary": "Sample minimal publish request", "value": { "cadences": [] } } }, "schema": { "$ref": "#/components/schemas/PutpublishRequest" }, "x-zs-llm-examples": [ "SamplePutRequestCustomView", "SamplePutRequestManualType" ] } }, "description": "The request body must contain a Cadences array with the publishing configuration for each Cadence." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful publish of a Cadence, returning the result code and identifier of the published Cadence.", "summary": "Successful Cadence publish response", "value": { "cadences": [ { "code": "SUCCESS", "details": { "id": "111112000000092007" }, "message": "Cadences published successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponse200" } } }, "description": "Returns a success response confirming the Cadence was published." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows an error response when the provided Cadence ID is invalid.", "summary": "Invalid Cadence ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the given id seems to be invalid", "status": "error" } }, "InvalidKeyInRequestBody": { "description": "Shows an error response when the process_existing_records key is provided for a Cadence with manual enrollment type.", "summary": "Invalid key in request body error", "value": { "cadences": [ { "code": "NOT_ALLOWED", "details": { "api_name": "process_existing_records", "json_path": "$.cadences[0].process_existing_records" }, "message": "For manual Enrollment we wont add process_existing_records key not allowed", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows an error response when the configured action count exceeds the allowed limit.", "summary": "Action count limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 70 }, "message": " action Configured more than allowed limit", "status": "error" } }, "LimitExceededResponse2": { "description": "Shows an error response when the number of activated Cadences for a module exceeds the allowed limit.", "summary": "Cadences per module activation limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 30 }, "message": "More than 30 Cadences cannot be activated for module", "status": "error" } }, "LimitExceededResponse3": { "description": "Shows an error response when the total number of activated Cadences exceeds the organization limit.", "summary": "Total Cadence activation limit exceeded error", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 150 }, "message": "More than 150 Cadences cannot be activated", "status": "error" } }, "NotAllowedResponse1": { "description": "Shows an error response when attempting to merge published Cadences, which is not permitted.", "summary": "Cannot merge published Cadences error", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Cannot merge published Cadences / Only Cadences in draft can be merged with its parent", "status": "error" } }, "NotAllowedResponse2": { "description": "Shows an error response when the Cadence does not contain any follow-up actions.", "summary": "No follow-up actions in Cadence error", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Cadence must contain at least one follow-up to publish", "status": "error" } }, "NotAllowedResponse3": { "description": "Shows an error response when the task action is not supported in the current edition.", "summary": "Task action not supported error", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Task Action Not Supported in this Edition", "status": "error" } }, "NotSupportedResponse1": { "description": "Shows an error response when the Custom View criteria contain unsupported fields.", "summary": "Custom view unsupported fields error", "value": { "code": "NOT_SUPPORTED", "details": {}, "message": "The custom_view contains unsupported fields in the criteria", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AllErrorResponse" }, { "$ref": "#/components/schemas/ErrorResponseWithCadenceAsHead" } ], "description": "Represents the error response for the Cadence publish operation, containing either a standard error or a per-Cadence error response.", "x-zs-$id": "CadencesPublishErrorResponseSchema" } } }, "description": "Returned when the request contains invalid data, or when the\nCadence cannot be published due to its current state, edition restrictions,\nlimit violations, or unsupported configuration.\\n**Resolution:** The Cadence\nID must be valid, at least one follow-up action must be configured, and\nall publishing requirements must be met." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows an error response when the user lacks permission to publish Cadences.", "summary": "No permission to publish Cadence error", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Cadences" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AllErrorResponse" } } }, "description": "The user does not have permission to publish Cadences.\n**Resolution:** The CRM administrator must grant the required Cadence management permission to the user's profile, and a new access token must be generated with the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.cadences.CREATE" ] } ], "summary": "Publish a Cadence", "tags": [ "cadences" ], "x-zoho-document": "cadences", "x-zs-llm-description": "The request body cadences array should be empty ([]) for manual-type cadences; for custom-view cadences, include a single element with process_existing_records: true to enroll records already in the view at publish time. After the first publish, the cadence is inactive - call the activate endpoint to begin enrolling records." } }, "/crm/v8/settings/automation/field_updates": { "delete": { "description": "Deletes multiple Field Update actions specified by their IDs. Specify the action IDs as a comma-separated list using the ids query parameter. You can delete a maximum of 10 actions in a single request. Field Update actions associated with active automation rules or marked as read-only cannot be deleted. Use the Get Field Updates API to retrieve the Field Update IDs. The response includes the success or failure status for each specified ID. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to get the Field Update IDs.", "operationId": "deleteFieldUpdates", "parameters": [ { "$ref": "#/components/parameters/FieldUpdatesParamQueryIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "BulkDeleteAllSuccess": { "summary": "All requested field updates deleted successfully", "value": { "field_updates": [ { "code": "SUCCESS", "details": { "id": "111111000000090003" }, "message": "field update deleted successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111111000000090007" }, "message": "field update deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkDeleteSuccessResponse" } } }, "description": "Bulk delete completed successfully for all requested field update IDs." }, "207": { "content": { "application/json": { "examples": { "BulkDeleteMixedResult": { "summary": "Mixed response - one invalid ID, one success, one associated field update", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "id": "111111000000090003" }, "message": "the id given seems to be invalid", "status": "error" }, { "code": "SUCCESS", "details": { "id": "111111000000081106" }, "message": "field update deleted successfully", "status": "success" }, { "code": "NOT_ALLOWED", "details": { "id": "111111000000064003" }, "message": "This field update is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkDeleteMixedResponse" } } }, "description": "Bulk delete completed with mixed results. Some IDs were deleted successfully while others failed with INVALID_DATA or NOT_ALLOWED." }, "400": { "content": { "application/json": { "examples": { "BulkDeleteAllFailed": { "summary": "All provided IDs failed - mix of invalid IDs and associated field updates", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "id": "111111000000199637" }, "message": "the id given seems to be invalid", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "111111000000227042" }, "message": "the id given seems to be invalid", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "111111000000129018" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "IdsLimitExceededResponse": { "summary": "Error when more than 10 IDs are provided in the ids parameter", "value": { "code": "INVALID_DATA", "details": { "maximum_length": 10, "param_name": "ids" }, "message": "Ids maximum length exceeded", "status": "error" } }, "IdsMissingResponse": { "summary": "Error when the required ids query parameter is not provided", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MissingDeleteIdParameterError", "x-zs-$id": "BulkDeleteRequiredParamMissingRef" }, { "$ref": "#/components/schemas/BulkDeleteErrorResponse", "x-zs-$id": "BulkDeleteErrorResponseRef" }, { "$ref": "#/components/schemas/IdsLimitExceededError", "x-zs-$id": "IdsLimitExceededErrorRef" }, { "$ref": "#/components/schemas/BulkDeleteFailureItem" }, { "$ref": "#/components/schemas/BulkDeleteInvalidIdParamError" } ], "x-zs-$id": "FieldUpdatesDeleteErrorResponse" } } }, "description": "Bulk delete failed. Either all provided IDs failed validation/association checks, the ids parameter is missing, or the number of IDs exceeded the maximum allowed limit." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "Crm_Implied_Customize_Zoho_CRM", "Crm_Implied_Manage_ConnectedWorkflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FeatureNoPermissionError", "x-zs-$id": "FieldUpdatesDeleteForbidden" } } }, "description": "Indicates that the user does not have the necessary permissions to delete field update details." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.DELETE" ] } ], "summary": "To delete multiple field update actions", "tags": [ "field_updates" ], "x-zoho-document": "field_updates", "x-zs-llm-description": "Bulk-removes field update actions; pass ids as a comma-separated query param (up to 10). Actions tied to active automation rules come back as NOT_ALLOWED; read-only actions are also blocked. Each ID gets its own success or error in the response." }, "get": { "description": "Retrieves a paginated list of field update actions. OPTIONAL FILTERS: module (string — filter by module API name), related_module (string — filter by related module API name), feature_type ('workflow'), sort_by, sort_order, page, per_page. Use the Fields metadata API to get field IDs and API names, and the Modules metadata API to get module API names and IDs. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) before associating them with workflow rules via the associate action.", "operationId": "getFieldUpdates", "parameters": [ { "$ref": "#/components/parameters/FieldUpdatesParamQueryFilter" }, { "$ref": "#/components/parameters/FieldUpdatesParamQueryModule" }, { "$ref": "#/components/parameters/FieldUpdatesParamQueryRelatedModule" }, { "$ref": "#/components/parameters/FieldUpdatesParamQueryFeatureType" }, { "$ref": "#/components/parameters/FieldUpdatesParamQuerySortOrder" }, { "$ref": "#/components/parameters/FieldUpdatesParamQuerySortBy" }, { "$ref": "#/components/parameters/ParamQueryIncludeInnerDetails1" }, { "$ref": "#/components/parameters/FieldUpdatesParamQueryPage" }, { "$ref": "#/components/parameters/FieldUpdatesParamQueryPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "field_updates": [ { "apply_assignment_threshold": false, "associated": false, "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-11-20T22:34:38-08:00", "deletable": true, "editable": true, "feature_type": "workflow", "field": { "api_name": "Layout", "id": "3361265000000098017" }, "id": "3361265000006176255", "lock_status": { "locked": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-11-20T22:34:38-08:00", "module": { "api_name": "Deals", "id": "3361265000000000131" }, "name": "LayoutPipeline", "notify": false, "related_module": null, "related_records": null, "source": "crm", "type": "static", "update_type": "append", "value": { "display_label": "TestLayout", "id": "3361265000001347001", "name": "TestLayout" } }, { "apply_assignment_threshold": false, "associated": false, "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-11-20T22:34:08-08:00", "deletable": true, "editable": true, "feature_type": "workflow", "field": { "api_name": "Pipeline", "id": "3361265000000236001" }, "id": "3361265000006176251", "lock_status": { "locked": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-11-20T22:34:08-08:00", "module": { "api_name": "Deals", "id": "3361265000000000131" }, "name": "DependentField", "notify": false, "related_module": null, "related_records": null, "source": "crm", "type": "static", "update_type": "overwrite", "value": "Test" }, { "apply_assignment_threshold": true, "associated": false, "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-11-20T22:33:36-08:00", "deletable": true, "editable": true, "feature_type": "workflow", "field": { "api_name": "Owner", "id": "3361265000000000515" }, "id": "3361265000006176247", "lock_status": { "locked": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-11-20T22:33:36-08:00", "module": { "api_name": "Deals", "id": "3361265000000000131" }, "name": "OwnerField", "notify": true, "related_module": null, "related_records": [ { "api_name": "Events", "id": "3361265000000000145" }, { "api_name": "Calls", "id": "3361265000000017015" } ], "source": "crm", "type": "static", "update_type": "append", "value": { "id": "3361265000002134004", "name": "testUser user2" } }, { "apply_assignment_threshold": false, "associated": false, "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-11-20T22:33:19-08:00", "deletable": true, "editable": true, "feature_type": "workflow", "field": { "api_name": "Multi_Select_1", "id": "3361265000006103385" }, "id": "3361265000006176243", "lock_status": { "locked": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-11-20T22:33:19-08:00", "module": { "api_name": "Deals", "id": "3361265000000000131" }, "name": "MultiSelect", "notify": false, "related_module": null, "related_records": null, "source": "crm", "type": "static", "update_type": "append", "value": [ "Option 2" ] }, { "apply_assignment_threshold": false, "associated": false, "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-11-20T22:32:58-08:00", "deletable": true, "editable": true, "feature_type": "workflow", "field": { "api_name": "Deal_Name", "id": "3361265000000000519" }, "id": "3361265000006176239", "lock_status": { "locked": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-11-20T22:32:58-08:00", "module": { "api_name": "Deals", "id": "3361265000000000131" }, "name": "FUP_POST", "notify": false, "related_module": null, "related_records": null, "source": "crm", "type": "static", "update_type": "overwrite", "value": "PostTest" } ], "info": { "count": 5, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "$ref": "#/components/schemas/FieldUpdatesListResponse" } } }, "description": "Successful response for listing field update actions. Includes configured field update definitions and pagination metadata." }, "204": { "description": "No content" }, "400": { "content": { "application/json": { "examples": { "InvalidFeatureTypeResponse": { "summary": "Error response when an unsupported feature_type value is passed (e.g., 'action' instead of 'workflow')", "value": { "code": "INVALID_DATA", "details": { "param_name": "feature_type" }, "message": "the given feature name is invalid", "status": "error" } }, "InvalidModuleResponse": { "summary": "Error response when the module query parameter contains a non-existent module name", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidSortByResponse": { "summary": "Error response when sort_by has an invalid value (expected 'modified_time' or similar)", "value": { "code": "INVALID_DATA", "details": { "param_name": "sort_by" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidSortOrderResponse": { "summary": "Error response when sort_order has an invalid value (expected 'asc' or 'desc')", "value": { "code": "INVALID_DATA", "details": { "param_name": "sort_order" }, "message": "The value provided to the param is Invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldUpdatesInvalidDataParamError", "x-zs-$id": "InvalidDataParamErrorRef" }, { "$ref": "#/components/schemas/FieldUpdatesInvalidModuleError", "x-zs-$id": "InvalidModuleErrorRef" } ], "x-zs-$id": "GetFieldUpdatesBadRequest" } } }, "description": "Returned when a query parameter value is invalid. This includes invalid module names, unsupported feature types, and invalid sort parameters." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "Crm_Implied_Customize_Zoho_CRM", "Crm_Implied_Manage_ConnectedWorkflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FeatureNoPermissionError", "x-zs-$id": "GetFieldUpdatesForbidden" } } }, "description": "Indicates that the user does not have the necessary permissions to read all the field update details." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Get Field Updates", "tags": [ "field_updates" ], "x-zoho-document": "field_updates", "x-zs-llm-description": "Fetches a paginated list of field update actions; filter by module api_name, related_module api_name, or feature_type ('workflow') using sort_by, sort_order, page, per_page. Use to look up field update IDs before linking them to workflow rules via associate." }, "post": { "description": "Creates a field update action that assigns a static value to a field, triggered by a workflow rule. For single-value fields, use a string for value. For multi-select and multi-user field types, use an array for value (for example, ['Call', 'Advertisement']). update_type (mandatory for multi-select and multi-user fields) specifies how to update the field and is supported only for multi-select fields: overwrite replaces existing values, append adds to existing values. dependent_fields specifies fields affected when the target field changes — primarily used for picklist dependencies, where one field's value controls another's valid options. For example, updating Country to India restricts the dependent State field to Indian states.\n", "operationId": "createFieldUpdates", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "field_updates": [ { "apply_assignment_threshold": true, "dependent_fields": [ { "field": { "api_name": "Stage", "id": "3361265000000000525" }, "value": "Qualification" } ], "feature_type": "workflow", "field": { "api_name": "Pipeline", "id": "3361265000000236001" }, "module": { "api_name": "Deals", "id": "3361265000000000131" }, "name": "FieldUpdatePOST", "notify": true, "related_records": [ { "api_name": "Events", "id": "3361265000000000145" }, { "api_name": "Calls", "id": "3361265000000017015" } ], "type": "static", "update_type": "append", "value": "Test" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateFieldUpdateRequest" } } }, "description": "Request body containing the field update configuration to create. Only one field update can be created per request. For dependency-driven fields, include dependent_fields as required: Pipeline -> Stage, Layout -> Pipeline -> Stage (nested), Owner -> user object from Users API." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "summary": "Success response for status 201", "value": { "field_updates": [ { "code": "SUCCESS", "details": { "id": "3361265000006103128" }, "message": "fieldupdate created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostfieldupdatesResponse201" } } }, "description": "Field update action created successfully." }, "400": { "content": { "application/json": { "examples": { "ApplyAssignmentThresholdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "apply_assignment_threshold", "expected_data_type": "boolean", "json_path": "$.field_updates[*].apply_assignment_threshold" }, "message": "Invalid data type", "status": "error" } ] } }, "ApplyAssignmentThresholdInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "apply_assignment_threshold", "expected_data_type": "boolean", "json_path": "$.field_updates[*].apply_assignment_threshold" }, "message": "Invalid data type", "status": "error" } ] } }, "ApplyAssignmentThresholdNotAllowed1": { "summary": "Error response with code NOT_ALLOWED: This key is not supported for this particular action (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "NOT_ALLOWED", "details": { "api_name": "apply_assignment_threshold", "json_path": "$.field_updates[0].apply_assignment_threshold" }, "message": "This key is not supported for this particular action", "status": "error" } ] } }, "ApplyAssignmentThresholdNotAllowed2": { "summary": "Error response with code NOT_ALLOWED: This key is not supported for this particular action (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "NOT_ALLOWED", "details": { "api_name": "apply_assignment_threshold", "json_path": "$.field_updates[0].apply_assignment_threshold" }, "message": "This key is not supported for this particular action", "status": "error" } ] } }, "DependentFieldApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].dependent_fields[*].field.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldApiNameExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].dependent_fields[*].field.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldApiNameInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldFieldExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "json_path": "$.field_updates[*].dependent_fields[*].field", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldFieldExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "json_path": "$.field_updates[*].dependent_fields[*].field", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldFieldInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldFieldInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldFieldMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Required field is missing", "status": "error" } ] } }, "DependentFieldFieldMandatoryNotFound2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Required field is missing", "status": "error" } ] } }, "DependentFieldIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].dependent_fields[*].field.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldIdExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].dependent_fields[*].field.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].dependent_fields[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldIdInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].dependent_fields[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldMissing1": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: dependent_fields)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "dependent_fields", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].dependent_fields" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissing2": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: dependent_fields)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "dependent_fields", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].dependent_fields" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldValueExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.field_updates[*].dependent_fields[*].value", "maximum_length": 13 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldValueExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.field_updates[*].dependent_fields[*].value", "maximum_length": 13 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldValueInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldValueInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldValueMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "DependentFieldValueMandatoryNotFound2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "DependentFieldsExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: dependent_fields)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "dependent_fields", "json_path": "$.field_updates[*].dependent_fields", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldsExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: dependent_fields)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "dependent_fields", "json_path": "$.field_updates[*].dependent_fields", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldsInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: dependent_fields)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "dependent_fields", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].dependent_fields" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldsInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: dependent_fields)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "dependent_fields", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].dependent_fields" }, "message": "Invalid data type", "status": "error" } ] } }, "FeatureTypeInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "expected_data_type": "text", "json_path": "$.field_updates[*].feature_type" }, "message": "Invalid data type", "status": "error" } ] } }, "FeatureTypeInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "expected_data_type": "text", "json_path": "$.field_updates[*].feature_type" }, "message": "Invalid data type", "status": "error" } ] } }, "FeatureTypeUnsupportedValue1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.field_updates[*].feature_type", "supported_values": [ "workflow" ] }, "message": "Invalid data", "status": "error" } ] } }, "FeatureTypeUnsupportedValue2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.field_updates[*].feature_type", "supported_values": [ "workflow" ] }, "message": "Invalid data", "status": "error" } ] } }, "FeatureTypeUnsupportedValue3": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.field_updates[*].feature_type", "supported_values": [ "workflow" ] }, "message": "Invalid data", "status": "error" } ] } }, "FeatureTypeUnsupportedValue4": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.field_updates[*].feature_type", "supported_values": [ "workflow" ] }, "message": "Invalid data", "status": "error" } ] } }, "FieldAmbiguity1": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: The field api name seems to be invalid", "value": { "field_updates": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.field_updates[0].field.id" }, { "api_name": "api_name", "json_path": "$.field_updates[0].field.api_name" } ] }, "message": "The field api name seems to be invalid", "status": "error" } ] } }, "FieldAmbiguity2": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: The field api name seems to be invalid", "value": { "field_updates": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.field_updates[0].field.id" }, { "api_name": "api_name", "json_path": "$.field_updates[0].field.api_name" } ] }, "message": "The field api name seems to be invalid", "status": "error" } ] } }, "FieldApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].field.api_name", "maximum_length": 8 }, "message": "Invalid data", "status": "error" } ] } }, "FieldApiNameExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].field.api_name", "maximum_length": 8 }, "message": "Invalid data", "status": "error" } ] } }, "FieldApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldApiNameInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "json_path": "$.field_updates[*].field", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "FieldExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "json_path": "$.field_updates[*].field", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "FieldIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].field.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "FieldIdExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].field.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "FieldIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldIdInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].field" }, "message": "Required field is missing", "status": "error" } ] } }, "FieldMandatoryNotFound2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].field" }, "message": "Required field is missing", "status": "error" } ] } }, "FieldUpdatesInvalidData": { "summary": "Error response with code INVALID_DATA: invalid data (Field: field_updates)", "value": { "code": "INVALID_DATA", "details": { "api_name": "field_updates", "json_path": "$.field_updates" }, "message": "invalid data", "status": "error" } }, "ModuleAmbiguity1": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: The given moduleid seems to be invalid", "value": { "field_updates": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.field_updates[0].module.id" }, { "api_name": "api_name", "json_path": "$.field_updates[0].module.api_name" } ] }, "message": "The given moduleid seems to be invalid", "status": "error" } ] } }, "ModuleAmbiguity2": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: The given moduleid seems to be invalid", "value": { "field_updates": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.field_updates[0].module.id" }, { "api_name": "api_name", "json_path": "$.field_updates[0].module.api_name" } ] }, "message": "The given moduleid seems to be invalid", "status": "error" } ] } }, "ModuleApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].module.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "ModuleApiNameExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].module.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "ModuleApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleApiNameInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: module)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.field_updates[*].module", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "ModuleExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: module)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.field_updates[*].module", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "ModuleIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].module.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "ModuleIdExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].module.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "ModuleIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleIdInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: module)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.field_updates[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "ModuleMandatoryNotFound2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: module)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.field_updates[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "NameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.field_updates[*].name", "maximum_length": 15 }, "message": "Invalid data", "status": "error" } ] } }, "NameExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.field_updates[*].name", "maximum_length": 15 }, "message": "Invalid data", "status": "error" } ] } }, "NameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.field_updates[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "NameInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.field_updates[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "NameMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.field_updates[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "NameMandatoryNotFound2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.field_updates[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "NotifyInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: notify)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.field_updates[*].notify" }, "message": "Invalid data type", "status": "error" } ] } }, "NotifyInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: notify)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.field_updates[*].notify" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].related_records[*].api_name", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "RelatedRecordApiNameExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.field_updates[*].related_records[*].api_name", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "RelatedRecordApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].related_records[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordApiNameInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].related_records[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].related_records[*].id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "RelatedRecordIdExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.field_updates[*].related_records[*].id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "RelatedRecordIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].related_records[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordIdInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].related_records[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordsExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: related_records)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "related_records", "json_path": "$.field_updates[*].related_records", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "RelatedRecordsExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: related_records)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "related_records", "json_path": "$.field_updates[*].related_records", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "RelatedRecordsInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: related_records)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "related_records", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].related_records" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordsInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: related_records)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "related_records", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].related_records" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordsNotAllowed1": { "summary": "Error response with code NOT_ALLOWED: This key is not supported for this particular action (Field: related_records)", "value": { "field_updates": [ { "code": "NOT_ALLOWED", "details": { "api_name": "related_records", "json_path": "$.field_updates[0].related_records" }, "message": "This key is not supported for this particular action", "status": "error" } ] } }, "RelatedRecordsNotAllowed2": { "summary": "Error response with code NOT_ALLOWED: This key is not supported for this particular action (Field: related_records)", "value": { "field_updates": [ { "code": "NOT_ALLOWED", "details": { "api_name": "related_records", "json_path": "$.field_updates[0].related_records" }, "message": "This key is not supported for this particular action", "status": "error" } ] } }, "TypeExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.field_updates[*].type", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "TypeExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.field_updates[*].type", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "TypeInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.field_updates[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "TypeInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.field_updates[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "TypeMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: type)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.field_updates[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "TypeMandatoryNotFound2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: type)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.field_updates[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "TypeUnsupportedValue1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.field_updates[*].type", "supported_values": [ "static" ] }, "message": "Invalid data", "status": "error" } ] } }, "TypeUnsupportedValue2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.field_updates[*].type", "supported_values": [ "static" ] }, "message": "Invalid data", "status": "error" } ] } }, "UpdateTypeExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "json_path": "$.field_updates[*].update_type", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "UpdateTypeExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "json_path": "$.field_updates[*].update_type", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "UpdateTypeInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "expected_data_type": "text", "json_path": "$.field_updates[*].update_type" }, "message": "Invalid data type", "status": "error" } ] } }, "UpdateTypeInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "expected_data_type": "text", "json_path": "$.field_updates[*].update_type" }, "message": "Invalid data type", "status": "error" } ] } }, "UpdateTypeUnsupportedValue1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "json_path": "$.field_updates[*].update_type", "supported_values": [ "overwrite", "append" ] }, "message": "Invalid data", "status": "error" } ] } }, "UpdateTypeUnsupportedValue2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "json_path": "$.field_updates[*].update_type", "supported_values": [ "overwrite", "append" ] }, "message": "Invalid data", "status": "error" } ] } }, "ValueExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.field_updates[*].value", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "ValueExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.field_updates[*].value", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "ValueInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "ValueInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "ValueMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.field_updates[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "ValueMandatoryNotFound2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.field_updates[*].value" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldUpdatesInvalidDataGenericError" }, { "additionalProperties": false, "description": "Wrapped error response with field_updates", "properties": { "field_updates": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/ModuleIdApiNameAmbiguityError" }, { "$ref": "#/components/schemas/FieldApiAmbiguityError" }, { "$ref": "#/components/schemas/UnsupportedKeyNotAllowedError" }, { "$ref": "#/components/schemas/FieldUpdatesDependentFieldMissingError" }, { "$ref": "#/components/schemas/FieldUpdatesMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/InvalidFieldValueTypeError" }, { "$ref": "#/components/schemas/FieldLengthExceededError" }, { "$ref": "#/components/schemas/FieldUpdatesInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidDataFieldValidationError" }, { "$ref": "#/components/schemas/FieldUpdatesExpectedFieldMissingError" }, { "$ref": "#/components/schemas/FieldUpdatesDependentMismatchError" } ], "x-zs-$id": "CreateFieldUpdatesErrorResponse" }, "maxItems": 25, "type": "array" } }, "required": [ "field_updates" ], "type": "object", "x-zs-$id": "DefinitionErrorResponses" } ], "x-zs-$id": "CreateFieldUpdatesErrorWrapper" } } }, "description": "Validation error. Returned when one or more request fields are missing, invalid, mismatched with dependencies, or not allowed for the selected field update configuration." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: feature not available in this edition", "value": { "field_updates": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "Crm_Implied_Customize_Zoho_CRM", "Crm_Implied_Manage_ConnectedWorkflow" ] }, "message": "feature not available in this edition", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Error response indicating that the user does not have the necessary permissions to create a field update action.", "properties": { "field_updates": { "description": "List of error responses for each field update action that failed due to insufficient permissions.", "items": { "$ref": "#/components/schemas/FeatureNoPermissionError" }, "maxItems": 10, "type": "array" } }, "required": [ "field_updates" ], "type": "object", "x-zs-$id": "CreateFieldUpdatesForbiddenWrapper" } } }, "description": "Indicates that the user does not have the necessary permissions to create a field update action." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.CREATE" ] } ], "summary": "Create Field Update", "tags": [ "field_updates" ], "x-zoho-document": "field_updates", "x-zs-llm-description": "Adds a new field update action that sets a static value on a field when a workflow rule fires. Before calling: fetch field id and api_name from GET /settings/fields?module={api_name}. For Pipeline fields: get valid values from GET /settings/pipeline?module={api_name} and include Stage in dependent_fields. For Layout fields: get IDs from GET /settings/layouts and include dependent Pipeline. For Owner fields: get user id from GET /users and supply notify plus related_records. Body must have a field_updates array with one entry covering name, module, field, type ('static'), and value. The response contains the new action ID needed for workflow rule association.", "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "/crm/v8/settings/automation/field_updates/{id}": { "delete": { "description": "Deletes a single field update action identified by the path ID. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to retrieve the field update ID. Actions associated with active automation rules return a `NOT_ALLOWED` error, and read-only actions cannot be deleted.\n", "operationId": "deleteFieldUpdateById", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "field_updates": [ { "code": "SUCCESS", "details": { "id": "3361265000006131027" }, "message": "field update deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteFieldUpdateSuccessResponse" } } }, "description": "Indicates that the field update was deleted successfully." }, "400": { "content": { "application/json": { "examples": { "FieldUpdatesInvalidData": { "summary": "Error response with code INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "ReadOnlyActionNotAllowed1": { "summary": "Error response with code NOT_ALLOWED: field update can not be deleted", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "field update can not be deleted", "status": "error" } }, "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "id" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidFieldUpdateIdError" }, { "$ref": "#/components/schemas/MissingDeleteIdParameterError" }, { "$ref": "#/components/schemas/AssociatedFieldUpdateNotAllowedError" }, { "$ref": "#/components/schemas/DeleteFieldUpdateReadOnlyActionError" } ], "x-zs-$id": "DeleteFieldUpdateBadRequestResponse" } } }, "description": "Returned when the field update ID is invalid, missing, or not deletable due to association/read-only constraints." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "Crm_Implied_Customize_Zoho_CRM", "Crm_Implied_Manage_ConnectedWorkflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FeatureNoPermissionError", "x-zs-$id": "DeleteFieldUpdateForbiddenResponse" } } }, "description": "Indicates that the user does not have the necessary permissions to edit a field update action." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.DELETE" ] } ], "summary": "Delete Field Update", "tags": [ "field_updates" ], "x-zoho-document": "field_updates", "x-zs-llm-description": "Removes a single field update action by its path ID. Actions attached to active automation rules are rejected with NOT_ALLOWED; read-only actions cannot be removed." }, "get": { "description": "Retrieves the details of the specified Field Update action, including its field configuration, module details, configured value, dependent fields, and audit information. Specify the Field Update ID in the path parameter. To retrieve additional field metadata, set the 'include_inner_details' query parameter to one or more of field_label, enable_colour_code, pick_list_values.colour_code, data_type, or display_value. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module IDs. This API is useful for inspecting the current configuration of a Field Update action before updating it.\n", "operationId": "getFieldUpdateById", "parameters": [ { "$ref": "#/components/parameters/FieldUpdatesParamQueryIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "field_updates": [ { "apply_assignment_threshold": false, "associated": false, "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-11-19T03:12:20-08:00", "deletable": true, "dependent_fields": [ { "field": { "api_name": "Stage", "id": "3361265000000000525", "ui_type": 26 }, "value": "Qualification" } ], "editable": true, "feature_type": "workflow", "field": { "api_name": "Pipeline", "id": "3361265000000236001", "ui_type": 2 }, "id": "3361265000006103364", "lock_status": { "locked": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-11-19T03:12:20-08:00", "module": { "api_name": "Deals", "id": "3361265000000000131", "moduleName": "Potentials", "plural_label": "Deals WF", "singular_label": "Deal" }, "name": "FieldUpdateGET", "notify": false, "related_module": null, "related_records": [ { "api_name": "Events", "id": "3361265000000000145" }, { "api_name": "Calls", "id": "3361265000000017015" } ], "source": "crm", "type": "static", "update_type": "append", "value": "Test" } ] } } }, "schema": { "$ref": "#/components/schemas/FieldUpdateByIdResponse" } } }, "description": "Successful retrieval of the requested field update action." }, "204": { "description": "No field update action found for the given ID." }, "400": { "content": { "application/json": { "examples": { "InvalidIncludeInnerDetailsResponse": { "summary": "Error response with code INVALID_DATA: include_inner_details value is invalid", "value": { "code": "INVALID_DATA", "details": { "param_name": "include_inner_details" }, "message": "The value provided to the param is Invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldUpdatesInvalidDataParamError" }, { "$ref": "#/components/schemas/MissingIncludeInnerDetailsParamError" } ], "x-zs-$id": "FieldUpdateByIdBadRequest" } } }, "description": "Invalid query parameter value. Returned when include_inner_details contains an unsupported value." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "Crm_Implied_Customize_Zoho_CRM", "Crm_Implied_Manage_ConnectedWorkflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FeatureNoPermissionError", "x-zs-$id": "FieldUpdateByIdForbidden" } } }, "description": "Indicates that the user does not have the necessary permissions to read a field update details." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Get Field Update By Id", "tags": [ "field_updates" ], "x-zoho-document": "field_updates", "x-zs-llm-description": "Fetches the complete definition of one field update action by its id path param. Pass include_inner_details=true for extended field metadata. Response includes field config, module, value, dependent fields, and audit info. Run this before a PUT to see what is currently stored." }, "parameters": [ { "description": "Unique identifier of the field update action. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to retrieve the field update IDs.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "3361265000006103409" ], "maxLength": 255, "type": "string" } } ], "put": { "description": "Updates an existing field update action identified by the path ID. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to find the field update ID. Locked actions require the appropriate privilege, and read-only actions cannot be modified. For single-value fields, use a string for value. For multi-select and multi-user field types, use an array for value (for example, ['Call', 'Advertisement']). update_type (mandatory for multi-select and multi-user fields) specifies how to update the field and is supported only for multi-select fields: overwrite replaces existing values, append adds to existing values. dependent_fields specifies fields affected when the target field changes — primarily used for picklist dependencies. For example, updating Country to India restricts the dependent State field to Indian states.\n", "operationId": "updateFieldUpdateById", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample request body", "value": { "field_updates": [ { "apply_assignment_threshold": true, "dependent_fields": [ { "field": { "api_name": "Stage", "id": "3361265000000000525" }, "value": "Qualification" } ], "feature_type": "workflow", "field": { "api_name": "Pipeline", "id": "3361265000000236001" }, "module": { "api_name": "Deals", "id": "3361265000000000131" }, "name": "FieldUpdatePUT", "notify": true, "related_records": [ { "api_name": "Events", "id": "3361265000000000145" }, { "api_name": "Calls", "id": "3361265000000017015" } ], "type": "static", "update_type": "append", "value": "Test" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateFieldUpdateRequest" } } }, "description": "Request body containing exactly one field update configuration to modify." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "field_updates": [ { "code": "SUCCESS", "details": { "id": "3361265000006103518" }, "message": "fieldupdate updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateFieldUpdateSuccessResponse" } } }, "description": "Field update action updated successfully." }, "400": { "content": { "application/json": { "examples": { "ApplyAssignmentThresholdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].related_records[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.field_updates[*].type", "supported_values": [ "static" ] }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.field_updates[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldFieldExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.field_updates[*].feature_type", "supported_values": [ "workflow" ] }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldFieldInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "expected_data_type": "text", "json_path": "$.field_updates[*].feature_type" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldFieldMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Required field is missing", "status": "error" } ] } }, "DependentFieldIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "expected_data_type": "text", "json_path": "$.field_updates[*].update_type" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "apply_assignment_threshold", "expected_data_type": "boolean", "json_path": "$.field_updates[*].apply_assignment_threshold" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldMissing1": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: related_records)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "related_records", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].related_records" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissing2": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: notify)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "notify", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates.notify" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "apply_assignment_threshold", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].apply_assignment_threshold" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: dependent_fields)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "dependent_fields", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].dependent_fields" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse5": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: related_records)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "related_records", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].related_records" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse6": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: notify)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "notify", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates.notify" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse7": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "apply_assignment_threshold", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].apply_assignment_threshold" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldMissingResponse8": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: dependent_fields)", "value": { "field_updates": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "dependent_fields", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].dependent_fields" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentFieldValueExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.field_updates[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldValueInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "json_path": "$.field_updates[*].update_type", "supported_values": [ "overwrite", "append" ] }, "message": "Invalid data", "status": "error" } ] } }, "DependentFieldValueMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "DependentFieldsExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: notify)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.field_updates[*].notify" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentFieldsInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].related_records[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "DependentMismatchPostman": { "summary": "Error response with code DEPENDENT_MISMATCH: Dependent Field is not matching", "value": { "field_updates": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "field", "json_path": "$.field_updates[0].field" }, "json_path": "$.field_updates[0].value" }, "message": "Dependent Field is not matching", "status": "error" } ] } }, "FeatureTypeInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: dependent_fields)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "dependent_fields", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].dependent_fields" }, "message": "Invalid data type", "status": "error" } ] } }, "FeatureTypeUnsupportedValue1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "FeatureTypeUnsupportedValue2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].dependent_fields[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: dependent_fields)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "dependent_fields", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].dependent_fields" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "FieldMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "FieldUpdatesInvalidData": { "summary": "Error response with code INVALID_DATA: invalid data (Field: field_updates)", "value": { "code": "INVALID_DATA", "details": { "api_name": "field_updates", "json_path": "$.field_updates" }, "message": "invalid data", "status": "error" } }, "ModuleApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: apply_assignment_threshold)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "apply_assignment_threshold", "expected_data_type": "boolean", "json_path": "$.field_updates[*].apply_assignment_threshold" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleIdExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "json_path": "$.field_updates[*].update_type", "supported_values": [ "overwrite", "append" ] }, "message": "Invalid data", "status": "error" } ] } }, "ModuleIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleIdInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: update_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "update_type", "expected_data_type": "text", "json_path": "$.field_updates[*].update_type" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "ModuleInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.field_updates[*].type", "supported_values": [ "static" ] }, "message": "Invalid data", "status": "error" } ] } }, "ModuleMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].dependent_fields[*].field" }, "message": "Required field is missing", "status": "error" } ] } }, "NameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.field_updates[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "NameExceedsMaxLength2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.field_updates[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "NameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "NameInvalidDataType2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.field_updates[*].feature_type", "supported_values": [ "workflow" ] }, "message": "Invalid data", "status": "error" } ] } }, "NameMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].field" }, "message": "Required field is missing", "status": "error" } ] } }, "NotifyInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "ReadOnlyActionNotAllowedPostman": { "summary": "Error response with code NOT_ALLOWED: Insufficient privileges to edit action", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Insufficient privileges to edit action", "status": "error" } }, "RelatedRecordApiNameExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordApiNameInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordIdExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordIdInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordsExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordsInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.field_updates[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "RelatedRecordsNotAllowed1": { "summary": "Error response with code NOT_ALLOWED: This key is not supported for this particular action (Field: notify)", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "notify", "json_path": "$.field_updates.notify" }, "message": "This key is not supported for this particular action", "status": "error" } }, "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: the id given seems to be invalid", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "id" }, "message": "the id given seems to be invalid", "status": "error" } }, "RequiredPathIdMissingPostman": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "resource_path_index": 3 }, "message": "One of the expected parameter is missing", "status": "error" } }, "TypeExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.field_updates[*].dependent_fields[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "TypeInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].dependent_fields[*].field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "TypeUnsupportedValue1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: related_records)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "related_records", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].related_records" }, "message": "Invalid data type", "status": "error" } ] } }, "UpdateTypeExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: notify)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.field_updates[*].notify" }, "message": "Invalid data type", "status": "error" } ] } }, "UpdateTypeInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.field_updates[*].related_records[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "UpdateTypeUnsupportedValue1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: feature_type)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "expected_data_type": "text", "json_path": "$.field_updates[*].feature_type" }, "message": "Invalid data type", "status": "error" } ] } }, "ValueExceedsMaxLength1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.field_updates[*].related_records[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "ValueInvalidDataType1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: related_records)", "value": { "field_updates": [ { "code": "INVALID_DATA", "details": { "api_name": "related_records", "expected_data_type": "jsonarray", "json_path": "$.field_updates[*].related_records" }, "message": "Invalid data type", "status": "error" } ] } }, "ValueMandatoryNotFound1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field)", "value": { "field_updates": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.field_updates[*].field" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldUpdatesInvalidDataGenericError" }, { "$ref": "#/components/schemas/InvalidFieldUpdateIdError" }, { "$ref": "#/components/schemas/MissingFieldUpdateIdError" }, { "$ref": "#/components/schemas/UnsupportedKeyNotAllowedError" }, { "$ref": "#/components/schemas/UpdateFieldUpdateMissingPathIdError" }, { "$ref": "#/components/schemas/UpdateFieldUpdateReadOnlyActionError" }, { "additionalProperties": false, "description": "Wrapped error response with field_updates", "properties": { "field_updates": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/UnsupportedKeyNotAllowedError" }, { "$ref": "#/components/schemas/FieldUpdatesInvalidDataGenericError" }, { "$ref": "#/components/schemas/FieldUpdatesDependentFieldMissingError" }, { "$ref": "#/components/schemas/FieldUpdatesDependentMismatchError" }, { "$ref": "#/components/schemas/InvalidFieldValueTypeError" }, { "$ref": "#/components/schemas/FieldUpdatesMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/FieldUpdatesInvalidDataTypeError" } ], "x-zs-$id": "UpdateFieldUpdateValidationErrorItem" }, "maxItems": 25, "type": "array" } }, "required": [ "field_updates" ], "type": "object", "x-zs-$id": "UpdateFieldUpdateValidationErrorItemsWrapper" } ], "x-zs-$id": "UpdateFieldUpdateValidationErrorResponse" } } }, "description": "Validation error. Returned when one or more request fields are missing, invalid, mismatched with dependencies, or not allowed for the selected field update configuration." }, "403": { "content": { "application/json": { "examples": { "LockedActionNoPermissionPostman": { "summary": "Error response with code NO_PERMISSION: Insufficient privileges to edit locked action", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Insufficient privileges to edit locked action", "status": "error" } }, "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "Crm_Implied_Customize_Zoho_CRM", "Crm_Implied_Manage_ConnectedWorkflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UpdateFieldUpdateLockedActionPermissionError" }, { "$ref": "#/components/schemas/FeatureNoPermissionError" } ], "x-zs-$id": "UpdateFieldUpdateForbiddenResponse" } } }, "description": "Indicates that the user does not have the necessary permissions to edit a field update action." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.UPDATE" ] } ], "summary": "Update Field Update", "tags": [ "field_updates" ], "x-zoho-document": "field_updates", "x-zs-llm-description": "Modifies an existing field update action identified by path ID. Same setup as POST: look up field metadata and pipeline/layout/owner values from their respective APIs. All fields (name, module, field, type, value) must be sent in full partial payloads are unreliable. Dependency rules mirror create. Locked actions need elevated privilege; read-only actions cannot be changed.", "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "/crm/v8/settings/automation/scoring_rules": { "delete": { "description": "Permanently deletes multiple scoring rules", "operationId": "deleteScoringRules", "parameters": [ { "$ref": "#/components/parameters/ScoringRulesParamQueryIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful delete Scoring Rules response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000317218" }, "message": "scoring rule deleted successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111114000000317220" }, "message": "scoring rule deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRulesDeleteAllResponse" } } }, "description": "All rules are deleted successfully" }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Demonstrates a multi-status response when some Scoring Rule IDs are invalid while others are successfully deleted.", "summary": "Partial success delete Scoring Rules response", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "id": "111114000000317200" }, "message": "The id given seems to be invalid", "status": "error" }, { "code": "SUCCESS", "details": { "id": "111114000000317218" }, "message": "scoring rule deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRulesDelete207Response" } } }, "description": "Returns per-item operation statuses when some Scoring Rule IDs are invalid while others are successfully deleted." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.DELETE" ] } ], "summary": "Scoring Rules", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Bulk-delete scoring rules. Provide `ids` query parameter with comma-separated numeric rule IDs. Returns 200 if all succeed, 207 (multi-status) if some IDs are invalid." }, "get": { "description": "To retrieve a list of Scoring Rules configured in your Zoho CRM organization.", "operationId": "getScoringRules", "parameters": [ { "$ref": "#/components/parameters/ScoringRulesParamQueryModule" }, { "$ref": "#/components/parameters/ParamQueryLayoutId" }, { "$ref": "#/components/parameters/ScoringRulesParamQueryPage" }, { "$ref": "#/components/parameters/ScoringRulesParamQueryPerPage" }, { "$ref": "#/components/parameters/ParamQueryName" }, { "$ref": "#/components/parameters/ScoringRulesParamQueryFields" }, { "$ref": "#/components/parameters/ParamQueryActive" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful list Scoring Rules response", "value": { "info": { "count": 5, "more_records": false, "page": 1, "per_page": 50 }, "scoring_rules": [ { "active": true, "created_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "created_time": "2025-10-14T09:42:53+05:30", "description": "", "field_rules": [ { "criteria": { "comparator": "equal", "field": { "api_name": "Assistant", "id": "111114000000004570" }, "type": "value", "value": "asst" }, "id": "111114000000310446", "score": 10 }, { "criteria": { "comparator": "contains", "field": { "api_name": "Assistant", "id": "111114000000004570" }, "type": "value", "value": "awsst" }, "id": "111114000000310448", "score": 1 } ], "has_signal_rules": false, "id": "111114000000180006", "layout": null, "modified_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "modified_time": "2025-11-21T10:37:50+05:30", "module": { "api_name": "Contacts", "id": "111114000000002630" }, "name": "Contact scoring", "signal_rules": null }, { "active": true, "created_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "created_time": "2025-11-05T14:29:04+05:30", "description": "", "field_rules": [ { "criteria": { "comparator": "contains", "field": { "api_name": "Account_Site", "id": "111114000000004480" }, "type": "value", "value": "zoho" }, "id": "111114000000265029", "score": 10 }, { "criteria": { "comparator": "greater_equal", "field": { "api_name": "Annual_Revenue", "id": "111114000000004456" }, "type": "value", "value": "100000" }, "id": "111114000000265031", "score": 10 } ], "has_signal_rules": false, "id": "111114000000265003", "layout": { "api_name": "Standard", "display_label": "Standard", "id": "111114000000003628" }, "modified_by": null, "modified_time": null, "module": { "api_name": "Accounts", "id": "111114000000002632" }, "name": "ASR 1", "signal_rules": null }, { "active": true, "created_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "created_time": "2025-11-18T10:44:53+05:30", "description": "", "field_rules": [ { "criteria": { "comparator": "contains", "field": { "api_name": "Account_Site", "id": "111114000000004480" }, "type": "value", "value": "zohho" }, "id": "111114000000313070", "score": 10 } ], "has_signal_rules": false, "id": "111114000000313069", "layout": { "api_name": "Standard", "display_label": "Standard", "id": "111114000000003628" }, "modified_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "modified_time": "2025-11-21T12:13:04+05:30", "module": { "api_name": "Accounts", "id": "111114000000002632" }, "name": "ASR", "signal_rules": null }, { "active": false, "created_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "created_time": "2025-11-18T14:05:11+05:30", "description": "", "field_rules": [ { "criteria": { "comparator": "greater_than", "field": { "api_name": "Modified_Time", "id": "111114000000004830" }, "type": "value", "value": "${DUEINDAYS}+12" }, "id": "111114000000313123", "score": 10 } ], "has_signal_rules": false, "id": "111114000000313122", "layout": { "api_name": "Standard", "display_label": "Standard", "id": "111114000000003626" }, "modified_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "modified_time": "2025-11-20T18:26:01+05:30", "module": { "api_name": "Leads", "id": "111114000000002628" }, "name": "LSR", "signal_rules": null }, { "active": false, "created_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "created_time": "2025-11-19T19:56:51+05:30", "description": null, "field_rules": [ { "criteria": { "group": [ { "comparator": "equal", "field": { "api_name": "CF_Date", "id": "111114000000081970" }, "type": "value", "value": "2025-11-19" }, { "comparator": "equal", "field": { "api_name": "Company", "id": "111114000000004780" }, "type": "value", "value": "Zohho" } ], "group_operator": "AND" }, "id": "111114000000314010", "score": 10 }, { "criteria": { "comparator": "not_equal", "field": { "api_name": "Country", "id": "111114000000004892" }, "type": "value", "value": "${EMPTY}" }, "id": "111114000000314012", "score": -10 } ], "has_signal_rules": false, "id": "111114000000314009", "layout": { "api_name": "Standard", "display_label": "Standard", "id": "111114000000003626" }, "modified_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "modified_time": "2025-11-21T11:26:40+05:30", "module": { "api_name": "Leads", "id": "111114000000002628" }, "name": "Lead - Scoring", "signal_rules": [ { "id": "111114000000316001", "score": -100, "signal": { "id": "111114000000034755", "namespace": "zoho.emailinsight.bounce" } }, { "id": "111114000000316002", "score": 10, "signal": { "id": "111114000000034749", "namespace": "zoho.emailinsight.open" } } ] } ] } } }, "schema": { "$ref": "#/components/schemas/GetScoringRulesListResponse" } } }, "description": "Returns a list of all Scoring Rules configured in the organization, filtered by the provided query parameters." }, "204": { "description": "No scoring rules are configured" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates an error response when an invalid module API name is provided.\n**Resolution:** Provide a valid module API name.", "summary": "Error response with code INVALID_DATA: Please check whether the input values are correct", "value": { "code": "INVALID_DATA", "details": { "param_name": "module" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidModuleParamErrorResponse" } } }, "description": "Invalid module api_name is passed in module param value" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.READ" ] } ], "summary": "Scoring Rules", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Retrieves a paginated list of scoring rules configured in the CRM. Results can be filtered by module API name (`module`), layout ID (`layout_id`), or rule name (`name`). Each rule includes its field-based criteria, touch-point signal rules, custom score fields, layout, module, and audit metadata. Returns 204 with no body if no scoring rules are configured." }, "post": { "description": "Creates one or more scoring rules for specified modules and layouts. Only Leads and Contacts modules support signal rules. Deals, Accounts and Custom Modules do not support signal rules.", "operationId": "postScoringRules", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample create Scoring Rules request body", "value": { "scoring_rules": [ { "active": true, "custom_fields": [ { "field_label": "Lead - Scoring Score", "reference_field": { "api_name": "Score" } }, { "field_label": "Lead - Scoring Touch point Score", "reference_field": { "api_name": "Touch_Point_Score" } } ], "description": "", "field_rules": [ { "criteria": { "group": [ { "comparator": "equal", "field": { "api_name": "CF_Date", "data_type": "date", "field_label": "CF Date", "id": "111114000000081970" }, "type": "value", "value": "2025-11-19" }, { "comparator": "equal", "field": { "api_name": "Company", "data_type": "text", "field_label": "Company", "id": "111114000000004780" }, "type": "value", "value": "Zohho" } ], "group_operator": "and" }, "score": 10 }, { "criteria": { "comparator": "not_equal", "field": { "api_name": "Country", "data_type": "text", "field_label": "Country", "id": "111114000000004892" }, "type": "value", "value": "${EMPTY}" }, "score": -10 } ], "layout": { "api_name": "Standard", "display_label": "Standard", "id": "111114000000003626" }, "module": { "api_name": "Leads", "id": "111114000000002628" }, "name": "Lead - Scoring", "signal_rules": [ { "score": -99, "signal": { "id": "111114000000034755", "namespace": "zoho.emailinsight.bounce" } }, { "score": 10, "signal": { "id": "111114000000034749", "namespace": "zoho.emailinsight.open" } }, { "score": 100, "signal": { "id": "111114000000034752", "namespace": "zoho.emailinsight.click" } } ] } ] } } }, "schema": { "$ref": "#/components/schemas/CreateScoringRuleRequestBody" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "Accepts a JSON request body containing an array of Scoring Rule definitions to create." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "summary": "Successful create Scoring Rules response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "2995635000023340017" }, "message": "scoring rule created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateScoringRuleSuccessResponse" } } }, "description": "Scoring rule is created successfully, but one or more custom fields are not created." }, "207": { "content": { "application/json": { "examples": { "Success207": { "summary": "Partial success create Scoring Rules response", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name" }, "message": "required field not found", "status": "error" }, { "code": "SUCCESS", "details": { "id": "2995635000023340019" }, "message": "scoring rule created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRulesPartialSuccessResponse" } } }, "description": "Returns per-item operation statuses when some Scoring Rule items succeed and others fail in the same request." }, "400": { "content": { "application/json": { "examples": { "ActiveStateLimitExceededResponse1": { "description": "Demonstrates an error when the active Scoring Rule limit for the layout is reached.\n**Resolution:** Deactivate existing Scoring Rules before creating new ones.", "summary": "Error response with code ACTIVE_STATE_LIMIT_EXCEEDED: More than 5 active scoring rules cannot be created for a layout (Field: id)", "value": { "scoring_rules": [ { "code": "ACTIVE_STATE_LIMIT_EXCEEDED", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].layout.id", "limit": 5 }, "message": "More than 5 active scoring rules cannot be created for a layout", "status": "error" } ] } }, "AlreadyUsedResponse1": { "summary": "Error response with code ALREADY_USED: The criteria is already given in the same rule under different index (Field: criteria)", "value": { "scoring_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "criteria", "exists_in": { "api_name": "criteria", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "json_path": "$.scoring_rules[0].field_rules[1].criteria" }, "message": "The criteria is already given in the same rule under different index", "status": "error" } ] } }, "AlreadyUsedResponse2": { "description": "Demonstrates an error when the request submits the same reference field for more than one custom field.\n**Resolution:** Assign each reference field to only one custom field.", "summary": "Error response with code ALREADY_USED: Duplicate reference field (Field: reference_field)", "value": { "scoring_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "reference_field", "json_path": "$.scoring_rules[0].custom_fields[1].reference_field" }, "message": "Duplicate reference field", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Demonstrates an error when a duplicate custom field label is detected.\n**Resolution:** Provide a unique display name for each custom field.", "summary": "Error response with code DUPLICATE_DATA: Field label duplicate (Field: field_label)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Field label duplicate", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "description": "Demonstrates an error when field rules or signal rules are required but not provided for Leads or Contacts.\n**Resolution:** Include `field_rules` or `signal_rules` in the request.", "summary": "Error response with code EXPECTED_FIELD_MISSING: field_rules or signal_rules is expected(For leads and contacts)", "value": { "scoring_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "field_rules", "json_path": "$.scoring_rules[0].field_rules" }, { "api_name": "signal_rules", "json_path": "$.scoring_rules[0].signal_rules" } ] }, "message": "field_rules or signal_rules is expected", "status": "error" } ] } }, "ExpectedFieldMissingResponse2": { "description": "Demonstrates an error when field rules are required but not provided for modules other than Leads and Contacts.\n**Resolution:** Include `field_rules` in the request.", "summary": "Error response with code EXPECTED_FIELD_MISSING: Field_Rules is expected (Except Leads and Contacts)", "value": { "scoring_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "field_rules", "json_path": "$.scoring_rules[0].field_rules" } ] }, "message": "Field_Rules is expected", "status": "error" } ] } }, "ExpectedFieldMissingResponse3": { "description": "Demonstrates an error when the reference field value is empty in the Scoring Rule.\n**Resolution:** Include at least one field(id or api_name) in the reference field value object.", "summary": "Error response with code EXPECTED_FIELD_MISSING: Specify atleast one field", "value": { "scoring_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" }, { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "FieldLimitExceededResponse1": { "summary": "Error response with code FIELD_LIMIT_EXCEEDED: Field limit reached for the given field type in the given module", "value": { "scoring_rules": [ { "code": "FIELD_LIMIT_EXCEEDED", "details": { "limit": 40 }, "message": "Field limit reached for the given field type in the given module", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error when the Scoring Rule name contains invalid data.\n**Resolution:** Provide a valid name that meets the format requirements.", "summary": "Error response with code INVALID_DATA: invalid data (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "maximum_length": 25 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Demonstrates an error when the `field_label` value length is greater than the allowed limit.\n**Resolution:** Ensure `field_label` length is within the allowed limit.", "summary": "Error response with code INVALID_DATA: invalid data (Field: field_label)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Demonstrates an error when the reference field API name is invalid.\n**Resolution:** Provide a valid API name for the reference field.", "summary": "Error response with code INVALID_DATA: Reference field api_name given seems to be invalid (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name", "supported_values": [ "Positive_Score", "Negative_score", "Touch_Point_score", "Touch_Point_Positive_Score", "Touch_Point_Negative_Score", "Score" ] }, "message": "Reference field api_name given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Demonstrates an error when the reference field ID is invalid.\n**Resolution:** Provide a valid reference field ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" }, "message": "The id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Demonstrates an error when the description field contains an invalid data type.\n**Resolution:** Ensure `description` is a string value or null.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: description)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.scoring_rules[0].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Demonstrates an error when the description field contains greater than the allowed length.\n**Resolution:** Ensure the description value does not exceed the maximum length..", "summary": "Error response with code INVALID_DATA: Invalid data (Field: description)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.scoring_rules[0].description", "maximum_length": 500 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Demonstrates an error when the active field contains an invalid data type.\n**Resolution:** Ensure `active` is a Boolean value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: active)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "expected_data_type": "boolean", "json_path": "$.scoring_rules[0].active" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Demonstrates an error when the `custom_fields` array contains an invalid data type.\n**Resolution:** Ensure `custom_fields` is an array of valid objects.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: custom_fields)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_fields", "expected_data_type": "jsonarray", "json_path": "$.scoring_rules[0].custom_fields" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Demonstrates an error when the `custom_fields` array contains invalid data.\n**Resolution:** Verify each custom field object is valid.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: custom_fields)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_fields", "json_path": "$.scoring_rules[0].custom_fields", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Demonstrates an error when the `field_label` contains an invalid data type.\n**Resolution:** Ensure `field_label` is a string value.", "summary": "Error response: INVALID_DATA for invalid field_label type", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "expected_data_type": "text", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Demonstrates an error when the `field_label` exceeds the maximum length.\n**Resolution:** Ensure the `field_label` does not exceed the maximum length.", "summary": "Error response: INVALID_DATA for invalid field_label value", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates an error when the Scoring Rule name contains invalid data.\n**Resolution:** Provide a valid unique name for the Scoring Rule.", "summary": "Error response with code INVALID_DATA: invalid data (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "regex": "[^`~#%^&*()+=\";<>\\[\\]{}|\\\\]+$" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Demonstrates an error when the `reference_field` contains an invalid data type.\n**Resolution:** Ensure `reference_field` is a valid object.", "summary": "Error response: INVALID_DATA for invalid reference_field type", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_field", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Demonstrates an error when the `reference_field` contains invalid data.\n**Resolution:** Provide a valid reference field object.", "summary": "Error response: INVALID_DATA for invalid reference_field data", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_field", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Demonstrates an error when the `api_name` contains an invalid data type.\n**Resolution:** Ensure `api_name` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Demonstrates an error when the `api_name` contains invalid data.\n**Resolution:** Provide a valid API name.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Demonstrates an error when the `api_name` contains invalid data.\n**Resolution:** Ensure the API name follows the required naming convention.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name", "supported_values": [ "Positive_Score", "Negative_Score", "Touch_Point_Positive_Score", "Touch_Point_Negative_Score", "Touch_Point_Score", "Score" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "Demonstrates an error when `field_rules` contains an invalid data type.\n**Resolution:** Ensure `field_rules` is an array of valid objects.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_rules", "expected_data_type": "jsonarray", "json_path": "$.scoring_rules[0].field_rules" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "Demonstrates an error when `field_rules` contains invalid data.\n**Resolution:** Verify each field rule object is valid.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: field_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_rules", "json_path": "$.scoring_rules[0].field_rules", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "Demonstrates an error when criteria contains an invalid data type.\n**Resolution:** Ensure `criteria` is a valid object.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: criteria)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse28": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: score)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "score", "expected_data_type": "integer", "json_path": "$.scoring_rules[0].field_rules[0].score" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse29": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: signal_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "signal_rules", "expected_data_type": "jsonarray", "json_path": "$.scoring_rules[0].signal_rules" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error when the description field contains invalid data.\n**Resolution:** Ensure the description value is valid.", "summary": "Error response with code INVALID_DATA: invalid data (Field: description)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.scoring_rules[0].description", "maximum_length": 500 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse30": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: signal)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "signal", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].signal_rules[0].signal" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse31": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: namespace)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "namespace", "expected_data_type": "text", "json_path": "$.scoring_rules[0].signal_rules[0].signal.namespace" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse32": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: namespace)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "namespace", "json_path": "$.scoring_rules[0].signal_rules[0].signal.namespace", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse33": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.scoring_rules[0].signal_rules[0].signal.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse34": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].signal_rules[0].signal.id", "maximum_length": 20 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse35": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: score)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "score", "expected_data_type": "integer", "json_path": "$.scoring_rules[0].signal_rules[0].score" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse36": { "description": "Demonstrates an error when the `layout` field contains an invalid data type.\n**Resolution:** Ensure `layout` is a valid object.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: layout)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "layout", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].layout" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse37": { "description": "Demonstrates an error when the layout ID contains an invalid data type.\n**Resolution:** Ensure the layout `id` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.scoring_rules[0].layout.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse38": { "description": "Demonstrates an error when the layout API name contains an invalid data type.\n**Resolution:** Ensure `api_name` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.scoring_rules[0].layout.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse39": { "description": "Demonstrates an error when the layout API name contains invalid data.\n**Resolution:** Provide a valid API name for the layout.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.scoring_rules[0].layout.api_name", "maximum_length": 8 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error when the description field contains invalid data.\n**Resolution:** Ensure the description value is a valid string.", "summary": "Error response with code INVALID_DATA: invalid data (Field: description)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.scoring_rules[0].description", "maximum_length": 500 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse40": { "description": "Demonstrates an error when the `module` field contains an invalid data type.\n**Resolution:** Ensure `module` is a valid object.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse41": { "description": "Demonstrates an error when the module API name contains an invalid data type.\n**Resolution:** Ensure `api_name` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.scoring_rules[0].module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse42": { "description": "Demonstrates an error when the module ID contains an invalid data type.\n**Resolution:** Ensure the module `id` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.scoring_rules[0].module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse43": { "description": "Demonstrates an error when the module ID contains invalid data.\n**Resolution:** Provide a valid module ID.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].module.id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse44": { "description": "Demonstrates an error when the name contains an invalid data type.\n**Resolution:** Ensure `name` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.scoring_rules[0].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse45": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error when the layout ID refers to an invalid or non-existent layout.\n**Resolution:** Provide a valid layout ID.", "summary": "Error response with code INVALID_DATA: Layout id seems to be invalid (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].layout.id" }, "message": "Layout id seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Demonstrates an error when the module ID refers to an invalid or non-existent module.\n**Resolution:** Provide a valid module ID.", "summary": "Error response with code INVALID_DATA: Module specified seems to be invalid (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].module.id" }, "message": "Module specified seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Demonstrates an error when the module API name refers to an invalid or non-existent module.\n**Resolution:** Provide a valid module API name.", "summary": "Error response with code INVALID_DATA: Module specified seems to be invalid (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.scoring_rules[0].module.api_name" }, "message": "Module specified seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Demonstrates an error when invalid or unsupported signal id is provided in signal rules.\n**Resolution:** Provide a valid and supported signal id in the signal rules.", "summary": "Error response with code INVALID_DATA: Invalid or Unsupported signal id (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].signal_rules[0].signal.id" }, "message": "Invalid or Unsupported signal id", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Demonstrates an error when the `field_label` contains special characters.\n**Resolution:** Remove special characters from the field label.", "summary": "Error response with code INVALID_DATA: Special characters in field label (Field: field_label)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Special characters in field label", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Demonstrates an error when the number of criteria in `field_rules` exceeds the maximum limit of 50.\n**Resolution:** Reduce the number of criteria to 50 or fewer.", "summary": "Error response with code LIMIT_EXCEEDED: More than 50 criteria cannot be configured with field_rules (Field: field_rules)", "value": { "scoring_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "field_rules", "json_path": "$.scoring_rules[0].field_rules", "limit": 50 }, "message": "More than 50 criteria cannot be configured with field_rules", "status": "error" } ] } }, "LimitExceededResponse2": { "description": "Demonstrates an error when the total number of Scoring Rules for the layout exceeds the maximum of 10.\n**Resolution:** Delete existing Scoring Rules before creating new ones.", "summary": "Error response with code LIMIT_EXCEEDED: More than 10 scoring rules cannot be created for a layout (Field: id)", "value": { "scoring_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].layout.id", "limit": 10 }, "message": "More than 10 scoring rules cannot be created for a layout", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error when the name field is missing from the request.\n**Resolution:** Include the `name` field in each Scoring Rule item.", "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: name)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse10": { "description": "Demonstrates an error when the score field is missing from a field rule.\n**Resolution:** Include the `score` field in each field rule.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: score)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "score", "json_path": "$.scoring_rules[0].field_rules[0].score" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse11": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: signal)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "signal", "json_path": "$.scoring_rules[0].signal_rules[0].signal" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse12": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: score)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "score", "json_path": "$.scoring_rules[0].signal_rules[0].score" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse13": { "description": "Demonstrates an error when the module field is missing from a scoring rule.\n**Resolution:** Include the `module` field in the scoring rule object.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: module)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.scoring_rules[0].module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse14": { "description": "Demonstrates an error when the name field is missing from the scoring rule.\n**Resolution:** Include the `name` field in the scoring rule.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Demonstrates an error when the module field is missing from the Scoring Rule.\n**Resolution:** Include the `module` field in the Scoring Rule.", "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: module)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.scoring_rules[0].module" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Demonstrates an error when the criteria field is missing from a field rule.\n**Resolution:** Include the `criteria` field in each field rule.", "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: criteria)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "criteria", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: signal)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "signal", "json_path": "$.scoring_rules[0].signal_rules[0].signal" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Demonstrates an error when the field_label field is missing from a custom field.\n**Resolution:** Include the `field_label` field in each custom field.", "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: field_label)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Demonstrates an error when the `reference_field` is missing from a custom field.\n**Resolution:** Include the `reference_field` in each custom field.", "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: reference_field)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_field", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Demonstrates an error when the `field_label` is missing from a custom field.\n**Resolution:** Include the `field_label` in each custom field.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field_label)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Demonstrates an error when the `reference_field` is missing from a custom field.\n**Resolution:** Include the `reference_field` in each custom field.", "summary": "Error response: MANDATORY_NOT_FOUND for missing reference_field", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_field", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Demonstrates an error when the `criteria` is missing in a field rule.\n**Resolution:** Include the `criteria` in each field rule.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: criteria)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "criteria", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "message": "Required field is missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Demonstrates an error when the system keyword is used in the field label.\n**Resolution:** Do not use system keywords in the field label.", "summary": "Error response with code NOT_ALLOWED: System keyword not allowed in field label (Field: field_label)", "value": { "scoring_rules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "System keyword not allowed in field label", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the wrapped error response containing per-item error objects for the create Scoring Rules operation.", "properties": { "scoring_rules": { "description": "Represents an array of per-item error objects in the create Scoring Rules error response.", "items": { "$ref": "#/components/schemas/GeneralErrorResponse" }, "maxItems": 250, "type": "array" } }, "required": [ "scoring_rules" ], "type": "object", "x-zs-$id": "ScoringRulesErrorResponse" } } }, "description": "Returns an error response when the request contains invalid or missing data.\n**Resolution:** Verify that all field values are valid and required fields are present." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.CREATE" ] } ], "summary": "Scoring Rules", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Creates one or more scoring rules. Up to 10 rules per layout. Each rule requires `module` and `name`.\n\n**Required fields:**\n- `name` - scoring rule name.\n- `module` - CRM module (e.g., Leads, Contacts).\n- For Leads and Contacts: at least one of `field_rules` or `signal_rules` is required.\n- For other modules: `field_rules` is required.\n\n**field_rules** - CRM field criteria mapped to scores. Each entry needs `criteria` (filter on a CRM field) and `score` (integer, -100 to 100).\n\n**signal_rules** - interaction signal criteria. Each entry needs `signal` (with `namespace` and `id`) and `score`.\n\n**Optional:** `description`, `active` (default true), `layout` (null means all layouts), `custom_fields` (up to 6 CRM score field mappings).\n\nReturns 201 if all rules are created. Returns 207 (multi-status) if some fail." }, "put": { "description": "Updates one or more scoring rules. Returns 200 (all success) or 207 (partial success).", "operationId": "putScoringRules", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample update Scoring Rules request body", "value": { "scoring_rules": [ { "field_rules": [ { "criteria": { "comparator": "not_equal", "field": { "api_name": "Country", "data_type": "text", "id": "111114000000004892" }, "type": "value", "value": "${EMPTY}" }, "score": -10 }, { "id": "111114000000004892", "score": 45 } ], "id": "111114000000072349" }, { "id": "111114000000072349", "name": "Altered Scoring" }, { "custom_fields": [ { "field_label": "Contact Total Score", "reference_field": { "api_name": "Score" } } ], "id": "111114000000072349", "signal_rules": [ { "_delete": null, "id": "111114000000012345" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateScoringRulesRequestBody" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "Accepts a JSON request body containing an array of Scoring Rule updates." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful update Scoring Rules response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000313122" }, "message": "scoring rule updated successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111114000000313143" }, "message": "scoring rule updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRulesPutSuccessResponse" } } }, "description": "Rules updated successfully" }, "207": { "content": { "application/json": { "examples": { "Success207": { "summary": "Partial success update Scoring Rules response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000313122" }, "message": "scoring rule updated successfully", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].id" }, "message": "The id given seems to be invalid", "status": "error" }, { "code": "SUCCESS", "details": { "id": "111114000000313143" }, "message": "scoring rule updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PutScoringRulesPartialSuccessResponse" } } }, "description": "Few rule object has errors, others are updated successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadyUsedResponse1": { "description": "Demonstrates an error when a custom field is already in use in another Scoring Rule.\n**Resolution:** Use a different custom field.", "summary": "Error response with code ALREADY_USED: The custom field has already used in other places (Field: id)", "value": { "scoring_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "id", "associated_places": [ { "id": "1000000067060", "name": "L WFR", "type": "workflow" } ], "id": "1000000000047", "json_path": "$.scoring_rules[0].custom_fields[2].id" }, "message": "The custom field has already used in other places", "status": "error" } ] } }, "AlreadyUsedResponse2": { "description": "Demonstrates an error when the request submits the same reference field for more than one custom field or the reference field is already associated with another custom field in same Scoring Rule.\n**Resolution:** Assign each reference field to only one custom field.", "summary": "Error response with code ALREADY_USED: Duplicate reference field (Field: reference_field)", "value": { "scoring_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "reference_field", "json_path": "$.scoring_rules[0].custom_fields[1].reference_field" }, "message": "Duplicate reference field", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse1": { "description": "Demonstrates an error when ambiguity occurs during request processing.\n**Resolution:** Review the request for conflicting field references.", "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity while processing the request", "value": { "scoring_rules": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" }, { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Demonstrates an error when a duplicate Scoring Rule name is detected.\n**Resolution:** Provide a unique name for the Scoring Rule.", "summary": "Error response with code DUPLICATE_DATA: The data is already given in the name (Field: name)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name" }, "message": "The data is already given in the name", "status": "error" } ] } }, "DuplicateDataResponse2": { "description": "Demonstrates an error when a duplicate custom field label is detected.\n**Resolution:** Provide a unique display name for each custom field.", "summary": "Error response with code DUPLICATE_DATA: Field label duplicate (Field: field_label)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Field label duplicate", "status": "error" } ] } }, "DuplicateDataResponse3": { "description": "Demonstrates an error when a duplicate custom field label is detected.\n**Resolution:** Provide a unique display name for each custom field.", "summary": "Error response with code DUPLICATE_DATA: Field label duplicate (Field: field_label)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Field label duplicate", "status": "error" } ] } }, "DuplicateDataResponse4": { "description": "Demonstrates an error when duplicate criteria are found in the Scoring Rule.\n**Resolution:** Remove duplicate criteria entries.", "summary": "Error response with code DUPLICATE_DATA: The criteria is already available in the rule (Field: criteria)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "criteria", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "message": "The criteria is already available in the rule", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "description": "Demonstrates an error when the reference field value is empty in the Scoring Rule.\n**Resolution:** Include at least one field(id or api_name) in the reference field value object.", "summary": "Error response with code EXPECTED_FIELD_MISSING: Specify atleast one field", "value": { "scoring_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name" }, { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "FieldLimitExceededResponse1": { "summary": "Error response with code FIELD_LIMIT_EXCEEDED: Field limit reached for the given field type in the given module", "value": { "scoring_rules": [ { "code": "FIELD_LIMIT_EXCEEDED", "details": { "limit": 40 }, "message": "Field limit reached for the given field type in the given module", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error when the Scoring Rule name contains invalid data.\n**Resolution:** Provide a valid name that meets the format requirements.", "summary": "Error response: INVALID_DATA for invalid rule name", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "maximum_length": 25 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Demonstrates an error when `field_rules` contains an invalid data type.\n**Resolution:** Ensure `field_rules` is an array of valid objects.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_rules", "expected_data_type": "jsonarray", "json_path": "$.scoring_rules[0].field_rules" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Demonstrates an error when `field_rules` contains invalid data.\n**Resolution:** Verify each field rule object is valid.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: field_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_rules", "json_path": "$.scoring_rules[0].field_rules", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Demonstrates an error when criteria contains an invalid data type.\n**Resolution:** Ensure `criteria` is a valid object.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: criteria)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse14": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: score)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "score", "expected_data_type": "integer", "json_path": "$.scoring_rules[0].field_rules[0].score" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates an error when the Scoring Rule name contains invalid data.\n**Resolution:** Provide a valid Scoring Rule name.", "summary": "Error response with code INVALID_DATA: invalid data (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "regex": "[^`~#%^&*()+=\";<>\\[\\]{}|\\\\]+$" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error when the description contains invalid data.\n**Resolution:** Ensure the description value is valid.", "summary": "Error response with code INVALID_DATA: invalid data (Field: description)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.scoring_rules[0].description", "maximum_length": 500 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error when the `field_label` contains special characters.\n**Resolution:** Remove special characters from the field label.", "summary": "Error response with code INVALID_DATA: Special characters in field label (Field: field_label)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Special characters in field label", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error when the `field_label` contains invalid data.\n**Resolution:** Provide a valid display name for the custom field.", "summary": "Error response with code INVALID_DATA: invalid data (Field: field_label)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Demonstrates an error when the reference field API name is invalid.\n**Resolution:** Provide a valid API name for the reference field.", "summary": "Error response with code INVALID_DATA: Reference field api_name given seems to be invalid (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name", "supported_values": [ "Positive_Score", "Negative_score", "Touch_Point_score", "Touch_Point_Positive_Score", "Touch_Point_Negative_Score", "Score" ] }, "message": "Reference field api_name given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Demonstrates an error when the custom field ID is invalid.\n**Resolution:** Provide a valid custom field ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[1].id" }, "message": "The id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Demonstrates an error when the reference field ID is invalid.\n**Resolution:** Provide a valid reference field ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" }, "message": "The id given seems to be invalid", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error when a required field is missing from the request.\n**Resolution:** Include all required fields in the request.", "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: reference_field | field_label)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_field | field_label", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field | $.scoring_rules[0].custom_fields[0].field_label" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Demonstrates an error when the field_label contains a reserved system keyword.\n**Resolution:** Use a label that does not contain reserved system keywords.", "summary": "Error response with code NOT_ALLOWED: System keyword not allowed in field label (Field: field_label)", "value": { "scoring_rules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "System keyword not allowed in field label", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the wrapped error response containing per-item error objects for the update Scoring Rules operation.", "properties": { "scoring_rules": { "description": "Represents an array of per-item error objects in the update Scoring Rules error response.", "items": { "$ref": "#/components/schemas/GeneralErrorResponse" }, "maxItems": 25, "type": "array" } }, "required": [ "scoring_rules" ], "type": "object", "x-zs-$id": "ScoringRulesPutErrorResponse" } } }, "description": "Returns an error response when the request contains invalid or missing data.\n**Resolution:** Verify that all field values are valid and required fields are present." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.UPDATE" ] } ], "summary": "Scoring Rules", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Bulk-updates one or more scoring rules in a single request. Each rule in `scoring_rules` must identify the target via `id`. Partial updates are supported - only include fields that need to change; omitted fields are left unchanged.\n\n**Updatable fields per rule:**\n- `name` - rename the scoring rule.\n- `description` - update the rule description.\n- `active` - enable or disable the rule.\n- `field_rules` - CRM field criteria mapped to scores. Each entry needs `criteria` and `score`.\n- `signal_rules` - interaction signal rules. To delete an entry, supply its `id` with `_delete: null`.\n- `custom_fields` - reassign or rename score field mappings (up to 6). To delete an entry, supply its `id` with `_delete: null`.\n\n**Deleting nested entries with `_delete`:**\nTo remove an individual `signal_rule` or `custom_field` entry without replacing the entire array, include its `id` and set `_delete: null`.\n\nReturns 200 if all succeed, 207 (multi-status) if some fail." } }, "/crm/v8/settings/automation/scoring_rules/{ruleId}": { "delete": { "description": "Permanently deletes a single scoring rule identified by ruleId", "operationId": "deleteScoringRuleById", "parameters": [ { "$ref": "#/components/parameters/ParamPathRuleid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful delete Scoring Rule by ID response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000317200" }, "message": "scoring rule deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRuleDeleteSuccessResponse" } } }, "description": "Returns the operation status after deleting the specified Scoring Rule." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates an error response when the provided Scoring Rule ID is invalid.\n**Resolution:** Provide a valid Scoring Rule ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "The id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidRuleIdErrorResponse" } } }, "description": "Returns an error response when the provided Scoring Rule ID is invalid.\n**Resolution:** Verify that the ID is a valid Scoring Rule ID before retrying." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.DELETE" ] } ], "summary": "Delete a scoring rules by ID", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Delete a single scoring rule by ruleId. Returns 200 on success. Returns INVALID_DATA if the ruleId does not correspond to an existing rule." }, "get": { "description": "To retrieve the details of a specific Scoring Rule by its ID in your Zoho CRM organization.", "operationId": "getScoringRuleById", "parameters": [ { "$ref": "#/components/parameters/ParamPathRuleid" }, { "$ref": "#/components/parameters/ScoringRulesParamQueryIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful get Scoring Rule by ID response", "value": { "scoring_rules": [ { "active": false, "created_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "created_time": "2025-11-19T19:56:51+05:30", "custom_fields": [ { "api_name": "Lead_Scoring_Score", "id": "111114000000314018" }, { "api_name": "Lead_Scoring_Touch_point_Score", "id": "111114000000314035" } ], "description": null, "field_rules": [ { "criteria": { "group": [ { "comparator": "equal", "field": { "api_name": "CF_Date", "id": "111114000000081970" }, "type": "value", "value": "2025-11-19" }, { "comparator": "equal", "field": { "api_name": "Company", "id": "111114000000004780" }, "type": "value", "value": "Zohho" } ], "group_operator": "AND" }, "id": "111114000000314010", "score": 10 }, { "criteria": { "comparator": "not_equal", "field": { "api_name": "Country", "id": "111114000000004892" }, "type": "value", "value": "${EMPTY}" }, "id": "111114000000314012", "score": -10 } ], "has_signal_rules": false, "id": "111114000000314009", "layout": { "api_name": "Standard", "display_label": "Standard", "id": "111114000000003626" }, "modified_by": { "id": "111114000000057344", "name": "Vignesh SR", "zuid": "43249796" }, "modified_time": "2025-11-21T11:26:40+05:30", "module": { "api_name": "Leads", "id": "111114000000002628" }, "name": "Lead - Scoring", "signal_rules": [ { "id": "111114000000316001", "score": -100, "signal": { "id": "111114000000034755", "namespace": "zoho.emailinsight.bounce" } }, { "id": "111114000000316002", "score": 10, "signal": { "id": "111114000000034749", "namespace": "zoho.emailinsight.open" } } ] } ] } } }, "schema": { "$ref": "#/components/schemas/SuccessResponseGETById" } } }, "description": "Returns the details of the Scoring Rule matching the specified ID." }, "204": { "description": "No rule is available for the given rule id" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.READ" ] } ], "summary": "Get scoring rule by ID", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Retrieves the complete details of a single scoring rule by its unique `ruleId`. The response includes field-based scoring criteria (`field_rules`), touch-point signal rules (`signal_rules`), custom score tracking fields (`custom_fields`), associated layout and module, and audit metadata such as `created_by`, `modified_by`, and timestamps. Returns 204 with no body if no rule exists for the given ID." }, "put": { "description": "To update a specific Scoring Rule by its ID in your Zoho CRM organization.", "operationId": "putScoringRuleById", "parameters": [ { "$ref": "#/components/parameters/ParamPathRuleid" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample update Scoring Rule by ID request body", "value": { "scoring_rules": [ { "custom_fields": [ { "field_label": "Contact Total Score", "reference_field": { "api_name": "Score" } }, { "field_label": "Total score", "id": "111114000000012345" } ], "field_rules": [ { "criteria": { "comparator": "not_equal", "field": { "api_name": "Country", "data_type": "text", "field_label": "Country", "id": "111114000000004892" }, "type": "value", "value": "${EMPTY}" }, "score": -10 }, { "id": "111114000000004892", "score": 45 } ], "id": "111114000000072349", "name": "Altered scoring", "signal_rules": [ { "_delete": null, "id": "111114000000012345" }, { "score": -100, "signal": { "id": "111114000000034755", "namespace": "zoho.emailinsight.bounce" } } ] } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateScoringRulesByIDRequestBody" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "Accepts a JSON request body containing the updated Scoring Rule definition." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful update Scoring Rule by ID response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000313122" }, "message": "scoring rule updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRulePutSuccessResponse" } } }, "description": "Returns the operation status after updating the specified Scoring Rule." }, "400": { "content": { "application/json": { "examples": { "AlreadyUsedResponse1": { "description": "Demonstrates an error when a custom field is already in use in another Scoring Rule.\n**Resolution:** Use a different custom field.", "summary": "Error response with code ALREADY_USED: The custom field has already used in other places (Field: id)", "value": { "scoring_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "id", "associated_places": [ { "id": "111111000000067060", "name": "L WFR", "type": "workflow" } ], "id": "1000000000047", "json_path": "$.scoring_rules[0].custom_fields[2].id" }, "message": "The custom field has already used in other places", "status": "error" } ] } }, "AlreadyUsedResponse2": { "description": "Demonstrates an error when the request submits the same reference field for more than one custom field.\n**Resolution:** Assign each reference field to only one custom field.", "summary": "Error response with code ALREADY_USED: Duplicate reference field (Field: reference_field)", "value": { "scoring_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "reference_field", "json_path": "$.scoring_rules[0].custom_fields[1].reference_field" }, "message": "Duplicate reference field", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse1": { "description": "Demonstrates an error when ambiguity occurs during request processing.\n**Resolution:** Review the request for conflicting field references.", "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity while processing the request", "value": { "scoring_rules": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" }, { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Demonstrates an error when a duplicate Scoring Rule name is detected.\n**Resolution:** Provide a unique name for the Scoring Rule.", "summary": "Error response with code DUPLICATE_DATA: The data is already given in the name (Field: name)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name" }, "message": "The data is already given in the name", "status": "error" } ] } }, "DuplicateDataResponse2": { "description": "Demonstrates an error when a duplicate custom field label is detected.\n**Resolution:** Provide a unique display name for each custom field.", "summary": "Error response with code DUPLICATE_DATA: Field label duplicate (Field: field_label)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Field label duplicate", "status": "error" } ] } }, "DuplicateDataResponse3": { "description": "Demonstrates an error when a duplicate custom field label is detected.\n**Resolution:** Provide a unique display name for each custom field.", "summary": "Error response with code DUPLICATE_DATA: Field label duplicate (Field: field_label)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Field label duplicate", "status": "error" } ] } }, "DuplicateDataResponse4": { "description": "Demonstrates an error when duplicate criteria are found within the same rule.\n**Resolution:** Remove duplicate criteria entries.", "summary": "Error response with code DUPLICATE_DATA: The criteria is already available in the rule (Field: criteria)", "value": { "scoring_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "criteria", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "message": "The criteria is already available in the rule", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "description": "Demonstrates an error when no fields are specified in the Scoring Rule.\n**Resolution:** Include at least one field in the Scoring Rule configuration.", "summary": "Error response with code EXPECTED_FIELD_MISSING: Specify atleast one field", "value": { "scoring_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name" }, { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "FieldLimitExceededResponse1": { "summary": "Error response with code FIELD_LIMIT_EXCEEDED: Field limit reached for the given field type in the given module", "value": { "scoring_rules": [ { "code": "FIELD_LIMIT_EXCEEDED", "details": { "limit": 40 }, "message": "Field limit reached for the given field type in the given module", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error when the Scoring Rule name contains invalid data.\n**Resolution:** Provide a valid name that meets the format requirements.", "summary": "Error response with code INVALID_DATA: invalid data (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "maximum_length": 25 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Demonstrates an error when the Scoring Rule ID contains invalid data.\n**Resolution:** Provide a valid Scoring Rule ID.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Demonstrates an error when the name contains an invalid data type.\n**Resolution:** Ensure `name` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.scoring_rules[0].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Demonstrates an error when the name contains invalid data.\n**Resolution:** Provide a valid Scoring Rule name.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "maximum_length": 15 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Demonstrates an error when `field_rules` contains an invalid data type.\n**Resolution:** Ensure `field_rules` is an array of valid objects.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_rules", "expected_data_type": "jsonarray", "json_path": "$.scoring_rules[0].field_rules" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Demonstrates an error when `field_rules` contains invalid data.\n**Resolution:** Verify each field rule object is valid.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: field_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_rules", "json_path": "$.scoring_rules[0].field_rules", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Demonstrates an error when criteria contains an invalid data type.\n**Resolution:** Ensure `criteria` is a valid object.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: criteria)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].field_rules[0].criteria" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Demonstrates an error when criteria contains invalid data.\n**Resolution:** Verify the criteria object is valid.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: criteria)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "criteria", "json_path": "$.scoring_rules[0].field_rules[0].criteria", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates an error when the Scoring Rule name contains invalid data.\n**Resolution:** Provide a valid name.", "summary": "Error response with code INVALID_DATA: invalid data (Field: name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.scoring_rules[0].name", "regex": "[^`~#%^&*()+=\";<>\\[\\]{}|\\\\]+$" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error when the description contains invalid data.\n**Resolution:** Ensure the description value is valid.", "summary": "Error response with code INVALID_DATA: invalid data (Field: description)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.scoring_rules[0].description", "maximum_length": 500 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse33": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: score)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "score", "expected_data_type": "integer", "json_path": "$.scoring_rules[0].field_rules[0].score" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse34": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: signal_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "signal_rules", "expected_data_type": "jsonarray", "json_path": "$.scoring_rules[0].signal_rules" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse35": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: signal_rules)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "signal_rules", "json_path": "$.scoring_rules[0].signal_rules", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse36": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.scoring_rules[0].signal_rules[0].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse37": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].signal_rules[0].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse39": { "description": "Demonstrates an error when the `custom_fields` array contains an invalid data type.\n**Resolution:** Ensure `custom_fields` is an array of valid objects.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: custom_fields)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_fields", "expected_data_type": "jsonarray", "json_path": "$.scoring_rules[0].custom_fields" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error when the `field_label` contains special characters.\n**Resolution:** Remove special characters from the field label.", "summary": "Error response with code INVALID_DATA: Special characters in field label (Field: field_label)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Special characters in field label", "status": "error" } ] } }, "InvalidDataResponse40": { "description": "Demonstrates an error when the `custom_fields` array contains invalid data.\n**Resolution:** Verify each custom field object is valid.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: custom_fields)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_fields", "json_path": "$.scoring_rules[0].custom_fields", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse41": { "description": "Demonstrates an error when the `field_label` contains an invalid data type.\n**Resolution:** Ensure `field_label` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field_label)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "expected_data_type": "text", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse43": { "description": "Demonstrates an error when the `reference_field` contains an invalid data type.\n**Resolution:** Ensure `reference_field` is a valid object.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: reference_field)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_field", "expected_data_type": "jsonobject", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse45": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error when the `field_label` contains invalid data.\n**Resolution:** Provide a valid display name for the custom field.", "summary": "Error response with code INVALID_DATA: invalid data (Field: field_label)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Demonstrates an error when the reference field API name is invalid.\n**Resolution:** Provide a valid API name for the reference field.", "summary": "Error response with code INVALID_DATA: Reference field api_name given seems to be invalid (Field: api_name)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.api_name", "supported_values": [ "Positive_Score", "Negative_score", "Touch_Point_score", "Touch_Point_Positive_Score", "Touch_Point_Negative_Score", "Score" ] }, "message": "Reference field api_name given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Demonstrates an error when the custom field ID is invalid.\n**Resolution:** Provide a valid custom field ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[1].id" }, "message": "The id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Demonstrates an error when the reference field ID is invalid.\n**Resolution:** Provide a valid reference field ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field.id" }, "message": "The id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Demonstrates an error when the ID contains an invalid data type.\n**Resolution:** Ensure `id` is a string value.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "scoring_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.scoring_rules[0].id" }, "message": "Invalid data type", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error when a required field is missing from the request.\n**Resolution:** Include all required fields in the request.", "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: reference_field | field_label)", "value": { "scoring_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_field | field_label", "json_path": "$.scoring_rules[0].custom_fields[0].reference_field | $.scoring_rules[0].custom_fields[0].field_label" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Demonstrates an error when the field_label contains a reserved system keyword.\n**Resolution:** Use a label that does not contain reserved system keywords.", "summary": "Error response with code NOT_ALLOWED: System keyword not allowed in field label (Field: field_label)", "value": { "scoring_rules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "field_label", "json_path": "$.scoring_rules[0].custom_fields[0].field_label" }, "message": "System keyword not allowed in field label", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the wrapped error response for the update Scoring Rule by ID operation.", "properties": { "scoring_rules": { "description": "Represents an array of per-item error objects in the update Scoring Rule by ID error response.", "items": { "$ref": "#/components/schemas/GeneralErrorResponse" }, "maxItems": 25, "type": "array" } }, "required": [ "scoring_rules" ], "type": "object", "x-zs-$id": "ScoringRulesPut400ErrorResponse" } } }, "description": "Returns an error response when the request contains invalid or missing data.\n**Resolution:** Verify that all field values are valid and required fields are present." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.UPDATE" ] } ], "summary": "Update a scoring rules by ID", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Updates an existing scoring rule identified by the `ruleId` path parameter. The request body must contain a `scoring_rules` array with exactly one rule object. Partial updates are supported - only include the top-level fields that need to change.\n\n**Updatable fields:**\n- `name` - rename the scoring rule.\n- `description` - update the rule description.\n- `active` - enable or disable the rule.\n- `field_rules` - CRM field criteria mapped to scores. Each entry needs `criteria` and `score`.\n- `signal_rules` - interaction signal rules. Each entry needs `signal` and `score`. To delete a `signal_rule` entry, include its `id` with `_delete: null`.\n- `custom_fields` - reassign or rename CRM score field mappings (up to 6). To delete a mapping, supply its `id` with `_delete: null`.\n\n**Deleting nested entries with `_delete`:**\nTo remove an individual `field_rule` or `signal_rule` or `custom_field` entry without replacing the entire array, include the entry's `id` and set `_delete: null`.\n\nReturns 200 on success." } }, "/crm/v8/settings/automation/scoring_rules/{ruleId}/actions/activate": { "delete": { "description": "Deactivates an active scoring rule identified by `ruleId`, suspending its scoring evaluation without deleting it.", "operationId": "deleteActivate", "parameters": [ { "$ref": "#/components/parameters/ParamPathRuleid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful deactivate Scoring Rule response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000313122" }, "message": "scoring rule deactivated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRulesDeactivateSuccessResponse" } } }, "description": "Returns the operation status after the Scoring Rule is deactivated." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates an error response when the provided Scoring Rule ID is invalid.\n**Resolution:** Provide a valid Scoring Rule ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "The id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidRuleIdErrorResponse" } } }, "description": "Returns an error response when the provided Scoring Rule ID is invalid.\n**Resolution:** Verify that the ID is a valid Scoring Rule ID before retrying." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.DELETE" ] } ], "summary": "Deactivate a scoring rule", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Deactivate an active scoring rule by ruleId. The rule is retained but no longer evaluated during record updates. No request body required." }, "put": { "description": "Activates an inactive scoring rule identified by `ruleId`, enabling it to start evaluating and scoring CRM records based on its configured criteria.", "operationId": "putActivate", "parameters": [ { "$ref": "#/components/parameters/ParamPathRuleid" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Demonstrates a sample request body for the activate Scoring Rule operation.", "summary": "Sample activate Scoring Rule request body", "value": {} } }, "schema": { "$ref": "#/components/schemas/EmptyRequestBody" } } }, "description": "Accepts an empty JSON request body to activate the specified Scoring Rule." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful activate Scoring Rule response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000313122" }, "message": "scoring rule activated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRuleActivateSuccessResponse" } } }, "description": "Returns the operation status after the Scoring Rule is activated." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates an error response when the provided Scoring Rule ID is invalid.\n**Resolution:** Provide a valid Scoring Rule ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "The id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidRuleIdErrorResponse" } } }, "description": "Returns an error response when the provided Scoring Rule ID is invalid.\n**Resolution:** Verify that the ID is a valid Scoring Rule ID before retrying." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.UPDATE" ] } ], "summary": "Activate a scoring rule", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Activate a scoring rule by ruleId. Send an empty request body ({}). Maximum 5 active rules per layout; exceeding returns ACTIVE_STATE_LIMIT_EXCEEDED." } }, "/crm/v8/settings/automation/scoring_rules/{ruleId}/actions/clone": { "post": { "description": "To clone a Scoring Rule in your Zoho CRM organization.", "operationId": "postClone", "parameters": [ { "$ref": "#/components/parameters/ParamPathRuleid" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Demonstrates a sample request body for the clone Scoring Rule operation.", "summary": "Sample clone Scoring Rule request body", "value": {} } }, "schema": { "$ref": "#/components/schemas/EmptyRequestBody" } } }, "description": "Accepts an empty JSON request body to clone the specified Scoring Rule." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful clone Scoring Rule response", "value": { "scoring_rules": [ { "code": "SUCCESS", "details": { "id": "111114000000317265" }, "message": "scoring rule cloned successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ScoringRuleCloneSuccessResponse" } } }, "description": "Returns the operation status after the Scoring Rule is cloned." }, "400": { "content": { "application/json": { "examples": { "ActiveStateLimitExceededResponse1": { "description": "Demonstrates an error response when the maximum number of active Scoring Rules for the layout has been reached.\n**Resolution:** Deactivate existing Scoring Rules before cloning.", "summary": "Error response with code ACTIVE_STATE_LIMIT_EXCEEDED: More than 5 active scoring rules cannot be created for a layout (Field: id)", "value": { "scoring_rules": [ { "code": "ACTIVE_STATE_LIMIT_EXCEEDED", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].layout.id", "limit": 5 }, "message": "More than 5 active scoring rules cannot be created for a layout", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error response when the provided Scoring Rule ID is invalid.\n**Resolution:** Provide a valid Scoring Rule ID.", "summary": "Error response with code INVALID_DATA: The id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "The id given seems to be invalid", "status": "error" } }, "LimitExceededResponse1": { "description": "Demonstrates an error response when the total number of Scoring Rules for the layout has been reached.\n**Resolution:** Delete existing Scoring Rules before cloning.", "summary": "Error response with code LIMIT_EXCEEDED: More than 10 scoring rules cannot be created for a layout (Field: id)", "value": { "scoring_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "id", "json_path": "$.scoring_rules[0].layout.id", "limit": 10 }, "message": "More than 10 scoring rules cannot be created for a layout", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidRuleIdErrorResponse" }, { "additionalProperties": false, "description": "Wrapped error response with scoring_rules", "properties": { "scoring_rules": { "description": "Represents an array of per-item error objects in the clone Scoring Rule error response.", "items": { "anyOf": [ { "$ref": "#/components/schemas/GlobalScoringRuleLimitExceededErrorResponse" }, { "$ref": "#/components/schemas/ActiveStateLimitErrorResponse" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "scoring_rules" ], "type": "object", "x-zs-$id": "ScoringRuleCloneErrorOption2" } ], "x-zs-$id": "ScoringRuleCloneErrorResponse" } } }, "description": "Returns an error response when the maximum number of active or total Scoring Rules for the layout has been reached.\n**Resolution:** Deactivate or delete existing Scoring Rules before cloning." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.scoring_rules.CREATE" ] } ], "summary": "Clone a scoring rule", "tags": [ "scoring_rules" ], "x-zoho-document": "scoring_rules", "x-zs-llm-description": "Clone a scoring rule by ruleId. Creates an exact copy with name prefixed 'Copy of'. The clone is inactive by default. Send an empty request body ({})." } }, "/crm/v8/settings/automation/tasks": { "delete": { "description": "PURPOSE: Deletes one or more automation task definitions by their IDs. MANDATORY: ids query parameter (comma-separated task IDs, max 10). KEY CONSTRAINTS: Tasks associated with active workflow rules, approval processes, or blueprints cannot be deleted (returns NOT_ALLOWED error). Returns per-task success/error status. Use GET /settings/automation/tasks to discover task IDs before deleting.", "operationId": "deleteTasks", "parameters": [ { "$ref": "#/components/parameters/WorkflowTasksParamQueryIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "BulkDeleteSuccessResponse": { "description": "Returns one SUCCESS entry per requested task ID, indicating that every automation task in the **ids** list was deleted from the organization.", "summary": "All tasks deleted successfully", "value": { "tasks": [ { "code": "SUCCESS", "details": { "id": "111111000000098788" }, "message": "task deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkDeleteTasksSuccessResponse" } } }, "description": "Bulk delete completed successfully for all requested task IDs." }, "207": { "content": { "application/json": { "examples": { "BulkDeleteMixedResponse": { "description": "Returns a mixed-status response with one entry per requested ID, where some tasks were deleted successfully and others failed with NOT_ALLOWED or INVALID_DATA.", "summary": "Mixed success and failure results", "value": { "tasks": [ { "code": "SUCCESS", "details": { "id": "111111000000200035" }, "message": "task deleted successfully", "status": "success" }, { "code": "NOT_ALLOWED", "details": { "id": "111111000000190030" }, "message": "the specified task is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" }, { "code": "SUCCESS", "details": { "id": "111111000000165002" }, "message": "task deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkDeleteTasksMixedResponse" } } }, "description": "Bulk delete completed with mixed results. Some task IDs were deleted successfully while others failed with INVALID_DATA or NOT_ALLOWED." }, "400": { "content": { "application/json": { "examples": { "AllFailedArrayResponse": { "description": "Returns an array of per-ID failure entries when every task ID in the bulk DELETE request failed, surfacing NOT_ALLOWED and INVALID_DATA reasons individually.", "summary": "All IDs failed - per-ID error details in array", "value": { "tasks": [ { "code": "NOT_ALLOWED", "details": { "id": "111111000000190030" }, "message": "the specified task is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "111111000000195072" }, "message": "the id given seems to be invalid", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "111111000000195032" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "IdsLimitExceededResponse": { "description": "Returns the INVALID_DATA error when the **ids** query parameter contains more than 10 task IDs in a single request.", "summary": "INVALID_DATA: More than 10 IDs provided in the ids parameter", "value": { "code": "INVALID_DATA", "details": { "maximum_length": 10, "param_name": "ids" }, "message": "Ids maximum length exceeded", "status": "error" } }, "InvalidIdResponse": { "description": "Returns the INVALID_DATA error when one of the task IDs in the **ids** parameter does not exist in the organization.", "summary": "INVALID_DATA: One of the provided task IDs does not exist", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "ReadOnlyActionNotAllowedResponse": { "description": "Returns the NOT_ALLOWED error when one of the targeted tasks is read-only or system-managed and cannot be deleted.", "summary": "NOT_ALLOWED: Cannot delete a read-only or system-managed task", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Insufficient privileges to delete action", "status": "error" } }, "RequiredParamMissingResponse": { "description": "Returns the REQUIRED_PARAM_MISSING error when the **ids** query parameter is omitted from the bulk DELETE request.", "summary": "REQUIRED_PARAM_MISSING: ids query parameter not provided", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } }, "TaskAssociatedNotAllowedResponse": { "description": "Returns the NOT_ALLOWED error when one of the targeted tasks is linked to an active Approval Process, workflow rule, or Blueprint and cannot be deleted.", "summary": "NOT_ALLOWED: Task is linked to a workflow rule, Approval Process, or Blueprint", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "the specified task is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowTasksRequiredParamMissingError" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/TaskNotAllowedSchema" }, { "$ref": "#/components/schemas/BulkDeleteTasksAllFailedResponse" } ], "description": "Error response returned when a bulk delete of automation tasks fails validation, covering missing or oversized ids parameter and per-task delete failures.", "x-zs-$id": "DeleteTasksErrorResponses" } } }, "description": "Request validation failed or all provided task IDs failed deletion. Flat error for request-level issues (missing ids, limit exceeded, single-ID errors). Array response when multiple IDs all fail individually." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailureResponse": { "description": "Returns the AUTHENTICATION_FAILURE error when the request is missing a valid access token or the supplied token has expired.", "summary": "AUTHENTICATION_FAILURE: Authentication failed", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OauthScopeMismatchResponse": { "description": "Returns the OAUTH_SCOPE_MISMATCH error when the access token does not include the OAuth scope required to delete automation tasks.", "summary": "OAUTH_SCOPE_MISMATCH: Unauthorized", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PostTasksAuthenticationErrorResponse" } } }, "description": "Authentication or scope error while deleting automation tasks." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returns the NO_PERMISSION error when the user profile lacks the Crm_Implied_Manage_Workflow or WorkFlow_Tasks permission required to delete automation tasks.", "summary": "NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "WorkFlow_Tasks" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskNoPermissionSchema" } } }, "description": "Insufficient permission or feature not available in this CRM edition." }, "404": { "content": { "application/json": { "examples": { "InvalidTaskIdResponse": { "description": "Returns the INVALID_DATA error when one of the task IDs in the **ids** parameter does not exist in the organization.", "summary": "INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskInvalidDataSchema" } } }, "description": "The provided task ID does not exist." }, "500": { "content": { "application/json": { "examples": { "InternalServerErrorResponse": { "description": "Returns the INTERNAL_ERROR response when an unexpected server-side exception prevents the bulk delete from completing.", "summary": "INTERNAL_ERROR: Internal Server Error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } }, "description": "Internal server error." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.DELETE" ] } ], "summary": "Delete automation task definitions by IDs (bulk)", "tags": [ "workflow_tasks" ], "x-zoho-document": "workflow_tasks", "x-zs-llm-description": "Bulk-removes automation task definitions; pass ids as a comma-separated query parameter (up to 10). Tasks linked to active workflow rules, approval processes, or blueprints are blocked with NOT_ALLOWED. The response reports success or error per task. Use GET /settings/automation/tasks to look up task IDs first." }, "get": { "description": "PURPOSE: Retrieves a paginated list of automation task definitions. Supports filtering by module, feature_type, and name (via filter param). PAGINATION: page (default 1), per_page (default 200, max 200). Use info.more_records to determine if additional pages exist. A 204 response indicates no tasks match the supplied filters. Use this before PUT/DELETE to discover task IDs.", "operationId": "getWorkflowTasks", "parameters": [ { "$ref": "#/components/parameters/WorkflowTasksParamQueryFilter" }, { "$ref": "#/components/parameters/WorkflowTasksParamQueryFeatureType" }, { "$ref": "#/components/parameters/WorkflowTasksParamQueryModule" }, { "$ref": "#/components/parameters/WorkflowTasksParamQueryPerPage" }, { "$ref": "#/components/parameters/WorkflowTasksParamQueryPage" }, { "$ref": "#/components/parameters/WorkflowTasksParamQuerySortBy" }, { "$ref": "#/components/parameters/WorkflowTasksParamQuerySortOrder" } ], "responses": { "200": { "content": { "application/json": { "examples": { "TasksListSuccess": { "description": "Returns a paginated list of automation tasks spanning multiple modules and feature types, demonstrating workflow and approval-process tasks alongside varied field mapping configurations.", "summary": "Successful response listing automation tasks with different feature types and field mapping configurations", "value": { "info": { "count": 4, "more_records": false, "page": 1, "per_page": 200 }, "tasks": [ { "associated": true, "created_by": { "id": "3479217000000539001", "name": "John Smith" }, "created_time": "2025-08-15T10:30:00+00:00", "deletable": true, "editable": true, "feature_type": "workflow", "field_mappings": [ { "display_value": "Follow up on new lead", "field": { "api_name": "Subject", "id": "3479217000000000221" }, "type": "static", "value": "Follow up on new lead" }, { "display_value": "Trigger Date plus 2 business day(s)", "field": { "api_name": "Due_Date", "id": "3479217000000000223" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "2" } }, { "display_value": "Not Started", "field": { "api_name": "Status", "id": "3479217000000000229" }, "type": "static", "value": "Not Started" }, { "display_value": "High", "field": { "api_name": "Priority", "id": "3479217000000000231" }, "type": "static", "value": "High" } ], "id": "3479217000002131001", "lock_status": { "locked": false }, "modified_by": { "id": "3479217000000539001", "name": "John Smith" }, "modified_time": "2025-09-10T14:20:00+00:00", "module": { "api_name": "Leads", "id": "3479217000000000125", "moduleName": "Leads", "plural_label": "Leads", "singular_label": "Lead" }, "name": "Follow up on new lead", "notify": true, "related_module": null, "source": "crm" }, { "associated": true, "created_by": { "id": "3479217000000539002", "name": "Jane Doe" }, "created_time": "2025-09-05T08:00:00+00:00", "deletable": false, "editable": false, "feature_type": "approval_process", "field_mappings": [ { "display_value": "${Deals.Deal_Name}", "field": { "api_name": "Subject", "id": "3479217000000000221" }, "type": "merge_field", "value": "${Deals.Deal_Name}" }, { "display_value": "Trigger Date plus 5 day(s)", "field": { "api_name": "Due_Date", "id": "3479217000000000223" }, "type": "execution_time", "value": { "period": "days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "5" } }, { "display_value": "In Progress", "field": { "api_name": "Status", "id": "3479217000000000229" }, "type": "static", "value": "In Progress" }, { "display_value": "Highest", "field": { "api_name": "Priority", "id": "3479217000000000231" }, "type": "static", "value": "Highest" } ], "id": "3479217000002131002", "lock_status": { "locked": true }, "modified_by": { "id": "3479217000000539002", "name": "Jane Doe" }, "modified_time": "2025-09-05T08:00:00+00:00", "module": { "api_name": "Deals", "id": "3479217000000000137", "moduleName": "Deals", "plural_label": "Deals", "singular_label": "Deal" }, "name": "${Deals.Deal_Name}", "notify": false, "related_module": null, "source": "crm" }, { "associated": false, "created_by": { "id": "3479217000000539001", "name": "John Smith" }, "created_time": "2025-10-01T12:00:00+00:00", "deletable": true, "editable": true, "feature_type": "kiosks", "field_mappings": [ { "display_value": "Onboard new contact", "field": { "api_name": "Subject", "id": "3479217000000000221" }, "type": "static", "value": "Onboard new contact" }, { "display_value": "Trigger Date plus 1 business day(s)", "field": { "api_name": "Due_Date", "id": "3479217000000000223" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "1" } }, { "display_value": "Not Started", "field": { "api_name": "Status", "id": "3479217000000000229" }, "type": "static", "value": "Not Started" }, { "display_value": "Normal", "field": { "api_name": "Priority", "id": "3479217000000000231" }, "type": "static", "value": "Normal" }, { "display_value": "${Contacts.Owner}", "field": { "api_name": "Owner", "id": "3479217000000000233" }, "type": "merge_field", "value": "${Contacts.Owner}" } ], "id": "3479217000002654408", "lock_status": { "locked": false }, "modified_by": { "id": "3479217000000539001", "name": "John Smith" }, "modified_time": "2025-10-15T09:45:00+00:00", "module": { "api_name": "Contacts", "id": "3479217000000000129", "moduleName": "Contacts", "plural_label": "Contacts", "singular_label": "Contact" }, "name": "Onboard new contact", "notify": true, "related_module": { "api_name": "Onboarding_Flows", "id": "3479217000002650297", "module_name": "ProcessFlow1", "plural_label": "Onboarding Flows", "singular_label": "Onboarding Flow" }, "source": "crm" }, { "associated": false, "created_by": { "id": "3479217000000539002", "name": "Jane Doe" }, "created_time": "2025-07-20T16:30:00+00:00", "deletable": true, "editable": true, "feature_type": "blueprint", "field_mappings": [ { "display_value": "Review escalated task", "field": { "api_name": "Subject", "id": "3479217000000000221" }, "type": "static", "value": "Review escalated task" }, { "display_value": "Trigger Date plus 3 day(s)", "field": { "api_name": "Due_Date", "id": "3479217000000000223" }, "type": "execution_time", "value": { "period": "days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "3" } }, { "display_value": "Waiting on someone else", "field": { "api_name": "Status", "id": "3479217000000000229" }, "type": "static", "value": "Waiting on someone else" }, { "display_value": "Low", "field": { "api_name": "Priority", "id": "3479217000000000231" }, "type": "static", "value": "Low" } ], "id": "3479217000002131012", "lock_status": { "locked": false }, "modified_by": { "id": "3479217000000539002", "name": "Jane Doe" }, "modified_time": "2025-10-20T11:15:00+00:00", "module": { "api_name": "Tasks", "id": "3479217000000000143", "moduleName": "Tasks", "plural_label": "Tasks", "singular_label": "Task" }, "name": "Review escalated task", "notify": false, "related_module": null, "source": "crm" } ] } } }, "schema": { "$ref": "#/components/schemas/GetTasksSuccessResponse" } } }, "description": "Successful retrieval of a page of automation tasks. The info object conveys pagination state (page, per_page, count, more_records)." }, "204": { "description": "No automation tasks match the supplied filters or no tasks exist in the organization." }, "400": { "content": { "application/json": { "examples": { "InvalidFeatureTypeResponse": { "description": "Returns the INVALID_DATA error when the **feature_type** query parameter is set to a value that the API does not recognize.", "summary": "Error response when feature_type param is invalid", "value": { "code": "INVALID_DATA", "details": { "param_name": "feature_type" }, "message": "the given feature name is invalid", "status": "error" } }, "InvalidModuleResponse": { "description": "Returns the INVALID_MODULE error when the **module** query parameter does not match a valid CRM module API name.", "summary": "Error response when module param value is invalid", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidSortByResponse": { "description": "Returns the INVALID_DATA error when the **sort_by** query parameter is set to a field other than **modified_time**.", "summary": "Error response when sort_by param is invalid", "value": { "code": "INVALID_DATA", "details": { "param_name": "sort_by" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidSortOrderResponse": { "description": "Returns the INVALID_DATA error when the **sort_order** query parameter is set to a value other than **asc** or **desc**.", "summary": "Error response when sort_order param is invalid", "value": { "code": "INVALID_DATA", "details": { "param_name": "sort_order" }, "message": "The value provided to the param is Invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/GetTasksListErrorResponse" } } }, "description": "Invalid query parameter (module or feature_type), or the feature is not allowed." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailureResponse": { "description": "Returns the AUTHENTICATION_FAILURE error when the request is missing a valid access token or the supplied token has expired.", "summary": "AUTHENTICATION_FAILURE: Authentication failed", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OauthScopeMismatchResponse": { "description": "Returns the OAUTH_SCOPE_MISMATCH error when the access token does not include the OAuth scope required to list automation tasks.", "summary": "OAUTH_SCOPE_MISMATCH: Unauthorized", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PostTasksAuthenticationErrorResponse" } } }, "description": "Authentication failed or session expired." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returns the NO_PERMISSION error when the user profile lacks the Crm_Implied_Manage_Workflow or WorkFlow_Tasks permission required to access automation tasks.", "summary": "Error response when edition lacks workflow task permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "WorkFlow_Tasks" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskNoPermissionSchema" } } }, "description": "No permission to access workflow tasks" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "List automation task definitions with optional filters", "tags": [ "workflow_tasks" ], "x-zoho-document": "workflow_tasks", "x-zs-llm-description": "Fetches a paginated list of automation task definitions; filter by module, feature_type, or name via the filter param. page defaults to 1, per_page defaults to 200 (max 200); check info.more_records to see if further pages exist. A 204 means no tasks matched the filters. Run this before PUT/DELETE to look up task IDs." }, "post": { "description": "PURPOSE: Creates an automation task definition used by workflow rules, approval processes, blueprints, kiosks, scoring rules, and case escalation rules. PREREQUISITES: (1) Call GET /settings/automation/tasks to check existing task definitions and avoid duplicates. (2) Call GET /settings/layouts?module=Tasks to discover supported fields and identify mandatory fields where required: true in the field info. STRUCTURE: The request body contains a tasks array with exactly 1 task object. Each task requires: name (string), module ({api_name, id}), and field_mappings (array). Omitting mandatory fields returns REQUIRED_DATA_NOT_FOUND. Returns the created task ID.", "operationId": "createWorkflowTasks", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a create payload for an automation task bound to the **Leads** module with merge_field, static, and execution_time field_mappings entries.", "summary": "Sample request body", "value": { "tasks": [ { "feature_type": "workflow", "field_mappings": [ { "field": { "api_name": "Description", "id": "6660682000000002291" }, "type": "merge_field", "value": "Automated task for ${!Leads.First_Name}${!Leads.Last_Name}" }, { "field": { "api_name": "Subject", "id": "6660682000000002271" }, "type": "static", "value": "SampleTask" }, { "field": { "api_name": "Due_Date", "id": "6660682000000000223" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "3" } }, { "field": { "api_name": "Status", "id": "6660682000000002279" }, "type": "static", "value": "Not Started" }, { "field": { "api_name": "Priority", "id": "6660682000000002281" }, "type": "static", "value": "High" }, { "field": { "api_name": "URL_1", "id": "6660682000001522480" }, "type": "merge_field", "value": "${!Leads.Website}" }, { "field": { "api_name": "Number_1", "id": "6660682000001522575" }, "type": "merge_field", "value": "${!Leads.No_of_Employees}" }, { "display_value": "100000000000000000", "field": { "api_name": "Long_Integer_1", "id": "6660682000001522533" }, "type": "static", "value": "100000000000000000" }, { "field": { "api_name": "Single_Line_1", "id": "6660682000001522561" }, "type": "static", "value": "sample task" }, { "field": { "api_name": "Pick_List_1", "id": "6660682000000922691" }, "type": "static", "value": "Voter ID" }, { "field": { "api_name": "Email_1", "id": "6660682000001465098" }, "type": "static", "value": "john@zohotest.cim" }, { "field": { "api_name": "Percent_1", "id": "6660682000001522617" }, "type": "static", "value": "50" }, { "field": { "api_name": "Currency_1", "id": "6660682000001522589" }, "type": "merge_field", "value": "${!Leads.Annual_Revenue}" }, { "field": { "api_name": "Phone_1", "id": "6660682000001522603" }, "type": "merge_field", "value": "${!Leads.Phone}" }, { "field": { "api_name": "Decimal_1", "id": "6660682000001522547" }, "type": "static", "value": "12" } ], "module": { "api_name": "Leads", "id": "6660682000000002175" }, "name": "NewTask", "notify": true } ] } } }, "schema": { "$ref": "#/components/schemas/TaskCreateOrUpdateRequest" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "Task payload for create or update. tasks must contain exactly one task object. Required keys inside task are name, module, and field_mappings." }, "responses": { "201": { "content": { "application/json": { "examples": { "CreateTaskSuccess": { "description": "Returns the SUCCESS code and the newly created automation task ID, confirming that the task definition was persisted.", "summary": "Task created successfully", "value": { "tasks": [ { "code": "SUCCESS", "details": { "id": "6660682000001550002" }, "message": "task created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateTaskSuccessResponse" } } }, "description": "Task definition created successfully." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse": { "description": "Returns the AMBIGUITY_DURING_PROCESSING error when a field reference inside field_mappings supplies both **id** and **api_name** and the two do not resolve to the same field.", "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity while processing the request", "value": { "tasks": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.tasks[0].field_mapping[0].field.id" }, { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[0].field.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentFieldMissingResponse": { "description": "Returns the DEPENDENT_FIELD_MISSING error when a field_mapping value omits the **field_name** key required by its dependee api_name.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: field_name)", "value": { "tasks": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "field_name", "dependee": { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[1].field.api_name" }, "json_path": "$.tasks[0].field_mapping[1].value.field_name" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse": { "description": "Returns the DEPENDENT_MISMATCH error when a field_mapping **value** is inconsistent with the dependee **api_name** specified for the same mapping.", "summary": "Error response with code DEPENDENT_MISMATCH: the given value is invalid (Field: value)", "value": { "tasks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[1].field.api_name" }, "json_path": "$.tasks[0].field_mapping[1].value", "maximum_length": 150 }, "message": "the given value is invalid", "status": "error" } ] } }, "DependentMismatchResponse3": { "description": "Returns the DEPENDENT_MISMATCH error when a field_mapping **type** is incompatible with the dependee field referenced by **id** in the same mapping entry.", "summary": "Error response with code DEPENDENT_MISMATCH: Dependent Field is not matching", "value": { "tasks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "api_name": "id", "json_path": "$.tasks[0].field_mappings[2].field.id" }, "json_path": "$.tasks[0].field_mappings[2].type" }, "message": "Dependent Field is not matching", "status": "error" } ] } }, "DependentMismatchResponse4": { "description": "Returns the DEPENDENT_MISMATCH error when a field_mapping **value** does not match the value shape expected by the field_mapping **type**.", "summary": "Error response with code DEPENDENT_MISMATCH: Type and value is mismatched", "value": { "tasks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "type", "json_path": "$.tasks[0].field_mappings[0].type" }, "json_path": "$.tasks[0].field_mappings[0].value" }, "message": "Type and value is mismatched", "status": "error" } ] } }, "ExpectedFieldMissingResponse": { "description": "Returns the EXPECTED_FIELD_MISSING error when an entry inside field_mappings.field omits both **id** and **api_name**, leaving the target field unresolved.", "summary": "Error response with code EXPECTED_FIELD_MISSING: Specify Atleast one field", "value": { "tasks": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.tasks[0].field_mapping[0].field.id" }, { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[0].field.api_name" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidDataDatePeriodResponse": { "description": "Returns the INVALID_DATA error when an execution_time field_mapping value supplies a **period** value other than the accepted **days** or **business_days**.", "summary": "Error response with code INVALID_DATA: Invalid date Period", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "period", "json_path": "$.tasks[0].field_mappings[6].value.period" }, "message": "Invalid date Period", "status": "error" } ] } }, "InvalidDataFieldIdInvalidResponse": { "description": "Returns the INVALID_DATA error when a field_mapping field **id** does not match any field defined on the Tasks module.", "summary": "Error response with code INVALID_DATA: the fieldId given seems to be invalid", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[0].field_mappings[0].field.id" }, "message": "the fieldId given seems to be invalid", "status": "error" } ] } }, "InvalidDataGivenValueInvalidResponse": { "description": "Returns the INVALID_DATA error when an execution_time field_mapping value supplies an unsupported **time** component for a Remind_At configuration.", "summary": "Error response with code INVALID_DATA: The given value seems to be invalid", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "time", "json_path": "$.tasks[0].field_mappings[4].value.time" }, "message": "The given value seems to be invalid", "status": "error" } ] } }, "InvalidDataLengthExceededResponse": { "description": "Returns the INVALID_DATA error when a field_mapping **value** exceeds the maximum length allowed for the target field on the Tasks module.", "summary": "Error response with code INVALID_DATA: The length of the value exceeded the max limit", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.tasks[0].field_mappings[2].value", "maximum_length": 16 }, "message": "The length of the value exceeded the max limit", "status": "error" } ] } }, "InvalidDataNotifyValueResponse": { "description": "Returns the INVALID_DATA error when the **notify** flag is omitted or supplied with a value whose type is not Boolean.", "summary": "Error response with code INVALID_DATA: please specify notify value", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.tasks[0].notify" }, "message": "please specify notify value", "status": "error" } ] } }, "InvalidDataResponse": { "description": "Returns the INVALID_DATA error when a field_mapping **value** references a merge field token that is not supported on the resolved target field.", "summary": "Error response with code INVALID_DATA: Unsupported mergefield provided (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.tasks[0].field_mappings[4].value" }, "message": "Unsupported mergefield provided", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Returns the INVALID_DATA error when a field_mapping **field** object value exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: field)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "json_path": "$.tasks[*].field_mappings[*].field", "maximum_length": 2 }, "message": "The field given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Returns the INVALID_DATA error when a field_mapping **type** value is supplied with a non-text data type.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Returns the INVALID_DATA error when a field_mapping **type** value exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type", "maximum_length": 14 }, "message": "The field given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Returns the INVALID_DATA error when a field_mapping **type** is set to a value other than **static**, **merge_field**, or **execution_time**.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type", "supported_values": [ "static", "merge_field", "execution_time" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Returns the INVALID_DATA error when a field_mapping **value** is supplied with a non-text data type.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Returns the INVALID_DATA error when a field_mapping **value** exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.tasks[*].field_mappings[*].value", "maximum_length": 6 }, "message": "The field given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Returns the INVALID_DATA error when the task **name** is supplied with a non-text data type.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tasks[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Returns the INVALID_DATA error when the task **name** value exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tasks[*].name", "maximum_length": 7 }, "message": "The field given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Returns the INVALID_DATA error when an execution_time field_mapping value supplies an invalid **sign** for a due-date offset.", "summary": "Error response with code INVALID_DATA: please specify valid due date (Field: sign)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "sign", "json_path": "$.tasks[0].field_mapping[2].value.sign" }, "message": "please specify valid due date", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Returns the INVALID_DATA error when a field_mapping field **id** does not refer to an existing field on the Tasks module.", "summary": "Error response with code INVALID_DATA: the id given seems to be invalid (Field: id)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[0].field_mapping[0].field.id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Returns the INVALID_DATA error when the per-task **module** field is supplied as a primitive rather than the expected jsonobject.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.tasks[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Returns the INVALID_DATA error when the per-task **module** object value exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: module)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.tasks[*].module", "maximum_length": 2 }, "message": "The field given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Returns the INVALID_DATA error when the **notify** flag is supplied with a value whose data type is not Boolean.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: notify)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.tasks[*].notify" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Returns the INVALID_DATA error when **field_mappings** is supplied as a primitive rather than the expected jsonarray.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field_mappings)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "expected_data_type": "jsonarray", "json_path": "$.tasks[*].field_mappings" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Returns the INVALID_DATA error when the **field_mappings** payload exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: field_mappings)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "json_path": "$.tasks[*].field_mappings", "maximum_length": 19 }, "message": "The field given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Returns the INVALID_DATA error when an entry inside field_mappings supplies **field** as a primitive rather than the expected jsonobject.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.tasks[*].field_mappings[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataTabIdInvalidResponse": { "description": "Returns the INVALID_DATA error when the per-task **module.id** does not match an existing CRM module.", "summary": "Error response with code INVALID_DATA: the tabId given seems to be invalid", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[0].module.id" }, "message": "the tabId given seems to be invalid", "status": "error" } ] } }, "InvalidDataTypeGivenInvalidResponse": { "description": "Returns the INVALID_DATA error when a field_mapping **type** value is not one of the recognized mapping types.", "summary": "Error response with code INVALID_DATA: The type given is invalid", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.tasks[0].field_mappings[0].type" }, "message": "The type given is invalid", "status": "error" } ] } }, "InvalidDataTypeNotSupportedResponse": { "description": "Returns the INVALID_DATA error when a field_mapping **value** is supplied with an unsupported nested data type for the target field.", "summary": "Error response with code INVALID_DATA: data type not supported", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "jsonobject", "json_path": "$.tasks[0].field_mappings[9].value" }, "message": "data type not supported", "status": "error" } ] } }, "InvalidFieldApiNameLengthResponse": { "description": "Returns the INVALID_DATA error when the field **api_name** inside field_mappings exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.tasks[*].field_mappings[*].field.api_name", "maximum_length": 9 }, "message": "The field given seems to be invalid", "status": "error" } } }, "InvalidFieldApiNameTypeResponse": { "description": "Returns the INVALID_DATA error when the field **api_name** inside field_mappings is supplied with a non-text data type.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].field.api_name" }, "message": "Invalid data type", "status": "error" } } }, "InvalidFieldIdLengthResponse": { "description": "Returns the INVALID_DATA error when the field **id** inside field_mappings exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[*].field_mappings[*].field.id", "maximum_length": 19 }, "message": "The field given seems to be invalid", "status": "error" } } }, "InvalidFieldIdTypeResponse": { "description": "Returns the INVALID_DATA error when the field **id** inside field_mappings is supplied with a non-bigint data type.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.tasks[*].field_mappings[*].field.id" }, "message": "Invalid data type", "status": "error" } } }, "InvalidModuleApiNameLengthResponse": { "description": "Returns the INVALID_DATA error when the module **api_name** value exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.tasks[*].module.api_name", "maximum_length": 5 }, "message": "The field given seems to be invalid", "status": "error" } } }, "InvalidModuleApiNameTypeResponse": { "description": "Returns the INVALID_DATA error when the module **api_name** is supplied with a non-text data type.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.tasks[*].module.api_name" }, "message": "Invalid data type", "status": "error" } } }, "InvalidModuleIdLengthResponse": { "description": "Returns the INVALID_DATA error when the module **id** value exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[*].module.id", "maximum_length": 19 }, "message": "The field given seems to be invalid", "status": "error" } } }, "InvalidModuleIdTypeResponse": { "description": "Returns the INVALID_DATA error when the module **id** is supplied with a non-bigint data type.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.tasks[*].module.id" }, "message": "Invalid data type", "status": "error" } } }, "InvalidModuleResponse": { "description": "Returns the INVALID_MODULE error when the **module.id** in a task object does not match an existing CRM module.", "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid (Field: id)", "value": { "tasks": [ { "code": "INVALID_MODULE", "details": { "api_name": "id", "json_path": "$.tasks[0].module.id" }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "MandatoryDataMissingResponse": { "description": "Returns the MANDATORY_NOT_FOUND error when a field_mapping omits the **value** key required for the resolved target field.", "summary": "Error response with code MANDATORY_NOT_FOUND: The required data missing", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.tasks[0].field_mappings[0].value" }, "message": "The required data missing", "status": "error" } ] } }, "MandatoryFieldApiNameResponse": { "description": "Returns the MANDATORY_NOT_FOUND error when the field **api_name** key inside field_mappings.field is omitted.", "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.tasks[*].field_mappings[*].field.api_name" }, "message": "Required field is missing", "status": "error" } } }, "MandatoryFieldIdResponse": { "description": "Returns the MANDATORY_NOT_FOUND error when the field **id** key inside field_mappings.field is omitted.", "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.tasks[*].field_mappings[*].field.id" }, "message": "Required field is missing", "status": "error" } } }, "MandatoryModuleApiNameResponse": { "description": "Returns the MANDATORY_NOT_FOUND error when the module **api_name** is omitted from the task object.", "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.tasks[*].module.api_name" }, "message": "Required field is missing", "status": "error" } } }, "MandatoryNotFoundResponse": { "description": "Returns the MANDATORY_NOT_FOUND error when a field_mapping omits the **value** key required for the resolved target field.", "summary": "Error response with code MANDATORY_NOT_FOUND: mandatory field is not given (Field: value)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.tasks[0].field_mapping[0].value" }, "message": "mandatory field is not given", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Returns the MANDATORY_NOT_FOUND error when the required **module** object is omitted from the task payload.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: module)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.tasks[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Returns the MANDATORY_NOT_FOUND error when the required **field_mappings** array is omitted from the task payload.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field_mappings)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_mappings", "json_path": "$.tasks[*].field_mappings" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Returns the MANDATORY_NOT_FOUND error when an entry inside field_mappings omits the required **type** key.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: type)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Returns the MANDATORY_NOT_FOUND error when an entry inside field_mappings omits the required **value** key.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.tasks[*].field_mappings[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Returns the MANDATORY_NOT_FOUND error when the required task **name** is omitted from the payload.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tasks[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "RequiredDataNotFoundResponse": { "description": "Returns the REQUIRED_DATA_NOT_FOUND error when a field_mapping does not include all sub-keys required by the resolved target field (for example, omitting **field.api_name** for a Subject mapping).", "summary": "Error response with code REQUIRED_DATA_NOT_FOUND: The required data missing", "value": { "tasks": [ { "code": "REQUIRED_DATA_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.tasks[0].field_mappings", "sub_json_path": "field.api_name", "value": "Subject" }, "message": "The required data missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response with tasks", "properties": { "tasks": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/TaskNotAllowedSchema" }, { "$ref": "#/components/schemas/AutomationFieldMappingExpectedFieldMissingError" }, { "$ref": "#/components/schemas/WorkflowTasksAmbiguityDuringProcessingError" }, { "$ref": "#/components/schemas/AutomationFieldMappingDependentFieldMissingError" }, { "$ref": "#/components/schemas/TaskDependentMismatchSchema" }, { "$ref": "#/components/schemas/TaskInvalidModuleSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/TaskDuplicateDataSchema" }, { "$ref": "#/components/schemas/TaskMandatoryNotFoundSchema" }, { "$ref": "#/components/schemas/AutomationFieldMappingRequiredDataNotFoundError" } ], "description": "Represents a single per-task validation error returned within the **tasks** array when individual task entries fail validation." }, "maxItems": 25, "type": "array" } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedCreateTasksErrorResponse" }, { "additionalProperties": false, "description": "Wrapped error response with tasks", "properties": { "tasks": { "anyOf": [ { "$ref": "#/components/schemas/TaskMandatoryNotFoundSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" } ], "description": "Represents the single error object returned when the create fails due to a request-structure issue such as a missing module api_name or an invalid module data type." } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedSingleCreateTasksErrorResponse" } ], "description": "Error response returned when an automation task create fails validation, covering request-structure errors, per-task field-mapping errors, dependent-field mismatches, and missing mandatory fields.", "x-zs-$id": "CreateTasksErrorResponses" } } }, "description": "Validation error in request payload. Two response shapes exist: (1) Request-structure errors (e.g., invalid module type/length, missing field api_name) return tasks as a single error object. (2) Per-task validation errors (e.g., field_mapping errors, dependent mismatch, mandatory not found) return tasks as an array with one error object per task entry. Parse tasks as either object or array to handle both shapes." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailureResponse": { "description": "Returns the AUTHENTICATION_FAILURE error when the request is missing a valid access token or the supplied token has expired.", "summary": "AUTHENTICATION_FAILURE: Authentication failed", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OauthScopeMismatchResponse": { "description": "Returns the OAUTH_SCOPE_MISMATCH error when the access token does not include the OAuth scope required to create automation tasks.", "summary": "OAUTH_SCOPE_MISMATCH: Unauthorized", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PostTasksAuthenticationErrorResponse" } } }, "description": "Authentication or scope error while creating automation tasks." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returns the NO_PERMISSION error when the user profile lacks the Crm_Implied_Manage_Workflow or WorkFlow_Tasks permission required to create automation tasks.", "summary": "Feature not available in this edition / insufficient permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "WorkFlow_Tasks" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskNoPermissionSchema" } } }, "description": "No permission to create automation tasks." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPatternResponse": { "description": "Returns the INVALID_URL_PATTERN error when the request URL does not match the **/settings/automation/tasks** endpoint pattern.", "summary": "INVALID_URL_PATTERN: Please check if the URL trying to access is a correct one", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidUrlPatternErrorResponse" } } }, "description": "Invalid URL pattern." }, "500": { "content": { "application/json": { "examples": { "InternalServerErrorResponse": { "description": "Returns the INTERNAL_ERROR response when an unexpected server-side exception prevents the create from completing.", "summary": "INTERNAL_ERROR: Internal Server Error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } }, "description": "Internal server error." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.CREATE" ] } ], "summary": "Create an Automation Task ", "tags": [ "workflow_tasks" ], "x-zoho-document": "workflow_tasks", "x-zs-llm-description": "Adds a new automation task definition that workflow rules, approval processes, blueprints, kiosks, scoring rules, or case escalation rules can reference. Before calling: (1) GET /settings/automation/tasks to check for existing definitions and avoid duplicates; (2) GET /settings/layouts?module=Tasks to find supported fields and those where required: true. Send a tasks array with exactly one entry covering name (string), module ({api_name, id}), and field_mappings (array). Leaving out a mandatory field returns REQUIRED_DATA_NOT_FOUND. The response contains the new task ID.", "x-zs-llm-examples": [ "SamplePostRequest" ] }, "put": { "description": "PURPOSE: Updates an existing automation task definition identified by the path parameter ID. PREREQUISITES: (1) Call GET /settings/automation/tasks/{id} to obtain the current task structure. (2) Call GET /settings/layouts?module=Tasks to verify supported fields and identify mandatory fields where required: true in the field info. BEHAVIOR: This is a full replacement - all field_mappings must be provided, not just the changed ones. KEY CONSTRAINTS: Locked tasks (locked by workflow rules, approval processes, or blueprints) return 401 AUTHORIZATION_ERROR. Read-only tasks return 400.", "operationId": "updateWorkflowTask", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample request body", "value": { "tasks": [ { "feature_type": "workflow", "field_mappings": [ { "field": { "api_name": "Description", "id": "6660682000000002291" }, "type": "merge_field", "value": "Automated task for ${!Leads.First_Name}${!Leads.Last_Name}" }, { "field": { "api_name": "Subject", "id": "6660682000000002271" }, "type": "static", "value": "Updated: Follow up with lead" }, { "field": { "api_name": "Due_Date", "id": "6660682000000000223" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "5" } }, { "field": { "api_name": "Status", "id": "6660682000000002279" }, "type": "static", "value": "In Progress" }, { "field": { "api_name": "Priority", "id": "6660682000000002281" }, "type": "static", "value": "High" }, { "field": { "api_name": "URL_1", "id": "6660682000001522480" }, "type": "merge_field", "value": "${!Leads.Website}" }, { "field": { "api_name": "Number_1", "id": "6660682000001522575" }, "type": "merge_field", "value": "${!Leads.No_of_Employees}" }, { "display_value": "100000000000000000", "field": { "api_name": "Long_Integer_1", "id": "6660682000001522533" }, "type": "static", "value": "100000000000000000" }, { "field": { "api_name": "Single_Line_1", "id": "6660682000001522561" }, "type": "static", "value": "sample task" }, { "field": { "api_name": "Pick_List_1", "id": "6660682000000922691" }, "type": "static", "value": "Voter ID" }, { "field": { "api_name": "Email_1", "id": "6660682000001465098" }, "type": "static", "value": "john@zohotest.cim" }, { "field": { "api_name": "Percent_1", "id": "6660682000001522617" }, "type": "static", "value": "50" }, { "field": { "api_name": "Currency_1", "id": "6660682000001522589" }, "type": "merge_field", "value": "${!Leads.Annual_Revenue}" }, { "field": { "api_name": "Phone_1", "id": "6660682000001522603" }, "type": "merge_field", "value": "${!Leads.Phone}" }, { "field": { "api_name": "Decimal_1", "id": "6660682000001522547" }, "type": "static", "value": "12" } ], "module": { "api_name": "Leads", "id": "6660682000000002175" }, "name": "Updated: Follow up with lead", "notify": true } ] } } }, "schema": { "$ref": "#/components/schemas/TaskCreateOrUpdateRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "Task payload for create or update. tasks must contain exactly one task object. Required keys inside task are name, module, and field_mappings." }, "responses": { "200": { "content": { "application/json": { "examples": { "UpdateTaskSuccessResponse": { "summary": "Task updated successfully", "value": { "tasks": [ { "code": "SUCCESS", "details": { "id": "111111000000190030" }, "message": "task updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateTaskSuccessResponse" } } }, "description": "Task updated successfully. Returns the updated task ID." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse": { "summary": "AMBIGUITY_DURING_PROCESSING: field.id and field.api_name conflict", "value": { "tasks": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.tasks[0].field_mappings[0].field.id" }, { "api_name": "api_name", "json_path": "$.tasks[0].field_mappings[0].field.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentFieldMissingResponse1": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: field_name)", "value": { "tasks": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "field_name", "dependee": { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[1].field.api_name" }, "json_path": "$.tasks[0].field_mapping[1].value.field_name" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse2": { "summary": "Error response with code DEPENDENT_MISMATCH: the given value is invalid (Field: value)", "value": { "tasks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[1].field.api_name" }, "json_path": "$.tasks[0].field_mapping[1].value", "maximum_length": 150 }, "message": "the given value is invalid", "status": "error" } ] } }, "Error400Response1": { "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.tasks[*].module.api_name" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response10": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.tasks[*].field_mappings[*].field.id" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response11": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[*].field_mappings[*].field.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } } }, "Error400Response2": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.tasks[*].module.api_name" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response3": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.tasks[*].module.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } } }, "Error400Response4": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.tasks[*].module.id" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response5": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[*].module.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } } }, "Error400Response6": { "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.tasks[*].field_mappings[*].field.api_name" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response7": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].field.api_name" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response8": { "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.tasks[*].field_mappings[*].field.api_name", "maximum_length": 9 }, "message": "Invalid data", "status": "error" } } }, "Error400Response9": { "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.tasks[*].field_mappings[*].field.id" }, "message": "Required field is missing", "status": "error" } } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: Unsupported mergefield provided (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.tasks[0].field_mappings[4].value" }, "message": "Unsupported mergefield provided", "status": "error" } ] } }, "InvalidDataResponse10": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.tasks[*].field_mappings[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse11": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: field)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "json_path": "$.tasks[*].field_mappings[*].field", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse13": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type", "maximum_length": 14 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type", "supported_values": [ "static", "merge_field", "execution_time" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.tasks[*].field_mappings[*].value", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tasks[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse18": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tasks[*].name", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: please specify valid due date (Field: sign)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "sign", "json_path": "$.tasks[0].field_mapping[2].value.sign" }, "message": "please specify valid due date", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: the id given seems to be invalid (Field: id)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[0].field_mapping[0].field.id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.tasks[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: module)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.tasks[*].module", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: notify)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.tasks[*].notify" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse8": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field_mappings)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "expected_data_type": "jsonarray", "json_path": "$.tasks[*].field_mappings" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: field_mappings)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "json_path": "$.tasks[*].field_mappings", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid (Field: id)", "value": { "tasks": [ { "code": "INVALID_MODULE", "details": { "api_name": "id", "json_path": "$.tasks[0].module.id" }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: module)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.tasks[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field_mappings)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_mappings", "json_path": "$.tasks[*].field_mappings" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: type)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.tasks[*].field_mappings[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tasks[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "ReadOnlyTaskNotAllowedResponse": { "summary": "NOT_ALLOWED: Cannot update a read-only task", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Insufficient privileges to edit Read only task", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response with tasks", "properties": { "tasks": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/AutomationFieldMappingDependentFieldMissingError" }, { "$ref": "#/components/schemas/TaskDependentMismatchSchema" }, { "$ref": "#/components/schemas/AutomationFieldMappingExpectedFieldMissingError" }, { "$ref": "#/components/schemas/TaskInvalidModuleSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/AuthorizationError" }, { "$ref": "#/components/schemas/TaskMandatoryNotFoundSchema" }, { "$ref": "#/components/schemas/WorkflowTasksAmbiguityDuringProcessingError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedPutTaskByIdErrorResponse" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/TaskNotAllowedSchema" }, { "additionalProperties": false, "description": "Wrapped error response with tasks", "properties": { "tasks": { "anyOf": [ { "$ref": "#/components/schemas/TaskMandatoryNotFoundSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" } ] } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedPutTaskByIdSingleErrorResponse" } ], "x-zs-$id": "PutTaskByIdErrorResponses" } } }, "description": "Validation error in request payload. Two response shapes exist: (1) Request-structure errors (e.g., invalid task ID, read-only task, invalid module type/length, missing field api_name) return tasks as a single error object. (2) Per-task validation errors (e.g., field_mapping errors, dependent mismatch, mandatory not found) return tasks as an array with one error object per task entry. Parse tasks as either object or array to handle both shapes." }, "401": { "content": { "application/json": { "examples": { "LockedTaskAuthorizationErrorResponse": { "summary": "AUTHORIZATION_ERROR: Task is locked and cannot be edited", "value": { "tasks": [ { "code": "AUTHORIZATION_ERROR", "details": {}, "message": "Insufficient privileges to perform this operation", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped authorization error response for locked tasks.", "properties": { "tasks": { "description": "Array containing the authorization error.", "items": { "$ref": "#/components/schemas/AuthorizationError" }, "maxItems": 1, "type": "array" } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedErrorResponseWithTaskById" } } }, "description": "Locked or system-managed task cannot be edited. The task is protected by a workflow rule, approval process, or blueprint lock. The AUTHORIZATION_ERROR is returned inside a tasks array wrapper. Note: Unlike standard HTTP 401 semantics, this response indicates the task is locked by a workflow rule, approval process, or blueprint, not an authentication failure." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "summary": "NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "WorkFlow_Tasks" ] }, "message": "feature not available in this edition", "status": "error" } }, "ReadOnlyTaskResponse": { "summary": "NOT_ALLOWED: Cannot edit a read-only task", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Insufficient privileges to edit Read only task", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TaskNoPermissionSchema" }, { "$ref": "#/components/schemas/TaskNotAllowedSchema" } ], "x-zs-$id": "PutTaskByIdForbiddenResponses" } } }, "description": "Insufficient permission, feature not available, or task is read-only." }, "404": { "content": { "application/json": { "examples": { "InvalidTaskIdResponse": { "summary": "INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskInvalidDataSchema" } } }, "description": "The provided task ID does not exist." }, "500": { "content": { "application/json": { "examples": { "InternalServerErrorResponse": { "summary": "INTERNAL_ERROR: Internal Server Error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } }, "description": "Internal server error." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.UPDATE" ] } ], "summary": "Update an automation task definition by ID (full replacement)", "tags": [ "workflow_tasks" ], "x-zoho-document": "workflow_tasks", "x-zs-llm-description": "Replaces the full configuration of an automation task identified by the path parameter ID. Before calling: (1) GET /settings/automation/tasks/{id} to read the current structure; (2) GET /settings/layouts?module=Tasks to confirm supported fields and find any where required: true. All field_mappings must be included this is a full replacement, not a patch. Locked tasks (held by workflow rules, approval processes, or blueprints) return 401 AUTHORIZATION_ERROR; read-only tasks return 400.", "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "/crm/v8/settings/automation/tasks/{id}": { "delete": { "description": "PURPOSE: Deletes a single automation task definition by its ID. MANDATORY: id path parameter (string - automation task definition ID, not a Task record ID). KEY CONSTRAINTS: Tasks associated with active workflow rules, approval processes, or blueprints cannot be deleted (returns NOT_ALLOWED). Returns success/error status.", "operationId": "deleteTaskById", "parameters": [ { "description": "Represents the unique ID of the task that you want to delete. Skip this parameter if you have specified the ID in the request URL. You can pass upto 10 comma-separated IDs in this parameter. Tasks associated with active workflow rules, approval processes, or blueprints cannot be deleted. Use the [Workflow Tasks API](workflow_tasks.yaml#$.paths./settings/automation/tasks.get) to retrieve the ID.\n", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 20, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Returns the SUCCESS code and the deleted task ID, confirming that the automation task definition was removed from the organization.", "summary": "Task deleted successfully", "value": { "tasks": [ { "code": "SUCCESS", "details": { "id": "111112000000035041" }, "message": "task deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteTaskByIdSuccessResponse" } } }, "description": "Task deleted successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Returns the INVALID_DATA error when the path **id** does not match an existing automation task definition.", "summary": "Error response with code INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "NotAllowedResponse1": { "description": "Returns the NOT_ALLOWED error when the automation task cannot be deleted because it is associated with an active Approval Process, workflow rule, or Blueprint.", "summary": "Error response with code NOT_ALLOWED: Task is associated with at least one of Approval Process/Workflow Rules/Blueprint", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Task is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TaskNotAllowedSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" } ], "description": "Error response returned when a single automation task delete fails validation, such as an invalid ID or the task being associated with active automation.", "x-zs-$id": "InvalidTaskIdErrorResponse" } } }, "description": "Invalid task ID or task cannot be deleted due to active association with workflow/approval/Blueprint." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailureResponse": { "description": "Returns the AUTHENTICATION_FAILURE error when the request is missing a valid access token or the supplied token has expired.", "summary": "AUTHENTICATION_FAILURE: Authentication failed", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OauthScopeMismatchResponse": { "description": "Returns the OAUTH_SCOPE_MISMATCH error when the access token does not include the OAuth scope required to delete automation tasks.", "summary": "OAUTH_SCOPE_MISMATCH: Unauthorized", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PostTasksAuthenticationErrorResponse" } } }, "description": "Authentication or scope error while deleting the automation task." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Returns the NO_PERMISSION error when the user profile lacks the Crm_Implied_manage_workflow permission required to delete automation tasks.", "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_manage_workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskNoPermissionSchema" } } }, "description": "Insufficient permission to delete automation tasks." }, "500": { "content": { "application/json": { "examples": { "InternalServerErrorResponse": { "description": "Returns the INTERNAL_ERROR response when an unexpected server-side exception prevents the delete from completing.", "summary": "INTERNAL_ERROR: Internal Server Error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } }, "description": "Internal server error." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.DELETE" ] } ], "summary": "Automation Task", "tags": [ "workflow_tasks" ], "x-zoho-document": "workflow_tasks", "x-zs-llm-description": "Removes a single automation task definition by the id path param (the definition ID, not a Task record ID). Tasks attached to active workflow rules, approval processes, or blueprints are rejected with NOT_ALLOWED. The response indicates success or error for the deletion." }, "get": { "description": "PURPOSE: Retrieves the full details of a specific automation task definition including field mappings, module association, lock status, and metadata. MANDATORY: id path parameter (string - automation task definition ID, not a Task record ID). Returns 204 if the task does not exist. Use this to inspect the current state before updating via PUT.", "operationId": "getTaskById", "parameters": [ { "description": "The unique ID of the automation task definition to retrieve (not a Task record ID).", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 20, "type": "string" } }, { "$ref": "#/components/parameters/WorkflowTasksParamQueryIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetTaskByIdSuccessResponse": { "description": "Returns the full configuration of a single automation task, including its module, lock_status, field_mappings, and audit metadata such as created_by and modified_by.", "summary": "Single task retrieved successfully", "value": { "tasks": [ { "associated": true, "created_by": { "id": "111111000000051635", "name": "vignesh B" }, "created_time": "2023-10-20T11:17:30+05:30", "deletable": true, "editable": true, "feature_type": "workflow", "field_mappings": [ { "display_value": "efefdeff", "field": { "api_name": "Subject", "id": "111111000000000221" }, "type": "static", "value": "efefdeff" }, { "display_value": "From Date plus 1 day(s)", "field": { "api_name": "Due_Date", "id": "111111000000000223" }, "type": "execution_time", "value": { "period": "days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "1" } }, { "display_value": "Not Started", "field": { "api_name": "Status", "id": "111111000000000229" }, "type": "static", "value": "Not Started" }, { "display_value": "High", "field": { "api_name": "Priority", "id": "111111000000000231" }, "type": "static", "value": "High" } ], "id": "111111000000190030", "lock_status": { "locked": false }, "modified_by": { "id": "111111000000051635", "name": "vignesh B" }, "modified_time": "2023-10-20T11:17:30+05:30", "module": { "api_name": "Leads", "id": "111111000000002393" }, "name": "efefdeff", "notify": false, "related_module": null, "source": "user" } ] } } }, "schema": { "$ref": "#/components/schemas/GetTaskByIdSuccessResponse" } } }, "description": "Returns the full task configuration including field_mappings, module, lock_status, and metadata." }, "204": { "description": "Request processed successfully but no task record matched the provided ID in the current context." }, "400": { "content": { "application/json": { "examples": { "InvalidFeatureTypeResponse": { "description": "Returns the INVALID_DATA error when the **feature_type** query parameter passed alongside the task ID is not one of the recognized automation feature names.", "summary": "INVALID_DATA: the given feature name is invalid", "value": { "code": "INVALID_DATA", "details": { "param_name": "feature_type" }, "message": "the given feature name is invalid", "status": "error" } }, "InvalidModuleResponse": { "description": "Returns the INVALID_MODULE error when the **module** query parameter does not match a valid CRM module API name.", "summary": "INVALID_MODULE: The value provided to the param is Invalid", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidTaskIdResponse": { "description": "Returns the INVALID_DATA error when the path **id** does not refer to an existing automation task definition.", "summary": "INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/TaskInvalidModuleSchema" }, { "$ref": "#/components/schemas/TaskNotAllowedSchema" } ], "description": "Error response returned when a request to retrieve a single automation task fails validation, covering invalid task ID, module, or feature_type values supplied alongside the path id.", "x-zs-$id": "GetTaskByIdErrorResponses" } } }, "description": "Invalid task ID, invalid feature_type query parameter, or invalid module query parameter." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailureResponse": { "description": "Returns the AUTHENTICATION_FAILURE error when the request is missing a valid access token or the supplied token has expired.", "summary": "AUTHENTICATION_FAILURE: Authentication failed", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OauthScopeMismatchResponse": { "description": "Returns the OAUTH_SCOPE_MISMATCH error when the access token does not include the OAuth scope required to read automation tasks.", "summary": "OAUTH_SCOPE_MISMATCH: Unauthorized", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PostTasksAuthenticationErrorResponse" } } }, "description": "Authentication or scope error while retrieving the automation task." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returns the NO_PERMISSION error when the user profile lacks the Crm_Implied_Manage_Workflow or WorkFlow_Tasks permission required to access automation tasks.", "summary": "NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "WorkFlow_Tasks" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskNoPermissionSchema" } } }, "description": "Insufficient permission or feature not available in this CRM edition." }, "404": { "content": { "application/json": { "examples": { "InvalidTaskIdResponse": { "description": "Returns the INVALID_DATA error when the automation task ID in the request URL does not exist in the organization.", "summary": "INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskInvalidDataSchema" } } }, "description": "Task resource not found for the requested path ID." }, "500": { "content": { "application/json": { "examples": { "InternalServerErrorResponse": { "description": "Returns the INTERNAL_ERROR response when an unexpected server-side exception prevents the request from completing.", "summary": "INTERNAL_ERROR: Internal Server Error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } }, "description": "Internal server error." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Automation Task", "tags": [ "workflow_tasks" ], "x-zoho-document": "workflow_tasks", "x-zs-llm-description": "Retrieves the complete definition of one automation task including field mappings, module association, lock status, and metadata. Supply the automation task definition ID (not a Task record ID) as the id path param. Returns 204 when the task does not exist. Run this to review current state before issuing a PUT." }, "put": { "description": "PURPOSE: Updates an existing automation task definition identified by the path parameter ID. PREREQUISITES: (1) Call GET /settings/automation/tasks/{id} to obtain the current task structure. (2) Call GET /settings/layouts?module=Tasks to verify supported fields and identify mandatory fields where required: true in the field info. BEHAVIOR: This is a full replacement - all field_mappings must be provided, not just the changed ones. KEY CONSTRAINTS: Locked tasks (locked by workflow rules, approval processes, or blueprints) return 401 AUTHORIZATION_ERROR. Read-only tasks return 400.", "operationId": "updateWorkflowTaskById", "parameters": [ { "description": "The unique ID of the automation task definition to update (not a Task record ID). Use the [Workflow Tasks API](workflow_tasks.yaml#$.paths./settings/automation/tasks.get) to retrieve the ID.\n", "in": "path", "name": "id", "required": true, "schema": { "maxLength": 20, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows a full-replacement update payload for an automation task, supplying the **module**, **notify** flag, and a new **field_mappings** array with merge_field and static value entries.", "summary": "Sample request body", "value": { "tasks": [ { "feature_type": "workflow", "field_mappings": [ { "field": { "api_name": "Description", "id": "6660682000000002291" }, "type": "merge_field", "value": "Automated task for ${!Leads.First_Name}${!Leads.Last_Name}" }, { "field": { "api_name": "Subject", "id": "6660682000000002271" }, "type": "static", "value": "Updated: Follow up with lead" }, { "field": { "api_name": "Due_Date", "id": "6660682000000000223" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "5" } }, { "field": { "api_name": "Status", "id": "6660682000000002279" }, "type": "static", "value": "In Progress" }, { "field": { "api_name": "Priority", "id": "6660682000000002281" }, "type": "static", "value": "High" }, { "field": { "api_name": "URL_1", "id": "6660682000001522480" }, "type": "merge_field", "value": "${!Leads.Website}" }, { "field": { "api_name": "Number_1", "id": "6660682000001522575" }, "type": "merge_field", "value": "${!Leads.No_of_Employees}" }, { "display_value": "100000000000000000", "field": { "api_name": "Long_Integer_1", "id": "6660682000001522533" }, "type": "static", "value": "100000000000000000" }, { "field": { "api_name": "Single_Line_1", "id": "6660682000001522561" }, "type": "static", "value": "sample task" }, { "field": { "api_name": "Pick_List_1", "id": "6660682000000922691" }, "type": "static", "value": "Voter ID" }, { "field": { "api_name": "Email_1", "id": "6660682000001465098" }, "type": "static", "value": "john@zohotest.cim" }, { "field": { "api_name": "Percent_1", "id": "6660682000001522617" }, "type": "static", "value": "50" }, { "field": { "api_name": "Currency_1", "id": "6660682000001522589" }, "type": "merge_field", "value": "${!Leads.Annual_Revenue}" }, { "field": { "api_name": "Phone_1", "id": "6660682000001522603" }, "type": "merge_field", "value": "${!Leads.Phone}" }, { "field": { "api_name": "Decimal_1", "id": "6660682000001522547" }, "type": "static", "value": "12" } ], "module": { "api_name": "Leads", "id": "6660682000000002175" }, "name": "Updated: Follow up with lead", "notify": true } ] } } }, "schema": { "$ref": "#/components/schemas/TaskCreateOrUpdateRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "Task payload for create or update. tasks must contain exactly one task object. Required keys inside task are name, module, and field_mappings." }, "responses": { "200": { "content": { "application/json": { "examples": { "UpdateTaskSuccessResponse": { "description": "Returns the SUCCESS code and the updated task ID, confirming that the automation task definition was replaced with the new configuration.", "summary": "Task updated successfully", "value": { "tasks": [ { "code": "SUCCESS", "details": { "id": "111111000000190030" }, "message": "task updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateTaskSuccessResponse" } } }, "description": "Task updated successfully. Returns the updated task ID." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse": { "description": "Returns the AMBIGUITY_DURING_PROCESSING error when a field reference within field_mappings specifies both **id** and **api_name** and the two do not resolve to the same field.", "summary": "AMBIGUITY_DURING_PROCESSING: field.id and field.api_name conflict", "value": { "tasks": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.tasks[0].field_mappings[0].field.id" }, { "api_name": "api_name", "json_path": "$.tasks[0].field_mappings[0].field.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentFieldMissingResponse1": { "description": "Returns the DEPENDENT_FIELD_MISSING error when a field_mapping value omits the **field_name** key required by its dependee api_name.", "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: field_name)", "value": { "tasks": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "field_name", "dependee": { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[1].field.api_name" }, "json_path": "$.tasks[0].field_mapping[1].value.field_name" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Returns the DEPENDENT_MISMATCH error when a field_mapping **value** is inconsistent with the dependee **api_name** specified for the same mapping.", "summary": "Error response with code DEPENDENT_MISMATCH: the given value is invalid (Field: value)", "value": { "tasks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "api_name", "json_path": "$.tasks[0].field_mapping[1].field.api_name" }, "json_path": "$.tasks[0].field_mapping[1].value", "maximum_length": 150 }, "message": "the given value is invalid", "status": "error" } ] } }, "Error400Response1": { "description": "Returns the MANDATORY_NOT_FOUND error when the module **api_name** is omitted from the task object.", "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.tasks[*].module.api_name" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response10": { "description": "Returns the INVALID_DATA error when the field **id** inside field_mappings is supplied with a value whose data type is not a bigint.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.tasks[*].field_mappings[*].field.id" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response11": { "description": "Returns the INVALID_DATA error when the field **id** inside field_mappings exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[*].field_mappings[*].field.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } } }, "Error400Response2": { "description": "Returns the INVALID_DATA error when the module **api_name** is supplied with a value whose data type is not text.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.tasks[*].module.api_name" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response3": { "description": "Returns the INVALID_DATA error when the module **api_name** value exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.tasks[*].module.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } } }, "Error400Response4": { "description": "Returns the INVALID_DATA error when the module **id** is supplied with a value whose data type is not a bigint.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.tasks[*].module.id" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response5": { "description": "Returns the INVALID_DATA error when the module **id** value exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[*].module.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } } }, "Error400Response6": { "description": "Returns the MANDATORY_NOT_FOUND error when the **api_name** key inside an entry of field_mappings.field is omitted.", "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.tasks[*].field_mappings[*].field.api_name" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response7": { "description": "Returns the INVALID_DATA error when the field **api_name** inside field_mappings is supplied with a value whose data type is not text.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].field.api_name" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response8": { "description": "Returns the INVALID_DATA error when the field **api_name** inside field_mappings exceeds the maximum supported length.", "summary": "Error response", "value": { "tasks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.tasks[*].field_mappings[*].field.api_name", "maximum_length": 9 }, "message": "Invalid data", "status": "error" } } }, "Error400Response9": { "description": "Returns the MANDATORY_NOT_FOUND error when the field **id** key inside an entry of field_mappings.field is omitted.", "summary": "Error response", "value": { "tasks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.tasks[*].field_mappings[*].field.id" }, "message": "Required field is missing", "status": "error" } } }, "InvalidDataResponse1": { "description": "Returns the INVALID_DATA error when a field_mapping **value** references an unsupported merge field token.", "summary": "Error response with code INVALID_DATA: Unsupported mergefield provided (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.tasks[0].field_mappings[4].value" }, "message": "Unsupported mergefield provided", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Returns the INVALID_DATA error when an entry inside field_mappings supplies **field** as a primitive rather than the expected jsonobject.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.tasks[*].field_mappings[*].field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Returns the INVALID_DATA error when an entry inside field_mappings.field exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: field)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "json_path": "$.tasks[*].field_mappings[*].field", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Returns the INVALID_DATA error when a field_mapping **type** value is supplied with a non-text data type.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Returns the INVALID_DATA error when a field_mapping **type** value exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type", "maximum_length": 14 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Returns the INVALID_DATA error when a field_mapping **type** is set to a value other than **static**, **merge_field**, or **execution_time**.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type", "supported_values": [ "static", "merge_field", "execution_time" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Returns the INVALID_DATA error when a field_mapping **value** is supplied with a non-text data type.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.tasks[*].field_mappings[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Returns the INVALID_DATA error when a field_mapping **value** exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.tasks[*].field_mappings[*].value", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Returns the INVALID_DATA error when the task **name** is supplied with a non-text data type.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tasks[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Returns the INVALID_DATA error when the task **name** value exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tasks[*].name", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Returns the INVALID_DATA error when an execution_time field_mapping value supplies an invalid **sign** for a due-date offset.", "summary": "Error response with code INVALID_DATA: please specify valid due date (Field: sign)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "sign", "json_path": "$.tasks[0].field_mapping[2].value.sign" }, "message": "please specify valid due date", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Returns the INVALID_DATA error when a field_mapping field **id** does not match an existing field on the Tasks module.", "summary": "Error response with code INVALID_DATA: the id given seems to be invalid (Field: id)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tasks[0].field_mapping[0].field.id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Returns the INVALID_DATA error when the path **id** in the request URL does not refer to an existing automation task definition.", "summary": "Error response with code INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidDataResponse5": { "description": "Returns the INVALID_DATA error when the per-task **module** field is supplied as a primitive rather than the expected jsonobject.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: module)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.tasks[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Returns the INVALID_DATA error when the per-task **module** object value exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: module)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.tasks[*].module", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Returns the INVALID_DATA error when the **notify** flag is supplied with a value whose data type is not Boolean.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: notify)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "notify", "expected_data_type": "boolean", "json_path": "$.tasks[*].notify" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Returns the INVALID_DATA error when **field_mappings** is supplied as a primitive rather than the expected jsonarray.", "summary": "Error response with code INVALID_DATA: Invalid data type (Field: field_mappings)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "expected_data_type": "jsonarray", "json_path": "$.tasks[*].field_mappings" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Returns the INVALID_DATA error when the **field_mappings** payload exceeds the maximum supported length.", "summary": "Error response with code INVALID_DATA: Invalid data (Field: field_mappings)", "value": { "tasks": [ { "code": "INVALID_DATA", "details": { "api_name": "field_mappings", "json_path": "$.tasks[*].field_mappings", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "description": "Returns the INVALID_MODULE error when the **module.id** in a task object does not match an existing CRM module.", "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid (Field: id)", "value": { "tasks": [ { "code": "INVALID_MODULE", "details": { "api_name": "id", "json_path": "$.tasks[0].module.id" }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Returns the MANDATORY_NOT_FOUND error when the required **module** object is omitted from the task payload.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: module)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.tasks[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Returns the MANDATORY_NOT_FOUND error when the required **field_mappings** array is omitted from the task payload.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: field_mappings)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field_mappings", "json_path": "$.tasks[*].field_mappings" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Returns the MANDATORY_NOT_FOUND error when an entry inside field_mappings omits the required **type** key.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: type)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.tasks[*].field_mappings[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Returns the MANDATORY_NOT_FOUND error when an entry inside field_mappings omits the required **value** key.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: value)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.tasks[*].field_mappings[*].value" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Returns the MANDATORY_NOT_FOUND error when the required task **name** is omitted from the payload.", "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "tasks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tasks[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "ReadOnlyTaskNotAllowedResponse": { "description": "Returns the NOT_ALLOWED error when the targeted automation task is read-only and cannot be modified.", "summary": "NOT_ALLOWED: Cannot update a read-only task", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Insufficient privileges to edit Read only task", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response with tasks", "properties": { "tasks": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/AutomationFieldMappingDependentFieldMissingError" }, { "$ref": "#/components/schemas/TaskDependentMismatchSchema" }, { "$ref": "#/components/schemas/AutomationFieldMappingExpectedFieldMissingError" }, { "$ref": "#/components/schemas/TaskInvalidModuleSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/AuthorizationError" }, { "$ref": "#/components/schemas/TaskMandatoryNotFoundSchema" }, { "$ref": "#/components/schemas/WorkflowTasksAmbiguityDuringProcessingError" } ], "description": "Represents a single per-task validation error returned within the **tasks** array when the update fails on individual task entries." }, "maxItems": 25, "type": "array" } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedPutTasksErrorResponse" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" }, { "$ref": "#/components/schemas/TaskNotAllowedSchema" }, { "additionalProperties": false, "description": "Wrapped error response with tasks", "properties": { "tasks": { "anyOf": [ { "$ref": "#/components/schemas/TaskMandatoryNotFoundSchema" }, { "$ref": "#/components/schemas/TaskInvalidDataSchema" } ], "description": "Represents the single error object returned when the update fails due to a request-structure issue such as an invalid module data type or a missing field api_name." } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedPutTasksSingleErrorResponse" } ], "description": "Error response returned when an automation task update fails validation, covering request-structure errors, per-task field-mapping errors, dependent-field mismatches, and missing mandatory fields.", "x-zs-$id": "PutTasksErrorResponses" } } }, "description": "Validation error in request payload. Two response shapes exist: (1) Request-structure errors (e.g., invalid task ID, read-only task, invalid module type/length, missing field api_name) return tasks as a single error object. (2) Per-task validation errors (e.g., field_mapping errors, dependent mismatch, mandatory not found) return tasks as an array with one error object per task entry. Parse tasks as either object or array to handle both shapes." }, "401": { "content": { "application/json": { "examples": { "LockedTaskAuthorizationErrorResponse": { "description": "Returns the AUTHORIZATION_ERROR when the targeted task is locked, typically because it is bound to an active workflow rule, Approval Process, or Blueprint.", "summary": "AUTHORIZATION_ERROR: Task is locked and cannot be edited", "value": { "tasks": [ { "code": "AUTHORIZATION_ERROR", "details": {}, "message": "Insufficient privileges to perform this operation", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped authorization error response for locked tasks.", "properties": { "tasks": { "description": "Array containing the authorization error.", "items": { "$ref": "#/components/schemas/AuthorizationError" }, "maxItems": 1, "type": "array" } }, "required": [ "tasks" ], "type": "object", "x-zs-$id": "WrappedErrorResponseWithTasks" } } }, "description": "Locked or system-managed task cannot be edited. The task is protected by a workflow rule, Approval Process, or Blueprint lock. The AUTHORIZATION_ERROR is returned inside a tasks array wrapper. Note: Unlike standard HTTP 401 semantics, this response indicates the task is locked by a workflow rule, Approval Process, or Blueprint, not an authentication failure." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returns the NO_PERMISSION error when the user profile lacks the Crm_Implied_Manage_Workflow or WorkFlow_Tasks permission required to update automation tasks.", "summary": "NO_PERMISSION: feature not available in this edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow", "WorkFlow_Tasks" ] }, "message": "feature not available in this edition", "status": "error" } }, "ReadOnlyTaskResponse": { "description": "Returns the NOT_ALLOWED error when the targeted task is a system-managed read-only task that cannot be edited regardless of profile permissions.", "summary": "NOT_ALLOWED: Cannot edit a read-only task", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Insufficient privileges to edit Read only task", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TaskNoPermissionSchema" }, { "$ref": "#/components/schemas/TaskNotAllowedSchema" } ], "description": "Error response returned when the caller is denied permission to update the automation task, either due to profile-level restrictions or because the task is read-only.", "x-zs-$id": "PutTasksForbiddenResponses" } } }, "description": "Insufficient permission, feature not available, or task is read-only." }, "404": { "content": { "application/json": { "examples": { "InvalidTaskIdResponse": { "description": "Returns the INVALID_DATA error when the automation task ID in the request URL does not exist in the organization.", "summary": "INVALID_DATA: the id given seems to be invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TaskInvalidDataSchema" } } }, "description": "The provided task ID does not exist." }, "500": { "content": { "application/json": { "examples": { "InternalServerErrorResponse": { "description": "Returns the INTERNAL_ERROR response when an unexpected server-side exception prevents the update from completing.", "summary": "INTERNAL_ERROR: Internal Server Error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InternalServerErrorResponse" } } }, "description": "Internal server error." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.UPDATE" ] } ], "summary": "Automation Task", "tags": [ "workflow_tasks" ], "x-zoho-document": "workflow_tasks", "x-zs-llm-description": "Replaces the full configuration of an existing automation task identified by the path parameter ID. Before calling: (1) GET /settings/automation/tasks/{id} to read the current structure; (2) GET /settings/layouts?module=Tasks to confirm supported fields and find any where required: true. Every field_mapping must be sent partial payloads are not supported. Locked tasks return 401 AUTHORIZATION_ERROR; read-only tasks return 400.", "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "/crm/v8/settings/automation/webhook_failures": { "get": { "description": "To retrieve detailed information about webhook execution failures in your Zoho CRM organization.\n\nOptionally filter results by module, webhook ID, and date range. If the **from** and **to** parameters are not specified, the API returns webhook failures from the last 30 days by default. The maximum allowed span between **from** and **to** is 90 days.\n", "operationId": "getWebhookFailures", "parameters": [ { "$ref": "#/components/parameters/ParamQueryWebhookId" }, { "$ref": "#/components/parameters/WebhooksParamQueryModule" }, { "$ref": "#/components/parameters/ParamQueryFrom" }, { "$ref": "#/components/parameters/ParamQueryTo" }, { "$ref": "#/components/parameters/WebhooksParamQueryPage" }, { "$ref": "#/components/parameters/WebhooksParamQueryPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response listing webhook execution failures, each containing the failure time, failure reason, the webhook reference, the triggering workflow rule, and the CRM record details.\n", "summary": "Successful retrieval of webhook execution failure records\n", "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 }, "webhook_failures": [ { "entity_details": { "id": "4876876000016474049", "module": { "api_name": "Leads", "id": "4876876000000002175" }, "name": "Freelancer.com" }, "failure_reason": "page_notfound", "failure_time": "2025-10-21T17:08:07+05:30", "id": "4876876000016474075", "webhook": { "id": "4876876000016390771", "name": "Premium Lead Alert" }, "workflow_rule": { "id": "4876876000016390881", "name": "WF-C" } } ] } } }, "schema": { "$ref": "#/components/schemas/WebhookFailuresResponse" } } }, "description": "Returns a paginated list of webhook execution failure records matching the specified filters. Each item contains the failure time, failure reason, the webhook reference, the triggering workflow rule, and the CRM record that triggered the failure.\n" }, "204": { "description": "No webhook failure records match the specified filter criteria. Returned when no failures exist for the given module, webhook ID, or date range combination.\n" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates the error response when the **webhook_id** parameter contains a non-numeric value that does not match a valid webhook record.\n", "summary": "Error for invalid action ID in webhook_id parameter\n", "value": { "code": "INVALID_DATA", "details": { "param_name": "webhook_id" }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidDataResponse2": { "description": "Demonstrates the error response when the **from** or **to** date parameter does not conform to the YYYY-MM-DD format.\n", "summary": "Error for malformed date format in from or to parameter\n", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "datetime", "param_name": "from" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidDataResponse3": { "description": "Demonstrates the error response when the **from** or **to** date parameter is set to a future date.\n", "summary": "Error for future date in from or to parameter\n", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "datetime", "param_name": "to" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidModuleResponse1": { "description": "Demonstrates the error response when the **module** query parameter does not match a valid CRM module API name.\n", "summary": "Error for unrecognized module API name in module parameter\n", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/WebhooksInvalidModuleErrorResponse" }, { "$ref": "#/components/schemas/InvalidActionIDErrorResponse" }, { "$ref": "#/components/schemas/InvalidDateRangeErrorResponse" } ], "description": "Represents the error response returned when one or more query parameters in the request are invalid. The response body conforms to one of three error variants: an invalid module, an invalid webhook action ID, or an invalid date range.\n", "x-zs-$id": "GetWebhookFailuresInvalidDataErrorResponseSchema" } } }, "description": "One or more query parameters are invalid.\n\n**Resolution:** The module API name must be valid. The **webhook_id** must be numeric. The **from** and **to** dates must be in YYYY-MM-DD format and must not be in the future.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates the error response when the requesting user does not have the Manage Workflow permission on their CRM profile.\n", "summary": "Error for missing Manage Workflow permission\n", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_manage_workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "GetWebhookFailuresNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to retrieve webhook failure logs in this organization.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user's profile.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Get webhook execution failure records\n", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Returns the failure log for workflow webhook executions. Filter by module api_name (defaults to 'all') or a specific webhook_id (defaults to 'all'). from/to accept YYYY-MM-DD evaluated in the org time zone; from defaults to 30 days before to, to defaults to today. Returns 204 when no failures match the filters. Each entry includes failure_time, failure_reason, the webhook reference, the triggering workflow rule, and the CRM record in entity_details." } }, "/crm/v8/settings/automation/webhooks": { "delete": { "description": "To delete one or more webhook actions configured in your Zoho CRM account.\n\nUp to 10 webhooks can be deleted in a single API call using the **ids** query parameter. Read-only webhooks created by Zoho extensions cannot be deleted. \n\nWebhooks associated with active Workflow Rules, Approval Processes, or Blueprints cannot be deleted.", "operationId": "deleteWebhooks", "parameters": [ { "$ref": "#/components/parameters/WebhooksParamQueryIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful bulk delete response where all specified webhooks were deleted, with each entry confirming deletion of a single webhook.", "summary": "Successful bulk deletion of webhooks", "value": { "webhooks": [ { "code": "SUCCESS", "details": { "id": "5249735000000100001" }, "message": "Webhook is deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "5249735000000100002" }, "message": "Webhook is deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkDeleteWebhooksSuccessResponse" } } }, "description": "Returns the list of operation results confirming that all specified webhooks were deleted successfully." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Shows a multi-status response for a bulk DELETE request where the API deleted at least one webhook and rejected at least one, with per-webhook success and error entries.", "summary": "Partial success with mixed deletion results.", "value": { "webhooks": [ { "code": "SUCCESS", "details": { "id": "111111000000066004" }, "message": "webhook deleted successfully", "status": "success" }, { "code": "NOT_ALLOWED", "details": { "id": "111111000000057597" }, "message": "webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkDeletePartialSuccessResponse" } } }, "description": "Returns a multi-status response. Each item in the array independently indicates success or failure for the corresponding webhook in the request. The API deleted at least one webhook and rejected at least one deletion." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates the INVALID_DATA error response returned when one or more of the provided webhook IDs is invalid.", "summary": "INVALID_DATA error for an invalid webhook ID.", "value": { "code": "INVALID_DATA", "details": { "limit": 10, "param_name": "ids" }, "message": "Bulk deletion of records limit reached", "status": "error" } }, "NotAllowedAssociatedResponse1": { "description": "Demonstrates the NOT_ALLOWED error response returned when a webhook cannot be deleted because it is associated with at least one active Workflow Rule, Approval Process, or Blueprint.", "summary": "NOT_ALLOWED error for a webhook associated with automation rules.", "value": { "webhooks": [ { "code": "NOT_ALLOWED", "details": { "id": "5249735000000100001" }, "message": "This webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" } ] } }, "NotAllowedReadOnlyResponse1": { "description": "Demonstrates the NOT_ALLOWED error response returned when a webhook cannot be deleted because it is read-only, typically created by a Zoho extension.", "summary": "NOT_ALLOWED error for a read-only webhook.", "value": { "webhooks": [ { "code": "NOT_ALLOWED", "details": { "id": "5249735000000100001" }, "message": "Insufficient privileges to delete Read only webhook", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "description": "Demonstrates the REQUIRED_PARAM_MISSING error response returned when the ids query parameter is absent from the bulk DELETE request.", "summary": "REQUIRED_PARAM_MISSING error for absent ids parameter.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequiredParamMissingIdsError" }, { "$ref": "#/components/schemas/BulkDeleteLimitExceededError" }, { "additionalProperties": false, "description": "Represents the error variant returned when one or more webhooks in the bulk DELETE request cannot be deleted, containing the list of per-webhook error objects.", "properties": { "webhooks": { "description": "Represents the list of error objects for webhooks that could not be deleted, where each item indicates either a read-only restriction or an active automation association.", "items": { "anyOf": [ { "$ref": "#/components/schemas/BulkDeleteReadOnlyNotAllowedError" }, { "$ref": "#/components/schemas/BulkDeleteAssociatedNotAllowedError" } ], "description": "Represents the error details for a single webhook that could not be deleted, indicating either a read-only restriction or an active association with Workflow Rules, Approval Processes, or Blueprints." }, "maxItems": 10, "type": "array" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "BulkDeleteWebhooksNotAllowedWrappedError" } ], "description": "Contains the error response when one or more bulk webhook deletions fail, represented as a union of specific error variants for a missing parameter, an exceeded limit, or disallowed operations.", "x-zs-$id": "DeleteWebhooksInvalidDataErrorResponseSchema" } } }, "description": "The request failed because the ids parameter is missing, more than 10 webhook IDs were provided, or one or more webhooks cannot be deleted because they are read-only or associated with active automation rules.\n\n**Resolution:** Ensure the ids parameter is present, contains no more than 10 comma-separated webhook IDs, and that none of the specified webhooks are read-only or associated with active Workflow Rules, Approval Processes, or Blueprints." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates the NO_PERMISSION error response returned when the requesting user does not have the required CRM profile permission to delete webhooks.", "summary": "NO_PERMISSION error for insufficient profile privileges.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "DeleteWebhooksNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to delete webhooks in this CRM organization.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.DELETE" ] } ], "summary": "Delete one or more webhooks", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Bulk-deletes webhooks by their IDs; supply ids as a comma-separated query parameter (up to 10). Read-only webhooks created by extensions and webhooks tied to active workflow rules, approval processes, or blueprints all return NOT_ALLOWED. Returns 200 when all succeed or 207 (Multi-Status) for mixed results. Use `getWebhooks` to find IDs first." }, "get": { "description": "To retrieve the list of all webhook action configurations available in your Zoho CRM organization. The response contains summary-level data for each webhook, including the module, URL, HTTP method, feature type, and audit metadata. Use the [Get Webhooks API using ID](webhooks.yaml#$.paths./settings/automation/webhooks/{webhook_ID}.get) to retrieve the full configuration of a specific webhook.", "operationId": "getWebhooks", "parameters": [ { "$ref": "#/components/parameters/WebhooksParamQueryModule" }, { "$ref": "#/components/parameters/WebhooksParamQueryPage" }, { "$ref": "#/components/parameters/WebhooksParamQueryPerPage" }, { "$ref": "#/components/parameters/WebhooksParamQuerySortBy" }, { "$ref": "#/components/parameters/WebhooksParamQuerySortOrder" }, { "$ref": "#/components/parameters/WebhooksParamQueryFeatureType" }, { "$ref": "#/components/parameters/WebhooksParamQueryRelatedModule" }, { "$ref": "#/components/parameters/ParamQueryFilters" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful list response containing three webhook summary objects, each with module, URL, HTTP method, feature type, and audit metadata fields.", "summary": "Successful list of webhook summary objects", "value": { "info": { "count": 10, "max_limit": 200, "more_records": false, "page": 1, "per_page": 200 }, "webhooks": [ { "associated": false, "created_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "created_time": "2025-07-12T06:55:54-07:00", "deletable": true, "description": "Protected Data", "editable": true, "feature_type": "workflow", "http_method": "POST", "id": "5725767000007186002", "lock_status": { "locked": false }, "modified_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "modified_time": "2025-07-12T06:55:54-07:00", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "Zoho's Data", "related_module": null, "source": "crm", "url": "https://webhook.site/3588de27-e3bd-4237-894b-f140143f3d99" }, { "associated": false, "created_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "created_time": "2025-07-06T08:00:01-07:00", "deletable": true, "description": null, "editable": true, "feature_type": "workflow", "http_method": "POST", "id": "5725767000007084238", "lock_status": { "locked": false }, "modified_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "modified_time": "2025-07-06T08:00:01-07:00", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "Zoho", "related_module": null, "source": "crm", "url": "https://webhook.site/3588de27-e3bd-4237-894b-f140143f3d99" }, { "associated": false, "created_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "created_time": "2025-07-06T04:16:24-07:00", "deletable": true, "description": "Description about the webhook", "editable": true, "feature_type": "workflow", "http_method": "POST", "id": "5725767000007093002", "lock_status": { "locked": false }, "modified_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "modified_time": "2025-07-06T04:16:24-07:00", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "New Lead Webhook API", "related_module": null, "source": "crm", "url": "https://webhook.site/3588de27-e3bd-4237-894b-f140143f3d99" } ] } }, "Success200Paginated": { "description": "Shows a paginated response containing the first page of webhook summary objects, with more_records set to true indicating additional webhooks exist on subsequent pages.", "summary": "Successful paginated list showing page one of two pages containing records.", "value": { "info": { "count": 1, "more_records": true, "page": 1, "per_page": 1 }, "webhooks": [ { "associated": false, "created_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "created_time": "2025-07-12T06:55:54-07:00", "deletable": true, "description": null, "editable": true, "feature_type": "workflow", "http_method": "POST", "id": "5725767000007186002", "lock_status": { "locked": false, "message": null }, "modified_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "modified_time": "2025-07-12T06:55:54-07:00", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "Lead Notification Webhook", "related_module": null, "source": "user", "url": "https://example.com/webhook-handler" } ] } } }, "schema": { "$ref": "#/components/schemas/GetWebhooksSuccessResponse" } } }, "description": "Returns a paginated list of webhook summary objects configured in your Zoho CRM organization. Each item contains the module, URL, HTTP method, feature type, and audit metadata. Full configuration fields such as headers, body, authentication, url_parameters, and date_time_format are omitted from this response." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows the error response when an invalid value is provided for the sort_order query parameter.", "summary": "Invalid query parameter value for sort_order", "value": { "code": "INVALID_DATA", "details": { "param_name": "sort_order" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidDataResponse2": { "description": "Shows the error response when the sort_by parameter contains a value that is not in the supported enum.", "summary": "Invalid sort_by parameter value", "value": { "code": "INVALID_DATA", "details": { "param_name": "sort_by" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidDataResponse3": { "description": "Shows the error response when the feature_type parameter contains a value that is not in the supported enum.", "summary": "Invalid feature_type parameter value", "value": { "code": "INVALID_DATA", "details": { "param_name": "feature_type" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidModuleResponse1": { "description": "Shows the error response when the module query parameter contains an API name that does not match any existing CRM module.", "summary": "Invalid module API name in module parameter", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/WebhooksInvalidModuleErrorResponse" }, { "$ref": "#/components/schemas/InvalidDataErrorResponse" } ], "description": "Contains the error response for an invalid query parameter. Each variant in the union indicates which parameter was invalid and why.", "x-zs-$id": "GetWebhooksInvalidParamErrorResponseSchema" } } }, "description": "One or more query parameters contain invalid values.\n\n**Resolution:** The module API name in the request must match a valid CRM module. The **sort_order**, **sort_by**, and **feature_type** values must match the supported enum values for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows the error response when the requesting user does not have the Manage Workflow permission required to list webhooks.", "summary": "Missing Manage Workflow permission for listing webhooks", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "GetWebhooksNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to list webhooks in the Zoho CRM organization.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user's profile.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Get webhooks", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Fetches a paginated list of webhook definitions; narrow results using filters for module, feature_type, related_module, or name. page defaults to 1, per_page max is 200; sort_by accepts only Modified_Time with asc/desc sort_order. The response carries summary-level data only headers, body, authentication, url_parameters, and date_time_format are omitted; call `getWebhookById` for the full config. Run this before PUT/DELETE to discover webhook IDs." }, "post": { "description": "To create a webhook action that fires an HTTP request to an external URL in your Zoho CRM organization when an automation trigger fires. \n\nThe `http_method` value controls which optional request fields are accepted. \n\n- POST and PUT accept `headers` and `body`\n- GET and DELETE methods accept `url_parameters`\n- DELETE also accepts `headers` \n\nTo retrieve valid module API names, refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource.", "operationId": "createWebhooks", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a create webhook request for the Leads module using POST with module parameters, custom headers, and body configuration.", "summary": "Webhook creation request with module parameters, custom headers, and body configuration.", "value": { "webhooks": [ { "authentication": { "type": "general" }, "body": { "format": "JSON", "raw_data_content": "{\n \"lead_id\": \"${!Leads.Id}\",\n \"email\": \"${!Leads.Email}\",\n \"owner\": \"${!Leads.Owner}\",\n \"source\": \"website\",\n \"version\": \"1.0\"\n}", "type": "raw" }, "description": "Protected Data", "feature_type": "workflow", "headers": { "custom_parameters": [ { "name": "source", "value": "website" }, { "name": "version", "value": "1.0" } ], "module_parameters": [ { "name": "lead_email", "value": "${!Leads.Email}" }, { "name": "lead_id", "value": "${!Leads.Id}" }, { "name": "lead_owner", "value": "${!Leads.Owner}" } ] }, "http_method": "POST", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "Zoho's Data", "url": "https://webhook.site/3588de27-e3bd-4237-894b-f140143f3d99" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateWebhooksRequestBody" } } }, "description": "The request body must contain a webhooks array with one object. The webhook object requires name, module, url, http_method, authentication, and feature_type." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Shows the successful response for a create webhook request, including the new webhook ID in the details object.", "summary": "Success response for webhook creation with new webhook ID", "value": { "webhooks": [ { "code": "SUCCESS", "details": { "id": "5725767000007186002" }, "message": "webhook created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateWebhooksSuccessResponse" } } }, "description": "Returns an array containing the operation result for the created webhook, including the new webhook ID." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse1": { "description": "Shows the error response when both module ID and api_name are provided but refer to different modules, causing an ambiguity error.", "summary": "Error response for module ID and API name conflict", "value": { "webhooks": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.webhooks[0].module.id" }, { "api_name": "api_name", "json_path": "$.webhooks[0].module.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentFieldMissingFormData": { "description": "Shows the error response when form_data_content is absent but body type is form_data, triggering a dependent field missing error.", "summary": "Error response for missing form_data_content when type is form_data", "value": { "webhooks": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "form_data_content", "dependee": { "api_name": "type", "json_path": "$.webhooks[0].body.type" }, "json_path": "$.webhooks[0].body.form_data_content" }, "message": "form data content key is mandatory for form body type", "status": "error" } ] } }, "DependentFieldMissingRawContent": { "description": "Shows the error response when raw_data_content is absent but body type is raw, triggering a dependent field missing error.", "summary": "Error response for missing raw_data_content when body type is raw", "value": { "webhooks": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "raw_data_content", "dependee": { "api_name": "format", "json_path": "$.webhooks[0].body.format" }, "json_path": "$.webhooks[0].body.raw_data_content" }, "message": "raw data content key is mandatory for raw body type", "status": "error" } ] } }, "DependentFieldMissingRelatedModule": { "description": "Shows the error response when related_module is absent but feature_type is kiosk, which requires a related module.", "summary": "Error response for missing related_module when feature_type is kiosk", "value": { "webhooks": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "related_module", "dependee": { "api_name": "feature_type", "json_path": "$.webhooks[0].feature_type" }, "json_path": "$.webhooks[0].related_module" }, "message": "Webhook action related module missing for kiosk feature", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Shows the error response when authentication type is general but connection_name is also provided, causing a dependent mismatch.", "summary": "Error response when authentication type is incompatible with connection_name.", "value": { "webhooks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "api_name": "connection_name", "json_path": "$.webhooks[0].authentication.connetion_name" }, "json_path": "$.webhooks[0].authentication.type" }, "message": "provide appropriate authentication type", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Shows the error response when the request includes fields incompatible with the chosen http_method, such as body with GET.", "summary": "Error response when request fields are incompatible with the chosen http_method.", "value": { "webhooks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "http_method", "dependee": { "api_name": "headers", "json_path": "$.webhooks[0].headers" }, "json_path": "$.webhooks[0].http_method" }, "message": "Invalid value provided for the given http method", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows the error response when a module parameter entry in headers contains a duplicate name.", "summary": "Error response for duplicate parameter name in module_parameters.", "value": { "webhooks": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[0].headers.module_parameters[1].name" }, "message": "duplicate parameter name found", "status": "error" } ] } }, "EmptyUrl": { "description": "Shows the error response when the URL field is present but contains an empty string.", "summary": "Error response for an empty URL field.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[0].url" }, "message": "Empty value is not allowed", "status": "error" } ] } }, "Error400Response1": { "description": "Shows the error response when the required module_parameters key is absent from the headers object.", "summary": "Error response when module_parameters is missing from the headers object", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module_parameters", "json_path": "$.webhooks[*].headers.module_parameters" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response10": { "description": "Shows the error response when raw_data_content in body has an incorrect data type.", "summary": "Error response for invalid data type in raw_data_content.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "raw_data_content", "expected_data_type": "text", "json_path": "$.webhooks[*].body.raw_data_content" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response11": { "description": "Shows the error response when raw_data_content in body exceeds the maximum allowed length.", "summary": "Error response when raw_data_content exceeds the maximum allowed length.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "raw_data_content", "json_path": "$.webhooks[*].body.raw_data_content", "maximum_length": 500 }, "message": "Invalid data", "status": "error" } } }, "Error400Response12": { "description": "Shows the error response when the required format field in body is absent.", "summary": "Error response when format is missing in body.", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response13": { "description": "Shows the error response when format in body has an incorrect data type.", "summary": "Error response for invalid data type in body format", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "expected_data_type": "text", "json_path": "$.webhooks[*].body.format" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response14": { "description": "Shows the error response when format in body exceeds the maximum allowed character length.", "summary": "Error response when format value exceeds the maximum allowed length", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } } }, "Error400Response15": { "description": "Shows the error response when format in body is not one of the accepted values.", "summary": "Error response when format value is not among the accepted values.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format", "supported_values": [ "JSON", "XML", "Text", "HTML" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response16": { "description": "Shows the error response when the required type field in body is absent.", "summary": "Error response when type is missing in body.", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response17": { "description": "Shows the error response when type in body has an incorrect data type; the expected type is text.", "summary": "Error response for invalid data type in body type.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.webhooks[*].body.type" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response18": { "description": "Shows the error response when type in body exceeds the maximum allowed length.", "summary": "Error response when type value exceeds the maximum allowed length.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type", "maximum_length": 10 }, "message": "Invalid data", "status": "error" } } }, "Error400Response19": { "description": "Shows the error response when type in body is not one of the accepted values.", "summary": "Error response when type value is not among the accepted values.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type", "supported_values": [ "form_data", "raw" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response2": { "description": "Shows the error response when module_parameters in headers has an incorrect data type.", "summary": "Error response for invalid data type in module_parameters.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "module_parameters", "expected_data_type": "jsonarray", "json_path": "$.webhooks[*].headers.module_parameters" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response20": { "description": "Shows the error response when the required type field in authentication is absent.", "summary": "Error response when type is missing in authentication.", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response21": { "description": "Shows the error response when type in authentication has an incorrect data type.", "summary": "Error response for invalid data type in authentication type.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.webhooks[*].authentication.type" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response22": { "description": "Shows the error response when type in authentication exceeds the maximum allowed length.", "summary": "Error response when type value exceeds the maximum allowed length in authentication.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } } }, "Error400Response23": { "description": "Shows the error response when type in authentication is not one of the accepted values.", "summary": "Error response when type value is not among the accepted values in authentication.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type", "supported_values": [ "general" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response3": { "description": "Shows the error response when module_parameters in headers exceeds the maximum allowed count.", "summary": "Error response when module_parameters exceeds the maximum allowed count in headers.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "module_parameters", "json_path": "$.webhooks[*].headers.module_parameters", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } } }, "Error400Response4": { "description": "Shows the error response when custom_parameters in headers has an incorrect data type.", "summary": "Error response for invalid data type in custom_parameters.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "custom_parameters", "expected_data_type": "jsonarray", "json_path": "$.webhooks[*].headers.custom_parameters" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response5": { "description": "Shows the error response when custom_parameters in headers exceeds the maximum allowed count.", "summary": "Error response when custom_parameters exceeds the maximum allowed count.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "custom_parameters", "json_path": "$.webhooks[*].headers.custom_parameters", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } } }, "Error400Response6": { "description": "Shows the error response when api_name in module has an incorrect data type.", "summary": "Error response for invalid data type in api_name.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.webhooks[*].module.api_name" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response7": { "description": "Shows the error response when api_name in module exceeds the maximum allowed length.", "summary": "Error response when api_name exceeds the maximum allowed length.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.webhooks[*].module.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } } }, "Error400Response8": { "description": "Shows the error response when ID in module has an incorrect data type.", "summary": "Error response for invalid data type in module ID.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.webhooks[*].module.id" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response9": { "description": "Shows the error response when ID in module exceeds the maximum allowed length.", "summary": "Error response when module ID exceeds the maximum allowed length.", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[*].module.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } } }, "ExpectedFieldMissing": { "description": "Shows the error response when the module object is present but neither ID nor api_name is provided.", "summary": "Error response when module is missing both ID and api_name.", "value": { "webhooks": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.webhooks[0].module.api_name" }, { "api_name": "id", "json_path": "$.webhooks[0].module.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidBodyFormat": { "description": "Shows the error response when body.format is invalid for the raw body type.", "summary": "Error respons when body.format value is not accepted.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "format", "json_path": "$.webhooks[0].body.format" }, "message": "invalid format passed in body", "status": "error" } ] } }, "InvalidBodyType": { "description": "Shows the error response when body.type is an unsupported value; the valid values are form_data, raw, or none.", "summary": "Error response when body.type value is not accepted.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[0].body.type" }, "message": "invalid body type passed", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows the error response for when the module ID given seems to be invalid.\n", "summary": "Error response when invalid ID given for module.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[0].module.id" }, "message": "the module id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows the error response for connection_name in authentication.\n", "summary": "Error response for invalid connection_name.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "connection_name", "json_path": "$.webhooks[0].authentication.connetion_name" }, "message": "Please provide valid connection name", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows the error response when headers in webhooks has an incorrect data type; the expected type is JSON object.", "summary": "Error response when the headers have invalid data type in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "headers", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].headers" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows the error response when the value of headers in webhooks exceeds the maximum allowed length.", "summary": "Error response when headers exceeds maximum length in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "headers", "json_path": "$.webhooks[*].headers", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows the error response when name in module_parameters[*] has an incorrect data type; the expected type is text.", "summary": "Error response when the name key has invalid data type in module_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.module_parameters[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows the error response when the value of name in module_parameters exceeds the maximum allowed length.", "summary": "Error response when name value exceeds maximum length in module_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].headers.module_parameters[*].name", "maximum_length": 10 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows the error response when value in module_parameters has an incorrect data type; the expected type is text.", "summary": "Error response when the invalid value is provided in module_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.module_parameters[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows the error response when the value of value in module_parameters exceeds the maximum allowed length.", "summary": "Error response when value exceeds maximum length for module_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[*].headers.module_parameters[*].value", "maximum_length": 15 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows the error response when name in custom_parameters has an incorrect data type; the expected type is text.", "summary": "Error response when the name has invalid value in custom_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.custom_parameters[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows the error response when the value of name in custom_parameters exceeds the maximum allowed length.", "summary": "Error response when the value of name exceeds maximum length in custom_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].headers.custom_parameters[*].name", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Shows the error response when value in custom_parameters has an incorrect data type; the expected type is text.", "summary": "Error response when the value has wrong data type in custom_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.custom_parameters[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows the error response for when special characters are used in name.", "summary": "Error response when special characters are used in name.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name" }, "message": "Special characters not allowed", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Shows the error response when the value of value in custom_parameters exceeds the maximum allowed length.", "summary": "Error response when the value exceeds maximum length in custom_parameters.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[*].headers.custom_parameters[*].value", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows the error response when module in webhooks has an incorrect data type; the expected type is JSON object.", "summary": "Error response when the module has invalid data type in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Shows the error response when the value of module in webhooks exceeds the maximum allowed length.", "summary": "Error response when the module exceeds maximum length in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.webhooks[*].module", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Shows the error response when description in webhooks has an incorrect data type; the expected type is text.", "summary": "Error response when description has wrong data type in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.webhooks[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Shows the error response when the value of description in webhooks exceeds the maximum allowed length.", "summary": "Error response when description exceeds maximum length in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.webhooks[*].description", "maximum_length": 250 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "Shows the error response when body in webhooks has an incorrect data type; the expected type is JSON object.", "summary": "Error response when body has invalid data type in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "body", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].body" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "Shows the error response when the value of body in webhooks exceeds the maximum allowed length.", "summary": "Error response when the body exceeds maximum length in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "body", "json_path": "$.webhooks[*].body", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "Shows the error response when url in webhooks has an incorrect data type; the expected type is website.", "summary": "Error response when URL has invalid data type in webhooks.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "expected_data_type": "website", "json_path": "$.webhooks[*].url" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse28": { "description": "Shows the error response when the value of url in webhooks exceeds the maximum allowed length.", "summary": "Shows the error response when URL exceeds maximum length.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[*].url", "maximum_length": 57 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse29": { "description": "Shows the error response when feature_type has an incorrect data type; the expected type is text.", "summary": "Error response when feature_type has invalid data type.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "expected_data_type": "text", "json_path": "$.webhooks[*].feature_type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows the error response when the value of name exceeds the maximum allowed length.", "summary": "Error response when the name exceeds maximum length.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[0].name", "maximum_length": 250 }, "message": "The lenght of name has exceeded the limit", "status": "error" } ] } }, "InvalidDataResponse30": { "description": "Shows the error response when the value of feature_type exceeds the maximum allowed length.", "summary": "Error response when the feature_type exceeds maximum length.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.webhooks[*].feature_type", "maximum_length": 20 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse31": { "description": "Shows the error response when http_method has an incorrect data type; the expected type is text.", "summary": "Error response when http_method has invalid data type.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "expected_data_type": "text", "json_path": "$.webhooks[*].http_method" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse32": { "description": "Shows the error response when the value of http_method exceeds the maximum allowed length.", "summary": "Error response when http_method exceeds maximum length.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "json_path": "$.webhooks[*].http_method", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse33": { "description": "Shows the error response when name has an incorrect data type; the expected type is text.", "summary": "Error response when name has invalid data type.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse34": { "description": "Shows the error response when the value of name exceeds the maximum allowed length.", "summary": "Error response when name exceeds maximum length.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].name", "maximum_length": 11 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse35": { "description": "Shows the error response when authentication has an incorrect data type; the expected type is JSON object.", "summary": "Error response when authentication data type is invalid.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "authentication", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].authentication" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse36": { "description": "Shows the error response when the value of authentication exceeds the maximum allowed length.", "summary": "Error response when the authentication exceeds maximum length.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "authentication", "json_path": "$.webhooks[*].authentication", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows the error response for http_method is invalid.", "summary": "Error response when http_method has invalid data type.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "json_path": "$.webhooks[0].http_method" }, "message": "The method type given is invalid", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows the error response for invalid URL.", "summary": "Error response for invalid URL.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[0].url" }, "message": "please enter a valid URL", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows the error response for invalid value in date_time_format.", "summary": "Error response for invalid values in date_format.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "date_format", "json_path": "$.webhooks[0].date_time_format.date_format" }, "message": "The Date given is invalid", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows the error response for invalid time_zone in date_time_format.", "summary": "Error response for invalid value in time_zone.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "time_zone", "json_path": "$.webhooks[0].date_time_format.time_zone" }, "message": "The timezone given is invalid", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows the error response for invalid values in datetime_format.", "summary": "Error response for invalid values in datetime_format.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "datetime_format", "json_path": "$.webhooks[0].date_time_format.datetime_format" }, "message": "The date time format given is invalid", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows the error response for invalid value in module_parameters.", "summary": "Error response for unsupported fields.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[0].headers.module_parameters[0].value" }, "message": "Unsupported fields are present", "status": "error" } ] } }, "InvalidFeatureType": { "description": "Shows the error response when feature_type in the request body is not a recognized automation feature type.", "summary": "Error response when the feature_type value is not recognized.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.webhooks[0].feature_type" }, "message": "the given feature name is invalid", "status": "error" } ] } }, "InvalidFormDataContent": { "description": "Shows the error response when body.form_data_content contains invalid or malformed data.", "summary": "Error response for invalid values in body.form_data_content.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "form_data_content", "json_path": "$.webhooks[0].body.form_data_content" }, "message": "inavlid form data content passed in body", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows the error response when the required name field is absent.", "summary": "Error response when the name key is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.webhooks[0].name" }, "message": "mandatory param missing", "status": "error" } ] } }, "MandatoryNotFoundResponse10": { "description": "Shows the error response when the required authentication field is absent.", "summary": "Error response when the authentication is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "authentication", "json_path": "$.webhooks[*].authentication" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows the error response when the required value field in custom_parameters is absent.", "summary": "Error response for value missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.webhooks[0].headers.custom_parameters[0].value" }, "message": "the given parameter is invalid, specify both name and value", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows the error response when the required name field in module_parameters is absent.", "summary": "Error response when name is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.webhooks[0].headers.module_parameters[0].name" }, "message": "the given parameter is invalid, specify both name and value", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows the error response when the required http_method field is absent.", "summary": "Shows the error response when http_method missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "http_method", "json_path": "$.webhooks[0].http_method" }, "message": "The method type is not given ", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Shows the error response when the required module field is absent.", "summary": "Error response when module is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.webhooks[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Shows the error response when the required URL field is absent.", "summary": "Error response when url key is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "url", "json_path": "$.webhooks[*].url" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Shows the error response when the required feature_type field is absent.", "summary": "Error response when the feature_type is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "feature_type", "json_path": "$.webhooks[*].feature_type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Shows the error response when the required http_method field is absent.", "summary": "Error response when the http_method is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "http_method", "json_path": "$.webhooks[*].http_method" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Shows the error response when the required name field is absent.", "summary": "Error response when the name key is missing.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.webhooks[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "SsrfUrl": { "description": "Shows the error response when the webhook URL references an SSRF-protected host.", "summary": "Error response when url key value fails SSRF validation.", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[0].url" }, "message": "Url you've configured is not secure", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the wrapped error response when the request body contains one or more invalid fields in the webhooks array.", "properties": { "webhooks": { "description": "Represents the array of validation error objects returned for the create request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandatoryParamMissingError" }, { "$ref": "#/components/schemas/InvalidModuleIdError" }, { "$ref": "#/components/schemas/AmbiguityProcessingErrorResponse" }, { "$ref": "#/components/schemas/InvalidNameErrorResponse" }, { "$ref": "#/components/schemas/NameLimitExceededErrorResponse" }, { "$ref": "#/components/schemas/InvalidMethodTypeErrorResponse" }, { "$ref": "#/components/schemas/InvalidUrlErrorResponse" }, { "$ref": "#/components/schemas/InvalidDateFormatErrorResponse" }, { "$ref": "#/components/schemas/InvalidTimezoneErrorResponse" }, { "$ref": "#/components/schemas/InvalidDateTimeFormatErrorResponse" }, { "$ref": "#/components/schemas/UnsupportedMergeFieldErrorResponse" }, { "$ref": "#/components/schemas/DuplicateDataErrorResponse" }, { "$ref": "#/components/schemas/AuthorizationDependentMismatchError" }, { "$ref": "#/components/schemas/ParameterNameValueMandatoryError" }, { "$ref": "#/components/schemas/HttpMethodMandatoryError" }, { "$ref": "#/components/schemas/InvalidConnectionNameError" }, { "$ref": "#/components/schemas/HttpMethodDependentMismatchError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataTypeError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataMaxLengthError" }, { "$ref": "#/components/schemas/WebhooksMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/WebhooksExpectedFieldMissingError" }, { "$ref": "#/components/schemas/WebhooksDependentFieldMissingError" }, { "$ref": "#/components/schemas/EmptyUrlError" }, { "$ref": "#/components/schemas/SsrfUrlError" }, { "$ref": "#/components/schemas/InvalidFeatureTypeError" }, { "$ref": "#/components/schemas/InvalidBodyTypeError" }, { "$ref": "#/components/schemas/InvalidBodyFormatError" }, { "$ref": "#/components/schemas/InvalidFormDataContentError" }, { "$ref": "#/components/schemas/NotAllowedErrorResponse" }, { "$ref": "#/components/schemas/WebhooksLimitExceededError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataSupportedValuesError" } ], "description": "Represents a single validation error object containing the error code, message, status, and details identifying the field that failed validation." }, "maxItems": 25, "type": "array" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PostWebhooksInvalidDataWrappedErrorResponse" }, { "additionalProperties": false, "description": "Represents the wrapped error response when a required field is missing from the webhook creation request.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksMandatoryFieldMissingError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PostWebhooksInvalidDataWrappedErrorResponseCore8" }, { "additionalProperties": false, "description": "Represents the wrapped error response when a field value has an incorrect data type.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataTypeError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PostWebhooksInvalidDataWrappedErrorResponseCore11" }, { "additionalProperties": false, "description": "Represents the wrapped error response when a field value exceeds the maximum allowed character length.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataMaxLengthError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PostWebhooksInvalidDataWrappedErrorResponseCore16" }, { "additionalProperties": false, "description": "Represents the wrapped error response when a field value is not among the accepted values for that field.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataSupportedValuesError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PostWebhooksInvalidDataWrappedErrorResponseCore15" }, { "$ref": "#/components/schemas/MandatoryParamMissingError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataSupportedValuesError" } ], "description": "Represents the error response body for a create webhook validation failure. Contains one of several wrapped error structures, each with a webhooks array or a direct error object.", "x-zs-$id": "PostWebhooksInvalidDataWrappedErrorResponseSchema" } } }, "description": "One or more request body fields are invalid.\n\n**Resolution:** The error details in the response body must be reviewed to identify the invalid field, and the value must be corrected before retrying." }, "403": { "content": { "application/json": { "examples": { "FeatureNotSupported": { "description": "Shows the error when the current CRM edition does not support webhook automation actions.", "summary": "Error response when webhooks is not available in current edition.", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "feature not available in this edition", "status": "error" } }, "NoPermissionResponse1": { "description": "Shows the error when the requesting user does not have the Crm_Implied_Manage_Workflow permission.", "summary": "Error response when user lacks Manage Workflow permission.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse" }, { "$ref": "#/components/schemas/WebhooksFeatureNotSupportedError" } ], "description": "Represents the error response for permission or feature-support issues encountered during webhook creation.", "x-zs-$id": "CreateWebhooksNoPermissionErrorResponseSchema" } } }, "description": "The requesting user does not have the Manage Workflow permission, or the current CRM edition does not support webhooks.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user's profile, or the account must be on an edition that supports webhooks." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.CREATE" ] } ], "summary": "Webhooks", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Adds a new webhook action that fires when automation triggers. Before calling: `getModules` to look up valid module api_names. Send a webhooks array with exactly one entry; required fields are name, module, url, http_method, authentication, and feature_type. http_method determines which keys are allowed: POST/PUT accept headers and body; GET/DELETE accept url_parameters; DELETE also accepts headers. Sending keys not allowed for the chosen method returns DEPENDENT_MISMATCH. The URL must begin with http://, https://, www., or ${...}; SSRF-protected hosts are rejected. The response contains the new webhook ID.", "x-zs-llm-examples": [ "SamplePostRequest" ] }, "put": { "description": "To update the configuration of an existing webhook in your Zoho CRM organization.\n\nThe module field cannot be changed after creation. The request body must contain a webhooks array with exactly one webhook object.\n\nTo retrieve valid module API names, refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource.", "operationId": "updateWebhooks", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows a webhook bulk update request with all required fields including name, module, url, http_method, authentication, and feature_type.", "summary": "Bulk update request for a webhook with all required fields", "value": { "webhooks": [ { "authentication": { "type": "general" }, "body": { "format": "JSON", "raw_data_content": "{\n \"lead_id\": \"${!Leads.Id}\",\n \"email\": \"${!Leads.Email}\",\n \"owner\": \"${!Leads.Owner}\",\n \"source\": \"website\",\n \"version\": \"1.0\"\n}", "type": "raw" }, "description": "Protected Data", "feature_type": "workflow", "headers": { "custom_parameters": [ { "name": "source", "value": "website" }, { "name": "version", "value": "1.0" } ], "module_parameters": [ { "name": "lead_email", "value": "${!Leads.Email}" }, { "name": "lead_id", "value": "${!Leads.Id}" }, { "name": "lead_owner", "value": "${!Leads.Owner}" } ] }, "http_method": "POST", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "Zoho's Data", "url": "https://webhook.site/3588de27-e3bd-4237-894b-f140143f3d99" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateWebhookRequest" } } }, "description": "The request body must contain a webhooks array with one object." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response confirming the webhook update completed, with the operation status code and the webhook ID in the details object.", "summary": "Successful webhook update response", "value": { "webhooks": [ { "code": "SUCCESS", "details": { "id": "5725767000007098001" }, "message": "webhook updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateWebhookSuccessResponse" } } }, "description": "Returns the success response for the webhook update operation, including the updated webhook ID in the **details** object." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse1": { "description": "Demonstrates the error when the module ID and api_name refer to different modules.", "summary": "Ambiguity error when module ID and api_name conflict", "value": { "webhooks": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.webhooks[0].module.id" }, { "api_name": "api_name", "json_path": "$.webhooks[0].module.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Demonstrates the error when request body fields are incompatible with the chosen http_method.", "summary": "Dependent mismatch error for incompatible authentication type", "value": { "webhooks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "api_name": "connection_name", "json_path": "$.webhooks[0].authentication.connetion_name" }, "json_path": "$.webhooks[0].authentication.type" }, "message": "provide appropriate authentication type", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Demonstrates the error when the chosen http_method is incompatible with the request body fields, such as providing headers or body with a GET or DELETE method.", "summary": "Dependent mismatch error for incompatible HTTP method and headers", "value": { "webhooks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "http_method", "dependee": { "api_name": "headers", "json_path": "$.webhooks[0].headers" }, "json_path": "$.webhooks[0].http_method" }, "message": "Invalid value provided for the given http method", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Demonstrates the error when two or more parameter entries in module_parameters or custom_parameters share the same name.", "summary": "Duplicate parameter name error in module_parameters", "value": { "webhooks": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[0].headers.module_parameters[1].name" }, "message": "duplicate parameter name found", "status": "error" } ] } }, "Error400Response1": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the headers.module_parameters field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing headers.module_parameters field", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module_parameters", "json_path": "$.webhooks[*].headers.module_parameters" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response10": { "description": "Demonstrates the INVALID_DATA error when the body.raw_data_content field has an incorrect data type.", "summary": "INVALID_DATA type error for body.raw_data_content field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "raw_data_content", "expected_data_type": "text", "json_path": "$.webhooks[*].body.raw_data_content" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response11": { "description": "Demonstrates the INVALID_DATA error when the body.raw_data_content field exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for body.raw_data_content field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "raw_data_content", "json_path": "$.webhooks[*].body.raw_data_content", "maximum_length": 500 }, "message": "Invalid data", "status": "error" } } }, "Error400Response12": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the body.format field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing body.format field", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response13": { "description": "Demonstrates the INVALID_DATA error when the body.format field has an incorrect data type.", "summary": "INVALID_DATA type error for body.format field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "expected_data_type": "text", "json_path": "$.webhooks[*].body.format" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response14": { "description": "Demonstrates the INVALID_DATA error when the body.format field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for body.format field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } } }, "Error400Response15": { "description": "Demonstrates the INVALID_DATA error when the body.format field value does not match one of the values that the field supports.", "summary": "INVALID_DATA unsupported value error for body.format field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format", "supported_values": [ "JSON", "XML", "Text", "HTML" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response16": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the body.type field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing body.type field", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response17": { "description": "Demonstrates the INVALID_DATA error when the body.type field has an incorrect data type.", "summary": "INVALID_DATA type error for body.type field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.webhooks[*].body.type" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response18": { "description": "Demonstrates the INVALID_DATA error when the body.type field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for body.type field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type", "maximum_length": 10 }, "message": "Invalid data", "status": "error" } } }, "Error400Response19": { "description": "Demonstrates the INVALID_DATA error when the body.type field value does not match one of the values that the field supports.", "summary": "INVALID_DATA unsupported value error for body.type field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type", "supported_values": [ "form_data", "raw" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response2": { "description": "Demonstrates the INVALID_DATA error when the headers.module_parameters field has an incorrect data type.", "summary": "INVALID_DATA type error for headers.module_parameters field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "module_parameters", "expected_data_type": "jsonarray", "json_path": "$.webhooks[*].headers.module_parameters" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response20": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the authentication.type field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing authentication.type field", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response21": { "description": "Demonstrates the INVALID_DATA error when the authentication.type field has an incorrect data type.", "summary": "INVALID_DATA type error for authentication.type field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.webhooks[*].authentication.type" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response22": { "description": "Demonstrates the INVALID_DATA error when the authentication.type field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for authentication.type field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } } }, "Error400Response23": { "description": "Demonstrates the INVALID_DATA error when the authentication.type field value is not among the supported values.", "summary": "INVALID_DATA unsupported value error for authentication.type field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type", "supported_values": [ "general" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response3": { "description": "Demonstrates the INVALID_DATA error when the headers.module_parameters field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for headers.module_parameters field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "module_parameters", "json_path": "$.webhooks[*].headers.module_parameters", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } } }, "Error400Response4": { "description": "Demonstrates the INVALID_DATA error when the headers.custom_parameters field has an incorrect data type.", "summary": "INVALID_DATA type error for headers.custom_parameters field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "custom_parameters", "expected_data_type": "jsonarray", "json_path": "$.webhooks[*].headers.custom_parameters" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response5": { "description": "Demonstrates the INVALID_DATA error when the headers.custom_parameters field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for headers.custom_parameters field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "custom_parameters", "json_path": "$.webhooks[*].headers.custom_parameters", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } } }, "Error400Response6": { "description": "Demonstrates the INVALID_DATA error when the module.api_name field has an incorrect data type.", "summary": "INVALID_DATA type error for module.api_name field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.webhooks[*].module.api_name" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response7": { "description": "Demonstrates the INVALID_DATA error when the module.api_name field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for module.api_name field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.webhooks[*].module.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } } }, "Error400Response8": { "description": "Demonstrates the INVALID_DATA error when the module.ID field has an incorrect data type.", "summary": "INVALID_DATA type error for module.ID field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.webhooks[*].module.id" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response9": { "description": "Demonstrates the INVALID_DATA error when the module.ID field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for module.ID field", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[*].module.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } } }, "InvalidDataResponse1": { "description": "Demonstrates the INVALID_DATA error when the module.ID value does not correspond to a valid CRM module.", "summary": "INVALID_DATA error for invalid module.ID value", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[0].module.id" }, "message": "the module id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Demonstrates the INVALID_DATA error when the headers.module_parameters value contains an unsupported merge field.", "summary": "INVALID_DATA error for unsupported merge field in headers", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[0].headers.module_parameters[0].value" }, "message": "Unsupported fields are present", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Demonstrates the INVALID_DATA error when the authentication.connection_name value is not valid.", "summary": "INVALID_DATA error for invalid authentication.connection_name", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "connection_name", "json_path": "$.webhooks[0].authentication.connetion_name" }, "message": "Please provide valid connection name", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Demonstrates the INVALID_DATA error when the headers field has an incorrect data type.", "summary": "INVALID_DATA type error for headers field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "headers", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].headers" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Demonstrates the INVALID_DATA error when the headers field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for headers field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "headers", "json_path": "$.webhooks[*].headers", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Demonstrates the INVALID_DATA error when a module_parameters name field in headers has an incorrect data type.", "summary": "INVALID_DATA type error for headers.module_parameters name field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.module_parameters[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Demonstrates the INVALID_DATA error when a module_parameters name field in headers exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for headers.module_parameters name field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].headers.module_parameters[*].name", "maximum_length": 10 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Demonstrates the INVALID_DATA error when a module_parameters value field in headers has an incorrect data type.", "summary": "INVALID_DATA type error for headers.module_parameters value field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.module_parameters[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Demonstrates the INVALID_DATA error when a module_parameters value field in headers exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for headers.module_parameters value field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[*].headers.module_parameters[*].value", "maximum_length": 15 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Demonstrates the INVALID_DATA error when a custom_parameters name field in headers has an incorrect data type.", "summary": "INVALID_DATA type error for headers.custom_parameters name field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.custom_parameters[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Demonstrates the INVALID_DATA error when a custom_parameters name field in headers exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for headers.custom_parameters name field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].headers.custom_parameters[*].name", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates the INVALID_DATA error when the webhook name contains special characters that are not permitted.", "summary": "INVALID_DATA error for special characters in webhook name", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name" }, "message": "Special characters not allowed", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Demonstrates the INVALID_DATA error when a custom_parameters value field in headers has an incorrect data type.", "summary": "INVALID_DATA type error for headers.custom_parameters value field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.custom_parameters[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Demonstrates the INVALID_DATA error when a custom_parameters value field in headers exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for headers.custom_parameters value field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[*].headers.custom_parameters[*].value", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Demonstrates the INVALID_DATA error when the module field has an incorrect data type.", "summary": "INVALID_DATA type error for module field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Demonstrates the INVALID_DATA error when the module field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for module field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.webhooks[*].module", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Demonstrates the INVALID_DATA error when the description field has an incorrect data type.", "summary": "INVALID_DATA type error for description field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.webhooks[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "Demonstrates the INVALID_DATA error when the description field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for description field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.webhooks[*].description", "maximum_length": 250 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "Demonstrates the INVALID_DATA error when the body field has an incorrect data type.", "summary": "INVALID_DATA type error for body field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "body", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].body" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "Demonstrates the INVALID_DATA error when the body field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for body field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "body", "json_path": "$.webhooks[*].body", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse28": { "description": "Demonstrates the INVALID_DATA error when the url field has an incorrect data type.", "summary": "INVALID_DATA type error for url field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "expected_data_type": "website", "json_path": "$.webhooks[*].url" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse29": { "description": "Demonstrates the INVALID_DATA error when the url field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for url field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[*].url", "maximum_length": 57 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates the INVALID_DATA error when the webhook name exceeds the maximum allowed character length.", "summary": "INVALID_DATA name length exceeded error for webhook name", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[0].name", "maximum_length": 250 }, "message": "The lenght of name has exceeded the limit", "status": "error" } ] } }, "InvalidDataResponse30": { "description": "Demonstrates the INVALID_DATA error when the feature_type field has an incorrect data type.", "summary": "INVALID_DATA type error for feature_type field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "expected_data_type": "text", "json_path": "$.webhooks[*].feature_type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse31": { "description": "Demonstrates the INVALID_DATA error when the feature_type field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for feature_type field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.webhooks[*].feature_type", "maximum_length": 20 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse32": { "description": "Demonstrates the INVALID_DATA error when the http_method field has an incorrect data type.", "summary": "INVALID_DATA type error for http_method field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "expected_data_type": "text", "json_path": "$.webhooks[*].http_method" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse33": { "description": "Demonstrates the INVALID_DATA error when the http_method field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for http_method field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "json_path": "$.webhooks[*].http_method", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse34": { "description": "Demonstrates the INVALID_DATA error when the name field has an incorrect data type.", "summary": "INVALID_DATA type error for name field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse35": { "description": "Demonstrates the INVALID_DATA error when the name field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for name field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].name", "maximum_length": 11 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse36": { "description": "Demonstrates the INVALID_DATA error when the authentication field has an incorrect data type.", "summary": "INVALID_DATA type error for authentication field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "authentication", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].authentication" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse37": { "description": "Demonstrates the INVALID_DATA error when the authentication field value exceeds the maximum allowed length.", "summary": "INVALID_DATA length error for authentication field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "authentication", "json_path": "$.webhooks[*].authentication", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates the INVALID_DATA error when the http_method value is not a supported HTTP method for webhook operations.", "summary": "INVALID_DATA error for unsupported http_method value", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "json_path": "$.webhooks[0].http_method" }, "message": "The method type given is invalid", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates the INVALID_DATA error when the url field value is not a valid URL.", "summary": "INVALID_DATA error for invalid webhook URL", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[0].url" }, "message": "please enter a valid URL", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Demonstrates the INVALID_DATA error when the date_time_format.date_format value is invalid.", "summary": "INVALID_DATA error for invalid date_format value", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "date_format", "json_path": "$.webhooks[0].date_time_format.date_format" }, "message": "The Date given is invalid", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Demonstrates the INVALID_DATA error when the date_time_format.time_zone value is not a supported timezone identifier.", "summary": "INVALID_DATA error for invalid time_zone value", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "time_zone", "json_path": "$.webhooks[0].date_time_format.time_zone" }, "message": "The timezone given is invalid", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Demonstrates the INVALID_DATA error when the date_time_format.datetime_format value is invalid.", "summary": "INVALID_DATA error for invalid datetime_format value", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "datetime_format", "json_path": "$.webhooks[0].date_time_format.datetime_format" }, "message": "The date time format given is invalid", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Demonstrates the INVALID_DATA error when the webhook ID in the request body does not match an existing webhook.", "summary": "INVALID_DATA error for invalid webhook ID in the request body", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[0].id" }, "message": "The ID given is invalid", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when a required parameter or field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing required field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.webhooks[0].headers.custom_parameters[0].value" }, "message": "the given parameter is invalid, specify both name and value", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when a parameter entry is missing its required name or value fields.", "summary": "MANDATORY_NOT_FOUND error for missing parameter name or value", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.webhooks[0].headers.module_parameters[0].name" }, "message": "the given parameter is invalid, specify both name and value", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the http_method field is absent from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing http_method field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "http_method", "json_path": "$.webhooks[0].http_method" }, "message": "The method type is not given ", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the module field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing module field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.webhooks[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the url field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing url field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "url", "json_path": "$.webhooks[*].url" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the feature_type field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing feature_type field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "feature_type", "json_path": "$.webhooks[*].feature_type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the http_method field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing http_method field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "http_method", "json_path": "$.webhooks[*].http_method" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the name field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing name field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.webhooks[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Demonstrates the MANDATORY_NOT_FOUND error when the authentication field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error for missing authentication field", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "authentication", "json_path": "$.webhooks[*].authentication" }, "message": "Required field is missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Demonstrates the NOT_ALLOWED error when a request attempts to edit a read-only webhook created by a Marketplace extension.", "summary": "NOT_ALLOWED error for editing a read-only webhook", "value": { "webhooks": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.webhooks[0].id" }, "message": "Insufficient privileges to edit Read only webhook", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "Demonstrates the NOT_ALLOWED error when a request attempts to modify a webhook that is associated with a Marketplace extension.", "summary": "NOT_ALLOWED error for modifying a Marketplace-associated webhook", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Webhook is associated with MarketPlace", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response where the webhooks property is an array containing a single error object, returned for most field-level validation errors in the bulk update request.", "properties": { "webhooks": { "description": "Represents the array containing the error object for the invalid webhook in the bulk update response.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidModuleIdError" }, { "$ref": "#/components/schemas/AmbiguityProcessingErrorResponse" }, { "$ref": "#/components/schemas/InvalidNameErrorResponse" }, { "$ref": "#/components/schemas/NameLimitExceededErrorResponse" }, { "$ref": "#/components/schemas/InvalidMethodTypeErrorResponse" }, { "$ref": "#/components/schemas/InvalidUrlErrorResponse" }, { "$ref": "#/components/schemas/InvalidDateFormatErrorResponse" }, { "$ref": "#/components/schemas/InvalidTimezoneErrorResponse" }, { "$ref": "#/components/schemas/InvalidDateTimeFormatErrorResponse" }, { "$ref": "#/components/schemas/InvalidWebhookIdError" }, { "$ref": "#/components/schemas/UnsupportedMergeFieldErrorResponse" }, { "$ref": "#/components/schemas/DuplicateDataErrorResponse" }, { "$ref": "#/components/schemas/AuthorizationDependentMismatchError" }, { "$ref": "#/components/schemas/ParameterNameValueMandatoryError" }, { "$ref": "#/components/schemas/HttpMethodMandatoryError" }, { "$ref": "#/components/schemas/InvalidConnectionNameError" }, { "$ref": "#/components/schemas/HttpMethodDependentMismatchError" }, { "$ref": "#/components/schemas/ReadOnlyWebhookNotAllowedError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataTypeError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataMaxLengthError" }, { "$ref": "#/components/schemas/WebhooksMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/ModuleChangeNotAllowedError" }, { "$ref": "#/components/schemas/KioskNameChangeNotAllowedError" } ], "description": "Represents an individual webhook validation error, indicating which field failed validation and the associated error code and message." }, "maxItems": 25, "type": "array" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksBulkInvalidRequestBodyError" }, { "$ref": "#/components/schemas/MarketplaceWebhookNotAllowedError" }, { "additionalProperties": false, "description": "Represents the error returned when a field value has an incorrect data type. The **webhooks** property contains the error object directly.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksMandatoryFieldMissingError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksBulkMandatoryFieldMissingWrappedError" }, { "additionalProperties": false, "description": "Represents the error returned when a field value exceeds the maximum allowed character length. The **webhooks** property contains the error object directly.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataTypeError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksBulkInvalidDataTypeWrappedError" }, { "additionalProperties": false, "description": "Represents the error returned when a field value is not among the supported values. The **webhooks** property contains the error object directly.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataMaxLengthError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksBulkInvalidDataMaxLengthWrappedError" }, { "additionalProperties": false, "description": "Represents the error returned when a field value is not among the accepted values for that field. The **webhooks** property contains the error object directly, not wrapped in an array.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataSupportedValuesError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksBulkInvalidDataSupportedValuesWrappedError" } ], "description": "Contains the error response for an invalid webhook update request. The schema is a union of specific error variants covering field-level validation, data type, length, and supported value violations.", "x-zs-$id": "PutWebhooksBulkInvalidDataErrorResponseSchema" } } }, "description": "One or more request body fields are invalid. Returned for validation errors including invalid module ID, unsupported HTTP method, malformed URL, SSRF-protected URL, unsupported feature type, duplicate parameter names, module change attempt, and data type or length violations.\n\n**Resolution:** All required fields must be present in the request body, and each field value must match the expected type, format, and allowed values for this operation. The module field cannot be changed after webhook creation." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates the NO_PERMISSION error when the requesting user lacks the Manage Workflow CRM profile permission.", "summary": "NO_PERMISSION error for missing Manage Workflow profile permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "PutWebhooksBulkNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to update webhooks in this organization.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.UPDATE" ] } ], "summary": "Update webhooks", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Replaces one webhook in a single call. Before submitting: (1) list webhook IDs via `getWebhooks`; (2) confirm valid module api_names via `getModules`. Full-replacement semantics apply include every field you want to keep, since omitted fields revert to defaults or null. The webhook object must carry its id field. Module and kiosk names cannot be changed; read-only or marketplace/extension webhooks return NOT_ALLOWED.", "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "/crm/v8/settings/automation/webhooks/actions/associated_modules": { "get": { "description": "To retrieve the list of CRM modules that have at least one webhook currently associated in your Zoho CRM organization.\n\nResults are filtered based on the requesting user's module access permissions. Use these module API names as valid values for the module filter when querying webhook failures.", "operationId": "getWebhookAssociatedModules", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response listing the CRM modules that have at least one webhook associated, filtered by the requesting user's module access permissions.", "summary": "Successful response listing modules with associated webhooks", "value": { "associated_modules": [ { "api_name": "Leads", "id": "4876876000000002175" }, { "api_name": "Deals", "id": "4876876000000002181" } ] } } }, "schema": { "$ref": "#/components/schemas/AssociatedModulesResponse" } } }, "description": "Returns the list of CRM modules that have at least one webhook associated. Results are filtered based on the requesting user's module access permissions." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates the error response when the requesting user does not have the Manage Workflow permission on their CRM profile.", "summary": "NO_PERMISSION error for missing Manage Workflow permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied__Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "GetAssociatedModulesNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to retrieve webhook-associated modules in this Zoho CRM organization.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Get webhook-associated modules", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Lists the modules where workflow webhooks are currently in use; results are filtered to modules the requester can access. Use the returned api_names as the module filter when querying /webhook_failures to avoid INVALID_MODULE errors. No query parameters needed. Missing privilege returns 403 NO_PERMISSION." } }, "/crm/v8/settings/automation/webhooks/actions/usage_reports": { "get": { "description": "To retrieve usage statistics for webhook actions executed in your Zoho CRM organization. Specify the **group_by** parameter to control the granularity of results; optionally filter by automation feature type and date range.\n", "operationId": "getWebhookUsageReports", "parameters": [ { "$ref": "#/components/parameters/ParamQueryGroupBy" }, { "$ref": "#/components/parameters/ParamQueryType" }, { "$ref": "#/components/parameters/ParamQueryFrom" }, { "$ref": "#/components/parameters/ParamQueryTo" }, { "$ref": "#/components/parameters/WebhooksParamQueryPage" }, { "$ref": "#/components/parameters/WebhooksParamQueryPerPage" }, { "$ref": "#/components/parameters/WebhooksParamQuerySortOrder" }, { "$ref": "#/components/parameters/ParamQueryUsageIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response containing the **data_usage** array with webhook action usage entries grouped according to the **group_by** parameter. When **group_by** includes **resource**, each entry represents one webhook action per day; when **group_by** is **date** only, each entry represents the daily total across all webhook actions.\n", "summary": "Successful webhook action usage report response\n", "value": { "data_usage": [ { "count": 1, "date": "2025-10-23", "resource": { "id": "4876876000016390771", "name": "Premium Lead Alert" }, "type": "webhooks" }, { "count": 1, "date": "2025-10-21", "resource": { "id": "4876876000016390771", "name": "Premium Lead Alert" }, "type": "webhooks" }, { "count": 8, "date": "2025-10-17", "resource": { "id": "4876876000016390771", "name": "Premium Lead Alert" }, "type": "webhooks" } ], "info": { "count": 3, "max_limit": 2500, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "$ref": "#/components/schemas/AutomationUsageReportResponse" } } }, "description": "Returns the webhook action usage report for the requested date range. Each item in the **data_usage** array represents usage grouped by the criteria specified in the **group_by** parameter. When **group_by** includes **resource**, each item represents one webhook action per day; when **group_by** is **date** only, each item represents the daily total across all webhook actions.\n" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows the error response returned when the **from** or **to** date parameter contains a future date value. The **from** and **to** parameters must be dates in the past or the current date in YYYY-MM-DD format.\n", "summary": "INVALID_DATA error for a future date parameter value.\n", "value": { "code": "INVALID_DATA", "details": { "param_name": "type" }, "message": "feature type is invalid", "status": "error" } }, "InvalidDataResponse2": { "description": "Shows the error response returned when the **type** query parameter contains an unsupported automation feature type value. The **type** value must match one of the supported automation feature types.\n", "summary": "INVALID_DATA error for an unsupported automation type value\n", "value": { "code": "INVALID_DATA", "details": { "param_name": "date" }, "message": "provided time is ahead", "status": "error" } }, "RequiredParamMissingResponse1": { "description": "Shows the error response returned when the required **group_by** parameter is absent from the request. The **group_by** parameter is mandatory and must include **date**.\n", "summary": "REQUIRED_PARAM_MISSING error when group_by is absent\n", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "group_by" }, "message": "One of the expected param is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AutomationUsageRequiredParamMissingError" }, { "$ref": "#/components/schemas/AutomationUsageInvalidDataError" } ], "description": "Represents the error response returned when one or more query parameters fail validation. Applies when **group_by** is missing or does not include **date**, when **type** has an unsupported value, when a date parameter is in the future, or when pagination parameters are invalid.\n", "x-zs-$id": "GetUsageReportsErrorResponseSchema" } } }, "description": "One or more query parameters are invalid.\n\n**Resolution:** The **group_by** parameter must be present and must include **date**. The **type** value must match a supported automation feature type. Date parameters must be in YYYY-MM-DD format and must not be in the future.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows the error response returned when the requesting user's CRM profile lacks the Manage Automation Actions permission required to retrieve webhook action usage reports.\n", "summary": "NO_PERMISSION error for insufficient profile permissions\n", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_manage_workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AutomationUsageNoPermissionError", "x-zs-$id": "GetUsageReportsNoPermissionResponseWrapper" } } }, "description": "Permission denied to retrieve webhook action usage reports.\n\n**Resolution:** The CRM administrator must grant the Manage Automation Actions permission to the user's profile.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Get webhook action usage reports\n", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Returns daily send counts for workflow webhook actions, optionally broken down by resource and action type. group_by is required and must contain 'date'; accepted combinations are 'date' alone (totals across all webhooks) or 'date,resource' (per-action rows with resource id and name). type restricts results to a specific automation context. from/to accept yyyy-MM-dd in the org time zone and default to the last 30 days. page, per_page, sort_order, and include_inner_details (adds nested fields like resource.layout_id) are optional. Supplying a future date returns 400." } }, "/crm/v8/settings/automation/webhooks/{webhookId}": { "delete": { "description": "To delete a specific webhook configured in your Zoho CRM organization using its unique ID.\n\nRead-only webhooks created by Marketplace extensions cannot be deleted. Webhooks associated with active Workflow Rules, Approval Processes, Blueprints, or Command Center also cannot be deleted.", "operationId": "deleteWebhooksById", "parameters": [ { "description": "Specify the unique ID of the webhook to delete. Refer to the [Get Webhooks](webhooks.yaml#$.paths./settings/automation/webhooks.get) resource for valid values.", "in": "path", "name": "webhookId", "required": true, "schema": { "maxLength": 20, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a success response confirming the deleted the webhook, with a success code and the webhook ID in the details object.", "summary": "Successful deletion of a single webhook by ID.", "value": { "webhooks": [ { "code": "SUCCESS", "details": { "id": "5725767000007098001" }, "message": "Webhook is deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteWebhookByIdSuccessResponse" } } }, "description": "Returns the delete operation result for the specified webhook. The webhooks array contains one item indicating whether Zoho CRM deleted the webhook successfully or why it could not be deleted." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows the error response when the webhook ID in the request body does not match any existing webhook in the organization.", "summary": "Invalid webhook ID in request body", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[0].id" }, "message": "The ID given is invalid", "status": "error" } ] } }, "InvalidWebhookIdPathResponse1": { "description": "Shows the error response when the webhook ID in the URL path does not match any existing webhook in the organization.", "summary": "Invalid webhook ID in URL path", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "NotAllowedResponse1": { "description": "Shows the error response when attempting to delete a webhook created by a Marketplace extension, which cannot be deleted through the API.", "summary": "Webhook created by a Marketplace extension cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Webhook is associated with MarketPlace", "status": "error" } }, "NotAllowedResponse2": { "description": "Shows the error response when attempting to delete a webhook that is associated with active Workflow Rules, Approval Processes, or Blueprints.", "summary": "Webhook associated with active automation rules cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "This webhook is associated with at least one of Approval Process/Workflow Rules/Blueprint", "status": "error" } }, "NotAllowedResponse3": { "description": "Shows the error response when attempting to delete a read-only webhook that cannot be deleted by the requesting user.", "summary": "Read-only webhook cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "id": "5249735000000100001" }, "message": "Insufficient privileges to delete Read only webhook", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MarketplaceWebhookNotAllowedError" }, { "$ref": "#/components/schemas/WebhookAssociatedWithRulesError" }, { "$ref": "#/components/schemas/ReadOnlyWebhookDeleteNotAllowedError" }, { "additionalProperties": false, "description": "Represents the error response when the webhook ID provided in the request does not match any existing webhook in the organization.", "properties": { "webhooks": { "description": "Represents the array containing the error details for the invalid webhook ID in a single-record DELETE request.", "items": { "$ref": "#/components/schemas/InvalidWebhookIdError" }, "maxItems": 1, "type": "array" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "DeleteWebhooksByIdInvalidDataWrappedErrorResponse" }, { "$ref": "#/components/schemas/InvalidWebhookIdPathError" } ], "description": "Contains the error response when a single webhook DELETE request fails, covering variants for an invalid webhook ID, not-allowed conditions, and Marketplace restrictions.", "x-zs-$id": "DeleteWebhooksByIdInvalidDataErrorResponseSchema" } } }, "description": "The webhook ID is invalid, the webhook is read-only, or the webhook is associated with active automation rules or created by a Marketplace extension.\n\n**Resolution:** The webhook ID in the request URL must match an existing webhook. The webhook must not be read-only or associated with active Workflow Rules, Approval Processes, or Blueprints." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows the error response when the requesting user does not have the Manage Workflow permission on their CRM profile.", "summary": "Insufficient Manage Workflow permission to delete webhook", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "DeleteWebhooksByIdNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to delete the specified webhook in this Zoho CRM organization.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.DELETE" ] } ], "summary": "Delete a webhook by ID", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Removes a single webhook by the webhookId path param. Read-only webhooks (extension-created) and webhooks referenced by active workflow rules, approval processes, blueprints, or command center all return NOT_ALLOWED. Passing an invalid webhook ID returns INVALID_DATA. The response reports success or error for the deletion." }, "get": { "description": "To retrieve the configuration of a specific webhook in your Zoho CRM organization using its ID.\n\nUse the [Get Webhooks API](webhooks.yaml#$.paths./settings/automation/webhooks.get) first to discover webhook IDs.", "operationId": "getWebhookById", "parameters": [ { "description": "Specify the ID of the webhook to retrieve. Refer to the [Get Webhooks](webhooks.yaml#$.paths./settings/automation/webhooks.get) resource for valid values.", "in": "path", "name": "webhookId", "required": true, "schema": { "maxLength": 20, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response containing the full webhook configuration, including headers, body, authentication, url_parameters, and date_time_format fields.", "summary": "Successful response for Get Webhook by ID", "value": { "webhooks": [ { "associated": true, "authentication": { "connection_name": "", "type": "general" }, "body": { "form_data_content": { "custom_parameters": [ { "name": "source_system", "value": "zoho_crm" } ], "module_parameters": [ { "name": "lead_email", "value": "${!Leads.Email}" } ] }, "format": null, "type": "form_data" }, "created_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "created_time": "2025-07-06T04:16:24-07:00", "date_time_format": { "date_format": "dd-mmmm-yyyy", "datetime_format": "dd-mm-yyyy H:M:S", "time_zone": "Etc/GMT+12" }, "deletable": true, "description": "Sends lead data to external CRM sync service", "editable": true, "feature_type": "workflow", "headers": { "custom_parameters": [ { "name": "x-api-key", "value": "my-static-api-key" } ], "module_parameters": [ { "name": "lead_modified_time", "value": "${!Leads.Modified_Time}" } ] }, "http_method": "POST", "id": "5725767000007084001", "lock_status": { "locked": false, "message": null }, "modified_by": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "modified_time": "2025-07-12T06:55:54-07:00", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "Lead Sync Webhook", "related_module": null, "source": "user", "url": "https://example.com/webhook-handler", "url_parameters": null } ] } } }, "schema": { "$ref": "#/components/schemas/GetWebhookByIdSuccessResponse" } } }, "description": "Returns the full configuration of the specified webhook, including **headers**, **body**, **url_parameters**, **authentication**, and **date_time_format**." }, "204": { "description": "Returns no content when no webhook matches the specified ID. The request was valid, but the response body is empty." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates the error response when the requesting user does not have the Manage Webhook permission on their CRM profile.", "summary": "NO_PERMISSION error for missing Manage Webhook permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "GetWebhookByIdNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to retrieve webhook details in this Zoho CRM organization.\n\n**Resolution:** The CRM administrator must grant the Manage Webhook permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.READ" ] } ], "summary": "Get webhook by ID", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Retrieves the complete configuration of one webhook including headers, body, url_parameters, authentication, and date_time_format fields that the list endpoint omits. Supply the webhook ID as the webhookId path param. Returns 204 if the webhook does not exist. Run this before a PUT to see what is currently stored." }, "put": { "description": "To update the configuration of a specific webhook in your Zoho CRM organization using its ID.\n\nThe module field cannot be changed after webhook creation. Read-only webhooks created by Marketplace extensions cannot be updated.", "operationId": "updateWebhookById", "parameters": [ { "description": "Specify the unique ID of the webhook to update. Refer to the [Get Webhooks](webhooks.yaml#$.paths./settings/automation/webhooks.get) resource for valid values.", "in": "path", "name": "webhookId", "required": true, "schema": { "maxLength": 20, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows a webhook update request with the required fields, including name, module, URL, HTTP method, and authentication configuration.", "summary": "Update a webhook with full configuration", "value": { "webhooks": [ { "authentication": { "type": "general" }, "body": { "format": "JSON", "raw_data_content": "{\n \"lead_id\": \"${!Leads.Id}\",\n \"email\": \"${!Leads.Email}\",\n \"owner\": \"${!Leads.Owner}\",\n \"source\": \"website\",\n \"version\": \"1.0\"\n}", "type": "raw" }, "description": "Protected Data", "feature_type": "workflow", "headers": { "custom_parameters": [ { "name": "source", "value": "website" }, { "name": "version", "value": "1.0" } ], "module_parameters": [ { "name": "lead_email", "value": "${!Leads.Email}" }, { "name": "lead_id", "value": "${!Leads.Id}" }, { "name": "lead_owner", "value": "${!Leads.Owner}" } ] }, "http_method": "POST", "module": { "api_name": "Leads", "id": "5725767000000002175" }, "name": "Zoho's Data", "url": "https://webhook.site/3588de27-e3bd-4237-894b-f140143f3d99" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateWebhookRequest" } } }, "description": "The request body must contain a webhooks array with one object." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response confirming the webhook update, including the operation status code and the webhook ID.", "summary": "Successful webhook update response", "value": { "webhooks": [ { "code": "SUCCESS", "details": { "id": "5725767000007098001" }, "message": "webhook updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateWebhookSuccessResponse" } } }, "description": "Returns the result of the webhook update request for the specified webhook ID, including the webhook ID in the details object." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse1": { "description": "Shows the AMBIGUITY_DURING_PROCESSING error returned when both the module ID and api_name are provided but refer to different modules.", "summary": "Module id and api_name refer to different modules", "value": { "webhooks": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.webhooks[0].module.id" }, { "api_name": "api_name", "json_path": "$.webhooks[0].module.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DependentMismatchResponse1": { "description": "Shows the DEPENDENT_MISMATCH error returned when authentication.type is general but a connection_name is also provided, or vice versa.", "summary": "Authentication type mismatch with connection name.", "value": { "webhooks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "type", "dependee": { "api_name": "connection_name", "json_path": "$.webhooks[0].authentication.connetion_name" }, "json_path": "$.webhooks[0].authentication.type" }, "message": "provide appropriate authentication type", "status": "error" } ] } }, "DependentMismatchResponse2": { "description": "Shows the DEPENDENT_MISMATCH error returned when the request body includes fields incompatible with the chosen http_method.", "summary": "HTTP method and request body fields are incompatible", "value": { "webhooks": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "http_method", "dependee": { "api_name": "headers", "json_path": "$.webhooks[0].headers" }, "json_path": "$.webhooks[0].http_method" }, "message": "Invalid value provided for the given http method", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows the DUPLICATE_DATA error returned when two or more parameter entries in module_parameters or custom_parameters share the same name.", "summary": "Duplicate parameter name in module or custom parameters.", "value": { "webhooks": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[0].headers.module_parameters[1].name" }, "message": "duplicate parameter name found", "status": "error" } ] } }, "Error400Response1": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field is absent from the request body.", "summary": "Required field missing from request body", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module_parameters", "json_path": "$.webhooks[*].headers.module_parameters" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response10": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type.", "summary": "Field value has an incorrect data type", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "raw_data_content", "expected_data_type": "text", "json_path": "$.webhooks[*].body.raw_data_content" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response11": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified field.", "summary": "Field value is invalid", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "raw_data_content", "json_path": "$.webhooks[*].body.raw_data_content", "maximum_length": 500 }, "message": "Invalid data", "status": "error" } } }, "Error400Response12": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field is absent from the webhook request body.", "summary": "Required field missing from webhook request", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response13": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook request body.", "summary": "Field value has an incorrect data type in webhook request", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "expected_data_type": "text", "json_path": "$.webhooks[*].body.format" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response14": { "description": "Shows the INVALID_DATA error returned when a field value fails validation in the webhook request body.", "summary": "Field value fails validation in webhook request", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } } }, "Error400Response15": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified field in the webhook request.", "summary": "Field value is not valid", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "format", "json_path": "$.webhooks[*].body.format", "supported_values": [ "JSON", "XML", "Text", "HTML" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response16": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required webhook field is missing from the request body.", "summary": "Required field missing from webhook request", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response17": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook update request.", "summary": "Field value has an incorrect data type", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.webhooks[*].body.type" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response18": { "description": "Shows the INVALID_DATA error returned when a field value fails validation in the webhook update request.", "summary": "Field value fails validation", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type", "maximum_length": 10 }, "message": "Invalid data", "status": "error" } } }, "Error400Response19": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for its schema type in the webhook update request.", "summary": "Field value is not valid for its schema type", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].body.type", "supported_values": [ "form_data", "raw" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response2": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type for the specified webhook field.", "summary": "Webhook field value has an incorrect data type", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "module_parameters", "expected_data_type": "jsonarray", "json_path": "$.webhooks[*].headers.module_parameters" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response20": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a mandatory webhook configuration field is absent from the request body.", "summary": "Required webhook field is missing", "value": { "webhooks": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type" }, "message": "Required field is missing", "status": "error" } } }, "Error400Response21": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook update request.", "summary": "Field value has an incorrect data type", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.webhooks[*].authentication.type" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response22": { "description": "Shows the INVALID_DATA error returned when a field value fails validation in the webhook update request.", "summary": "Field value is invalid", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } } }, "Error400Response23": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified webhook field.", "summary": "Field value is not valid", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.webhooks[*].authentication.type", "supported_values": [ "general" ] }, "message": "Invalid data", "status": "error" } } }, "Error400Response3": { "description": "Shows the INVALID_DATA error returned when a field value fails validation in the webhook update request body.", "summary": "Field value is invalid in webhook update request", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "module_parameters", "json_path": "$.webhooks[*].headers.module_parameters", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } } }, "Error400Response4": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook update request body.", "summary": "Field value has an incorrect data type", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "custom_parameters", "expected_data_type": "jsonarray", "json_path": "$.webhooks[*].headers.custom_parameters" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response5": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified field in the webhook update request.", "summary": "Field value is not valid", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "custom_parameters", "json_path": "$.webhooks[*].headers.custom_parameters", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } } }, "Error400Response6": { "description": "Shows the INVALID_DATA error returned when a field value fails validation in the webhook update request.", "summary": "Field value fails validation", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.webhooks[*].module.api_name" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response7": { "description": "Shows the INVALID_DATA error returned when a field value is not valid in the webhook update request.", "summary": "Field value is not valid in webhook update", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.webhooks[*].module.api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } } }, "Error400Response8": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type for the specified field.", "summary": "Webhook field value has an incorrect data type", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.webhooks[*].module.id" }, "message": "Invalid data type", "status": "error" } } }, "Error400Response9": { "description": "Shows the INVALID_DATA error returned when a field value fails validation for the specified field in the webhook update.", "summary": "Webhook field value fails validation", "value": { "webhooks": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[*].module.id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } } }, "InvalidDataResponse1": { "description": "Shows the INVALID_DATA error returned when the module ID in the request body does not match an existing CRM module.", "summary": "Module ID in request body is invalid", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[0].module.id" }, "message": "the module id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse10": { "description": "Shows the INVALID_DATA error returned when a merge-field token in the webhook configuration references an unsupported field.", "summary": "Merge-field token references an unsupported field", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[0].headers.module_parameters[0].value" }, "message": "Unsupported fields are present", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows the INVALID_DATA error returned when the connection_name in the authentication configuration does not exist or is invalid.", "summary": "Connection name is invalid or does not exist", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "connection_name", "json_path": "$.webhooks[0].authentication.connetion_name" }, "message": "Please provide valid connection name", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook request.", "summary": "Field value has an incorrect data type", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "headers", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].headers" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified webhook field.", "summary": "Field value is invalid", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "headers", "json_path": "$.webhooks[*].headers", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type for the webhook update.", "summary": "Field value has an incorrect data type", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.module_parameters[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for a webhook configuration field.", "summary": "Field value is not valid for webhook configuration", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].headers.module_parameters[*].name", "maximum_length": 10 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook configuration.", "summary": "Field value has an incorrect data type in webhook configuration", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.module_parameters[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows the INVALID_DATA error returned when a field value fails validation in the webhook configuration.", "summary": "Field value fails validation in webhook configuration", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[*].headers.module_parameters[*].value", "maximum_length": 15 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for its schema type in the webhook configuration.", "summary": "Field value is not valid for its schema type", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.custom_parameters[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Shows the INVALID_DATA error returned when a field value fails schema validation in the webhook update request.", "summary": "Field value fails schema validation", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].headers.custom_parameters[*].name", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows the INVALID_DATA error returned when the webhook name contains invalid or unsupported characters.", "summary": "Webhook name contains invalid characters", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name" }, "message": "Special characters not allowed", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook schema.", "summary": "Field value has an incorrect data type in webhook schema", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.webhooks[*].headers.custom_parameters[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified field type.", "summary": "Field value is not valid for the specified field type", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.webhooks[*].headers.custom_parameters[*].value", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Shows the INVALID_DATA error returned when a field value fails validation for the specified field type in the webhook update request.", "summary": "Field value has an incorrect data type", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Shows the INVALID_DATA error returned when a field value fails validation in the webhook update request.", "summary": "Field value fails validation", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.webhooks[*].module", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type for the webhook configuration.", "summary": "Field value has an incorrect data type for webhook configuration", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.webhooks[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified field type.", "summary": "Field value is not valid for the specified field type", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.webhooks[*].description", "maximum_length": 250 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type for a webhook configuration property.", "summary": "Field value has an incorrect data type for a webhook property", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "body", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].body" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "Shows the INVALID_DATA error returned when a field value fails validation for a webhook configuration property.", "summary": "Field value fails validation for a webhook property", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "body", "json_path": "$.webhooks[*].body", "maximum_length": 3 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse28": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in a webhook configuration.", "summary": "Field value has an incorrect data type in webhook configuration", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "expected_data_type": "website", "json_path": "$.webhooks[*].url" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse29": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for a webhook configuration property.", "summary": "Field value is not valid for a webhook configuration property", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[*].url", "maximum_length": 57 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows the INVALID_DATA error returned when the webhook name exceeds the maximum allowed character length.", "summary": "Webhook name exceeds maximum allowed length", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[0].name", "maximum_length": 250 }, "message": "The lenght of name has exceeded the limit", "status": "error" } ] } }, "InvalidDataResponse30": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in the webhook update request body.", "summary": "Field value has an incorrect data type in request body", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "expected_data_type": "text", "json_path": "$.webhooks[*].feature_type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse31": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified field in the webhook update request.", "summary": "Field value is not valid in webhook update request", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.webhooks[*].feature_type", "maximum_length": 20 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse32": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type for the webhook update request.", "summary": "Field value has an incorrect data type for webhook update", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "expected_data_type": "text", "json_path": "$.webhooks[*].http_method" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse33": { "description": "Shows the INVALID_DATA error returned when a field value is not valid in the webhook update request body.", "summary": "Field value is not valid in request body", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "json_path": "$.webhooks[*].http_method", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse34": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type in a webhook property.", "summary": "Field value has an incorrect data type in a webhook property", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.webhooks[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse35": { "description": "Shows the INVALID_DATA error returned when a field value fails validation for the specified webhook property.", "summary": "Field value fails validation for the specified webhook property", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.webhooks[*].name", "maximum_length": 11 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse36": { "description": "Shows the INVALID_DATA error returned when a field value has an incorrect data type for the specified webhook property.", "summary": "Field value has an incorrect data type for the specified webhook property", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "authentication", "expected_data_type": "jsonobject", "json_path": "$.webhooks[*].authentication" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse37": { "description": "Shows the INVALID_DATA error returned when a field value is not valid for the specified webhook property.", "summary": "Field value is not valid for the specified webhook property", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "authentication", "json_path": "$.webhooks[*].authentication", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows the INVALID_DATA error returned when the http_method value in the request body is not a supported HTTP method.", "summary": "HTTP method is not supported", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "http_method", "json_path": "$.webhooks[0].http_method" }, "message": "The method type given is invalid", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows the INVALID_DATA error returned when the url field value is not a valid URL.", "summary": "Webhook URL is not valid", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "url", "json_path": "$.webhooks[0].url" }, "message": "please enter a valid URL", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows the INVALID_DATA error returned when the date_format value in date_time_format is invalid.", "summary": "Date format is invalid", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "date_format", "json_path": "$.webhooks[0].date_time_format.date_format" }, "message": "The Date given is invalid", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows the INVALID_DATA error returned when the time_zone value in date_time_format is not a supported timezone identifier.", "summary": "Timezone identifier is not supported", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "time_zone", "json_path": "$.webhooks[0].date_time_format.time_zone" }, "message": "The timezone given is invalid", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows the INVALID_DATA error returned when the datetime_format value in date_time_format is invalid.", "summary": "DateTime format is invalid", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "datetime_format", "json_path": "$.webhooks[0].date_time_format.datetime_format" }, "message": "The date time format given is invalid", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows the INVALID_DATA error returned when the webhook ID in the request body does not match an existing webhook.", "summary": "Webhook ID in request body is invalid", "value": { "webhooks": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.webhooks[0].id" }, "message": "The ID given is invalid", "status": "error" } ] } }, "InvalidWebhookIdPathResponse1": { "description": "Shows the INVALID_DATA error returned when the webhook ID in the URL path does not match an existing webhook.", "summary": "Webhook ID in URL path is invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a parameter entry is missing its name or value.", "summary": "Parameter entry missing name or value", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "value", "json_path": "$.webhooks[0].headers.custom_parameters[0].value" }, "message": "the given parameter is invalid, specify both name and value", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a parameter entry in the webhook request is missing its name or value.", "summary": "Parameter entry missing name or value in webhook request.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.webhooks[0].headers.module_parameters[0].name" }, "message": "the given parameter is invalid, specify both name and value", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows the MANDATORY_NOT_FOUND error returned when the http_method field is absent from the webhook request body.", "summary": "HTTP method field is missing from request body", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "http_method", "json_path": "$.webhooks[0].http_method" }, "message": "The method type is not given ", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required webhook configuration field is absent from the request body.", "summary": "Required webhook configuration field is missing", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.webhooks[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field is absent from the webhook update request body.", "summary": "Required field is absent from request body", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "url", "json_path": "$.webhooks[*].url" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field is missing from the webhook update request.", "summary": "Required field missing from webhook update request.", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "feature_type", "json_path": "$.webhooks[*].feature_type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field is absent from the webhook update request body.", "summary": "Required field absent from webhook update", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "http_method", "json_path": "$.webhooks[*].http_method" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field is missing from the webhook configuration in the request body.", "summary": "Required webhook configuration field is missing", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.webhooks[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field is absent from the webhook request body.", "summary": "Required field absent from webhook request", "value": { "webhooks": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "authentication", "json_path": "$.webhooks[*].authentication" }, "message": "Required field is missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "Shows the NOT_ALLOWED error returned when a request attempts to update a read-only webhook created by a Marketplace extension.", "summary": "Editing a read-only webhook is not allowed", "value": { "webhooks": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.webhooks[0].id" }, "message": "Insufficient privileges to edit Read only webhook", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "Shows the NOT_ALLOWED error returned when a request attempts to modify a webhook created by a Marketplace extension.", "summary": "Webhook associated with a Marketplace extension cannot be modified", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "Webhook is associated with MarketPlace", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the wrapped error response for most field-level validation failures, where the **webhooks** key contains an array of error objects for the invalid webhook.", "properties": { "webhooks": { "description": "Represents the list of error objects for the invalid webhook in the update-by-ID request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidModuleIdError" }, { "$ref": "#/components/schemas/AmbiguityProcessingErrorResponse" }, { "$ref": "#/components/schemas/InvalidNameErrorResponse" }, { "$ref": "#/components/schemas/NameLimitExceededErrorResponse" }, { "$ref": "#/components/schemas/InvalidMethodTypeErrorResponse" }, { "$ref": "#/components/schemas/InvalidUrlErrorResponse" }, { "$ref": "#/components/schemas/InvalidDateFormatErrorResponse" }, { "$ref": "#/components/schemas/InvalidTimezoneErrorResponse" }, { "$ref": "#/components/schemas/InvalidDateTimeFormatErrorResponse" }, { "$ref": "#/components/schemas/InvalidWebhookIdError" }, { "$ref": "#/components/schemas/UnsupportedMergeFieldErrorResponse" }, { "$ref": "#/components/schemas/DuplicateDataErrorResponse" }, { "$ref": "#/components/schemas/AuthorizationDependentMismatchError" }, { "$ref": "#/components/schemas/ParameterNameValueMandatoryError" }, { "$ref": "#/components/schemas/HttpMethodMandatoryError" }, { "$ref": "#/components/schemas/InvalidConnectionNameError" }, { "$ref": "#/components/schemas/HttpMethodDependentMismatchError" }, { "$ref": "#/components/schemas/ReadOnlyWebhookNotAllowedError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataTypeError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataMaxLengthError" }, { "$ref": "#/components/schemas/WebhooksMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/ModuleChangeNotAllowedError" }, { "$ref": "#/components/schemas/KioskNameChangeNotAllowedError" }, { "$ref": "#/components/schemas/InvalidFormDataContentError" }, { "$ref": "#/components/schemas/InvalidBodyFormatError" }, { "$ref": "#/components/schemas/WebhooksInvalidDataSupportedValuesError" }, { "$ref": "#/components/schemas/InvalidBodyTypeError" }, { "$ref": "#/components/schemas/InvalidFeatureTypeError" }, { "$ref": "#/components/schemas/WebhooksExpectedFieldMissingError" }, { "$ref": "#/components/schemas/WebhooksDependentFieldMissingError" }, { "$ref": "#/components/schemas/EmptyUrlError" }, { "$ref": "#/components/schemas/SsrfUrlError" }, { "$ref": "#/components/schemas/WebhooksLimitExceededError" }, { "$ref": "#/components/schemas/NotAllowedErrorResponse" } ], "description": "Represents an individual webhook validation error returned by the update-by-ID request, identifying which field failed and providing the associated error code and message." }, "maxItems": 25, "type": "array" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksByIdInvalidRequestBodyError" }, { "$ref": "#/components/schemas/MarketplaceWebhookNotAllowedError" }, { "additionalProperties": false, "description": "Represents the error response when a required field is absent from the request body. The **webhooks** key contains the Mandatory Field Missing Error object directly.", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksMandatoryFieldMissingError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksByIdMandatoryFieldMissingWrappedError" }, { "additionalProperties": false, "description": "Represents the error response when a field value exceeds the maximum allowed character length. ", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataTypeError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksByIdInvalidDataTypeWrappedError" }, { "additionalProperties": false, "description": "Represents the error response when a field value has an incorrect data type. ", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataMaxLengthError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksByIdInvalidDataMaxLengthWrappedError" }, { "additionalProperties": false, "description": "Represents the error response when a field value is not among the accepted values for that field. ", "properties": { "webhooks": { "$ref": "#/components/schemas/WebhooksInvalidDataSupportedValuesError" } }, "required": [ "webhooks" ], "type": "object", "x-zs-$id": "PutWebhooksByIdInvalidDataSupportedValuesWrappedError" }, { "$ref": "#/components/schemas/InvalidWebhookIdPathError" } ], "description": "Contains the error response for an invalid webhook update-by-ID request.\n\nThe schema is a union of error variants covering field-level validation, module change restrictions, read-only webhook violations, data type errors, length violations, and supported value violations.", "x-zs-$id": "PutWebhooksByIdInvalidDataErrorResponseSchema" } } }, "description": "One or more request body fields are invalid. Returned for validation errors including invalid webhook ID, module change attempt, read-only webhook, unsupported HTTP method, malformed URL, and data type or length violations.\n\n**Resolution:** All required fields must be present and valid. The module field cannot be changed after webhook creation. Read-only webhooks created by extensions cannot be updated." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows the NO_PERMISSION error returned when the requesting user does not have the Manage Workflow CRM profile permission to update webhooks.", "summary": "User lacks Manage Workflow permission to update webhooks", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WebhooksNoPermissionErrorResponse", "x-zs-$id": "PutWebhooksByIdNoPermissionErrorResponseSchema" } } }, "description": "Permission denied to update webhooks in this Zoho CRM organization.\n\n**Resolution:** The CRM administrator must grant the Manage Workflow permission to the user profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.automation_actions.UPDATE" ] } ], "summary": "Update webhook by ID", "tags": [ "webhooks" ], "x-zoho-document": "webhooks", "x-zs-llm-description": "Replaces the configuration of an existing webhook identified by its path parameter ID. Before calling: (1) `getWebhookById` to read the current structure; (2) `getModules` to verify valid module api_names. Full-replacement semantics every field you want to retain must be present, omitted fields reset to defaults or null. Module and kiosk names are locked after creation; read-only or marketplace/extension webhooks return NOT_ALLOWED.", "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "/crm/v8/settings/automation/workflow_rules": { "delete": { "description": "To delete one or more workflow rules from your Zoho CRM organization. You can delete up to ten workflow rules in a single API call; when some deletions succeed and others fail, the API responds with a 207 Multi-Status.\n", "operationId": "deleteWorkflowRules", "parameters": [ { "$ref": "#/components/parameters/ParamQueryIdsSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "DELETE- Success response for status 200", "value": { "workflow_rules": [ { "code": "SUCCESS", "details": { "id": "3361265000006461011" }, "message": "WorkFlow Rule deleted successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "3361265000006492426" }, "message": "WorkFlow Rule deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowSuccessSchema" } } }, "description": "Workflow Rule deleted successfully" }, "207": { "content": { "application/json": { "examples": { "MultiStatusErrorRespose": { "summary": "MultiStatus response for status 207", "value": { "workflow_rules": [ { "code": "SUCCESS", "details": { "id": "3361265000006492443" }, "message": "WorkFlow Rule deleted successfully", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "3361265000006492444" }, "message": "the id given seems to be invalid", "status": "error" }, { "code": "NOT_ALLOWED", "details": { "id": "3361265000006492445" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped error response with workflow_rules", "properties": { "workflow_rules": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema" }, { "$ref": "#/components/schemas/SuccessResponseNestedSchema" } ] }, "maxItems": 10, "type": "array" } }, "required": [ "workflow_rules" ], "type": "object", "x-zs-$id": "WorkflowRuleDeleteMultiStatusErrorResponse" } } }, "description": "Multi-status response returned when a bulk deletion request contains a mix of successful and failed deletions. Each entry indicates whether the corresponding workflow rule was deleted successfully or returned an error\n" }, "400": { "content": { "application/json": { "examples": { "ActionLimitExceededResponse": { "summary": "Error response with code INVALID_DATA", "value": { "code": "INVALID_DATA", "details": { "maximum_length": 10, "param_name": "ids" }, "message": "Ids maximum length exceeded", "status": "error" } }, "MultipleErrorResponse": { "summary": "Error response with code multiple INVALID_DATA", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "id": "3361265000006492443" }, "message": "the id given seems to be invalid", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "3361265000006492444" }, "message": "the id given seems to be invalid", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "3361265000006492445" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "RequiredParamMissingErrorResponse": { "summary": "Error response with code REQUIRED_PARAM_MISSING", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema" }, { "additionalProperties": false, "description": "Wrapped error response with workflow_rules", "properties": { "workflow_rules": { "description": "Array of error objects", "items": { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema" }, "maxItems": 10, "type": "array" } }, "required": [ "workflow_rules" ], "type": "object", "x-zs-$id": "WorkflowRuleDeleteErrorResponse" } ], "x-zs-$id": "WorkflowRuleDeleteErrorResponses" } } }, "description": "The response returned when the deletion request is invalid, such as a malformed or missing rule ID. Resolution: verify the rule IDs in the request and resubmit." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "summary": "Error response for status 403", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Forbidden. The authenticated user does not have permission to perform this operation, or the workflow rules feature is not available in the current CRM edition. Resolution: verify the user's permissions and the organization's edition capabilities.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.DELETE" ] } ], "summary": "Delete One or More Workflow Rules", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Bulk-deletes workflow rules by IDs (comma-separated in ids query param, max 10). Locked rules cannot be deleted. Returns per-rule success/error status. Use getWorkflowRules first to discover rule IDs." }, "get": { "description": "To retrieve the list of workflow rules configured in your Zoho CRM organization, including their trigger conditions, module associations, and action configurations. By default, each rule includes only summary-level data; set the `include_inner_details` parameter to `true` to include full condition criteria and action configurations in the response. Results are paginated and can be filtered by module, activation status, trigger type, or rule name.\n", "operationId": "getWorkflowRules", "parameters": [ { "$ref": "#/components/parameters/ParamQueryPageSchema" }, { "$ref": "#/components/parameters/ParamQueryPerPageSchema" }, { "$ref": "#/components/parameters/WorkflowRulesParamQueryModuleSchema" }, { "$ref": "#/components/parameters/ParamQueryStatusActiveSchema" }, { "$ref": "#/components/parameters/ParamQueryExecuteOnSchema" }, { "$ref": "#/components/parameters/ParamQuerySortOrderSchema" }, { "$ref": "#/components/parameters/ParamQuerySortBySchema" }, { "$ref": "#/components/parameters/ParamQueryIncludeInnerDetailsSchema" }, { "$ref": "#/components/parameters/ParamQueryFilterSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetAllResponses": { "description": "Contains a list of workflow rule records, each including the rule name, associated module, trigger configuration, status, and audit metadata. The info object provides pagination details for the result set.", "summary": "Successful retrieval of the workflow rules list", "value": { "info": { "count": 2, "more_records": false, "page": 1, "per_page": 200 }, "workflow_rules": [ { "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-12-03T01:30:24-08:00", "deletable": true, "description": null, "editable": true, "execute_when": { "details": { "trigger_module": { "api_name": "Leads", "id": "3361265000000000125" } }, "type": "create" }, "id": "3361265000006526160", "last_executed_time": null, "lock": { "locked_by": null, "message": null, "status": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-12-03T01:30:24-08:00", "module": { "api_name": "Leads", "id": "3361265000000000125" }, "name": "GetFieldUpdate", "source": "crm", "status": { "active": true } }, { "created_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "created_time": "2025-12-03T01:41:35-08:00", "deletable": true, "description": null, "editable": true, "execute_when": { "details": { "trigger_module": { "api_name": "Leads", "id": "3361265000000000125" } }, "type": "create" }, "id": "3361265000006526223", "last_executed_time": null, "lock": { "locked_by": null, "message": null, "status": false }, "modified_by": { "id": "3361265000000535001", "name": "B Indumathi" }, "modified_time": "2025-12-03T01:48:01-08:00", "module": { "api_name": "Leads", "id": "3361265000000000125" }, "name": "ConvertGetWF", "source": "crm", "status": { "active": false } } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowRulesGetResponseSchema" } } }, "description": "Returns a paginated list of workflow rules defined in the Zoho CRM organization." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse": { "description": "Returned when an invalid value is supplied for the module parameter. The response identifies the offending parameter in the details object and the module API name must be a valid CRM module identifier.", "summary": "INVALID_MODULE error for an unrecognized module parameter value", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "InvalidParamResponse": { "description": "Returned when an invalid value is supplied for a request parameter, in this case sort_order. The details object within the response identifies the specific parameter that failed validation.", "summary": "INVALID_DATA error for an invalid sort_order parameter value", "value": { "code": "INVALID_DATA", "details": { "param_name": "sort_order" }, "message": "The value provided to the param is Invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema", "x-zs-$id": "WorkflowRuleGetAllErrorResponses" } } }, "description": "The request contains an invalid parameter value.\n**Resolution:** The module API name and all other parameter values must be valid; the details object identifies the offending parameter." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returned when the workflow rules feature is not available in the current Zoho CRM edition. The CRM account must be upgraded to an edition that includes the workflow rules feature.", "summary": "NO_PERMISSION error when workflow rules are unavailable in the current edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "The workflow rules feature is not available in the current CRM edition.\n**Resolution:** The CRM account must be upgraded to a Zoho CRM edition that includes the workflow rules feature." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.READ" ] } ], "summary": "List Workflow Rules in your Zoho CRM Organization\n", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Lists workflow rules with optional filters: module (api_name), status_active (bool), execute_on (trigger type). Set include_inner_details=true to get full conditions, criteria, and action configurations without it only summary metadata is returned. Paginated: page + per_page (max 200). Use this to discover rule IDs before PUT/DELETE operations." }, "post": { "description": "To create a workflow rule for a specified module in your Zoho CRM organization. Each request accepts exactly one rule, defined within the workflow_rules array.", "operationId": "postWorkflowRule", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "workflow_rules": [ { "conditions": [ { "criteria_details": { "criteria": { "group": [ { "comparator": "equal", "field": { "api_name": "Annual_Revenue", "id": "3361265000000000555" }, "value": "${NOTEMPTY}" }, { "comparator": "equal", "field": { "api_name": "Phone", "id": "3361265000000000557" }, "value": "${NOTEMPTY}" } ], "group_operator": "AND" } }, "instant_actions": { "actions": [ { "details": { "apply_restriction": true, "field_mappings": [ { "field": { "api_name": "Owner", "id": "3361265000000000515" }, "type": "static", "value": { "id": "3361265000002134004", "name": "user2 testUser" } }, { "field": { "api_name": "Deal_Name", "id": "3361265000000000519" }, "type": "static", "value": "CreateRecord-POST" }, { "field": { "api_name": "Closing_Date", "id": "3361265000000000521" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "2" } }, { "field": { "api_name": "Pipeline", "id": "3361265000000236001" }, "type": "static", "value": "Test" }, { "field": { "api_name": "Stage", "id": "3361265000000000525" }, "type": "static", "value": "Qualification" } ], "layout": { "id": "3361265000000095023", "name": "Standard" }, "module": { "api_name": "Deals", "id": "3361265000000000131" } }, "name": "CreateRecord-POST", "type": "create_record" }, { "details": { "field_mappings": [ { "field": { "api_name": "Event_Title", "id": "3361265000000000249" }, "type": "static", "value": "AddMeeting-POST" }, { "field": { "api_name": "Start_DateTime", "id": "3361265000000101001" }, "type": "execution_time", "value": { "period": "minutes", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "2" } }, { "field": { "api_name": "All_day", "id": "3361265000000057003" }, "type": "static", "value": "true" }, { "field": { "api_name": "Owner", "id": "3361265000000000247" }, "type": "static", "value": { "id": "3361265000002134004", "name": "user2 testUser" } } ], "host_unavailable": { "assign_record_owner_as_host": true }, "layout": { "id": "3361265000000095045", "name": "Standard" }, "meeting_duration": { "period": "minutes", "unit": 2 }, "module": { "api_name": "Events", "id": "3361265000000000145" } }, "name": "AddMeeting-POST", "type": "add_meeting" }, { "details": { "field_mappings": [ { "field": { "api_name": "Call_Type", "id": "3361265000000017021" }, "type": "static", "value": "Outbound" }, { "field": { "api_name": "Outgoing_Call_Status", "id": "3361265000000245003" }, "type": "static", "value": "Scheduled" }, { "field": { "api_name": "Call_Start_Time", "id": "3361265000000017029" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "2" } }, { "field": { "api_name": "Owner", "id": "3361265000000017017" }, "type": "static", "value": { "id": "3361265000002134004", "name": "user2 testUser" } }, { "field": { "api_name": "Call_Purpose", "id": "3361265000000017023" }, "type": "static", "value": "Demo" }, { "field": { "api_name": "Call_Agenda", "id": "3361265000000536391" }, "type": "static", "value": "Demo" } ], "layout": { "id": "3361265000000095033", "name": "Standard" }, "module": { "api_name": "Calls", "id": "3361265000000017015" } }, "name": "ScheduleCall-POST", "type": "schedule_call" }, { "details": { "module": { "api_name": "Contacts", "id": "3361265000000000129" }, "over_write": false, "tags": [ { "color_code": "#879BFC", "id": "3361265000001715141", "name": "criteria" } ] }, "name": "criteria", "type": "add_tags" }, { "details": { "module": { "api_name": "Contacts", "id": "3361265000000000129" }, "tags": [ { "color_code": "#879BFC", "id": "3361265000001715141", "name": "criteria" } ] }, "name": "criteria", "type": "remove_tags" }, { "details": { "add_to_existing_account": true, "add_to_existing_contact": false, "carry_tags": [ { "api_name": "Contacts", "id": "3361265000000000129" }, { "api_name": "Accounts", "id": "3361265000000000127" }, { "api_name": "Deals", "id": "3361265000000000131" } ], "change_owner": { "apply_assignment_threshold": false, "id": "4554012000000623001" }, "contact_role": "3361265000000000052", "create_deal": true, "field_mappings": [ { "field": { "api_name": "Deal_Name", "id": "3361265000000000519" }, "type": "static", "value": "CreatedViaConvert" }, { "field": { "api_name": "Closing_Date", "id": "3361265000000000521" }, "type": "execution_time", "value": { "period": "days", "sign": "plus", "trigger_field": "${CURRENTTIME}", "unit": "2" } }, { "field": { "api_name": "Stage", "id": "3361265000000000525" }, "type": "static", "value": "Qualification" }, { "field": { "api_name": "Pipeline", "id": "3361265000000236001" }, "type": "static", "value": "Standard (Standard)" } ], "move_attachment_to": { "api_name": "Contacts", "id": "3361265000000000129" } }, "name": "Create Contact, Account and Deal", "type": "convert" } ] }, "scheduled_actions": [ { "actions": [ { "id": "3361265000006458562", "name": "EmailNotification", "related_details": { "best_time": true }, "type": "email_notifications" }, { "details": { "apply_assignment_threshold": true, "assign_to": [ { "resource": { "id": "3361265000002134004", "name": "user2 testUser" }, "type": "user" }, { "allow_agent_user": true, "resource": { "id": "3361265000000015969", "name": "Manager" }, "type": "role" }, { "resource": { "id": "3361265000002284248", "name": "APGroup" }, "type": "group" }, { "associated_to": "team_profile", "resource": { "id": "3361265000001212003", "name": "Managers" }, "type": "profile" } ], "lookup_field": { "api_name": "Vendor_Name", "id": "3361265000000000447" }, "module": { "api_name": "Vendors", "id": "3361265000000000165" }, "notify": true, "related_records": [ { "api_name": "Events" }, { "api_name": "Calls" } ], "user_availability_based_on": [ "online_status" ] }, "name": "To users : user2 testUser", "related_details": { "lookup_field": { "api_name": "Vendor_Name", "id": "3361265000000000447" } }, "type": "assign_owner" }, { "id": "3361265000004189028", "name": "test", "type": "tasks" }, { "id": "3361265000006477034", "name": "Test", "type": "webhooks" }, { "id": "3361265000006131248", "name": "Function", "type": "functions" }, { "id": "3361265000006526009", "name": "FieldUpdate", "related_details": { "lookup_field": { "api_name": "Vendor_Name", "id": "3361265000000000447" } }, "type": "field_updates" } ], "execute_after": { "period": "minutes", "unit": 2 } } ], "sequence_number": 1 } ], "description": null, "execute_when": { "details": { "trigger_module": { "api_name": "Contacts", "id": "3361265000000000129" } }, "type": "create" }, "module": { "api_name": "Contacts", "id": "3361265000000000129" }, "name": "WORKFLOWRULE-POST" } ] } } }, "schema": { "$ref": "#/components/schemas/PostWorkflowRuleSchema" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "Workflow rule configuration payload." }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "POST- Success response for status 201", "value": { "workflow_rules": [ { "code": "SUCCESS", "details": { "id": "3361265000006294001" }, "message": "workflow created", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowSuccessSchema" } } }, "description": "Workflow Rule created successfully" }, "400": { "content": { "application/json": { "examples": { "ActionLimitExceededResponse": { "summary": "Error response with code LIMIT_EXCEEDED: per-type action limit exceeded in instant/scheduled actions", "value": { "workflow_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "actions", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions", "limit": 5 }, "message": "actions limit exceeded", "status": "error" } ] } }, "ActionNotSupportedForModuleResponse": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: action type not supported for module, or action's bound module does not match relational_criteria.module", "value": { "workflow_rules": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "module", "json_path": "$.workflow_rules[*].module" }, { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].type" } ] }, "message": "action not supported for this module", "status": "error" } ] } }, "ActionTypeMissingResponse": { "summary": "Error response with code INVALID_DATA: action type is required", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].type" }, "message": "invalid data", "status": "error" } ] } }, "ActionVsTriggerADPResponse1": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: action not supported for this trigger", "value": { "workflow_rules": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "type", "json_path": "$.workflow_rules[0].execute_when.type" }, { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].type" } ] }, "message": "action not supported for this trigger", "status": "error" } ] } }, "AssociateActionDependentFieldMissingResponse": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Missing Associated Action Id", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].type" }, "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].id" }, "message": "Dependent Field missing", "status": "error" } ] } }, "CannotCreateInactiveResponse": { "summary": "Error response with code INVALID_DATA: cannot create an inactive workflow rule", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "json_path": "$.workflow_rules[*].status.active" }, "message": "invalid data", "status": "error" } ] } }, "ChatNotificationFieldAmbiguityResponse": { "summary": "Error response: AMBIGUITY_DUE_TO - notify_to field id and api_name mismatch", "value": { "workflow_rules": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.notify_to.notify_fields.fields[0].id" }, { "api_name": "api_name", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.notify_to.notify_fields.fields[0].api_name" } ] }, "message": "Ambiguity during processing", "status": "error" } ] } }, "ChatNotificationInvalidTypeResponse": { "summary": "Error response: INVALID_DATA - invalid notify_to type for chat notification", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.notify_to.type" }, "message": "invalid data", "status": "error" } ] } }, "ChatNotificationMessageMissingResponse": { "summary": "Error response: MANDATORY_NOT_FOUND - chat notification message missing", "value": { "workflow_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "message", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.message" }, "message": "Required field is missing", "status": "error" } ] } }, "ChatNotificationNotifyToMissingResponse": { "summary": "Error response: DEPENDENT_FIELD_MISSING - notify_to id/name missing for user/channel type", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.notify_to.id" }, "message": "Required dependent field is missing", "status": "error" } ] } }, "CircuitsDetailsMissingResponse": { "summary": "Error response: MANDATORY_NOT_FOUND - circuits details or circuit_id missing", "value": { "workflow_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "details", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details" }, "message": "Required field is missing", "status": "error" } ] } }, "ConditionsLimitExceededResponse": { "summary": "Error response with code LIMIT_EXCEEDED: conditions count exceeds edition limit", "value": { "workflow_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "conditions", "json_path": "$.workflow_rules[*].conditions", "limit": 3 }, "message": "conditions limit exceeded", "status": "error" } ] } }, "ConnectedRecordModuleInvalidResponse": { "summary": "Error response: INVALID_DATA - create_connected_record module is not a valid child module", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.module" }, "message": "invalid data", "status": "error" } ] } }, "ConvertDependentFieldMissingResponse": { "summary": "Error response: DEPENDENT_FIELD_MISSING - convert action missing mandatory fields for Leads", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "add_to_existing_contact", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.add_to_existing_contact" }, "message": "Required dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse1": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: details)", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "dependee": { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].type" }, "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DependentMismatchResponse": { "summary": "Error response with code DEPENDENT_MISMATCH: Dependent Field is not matching (Field: module)", "value": { "workflow_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "module", "dependee": { "api_name": "module_selection", "json_path": "$.workflow_rules[0].conditions[0].criteria_details.relational_criteria.module_selection" }, "json_path": "$.workflow_rules[0].conditions[0].criteria_details.relational_criteria.module" }, "message": "Dependent Field is not matching", "status": "error" } ] } }, "EmailCreateRecordModuleInvalidResponse": { "summary": "Error response: INVALID_DATA - create_record_email module must be Leads or Contacts", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.module" }, "message": "invalid data", "status": "error" } ] } }, "EmailCreateRecordTooManyMappingsResponse": { "summary": "Error response: LIMIT_EXCEEDED - create_record_email allows exactly 1 field_mapping", "value": { "workflow_rules": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "field_mappings", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.field_mappings", "limit": 1 }, "message": "too many records", "status": "error" } ] } }, "ExecuteWhenMissingResponse": { "summary": "Error response with code MANDATORY_NOT_FOUND: execute_when is required", "value": { "workflow_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "execute_when", "json_path": "$.workflow_rules[*].execute_when" }, "message": "Required field is missing", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "summary": "Error response with code EXPECTED_FIELD_MISSING: Specify atleast one field", "value": { "workflow_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.module.api_name" }, { "api_name": "id", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.module.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "FailureResponse": { "summary": "Error response with code FAILURE: unexpected server-side error", "value": { "workflow_rules": [ { "code": "FAILURE", "details": {}, "message": "Unable to process your request. Please verify whether you have provided valid data.", "status": "error" } ] } }, "FeatureDisabledResponse": { "summary": "Error response with code FEATURE_DISABLED: a dependent feature is disabled", "value": { "workflow_rules": [ { "code": "FEATURE_DISABLED", "details": {}, "message": "Please enable the feature", "status": "error" } ] } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: workflow_rules)", "value": { "code": "INVALID_DATA", "details": { "api_name": "workflow_rules", "json_path": "$.workflow_rules" }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.workflow_rules[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.workflow_rules[*].execute_when.type", "supported_values": [ "create", "edit", "create_or_edit", "delete", "field_update", "rollup_summary_update", "section_update", "date_or_datetime", "score_increase", "score_update", "score_decrease", "recommendation", "field_update", "score_increase", "score_decrease", "score_update", "scheduled_call_field_update", "scheduled_call_section_update", "scheduled_call_edit", "scheduled_call_createedit", "outgoing_call_ring", "outgoing_call_start", "outgoing_call_section_update", "outgoing_call_createedit", "outgoing_call_field_update", "outgoing_call_edit", "incoming_call_ring", "incoming_call_start", "incoming_call_edit", "incoming_call_field_update", "incoming_call_createedit", "incoming_call_section_update", "anyaction", "delete", "missed_call", "create", "reschedule", "cancel", "reassign", "delete", "overdue", "marked_as_complete", "anyaction", "email_received", "mail_sent", "mail_sent_clicked", "mail_sent_replied", "mail_sent_opened", "mail_sent_bounced", "email_received_notreplied", "email_received_opened_notreplied", "mail_sent_replied_within", "mail_sent_opened_notreplied", "mail_sent_notreplied", "mail_sent_notopened", "fb_post_on_page", "fb_comment_on_page", "fb_like_on_post", "fb_send_message", "tw_mention_on", "tw_retweet_on_tweet", "tw_comment_on_tweet", "tw_send_message" ] }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "workflow_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.workflow_rules[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MeetingAmbiguityErrorResponse": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity during processing (Field: meeting_duration)", "value": { "workflow_rules": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "meeting_duration", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.meeting_duration" }, { "api_name": "field_mappings", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.field_mappings" } ] }, "message": "As All Day is passed true, meeting_duration cannot be configured", "status": "error" } ] } }, "MeetingCallInvalidDataResponse": { "summary": "Error response with code INVALID_DATA: Invalid Owner Id)", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.field_mappings[3].id" }, "message": "Invalid User ID", "status": "error" } ] } }, "MeetingExpectedFieldMissingResponse": { "summary": "Error response with code EXPECTED_FIELD_MISSING: Specify atleast one field", "value": { "workflow_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "assign_record_owner_as_host", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.host_unavailable.assign_record_owner_as_host" }, { "api_name": "assign_task", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.host_unavailable.assign_task" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "ModuleInvalidDataResponse": { "summary": "Error response with code INVALID_DATA: invalid module api_name or id", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.workflow_rules[*].module" }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "ModuleMandatoryNotFoundResponse": { "summary": "Error response with code MANDATORY_NOT_FOUND: module is required", "value": { "workflow_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.workflow_rules[*].module" }, "message": "Required field is missing", "status": "error" } ] } }, "NameLengthExceededResponse": { "summary": "Error response with code INVALID_DATA: workflow name exceeds max length", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.workflow_rules[*].name", "maximum_length": 100 }, "message": "value too long", "status": "error" } ] } }, "NameSpecialCharsResponse": { "summary": "Error response with code INVALID_DATA: workflow name contains special characters", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.workflow_rules[*].name" }, "message": "Special characters found", "status": "error" } ] } }, "NotAllowedErrorResponse": { "summary": "Error response with code NOT_ALLOWED: The unsupported action is given", "value": { "workflow_rules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].scheduled_actions[0].actions[0].type" }, "message": "The unsupported action is given", "status": "error" } ] } }, "RelCriteriaModuleSelectionMissingResponse": { "summary": "Error response with code MANDATORY_NOT_FOUND: module_selection missing for relational_criteria", "value": { "workflow_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module_selection", "json_path": "$.workflow_rules[0].conditions[0].criteria_details.relational_criteria.module_selection" }, "message": "Required field is missing", "status": "error" } ] } }, "ScheduledActionsDependentFieldMissingResponse": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: unit/period is missing", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "unit", "dependee": { "api_name": "execute_after", "json_path": "$.workflow_rules[0].conditions[0].scheduled_actions[0].execute_after" }, "json_path": "$.workflow_rules[0].conditions[0].scheduled_actions[0].execute_after.unit" }, "message": "Dependent Field missing", "status": "error" } ] } }, "ScheduledActionsExpectedFieldMissingResponse": { "summary": "Error response with code EXPECTED_FIELD_MISSING: Specify atleast one field", "value": { "workflow_rules": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "period", "json_path": "$.workflow_rules[0].conditions[0].scheduled_actions[0].execute_after.period" }, { "api_name": "unit", "json_path": "$.workflow_rules[0].conditions[0].scheduled_actions[0].execute_after.unit" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "ScheduledActionsRepeatConflictResponse": { "summary": "Error response with code DEPENDENT_MISMATCH: scheduled_actions not supported with repeat=true", "value": { "workflow_rules": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "scheduled_actions", "dependee": { "api_name": "repeat", "json_path": "$.workflow_rules[0].execute_when.details.repeat" }, "json_path": "$.workflow_rules[0].conditions[0].scheduled_actions" }, "message": "Dependent Field is not matching", "status": "error" } ] } }, "SocialActionDetailsMissingResponse": { "summary": "Error response: DEPENDENT_FIELD_MISSING - social action details/content missing", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "details", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details" }, "message": "Required dependent field is missing", "status": "error" } ] } }, "TagAmbiguityResponse": { "summary": "Error response: AMBIGUITY_DUE_TO - tag name and id resolve to different tags", "value": { "workflow_rules": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "name", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.tags[0].name" }, { "api_name": "id", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.tags[0].id" } ] }, "message": "Ambiguity during processing", "status": "error" } ] } }, "TagEmptyResponse": { "summary": "Error response: INVALID_DATA - tags array is empty", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "tags", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.tags" }, "message": "Tags array cannot be empty", "status": "error" } ] } }, "TagInvalidResponse": { "summary": "Error response: INVALID_DATA - tag name/id does not exist for the module", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "tags", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0].details.tags[0]" }, "message": "invalid data", "status": "error" } ] } }, "TriggerDependentFieldMissingResponse1": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: repeat)", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "repeat", "dependee": { "api_name": "type", "json_path": "$.workflow_rules[0].execute_when.type" }, "json_path": "$.workflow_rules[0].execute_when.details.repeat" }, "message": "Dependent Field missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response with workflow_rules", "properties": { "workflow_rules": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/DependentFieldMissingSchema" }, { "$ref": "#/components/schemas/ExpectedFieldMissingSchema" }, { "$ref": "#/components/schemas/AmbiguityDuringProcessingSchema" }, { "$ref": "#/components/schemas/LimitExceededSchema" }, { "$ref": "#/components/schemas/DependentMisMatchSchema" }, { "$ref": "#/components/schemas/AlreadyUsedSchema" }, { "$ref": "#/components/schemas/CannotRemoveSchema" }, { "$ref": "#/components/schemas/RequiredDataNotFoundSchema" }, { "$ref": "#/components/schemas/FeatureDisabledSchema" }, { "$ref": "#/components/schemas/FailureSchema" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "workflow_rules" ], "type": "object", "x-zs-$id": "WorkflowRuleCreateErrorResponse" } ], "x-zs-$id": "WorkflowRuleCreateErrorResponses" } } }, "description": "The response returned when the request contains invalid, missing, or unsupported data. Resolution: review the error details to identify the field or value that failed validation, correct it, and resubmit the request\n" }, "403": { "content": { "application/json": { "examples": { "FeatureNotSupportedResponse": { "summary": "Error response: FEATURE_NOT_SUPPORTED - workflow feature not available in this edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "feature not available in this edition", "status": "error" } }, "NoPermissionResponse": { "summary": "Error response: NO_PERMISSION - manage automation permission missing", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "MANAGE_WORKFLOW" ] }, "message": "feature not available in this edition", "status": "error" } }, "WorkflowRulesPermission": { "summary": "Error response: NO_PERMISSION - workflow rules feature not available", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "WORKFLOW_RULES" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Forbidden. The authenticated user does not have permission to perform this operation, or the workflow rules feature is not available in the current CRM edition. Resolution: verify the user's permissions and the organization's edition capabilities.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.CREATE" ] } ], "summary": "Create a workflow rule for a module", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Use this to create a new workflow rule. Always call getWorkflowConfigurations first to validate trigger availability for the target module triggers are module-specific despite being listed globally. Call getWorkflowRulesCount to check org limits before creating. The response returns the created rule ID. Common failures: INVALID_DATA (unsupported trigger for module), LIMIT_EXCEEDED (org quota hit), DEPENDENT_FIELD_MISSING (missing action details)." }, "put": { "description": "To update one or more existing workflow rules in your Zoho CRM organization, submit a `workflow_rules` array in the request body with each entry containing the rule's `id`. You can modify a rule's name, description, criteria, conditions, actions, and active status. Triggers may be updated only within the same trigger type — changing from one trigger category to another (for example, from a Record Action trigger to a Score-based trigger) is not supported. The module associated with a workflow rule cannot be changed after creation. To remove an existing condition or action, include it in the request with `_delete` set to `null`. Use the [Get Workflow Rules API](workflow_rules.yaml#$.paths./settings/automation/workflow_rules.get) to retrieve rule IDs before calling this operation.\n", "operationId": "updateWorkflowRule", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample request body", "value": { "workflow_rules": [ { "conditions": [ { "criteria_details": { "criteria": { "comparator": "equal", "field": { "api_name": "Department", "id": "3361265000000000455" }, "value": "${EMPTY}" } }, "id": "3361265000006492242", "instant_actions": { "actions": [ { "details": { "apply_assignment_threshold": false, "assign_to": [ { "resource": { "id": "3361265000002134004", "name": "user2 testUser" }, "type": "user" }, { "resource": { "id": "3361265000002134024", "name": "testUser1" }, "type": "user" } ], "module": { "api_name": "Vendors" }, "notify": false, "related_records": null, "user_availability_based_on": null }, "id": "3361265000006492245", "name": "To users : user2 testUser, testUser1", "type": "assign_owner" }, { "id": "3361265000006458562", "name": "EmailNotification", "type": "email_notifications" } ] }, "scheduled_actions": [ { "actions": [ { "details": { "module": { "api_name": "Contacts", "id": "3361265000000000129" }, "tags": [ { "color_code": "#879BFC", "id": "3361265000001715141", "name": "criteria" } ] }, "name": "criteria", "type": "remove_tags" } ], "id": "3361265000006526070" } ], "sequence_number": 1 } ], "execute_when": { "details": { "repeat": true, "trigger_module": { "api_name": "Contacts", "id": "3361265000000000129" } }, "type": "create_or_edit" }, "id": "3361265000006492241" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateWorkflowRuleSchema" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "Workflow rule configuration payload." }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "PUT- Success response for status 200", "value": { "workflow_rules": [ { "code": "SUCCESS", "details": { "id": "3361265000006294001" }, "message": "workflow updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowSuccessSchema" } } }, "description": "Workflow Rule updated successfully" }, "400": { "content": { "application/json": { "examples": { "AlreadyUsedResponse": { "summary": "Error response with code ALREADY_USED: The condition is already used in the mentioned workflow", "value": { "workflow_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "criteria_details", "exists_in": { "api_name": "criteria_details", "json_path": "$.workflow_rules[0].conditions[0].criteria_details" }, "json_path": "$.workflow_rules[0].conditions[1].criteria_details" }, "message": "duplicate criteria details.", "status": "error" } ] } }, "CannotRemoveLastActionResponse": { "summary": "Error response with code CANNOT_REMOVE: cannot delete the last remaining action from a condition", "value": { "workflow_rules": [ { "code": "CANNOT_REMOVE", "details": {}, "message": "Actions cannot be empty", "status": "error" } ] } }, "DependentFieldMissingResponse1": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: details)", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[1].type" }, "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[1].id" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DuplicateActionNotAllowedResponse": { "summary": "Error response with code INVALID_DATA: Duplicate action not allowed", "value": { "workflow_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "actions", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0]" }, "message": "Duplicate action not allowed", "status": "error" } ] } }, "InvalidConditionId": { "summary": "Error response with code INVALID_DATA: This given conditionid seems to be invalid", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.workflow_rules[0].conditions[0].id" }, "message": "This given conditionid seems to be invalid", "status": "error" } ] } }, "InvalidRuleIdResponse": { "summary": "Error response with code INVALID_DATA: the id given seems to be invalid", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.workflow_rules[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "NoUrlIdResponse": { "summary": "Error response with code INVALID_DATA: Workflow Rule Id is missing in the request body", "value": { "workflow_rules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.workflow_rules[0].id" }, "message": "The workflow processid is mandatory", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response with workflow_rules", "properties": { "workflow_rules": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/DependentFieldMissingSchema" }, { "$ref": "#/components/schemas/AlreadyUsedSchema" }, { "$ref": "#/components/schemas/ExpectedFieldMissingSchema" }, { "$ref": "#/components/schemas/AmbiguityDuringProcessingSchema" }, { "$ref": "#/components/schemas/LimitExceededSchema" }, { "$ref": "#/components/schemas/CannotRemoveSchema" }, { "$ref": "#/components/schemas/RequiredDataNotFoundSchema" }, { "$ref": "#/components/schemas/FailureSchema" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "workflow_rules" ], "type": "object", "x-zs-$id": "WorkflowRuleUpdateErrorResponse" } ], "x-zs-$id": "WorkflowRuleUpdateErrorResponses" } } }, "description": "The response returned when the request contains invalid, missing, or unsupported data. Resolution: review the error details to identify the field or value that failed validation, correct it, and resubmit the request.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "summary": "Error response for status 403", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Forbidden. The authenticated user does not have permission to perform this operation, or the workflow rules feature is not available in the current CRM edition. Resolution: verify the user's permissions and the organization's edition capabilities.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.UPDATE" ] } ], "summary": "Update workflow rules by ID in the request body\n", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Updates one or more workflow rules identified by id in the request body. Supports partial updates include only fields to change. Omitted actions are preserved; to remove an action set _delete: null. Cannot change module after creation. Locked rules return RECORD_LOCKED. Always GET the current rule first to avoid overwriting concurrent changes." } }, "/crm/v8/settings/automation/workflow_rules/actions/actions_count": { "get": { "description": "To retrieve the total number of actions configured in the specified workflow rules in your Zoho CRM organization, including counts categorized by action type across both instant and scheduled actions.", "operationId": "getWorkflowRulesActionsCount", "parameters": [ { "$ref": "#/components/parameters/ParamQueryIdsSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetActionsCount": { "summary": "Success response for status 200", "value": { "workflow_rules": [ { "conditions": [ { "id": "3361265000006526161", "instant_actions": { "actions_count": [ { "type": "field_updates", "value": 1 }, { "type": "assign_owner", "value": 1 }, { "type": "add_tags", "value": 1 }, { "type": "create_record", "value": 1 }, { "type": "webhooks", "value": 1 } ] }, "scheduled_actions": [ { "actions_count": [ { "type": "remove_tags", "value": 1 }, { "type": "email_notifications", "value": 1 }, { "type": "functions", "value": 1 } ] } ], "sequence_number": 1 } ], "id": "3361265000006526160" }, { "conditions": [ { "id": "3361265000006526224", "instant_actions": { "actions_count": [ { "type": "convert", "value": 1 } ] }, "scheduled_actions": null, "sequence_number": 1 } ], "id": "3361265000006526223" } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowActionCountsResponseSchema" } } }, "description": "OK - Successful response" }, "204": { "description": "No Content - Successful response with no body" }, "400": { "content": { "application/json": { "examples": { "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema" } } }, "description": "The response returned when the deletion request is invalid, such as a malformed or missing rule ID. Resolution: verify the rule IDs in the request and resubmit.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "summary": "Error response for status 403", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Forbidden. The authenticated user does not have permission to perform this operation, or the workflow rules feature is not available in the current CRM edition. Resolution: verify the user's permissions and the organization's edition capabilities.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.READ" ] } ], "summary": "Get Workflow Rule Action Counts", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Returns per-condition action counts (instant + scheduled) for specified rule IDs. Use to check how many action slots are consumed before adding new actions. Requires rule_ids query parameter." } }, "/crm/v8/settings/automation/workflow_rules/actions/module_specific_count": { "get": { "description": "To retrieve the count of active and total workflow rules configured for each module in your Zoho CRM organization.\n", "operationId": "getModuleSpecificActionsCount", "parameters": [ { "$ref": "#/components/parameters/WorkflowRulesParamQueryModuleSchema" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ModuleSpecificActionsCount": { "summary": "Success response for status 200", "value": { "module_specific_count": [ { "active_rules_configured": 1, "module": { "api_name": "Deals", "id": "111111000000002399" }, "total_rules_configured": 1 }, { "active_rules_configured": 1, "module": { "api_name": "Calls", "id": "111111000000002421" }, "total_rules_configured": 1 }, { "active_rules_configured": 2, "module": { "api_name": "Leads", "id": "111111000000002393" }, "total_rules_configured": 2 } ] } } }, "schema": { "$ref": "#/components/schemas/ModuleSpecificCountsResponseAllSchema" } } }, "description": "Success for specific module" }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: The value provided to the param is Invalid", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema" } } }, "description": "The response returned when the deletion request is invalid, such as a malformed or missing rule ID. Resolution: verify the rule IDs in the request and resubmit." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "summary": "Error response for status 403", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Forbidden. The authenticated user does not have permission to perform this operation, or the workflow rules feature is not available in the current CRM edition. Resolution: verify the user's permissions and the organization's edition capabilities.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.READ" ] } ], "summary": "Get Active and Total Workflow Rule Counts by Module\n", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Returns total workflow rule and action counts for a specific module, broken down by action type. Use to check module-level limits and capacity before creating new rules." } }, "/crm/v8/settings/automation/workflow_rules/actions/reorder": { "put": { "description": "To update the execution order of workflow rules for a specific module in your Zoho CRM organization. By default, rules execute in the order in which they were created. If any of the specified rule IDs are invalid, the entire request fails and no partial updates are applied.", "operationId": "reorderWorkflowRules", "parameters": [ { "$ref": "#/components/parameters/WorkflowRulesParamQueryModuleSchema" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows a reorder request body containing two workflow rules assigned new module-specific sequence positions, demonstrating how to reassign execution order by pairing each rule identifier with its target position.", "summary": "Sample request body", "value": { "reorder": { "workflow_rules": [ { "id": "3361265000006559113", "module_specific_sequence": 3 }, { "id": "3361265000006559076", "module_specific_sequence": 1 } ] } } } }, "schema": { "$ref": "#/components/schemas/ReorderWorkflowRulesRequestSchema" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "Workflow rule configuration payload." }, "responses": { "200": { "content": { "application/json": { "examples": { "ReorderWorkflowSuccess": { "description": "Shows a successful 200 response in which each submitted workflow rule is confirmed with a per-rule SUCCESS status code and the rule's identifier returned in the details object.", "summary": "Success response for status 200", "value": { "reorder": [ { "code": "SUCCESS", "details": { "id": "3361265000006559076" }, "message": "rules reordered successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "3361265000006559113" }, "message": "rules reordered successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ReOrderSuccessResponseSchema" } } }, "description": "OK - Successful response" }, "400": { "content": { "application/json": { "examples": { "Error400Response2": { "description": "Shows an INVALID_DATA error returned when the workflow_rules field is supplied with an incorrect data type instead of the required JSON array, with the expected data type and JSON path included in the error details.", "summary": "Error response", "value": { "reorder": [ { "code": "INVALID_DATA", "details": { "api_name": "workflow_rules", "expected_data_type": "jsonarray", "json_path": "$.reorder.workflow_rules" }, "message": "Invalid data type", "status": "error" } ] } }, "Error400Response3": { "description": "Shows an INVALID_DATA error returned when the workflow_rules field contains structurally invalid content, distinguishing this case from a data-type mismatch by indicating malformed field values rather than a wrong container type.", "summary": "Error response", "value": { "reorder": [ { "code": "INVALID_DATA", "details": { "api_name": "workflow_rules", "json_path": "$.reorder.workflow_rules", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows an INVALID_DATA error triggered when the same sequence number is assigned to more than one rule in the request, with the duplicate module_specific_sequence value located at the second array entry identified in the JSON path.", "summary": "Error response with code INVALID_DATA: duplicate data (Field: module_specific_sequence)", "value": { "reorder": [ { "code": "INVALID_DATA", "details": { "api_name": "module_specific_sequence", "json_path": "$.reorder.workflow_rules[1].module_specific_sequence" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an INVALID_DATA error triggered when the same workflow rule identifier appears more than once in the request array, with the offending duplicate ID located at the second array entry identified in the JSON path.", "summary": "Error response with code INVALID_DATA: duplicate data (Field: id)", "value": { "reorder": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.reorder.workflow_rules[1].id" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an INVALID_DATA error returned when a workflow rule identifier in the request does not correspond to an existing rule, with the invalid ID located at the first array entry identified in the JSON path.", "summary": "Error response with code INVALID_DATA: Invalid process id (Field: id)", "value": { "reorder": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.reorder.workflow_rules[0].id" }, "message": "Invalid process id", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows an INVALID_DATA error returned when a module_specific_sequence value falls outside the permissible range, with the out-of-range position identified at the second array entry in the JSON path.", "summary": "Error response with code INVALID_DATA: Invalid sequence number is given (Field: module_specific_sequence)", "value": { "reorder": [ { "code": "INVALID_DATA", "details": { "api_name": "module_specific_sequence", "json_path": "$.reorder.workflow_rules[1].module_specific_sequence" }, "message": "Invalid sequence number is given", "status": "error" } ] } }, "InvalidModuleResponse": { "description": "Shows an INVALID_MODULE error returned when the module query parameter contains an API name that does not match any recognised CRM module, with the offending parameter name surfaced in the error details.", "summary": "Error response with code INVALID_MODULE: Invalid Module", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "Invalid Module", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "Shows a MANDATORY_NOT_FOUND error returned when the module_specific_sequence field is omitted from one of the workflow rule objects in the request array, with the missing field's JSON path pointing to the second array entry.", "summary": "Error response with code MANDATORY_NOT_FOUND: The required data missing (Field: module_specific_sequence)", "value": { "reorder": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module_specific_sequence", "json_path": "$.reorder.workflow_rules[1].module_specific_sequence" }, "message": "The required data missing", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "description": "Shows a REQUIRED_PARAM_MISSING error returned when the mandatory module query parameter is absent from the request entirely, distinguishing this case from an invalid module name where the parameter is present but unrecognised.", "summary": "Error response with code REQUIRED_PARAM_MISSING: required param not found", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "required param not found", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema" }, { "additionalProperties": false, "description": "Wrapped error response with reorder", "properties": { "reorder": { "description": "Array of error objects", "maxItems": 10, "type": "array" } }, "type": "object", "x-zs-$id": "ReorderWorkflowErrorResponse" } ], "x-zs-$id": "ReorderWorkflowErrorResponseSchema" } } }, "description": "The response returned when the deletion request is invalid, such as a malformed or missing rule ID.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Shows a 403 NO_PERMISSION error returned when the authenticated user's CRM profile lacks the Crm_Implied_Manage_Workflow permission required to reorder workflow rules, with the missing permission name listed in the error details.", "summary": "Error response for status 403", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Forbidden. The authenticated user does not have permission to perform this operation, or the workflow rules feature is not available in the current CRM edition. Resolution: verify the user's permissions and the organization's edition capabilities.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.UPDATE" ] } ], "summary": "Update Workflow Rule Execution Order for Module", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Changes execution order of workflow rules for a module. Rules execute in the order specified in the request array. All active rules for the module must be included missing rules cause an error. Requires module query parameter." } }, "/crm/v8/settings/automation/workflow_rules/actions/rules_count": { "get": { "description": "To retrieve the organization-level quota and current usage counts for workflow rules and actions in your Zoho CRM organization. The response includes the total and active rule limits (both organization-wide and per module), the number of rules currently configured, and the per-rule limits for actions and scheduled action groups.\n", "operationId": "getWorkflowRulesCount", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Returns workflow rule quota details for an organization with two total rules configured and two active rules, against a total limit of 2,500 rules and an active limit of 2,000 rules.\n", "summary": "Successful retrieval of workflow rule quota and usage counts\n", "value": { "rules_count": { "active_rules_configured": 2, "active_rules_limit": 2000, "active_rules_limit_per_module": 75, "rules_per_process_limit": 10, "scheduled_actions_per_rule_limit": 5, "total_actions_per_rule_limit": 50, "total_rules_configured": 2, "total_rules_limit": 2500, "total_rules_limit_per_module": 125 } } } }, "schema": { "$ref": "#/components/schemas/WorkflowRulesCountResponseSchema" } } }, "description": "Returns the organization-level workflow rule quota and current usage counts.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returned when the caller lacks the `Crm_Implied_Manage_Workflow` permission or the feature is not available in the current Zoho CRM edition.\n", "summary": "Access denied due to missing permission or unsupported edition\n", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "The caller does not have permission to retrieve workflow rule counts, or the feature is not available in the current Zoho CRM edition.\n**Resolution:** The CRM administrator must grant the `Crm_Implied_Manage_Workflow` permission to the user's profile in Zoho CRM.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.READ" ] } ], "summary": "Get Workflow Rule Quota and Usage Counts\n", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Returns org-level workflow rules quota: configured vs maximum allowed rules and actions for your plan. Call this before postWorkflowRule to verify you have capacity. Also reveals per-rule limits (max conditions, max scheduled actions)." } }, "/crm/v8/settings/automation/workflow_rules/{id}": { "delete": { "description": "To delete a workflow rule from your Zoho CRM organization by its unique ID. Locked workflow rules cannot be deleted.\n", "operationId": "deleteWorkflowRuleById", "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful deletion response in which the API returns a SUCCESS code and the ID of the deleted workflow rule.", "summary": "Successful deletion of a workflow rule by ID", "value": { "workflow_rules": [ { "code": "SUCCESS", "details": { "id": "3361265000006294001" }, "message": "workflow deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowSuccessSchema" } } }, "description": "Returns the result of the workflow rule deletion, including the workflow rule ID and a success status." }, "400": { "content": { "application/json": { "examples": { "NotAllowedErrorResponse": { "description": "Shows a 400 error response in which the API returns a NOT_ALLOWED code, indicating that the requested delete operation is not permitted for the given workflow rule ID.", "summary": "400 error — delete operation not allowed for the workflow rule ID", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "UrlPathIdMissing": { "description": "Shows a 400 error response in which the API returns an INVALID_DATA code, indicating that the workflow rule ID supplied in the request URL path is invalid.", "summary": "400 error — invalid workflow rule ID in the request URL path", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UrlIdMissingSchema" } } }, "description": "The workflow rule ID provided in the request URL is invalid or the action is not permitted.\n**Resolution:** Verify that the workflow rule ID in the request path is a valid numeric ID and that the operation is allowed for the target workflow rule." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Shows a 403 error response in which the API returns a NO_PERMISSION code, indicating that the user's CRM profile lacks the Crm_Implied_Manage_Workflow permission required to delete workflow rules.", "summary": "403 error — insufficient permission to delete workflow rules", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "The user does not have permission to delete workflow rules.\n**Resolution:** The CRM administrator must grant the required permission to the user's CRM profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.DELETE" ] } ], "summary": "Delete a workflow rule by ID", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Deletes a single workflow rule by path ID. Locked rules cannot be deleted. Returns success or error status." }, "get": { "description": "To retrieve the complete configuration of a specific workflow rule in your Zoho CRM organization, including its trigger type, execution criteria, conditions, instant actions, scheduled actions, and lock status. Use the [Get All Workflow Rules](workflow_rules.yaml#$.paths./settings/automation/workflow_rules.get) operation to obtain the unique ID of the workflow rule to retrieve.\n", "operationId": "getWorkflowRuleById", "responses": { "200": { "content": { "application/json": { "examples": { "GetSuccessResponse": { "description": "Illustrates a successful response containing the full configuration of a workflow rule, including its trigger type, conditions with instant and scheduled actions, lock status, and usage metadata.\n", "summary": "Successful retrieval of a specific workflow rule's full configuration\n", "value": { "workflow_rules": [ { "category": "default", "conditions": [ { "criteria_details": { "criteria": { "comparator": "not_equal", "field": { "api_name": "Company", "id": "3361265000000000555" }, "type": "value", "value": "${EMPTY}" }, "relational_criteria": { "criteria": null, "module": null, "module_selection": null } }, "id": "3361265000006526161", "instant_actions": { "actions": [ { "details": { "apply_assignment_threshold": true, "assign_to": [ { "details": null, "resource": { "id": "3361265000002134004", "name": "user2 testUser", "type": "user" }, "type": "user" } ], "module": { "api_name": "Leads", "id": "3361265000000000125" }, "notify": true, "related_records": [ { "api_name": "Tasks", "id": "3361265000000000143" }, { "api_name": "Events", "id": "3361265000000000145" } ], "user_availability_based_on": [ "online_status" ] }, "id": "3361265000006526168", "name": "To users : user2 testUser", "related_details": null, "type": "assign_owner" }, { "details": { "module": { "api_name": "Contacts", "id": "3361265000000000129" } }, "id": "3361265000006486997", "name": "title", "related_details": { "lookup_field": { "api_name": "Lookup", "id": "3361265000002147008" } }, "type": "field_updates" }, { "details": { "module": { "api_name": "Leads", "id": "3361265000000000125" }, "over_write": false, "tags": [ { "color_code": "#FD87BD", "id": "3361265000001715037", "name": "criteria" } ] }, "id": "3361265000006526169", "name": "criteria", "type": "add_tags" }, { "id": "3361265000003613045", "name": "test_webhook", "type": "webhooks" }, { "details": { "apply_restriction": false, "field_mappings": [ { "display_value": "testUser user2", "field": { "api_name": "Owner", "id": "3361265000000000553" }, "type": "static", "value": { "id": "3361265000002134004", "name": "testUser user2" } }, { "display_value": "CreateRecord", "field": { "api_name": "Company", "id": "3361265000000000555" }, "type": "static", "value": "CreateRecord" }, { "display_value": "CreateRecord", "field": { "api_name": "Last_Name", "id": "3361265000000000559" }, "type": "static", "value": "CreateRecord" } ], "layout": { "display_label": "cloneLayout", "id": "3361265000006165015", "name": "cloneLayout" }, "module": { "api_name": "Leads", "id": "3361265000000000125" } }, "id": "3361265000006526170", "name": "Leads", "type": "create_record" } ] }, "scheduled_actions": [ { "actions": [ { "details": { "module": { "api_name": "Leads", "id": "3361265000000000125" }, "over_write": false, "tags": [ { "color_code": "#FD87BD", "id": "3361265000001715037", "name": "criteria" } ] }, "id": "3361265000006526192", "name": "criteria", "type": "remove_tags" }, { "id": "3361265000002157092", "name": "LeadTask", "related_details": null, "type": "tasks" }, { "id": "3361265000005845301", "name": "RB", "type": "functions" }, { "id": "3361265000004539004", "name": "testEmail", "related_details": null, "type": "email_notifications" }, { "details": { "field_mappings": [ { "display_value": "AddMeeting", "field": { "api_name": "Event_Title", "id": "3361265000000000249" }, "type": "static", "value": "AddMeeting" }, { "display_value": "Trigger Date plus 2 business day(s) 12:00 AM", "field": { "api_name": "Start_DateTime", "id": "3361265000000101001" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "time": "00:00", "trigger_field": "${CURRENTTIME}", "unit": "2" } }, { "display_value": "false", "field": { "api_name": "All_day", "id": "3361265000000057003" }, "type": "static", "value": "false" }, { "display_value": "testUser user2", "field": { "api_name": "Owner", "id": "3361265000000000247" }, "type": "static", "value": { "id": "3361265000002134004", "name": "testUser user2" } } ], "host_unavailable": { "assign_record_owner_as_host": true }, "layout": { "id": "3361265000000095045", "name": "Standard" }, "meeting_duration": { "period": "minutes", "unit": 2 }, "module": { "api_name": "Events", "id": "3361265000000000145" } }, "id": "3361265000006526193", "name": "AddMeeting", "type": "add_meeting" }, { "details": { "field_mappings": [ { "display_value": "Outbound", "field": { "api_name": "Call_Type", "id": "3361265000000017021" }, "type": "static", "value": "Outbound" }, { "display_value": "Scheduled", "field": { "api_name": "Outgoing_Call_Status", "id": "3361265000000245003" }, "type": "static", "value": "Scheduled" }, { "display_value": "Trigger Date plus 2 business day(s) 12:00 AM", "field": { "api_name": "Call_Start_Time", "id": "3361265000000017029" }, "type": "execution_time", "value": { "period": "business_days", "sign": "plus", "time": "00:00", "trigger_field": "${CURRENTTIME}", "unit": "2" } }, { "display_value": "testUser user2", "field": { "api_name": "Owner", "id": "3361265000000017017" }, "type": "static", "value": { "id": "3361265000002134004", "name": "testUser user2" } }, { "display_value": "Demo", "field": { "api_name": "Call_Purpose", "id": "3361265000000017023" }, "type": "static", "value": "Demo" }, { "display_value": "Demo", "field": { "api_name": "Call_Agenda", "id": "3361265000000536391" }, "type": "static", "value": "Demo" } ], "layout": { "id": "3361265000000095033", "name": "Standard" }, "module": { "api_name": "Calls", "id": "3361265000000017015" } }, "id": "3361265000006526194", "name": "Calls", "type": "schedule_call" } ], "execute_after": { "period": "business_hours", "unit": 1 }, "id": "3361265000006526188" } ], "sequence_number": 1 } ], "created_by": { "id": "4011656000000603001", "name": "Rishi LocalTest" }, "created_time": "2025-12-01T11:09:10+05:30", "deletable": true, "deprecated": false, "description": "ds", "editable": true, "execute_when": { "details": { "trigger_module": { "api_name": "Leads", "id": "4011656000000000125" } }, "type": "create" }, "id": "4011656000002144049", "last_executed_time": null, "lock": { "locked_by": null, "message": null, "status": false }, "modified_by": { "id": "4011656000000603001", "name": "Rishi LocalTest" }, "modified_time": "2025-12-01T11:15:03+05:30", "module": { "api_name": "Leads", "id": "4011656000000000125" }, "name": "fwsefw", "source": "crm", "status": { "active": true } } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowRuleSingleGetResponseSchema" } } }, "description": "Returns the complete configuration of the specified workflow rule.\n" }, "204": { "description": "Returns a successful response with no content.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Illustrates a 403 error response returned when the authenticated user lacks the required profile permissions to access the workflow rule.\n", "summary": "NO_PERMISSION error for workflow rule retrieval\n", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "The user does not have permission to access this API.\n**Resolution:** A Zoho CRM administrator must grant the user the required profile permissions to access workflow rules." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.READ" ] } ], "summary": "Retrieve Workflow Rule by ID\n", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Retrieves complete details of a single workflow rule including trigger, conditions, criteria, actions, lock status, and metadata. Use this before updating to understand the current rule structure. Always returns full inner details regardless of include_inner_details param." }, "parameters": [ { "$ref": "#/components/parameters/ParamQueryIdSchema" } ], "put": { "description": "To update an existing workflow rule in your Zoho CRM organization, use this operation with the rule's unique ID. You can modify the rule's name, description, triggers, criteria, conditions, and actions, or activate and deactivate the rule. Use the [Get Workflow Rules API](workflow_rules.yaml#$.paths./settings/automation/workflow_rules.get) to retrieve available rule IDs. Only include the fields you want to change; existing actions not specified in the request are preserved. To remove an existing condition or action, set its `_delete` key to null. You cannot change the module or trigger module of a workflow rule, and the trigger type cannot be changed across categories.", "operationId": "updateWorkflowRuleById", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Demonstrates a partial update request for an existing workflow rule identified by its path parameter. The payload includes a workflow_rules array containing the fields to be modified, such as name, description, triggers, criteria, conditions, or actions.\n", "summary": "Sample request body for updating a workflow rule by ID", "value": { "workflow_rules": [ { "conditions": [ { "criteria_details": { "criteria": { "comparator": "equal", "field": { "api_name": "Department", "id": "3361265000000000455" }, "value": "${EMPTY}" } }, "id": "3361265000006492242", "instant_actions": { "actions": [ { "details": { "apply_assignment_threshold": false, "assign_to": [ { "resource": { "id": "3361265000002134004", "name": "user2 testUser" }, "type": "user" }, { "resource": { "id": "3361265000002134024", "name": "testUser1" }, "type": "user" } ], "module": { "api_name": "Vendors" }, "notify": false, "related_records": null, "user_availability_based_on": null }, "id": "3361265000006492245", "name": "To users : user2 testUser, testUser1", "type": "assign_owner" }, { "id": "3361265000006458562", "name": "EmailNotification", "type": "email_notifications" } ] }, "sequence_number": 1 } ], "execute_when": { "details": { "repeat": true, "trigger_module": { "api_name": "Contacts", "id": "3361265000000000129" } }, "type": "create_or_edit" }, "id": "3361265000006492241" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateWorkflowRuleSchema" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body must contain a workflow_rules array with exactly one object representing the updated workflow rule configuration.\n" }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the response returned when a workflow rule is successfully updated. The workflow_rules array contains a SUCCESS code, the ID of the updated rule in the details object, and a status of success.\n", "summary": "Success response for updating a workflow rule", "value": { "workflow_rules": [ { "code": "SUCCESS", "details": { "id": "3361265000006294001" }, "message": "workflow updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowSuccessSchema" } } }, "description": "Returns the result of the workflow rule update, including the unique ID of the updated rule.\n" }, "400": { "content": { "application/json": { "examples": { "AlreadyUsedResponse": { "description": "Shows the 400 error response returned when a condition is already in use within the specified workflow rule. The response carries the ALREADY_USED code, indicating the update cannot proceed without resolving the conflict.\n", "summary": "Error response when a condition is already used in the workflow", "value": { "workflow_rules": [ { "code": "ALREADY_USED", "details": { "api_name": "criteria_details", "exists_in": { "api_name": "criteria_details", "json_path": "$.workflow_rules[0].conditions[0].criteria_details" }, "json_path": "$.workflow_rules[0].conditions[1].criteria_details" }, "message": "duplicate criteria details.", "status": "error" } ] } }, "DependentFieldMissingResponse1": { "description": "Shows the 400 error response returned when a required dependent field is absent from the update request. The DEPENDENT_FIELD_MISSING code identifies the missing field as details, which must be supplied for the update to succeed.\n", "summary": "Error response when a required dependent field is missing", "value": { "workflow_rules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "type", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[1].type" }, "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[1].id" }, "message": "Dependent Field missing", "status": "error" } ] } }, "DuplicateActionNotAllowedResponse": { "description": "Returned when the same action type appears more than once within a single condition in the workflow rule update request. The API rejects the payload with an INVALID_DATA error and the message \"Duplicate action not allowed\".\n", "summary": "INVALID_DATA error when a duplicate action type is detected", "value": { "workflow_rules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "actions", "json_path": "$.workflow_rules[0].conditions[0].instant_actions.actions[0]" }, "message": "Duplicate action not allowed", "status": "error" } ] } }, "InvalidConditionId": { "description": "Returned when the condition ID supplied in the request body does not correspond to a valid, existing condition. The API responds with an INVALID_DATA error and the message \"This given conditionid seems to be invalid\".\n", "summary": "INVALID_DATA error when the provided condition ID is not valid", "value": { "workflow_rules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.workflow_rules[0].conditions[0].id" }, "message": "This given conditionid seems to be invalid", "status": "error" } ] } }, "UrlPathIdMissing": { "description": "Returned when the URL path workflow rule ID provided does not correspond to a valid workflow rule ID. The API responds with an INVALID_DATA error and the message 'the id given seems to be invalid'.", "summary": "INVALID_DATA error when the URL path workflow rule ID is invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UrlIdMissingSchema" }, { "additionalProperties": false, "description": "Represents the error response returned when the request body fails validation and multiple field-level errors are reported.\n", "properties": { "workflow_rules": { "description": "Represents the array of workflow rule error objects returned when the request body fails validation.\n", "items": { "anyOf": [ { "$ref": "#/components/schemas/DependentFieldMissingSchema" }, { "$ref": "#/components/schemas/AlreadyUsedSchema" }, { "$ref": "#/components/schemas/ExpectedFieldMissingSchema" }, { "$ref": "#/components/schemas/AmbiguityDuringProcessingSchema" }, { "$ref": "#/components/schemas/LimitExceededSchema" }, { "$ref": "#/components/schemas/CannotRemoveSchema" }, { "$ref": "#/components/schemas/RequiredDataNotFoundSchema" }, { "$ref": "#/components/schemas/FailureSchema" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "workflow_rules" ], "type": "object", "x-zs-$id": "WorkflowRuleUpdateByIdErrorResponse" } ], "x-zs-$id": "WorkflowRuleUpdateByIdErrorResponses" } } }, "description": "The request contains invalid or conflicting data.\n**Resolution:** Review the error details in the response body and correct the request. Common causes include invalid field values, duplicate actions, missing dependent fields, ambiguous criteria, or exceeded rule and action limits." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returned when the authenticated user's CRM profile lacks the Manage Workflow permission required to update a workflow rule. The API responds with a 403 status and the NO_PERMISSION error code.\n", "summary": "NO_PERMISSION error when user lacks the Manage Workflow permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Permission denied for the requested resource.\n**Resolution:** The authenticated user does not have permission to perform this action. Only users with the Manage Workflow permission in their CRM profile can update workflow rules." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.UPDATE" ] } ], "summary": "Update Workflow Rule by ID\n", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Updates a single workflow rule by path ID. Same behavior as bulk PUT but targets one rule via URL. Supports partial updates omitted fields are preserved. To remove an action include it with _delete: null. GET the rule first to know current state." } }, "/crm/v8/settings/automation/workflow_rules/{workflowRuleId}/actions/usage": { "get": { "description": "To retrieve the action usage report for a specific workflow rule in your Zoho CRM organization, including trigger count and per-action success, failure, and queue metrics, as well as email engagement statistics. Results are scoped to a configurable date range.", "operationId": "getWorkflowRuleUsage", "parameters": [ { "$ref": "#/components/parameters/ParamQueryExecutedFrom" }, { "$ref": "#/components/parameters/ParamQueryExecutedTill" }, { "$ref": "#/components/parameters/ParamPathWorkflowRuleId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Represents a successful response for the getWorkflowRuleUsage operation. Contains a workflow_rules array with one rule entry, including its trigger count, name, record ID, reset time, and a conditions array detailing instant and scheduled action usage metrics such as success, failure, queue counts, and email engagement statistics.", "summary": "Successful retrieval of workflow rule action usage metrics", "value": { "workflow_rules": [ { "conditions": [ { "id": "4876876000013248002", "instant_actions": { "actions": [ { "associated_time": "2025-10-16T16:19:58+05:30", "failure_count": 0, "id": "4876876000016390103", "name": "High revenue Lead added", "queue_count": 0, "related_details": { "bounced": 0, "bulk_mail": false, "clicked": 0, "delivered": 1, "opened": 1, "sent": 1, "sent_percentage": 100, "unopened": 0, "unsent": 0 }, "success_count": 1, "type": "email_notifications" }, { "associated_time": "2025-08-08T22:40:00+05:30", "failure_count": 0, "id": "4876876000013248016", "name": "To users : Patricia Boyle", "success_count": 2, "type": "assign_owner" } ] }, "scheduled_actions": [ { "actions": [ { "associated_time": "2025-10-16T16:19:58+05:30", "failure_count": 0, "id": "4876876000016390103", "name": "High revenue Lead added", "queue_count": 0, "related_details": { "bounced": 0, "bulk_mail": false, "clicked": 0, "delivered": 1, "opened": 1, "sent": 1, "sent_percentage": 100, "unopened": 0, "unsent": 0 }, "success_count": 1, "type": "email_notifications" } ], "id": "4876876000016390118" } ], "usage_count": 2 }, { "id": "4876876000013248004", "instant_actions": { "actions": [ { "associated_time": "2025-08-08T22:40:00+05:30", "failure_count": 0, "id": "4876876000013248015", "name": "P1", "success_count": 0, "tag_id": "4876876000011037076", "type": "add_tags" } ] }, "scheduled_actions": [], "usage_count": 0 } ], "id": "4876876000013248001", "name": "High Value Lead Rule", "reset_time": "2025-10-16T16:23:04+05:30", "trigger_count": 3 } ] } } }, "schema": { "$ref": "#/components/schemas/WorkflowRuleUsageResponseSchema" } } }, "description": "Returns detailed execution usage metrics for the specified workflow rule, including trigger counts, conditions breakdowns, and instant and scheduled action usage statistics within the queried date range." }, "400": { "content": { "application/json": { "examples": { "DateRangeExceedsResponse": { "description": "Returned when the specified date range exceeds the maximum period allowed for querying workflow rule action usage. The caller should reduce the date range and resubmit the request.", "summary": "400 error when the queried date range exceeds the allowed limit", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "DATE_RANGE_EXCEEDS", "status": "error" } }, "InvalidDataTypeResponse": { "description": "Returned when a date or time query parameter is supplied in an unsupported format. The caller should ensure all date and time parameters conform to ISO 8601 format before resubmitting the request.", "summary": "400 error when a date or time parameter is not in ISO 8601 format", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "datetime", "param_name": "executed_from" }, "message": "Please provide ISO Time format to the param", "status": "error" } }, "InvalidRequestMethodResponse": { "description": "Returned when the HTTP method used to call this endpoint is not supported. The server rejects the request with error code INVALID_REQUEST_METHOD.", "summary": "Invalid HTTP request method used for this endpoint", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "RequiredParamMissingResponse": { "description": "Returned when one or more required query parameters — such as `executed_from` or `executed_till` — are absent from the request. The server responds with error code REQUIRED_PARAM_MISSING.", "summary": "Required query parameter missing from the request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "executed_from" }, "message": "required param not found", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema" } } }, "description": "The request could not be processed due to invalid or missing parameters.\n**Resolution:** The caller must ensure all required parameters are present, date ranges are within allowed limits, and values use the correct data types and formats." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailureResponse": { "description": "Returned when the access token included in the request is invalid, expired, or missing. The server responds with error code AUTHENTICATION_FAILURE.", "summary": "Authentication failed for the request", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidDataNoApiNameAndPathSchema", "x-zs-$id": "UnAuthorizedErrorResponseSchema" } } }, "description": "Authentication failed.\n**Resolution:** Verify that a valid OAuth access token with the ZohoCRM.settings.workflow_rules.READ scope is included in the Authorization header and has not expired." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Returned when the workflow rules feature is not available in the current Zoho CRM edition. The server responds with error code NO_PERMISSION.", "summary": "Workflow rules feature not available in the current Zoho CRM edition", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoPermissionSchema" } } }, "description": "Feature not available in this edition.\n**Resolution:** The Zoho CRM subscription must include an edition that supports workflow rules." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.READ" ] } ], "summary": "Retrieve Action Usage for a Workflow Rule", "tags": [ "workflow_rules" ], "x-zoho-document": "workflow_rules", "x-zs-llm-description": "Returns execution metrics for a specific workflow rule: trigger count, per-action success/failure counts, email engagement stats (sent, opened, clicked, bounced). Supports date range filtering via executed_from and executed_till (yyyy-MM-dd). Use to monitor rule health." } }, "/crm/v8/settings/business_hours": { "get": { "description": "Retrieves the current business hours configuration, including working days, operating hours, and timezone details.", "operationId": "getBusinessHours", "responses": { "200": { "content": { "application/json": { "examples": { "BusinessHoursDetails": { "summary": "Business Hours Details", "value": { "business_hours": { "business_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "custom_timing": [], "daily_timing": [ "09:00", "18:00" ], "id": "1234567890", "same_as_everyday": true, "timezone": "Asia/Kolkata", "type": "24_by_5", "week_starts_on": "Monday" } } } }, "schema": { "additionalProperties": false, "description": "Business hours retrieval response", "properties": { "business_hours": { "additionalProperties": false, "description": "The business hours configuration object containing all settings for the organization's working schedule.", "properties": { "business_days": { "description": "The specific days of the week on which the organization is open for business.", "items": { "description": "The specific days of the week on which the organization is open for business.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "maxItems": 7, "minItems": 1, "type": "array", "uniqueItems": true }, "custom_timing": { "description": "Different business hours for different days when same_as_everyday is false", "items": { "additionalProperties": false, "description": "Different business hours for different days when same_as_everyday is false", "properties": { "business_timing": { "description": "Start and end time for business hours on this specific day", "items": { "description": "Time in HH:MM format (24-hour)", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "days": { "description": "Specific day of the week for custom business hours", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" } }, "required": [ "days", "business_timing" ], "type": "object" }, "maxItems": 7, "type": [ "array", "null" ] }, "daily_timing": { "description": "Default working hours applied to all business days (start and end time)", "items": { "description": "Time in HH:MM format (24-hour)", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": [ "array", "null" ] }, "id": { "description": "The unique identifier assigned to this business hours configuration.", "maxLength": 255, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "BusinessHoursId" }, "same_as_everyday": { "description": "If true, the same operating hours apply to all business days. If false, hours vary by day and are defined in custom_timing.", "type": "boolean" }, "timezone": { "description": "Timezone for business hours (IANA timezone identifier)", "maxLength": 100, "type": "string" }, "type": { "description": "The type of business hours configuration: '24_by_7' for 24/7 operation, '24_by_5' for 24-hour weekday operation, or 'custom' for a customized schedule.", "enum": [ "24_by_7", "24_by_5", "custom" ], "type": "string" }, "week_starts_on": { "description": "The day on which the organization's work week begins.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" } }, "required": [ "week_starts_on", "type", "id", "timezone", "business_days", "same_as_everyday", "daily_timing", "custom_timing" ], "type": "object" } }, "required": [ "business_hours" ], "type": "object", "x-zs-$id": "BusinessHoursGetResponse" } } }, "description": "Successfully retrieved business hours configuration" }, "204": { "$ref": "#/components/responses/BusinessHoursNoContentResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.READ" ] } ], "summary": "Business Hours Configuration", "tags": [ "business_hours" ], "x-zoho-document": "business_hours" }, "post": { "description": "Creates a new business hours configuration for the organization, defining working days, operating hours, and timezone settings.", "operationId": "createBusinessHours", "requestBody": { "content": { "application/json": { "examples": { "CustomHours": { "summary": "Custom Business Hours", "value": { "business_hours": { "business_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "custom_timing": [ { "business_timing": [ "09:00", "18:00" ], "days": "Monday" } ], "daily_timing": [ "09:00", "18:00" ], "same_as_everyday": false, "type": "custom", "week_starts_on": "Monday" } } } }, "schema": { "additionalProperties": false, "description": "The request body for creating business hours", "properties": { "business_hours": { "additionalProperties": false, "description": "The business hours configuration object containing all settings for the organization's working schedule.", "properties": { "business_days": { "description": "The specific days of the week on which the organization is open for business.", "items": { "description": "Day of the week", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "maxItems": 7, "minItems": 1, "type": "array", "uniqueItems": true }, "custom_timing": { "description": "Different business hours for different days when same_as_everyday is false", "items": { "additionalProperties": false, "description": "Different business hours for different days when same_as_everyday is false", "properties": { "business_timing": { "description": "Start and end times for this specific day in 24-hour HH:MM format", "items": { "description": "Time in HH:MM format (24-hour)", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "days": { "description": "Specific day of the week for custom business hours", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" } }, "required": [ "days", "business_timing" ], "type": "object" }, "maxItems": 7, "type": "array" }, "daily_timing": { "description": "Default working hours applied to all business days (start and end time)", "items": { "description": "Time in HH:MM format (24-hour)", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "same_as_everyday": { "description": "If true, the same operating hours apply to all business days. If false, hours vary by day and are defined in custom_timing.", "type": "boolean" }, "type": { "description": "The type of business hours configuration: '24_by_7' for 24/7 operation, '24_by_5' for 24-hour weekday operation, or 'custom' for a customized schedule.", "enum": [ "24_by_7", "24_by_5", "custom" ], "type": "string" }, "week_starts_on": { "description": "The day on which the organization's work week begins.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" } }, "required": [ "week_starts_on", "type" ], "type": "object" } }, "required": [ "business_hours" ], "type": "object" }, "x-zs-llm-examples": [ "CustomHours" ] } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/BusinessHoursSuccessResponse" }, "400": { "content": { "application/json": { "examples": { "MultipleBusinessHours": { "summary": "Multiple Business Hours Error", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Organization can have only one Business Hour", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/BusinessHoursErrorResponses" } } }, "description": "The request could not be processed due to invalid data, missing required fields, business rule violations, or an attempt to create multiple business hours configurations ." }, "403": { "$ref": "#/components/responses/BusinessHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.CREATE" ] } ], "summary": "Business Hours Configuration", "tags": [ "business_hours" ], "x-zoho-document": "business_hours" }, "put": { "description": "Updates the existing business hours configuration with revised working days, operating hours, or timezone settings.", "operationId": "updateBusinessHours", "requestBody": { "content": { "application/json": { "examples": { "DeleteCustomTiming": { "summary": "Delete Custom Timing for a Specific Day", "value": { "business_hours": { "business_days": [ "Monday", "Tuesday", "Wednesday", "Thursday" ], "custom_timing": [ { "business_timing": [ "10:00", "17:00" ], "days": "Monday" }, { "business_timing": [ "10:30", "17:00" ], "days": "Tuesday" }, { "business_timing": [ "11:00", "17:00" ], "days": "Wednesday" }, { "business_timing": [ "09:00", "18:30" ], "days": "Thursday" }, { "_delete": true, "business_timing": [ "11:30", "18:30" ], "days": "Friday" } ], "same_as_everyday": false, "type": "custom", "week_starts_on": "Monday" } } }, "UpdateCustomHours": { "summary": "Update to Custom Business Hours", "value": { "business_hours": { "business_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "custom_timing": [ { "business_timing": [ "09:00", "18:00" ], "days": "Monday" } ], "daily_timing": [ "09:00", "18:00" ], "same_as_everyday": false, "type": "custom", "week_starts_on": "Monday" } } } }, "schema": { "additionalProperties": false, "description": "Business hours update request body", "properties": { "business_hours": { "additionalProperties": false, "description": "The business hours configuration object containing all settings for the organization's working schedule.", "properties": { "business_days": { "description": "The specific days of the week on which the organization is open for business.", "items": { "description": "The specific days of the week on which the organization is open for business.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "maxItems": 7, "minItems": 1, "type": "array", "uniqueItems": true }, "custom_timing": { "description": "Different business hours for different days when same_as_everyday is false", "items": { "additionalProperties": false, "description": "Different business hours for different days when same_as_everyday is false", "properties": { "_delete": { "description": "Set to true to delete the custom timing for this specific business day", "type": "boolean" }, "business_timing": { "description": "Start and end time for business hours on this specific day", "items": { "description": "Time in HH:MM format (24-hour)", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "days": { "description": "Specific day of the week for custom business hours", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" } }, "required": [ "days", "business_timing" ], "type": "object" }, "maxItems": 7, "type": "array" }, "daily_timing": { "description": "Default working hours applied to all business days (start and end time)", "items": { "description": "Time in HH:MM format (24-hour)", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "same_as_everyday": { "description": "If true, the same operating hours apply to all business days. If false, hours vary by day and are defined in custom_timing.", "type": "boolean" }, "type": { "description": "The type of business hours configuration: '24_by_7' for 24/7 operation, '24_by_5' for 24-hour weekday operation, or 'custom' for a customized schedule.", "enum": [ "24_by_7", "24_by_5", "custom" ], "type": "string" }, "week_starts_on": { "description": "The day on which the organization's work week begins.", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" } }, "type": "object" } }, "required": [ "business_hours" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateCustomHours", "DeleteCustomTiming" ] } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/BusinessHoursSuccessResponse" }, "400": { "content": { "application/json": { "examples": { "UpdateRestrictions": { "summary": "Update Restrictions Error", "value": { "business_hours": { "code": "NOT_ALLOWED", "details": {}, "message": "Cannot update business hours", "status": "error" } } } }, "schema": { "$ref": "#/components/schemas/BusinessHoursErrorResponses" } } }, "description": "The request could not be processed due to invalid data, missing required fields, or business rule violations." }, "403": { "$ref": "#/components/responses/BusinessHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.UPDATE" ] } ], "summary": "Business Hours Configuration", "tags": [ "business_hours" ], "x-zoho-document": "business_hours" } }, "/crm/v8/settings/business_hours/shift_hours": { "get": { "description": "Retrieves every shift hour configured for the organization, along with the timing, break hours, holidays, time zone, and assigned users of each shift, and an aggregate count of shifts that have at least one user assigned.", "operationId": "getShifts", "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Example response returned when retrieving every shift hour configured for the organization.", "summary": "An example of success shift hours response.", "value": { "shift_count": { "total_shift_with_user": 0 }, "shift_hours": [ { "break_hours": [], "custom_timing": null, "daily_timing": [ "09:00", "18:00" ], "holidays": [], "id": "1234567890", "name": "General Shift", "same_as_everyday": true, "shift_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata", "users": [], "users_count": 0 } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_count": { "additionalProperties": false, "description": "Represents aggregate counts that summarize the shift hour configurations returned in the response.", "properties": { "total_shift_with_user": { "description": "Represents the total number of shift hours that have at least one user assigned.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "total_shift_with_user" ], "type": "object" }, "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "break_hours": { "description": "Lists the break windows scheduled within the shift hour. A shift can have at most two break windows.", "items": { "additionalProperties": false, "description": "Each object specifies the days the break applies to and the break timing for those days.", "properties": { "break_days": { "description": "Lists the days of the week on which the break\nhour applies.\n\n\nPossible values: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "items": { "description": "Represents one day of the week on which the break hour applies.\n\n", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "custom_timing": { "description": "Lists per-day break timing overrides. This field is **mandatory** when the parent **same_as_everyday** is **false**. \n\nA day can have at most two breaks and the total break time on a day cannot exceed two hours.", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the break on that day. ", "properties": { "break_timing": { "description": "Represents the start and end time of the break on the specified day\nin `HH:MM` 24-hour format. A break must\nbe longer than 15 minutes and shorter\nthan 2 hours.\n", "items": { "description": "\"Represents the start time or end time of the window in `HH:MM`\n24-hour format. \"\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" }, "days": { "description": "Represents the day of the week to which\nthis custom break timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" } }, "required": [ "break_timing", "days" ], "type": "object" }, "maxItems": 7, "type": [ "array", "null" ] }, "daily_timing": { "description": "Represents the start and end time of the break\nin `HH:MM` 24-hour format, applied uniformly\nto every day the break is scheduled. \n\n\nThis field is **mandatory** when the parent\n**same_as_everyday** is **true**. A day can\nhave at most two breaks and the total break\ntime on a day cannot exceed two hours.\n", "items": { "description": "Each string represents the start time or end time of the window in `HH:MM` 24-hour format.\n`HH:MM` 24-hour format. \"\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": [ "array", "null" ] }, "id": { "description": "Represents the unique identifier of the break hour within the shift hour.", "maxLength": 100, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ShiftHoursBreakHoursId" }, "same_as_everyday": { "description": "Indicates whether the break hour follows the\nsame timing on every day the break is\nscheduled. \n\n\nPossible values:\n\n- `true` - the break hour uses the same timing\nevery day, and `daily_timing` becomes\nmandatory.\n\n- `false` - the break hour uses different\ntiming for different days, and `custom_timing`\nbecomes mandatory.\n", "type": "boolean" } }, "required": [ "custom_timing", "daily_timing", "same_as_everyday", "id", "break_days" ], "type": "object" }, "maxItems": 2, "type": [ "array", "null" ] }, "custom_timing": { "description": "Lists per-day shift timing overrides. ", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the shift on that day. This field is mandatory when **same_as_everyday** is **false**.", "properties": { "days": { "description": "Represents the day of the week to which this\ncustom shift timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "shift_timing": { "description": "Represents the start and end time of the shift on the specified\nday in `HH:MM` 24-hour format. \n", "items": { "description": "Represents the start time or end time of the window in `HH:MM`\n24-hour format. The first array entry is the\nstart time and the second is the end time.\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": "array" } }, "required": [ "days", "shift_timing" ], "type": "object" }, "maxItems": 7, "type": [ "array", "null" ] }, "daily_timing": { "description": "Represents the start and end time of the shift in `HH:MM` 24-hour\nformat, applied uniformly to every active day. This\nfield is **mandatory** when **same_as_everyday** is\n**true**.\n", "items": { "description": "\"Represents the start time or end time of the window in `HH:MM`\n24-hour format. \"\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 2, "minItems": 2, "type": [ "array", "null" ] }, "holidays": { "description": "Lists the holidays observed during the shift hour. The holiday date must fall between the current and the next financial year.", "items": { "additionalProperties": false, "description": "Each entry specifies the date and the name of the holiday. ", "properties": { "date": { "description": "Represents the date of the holiday in `YYYY-MM-DD` format.", "format": "date", "type": "string" }, "id": { "description": "Represents the unique identifier of the holiday.", "maxLength": 100, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ShiftsId" }, "name": { "description": "Represents the name of the holiday. The name must not contain the special characters.", "maxLength": 80, "type": "string" }, "userFmt": { "description": "Represents the holiday date formatted using the date format configured for the requesting user.", "maxLength": 100, "type": "string" }, "year": { "description": "Represents the year of the holiday.", "maxLength": 100, "type": "string" } }, "required": [ "date", "year", "name", "userFmt", "id" ], "type": "object" }, "maxItems": 365, "type": [ "array", "null" ] }, "id": { "description": "Represents the unique identifier of the shift hour.", "maxLength": 100, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ShiftHoursId" }, "name": { "description": "Represents the name of the shift hour. The name must be unique within the organization and must not contain the special characters.", "maxLength": 80, "type": "string" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same\ntiming on every active day. \n\n\n**Possible values**:\n\n- **true** - the shift hour uses the same timing\nevery day, and **daily_timing** becomes mandatory.\n\n- **false** - the shift hour uses different timing\nfor different days, and **custom_timing** becomes\nmandatory.\n", "type": "boolean" }, "shift_days": { "description": "Lists the days of the week on which the shift hour\nis active. You can set shift timing only on the days\nyour organization operates.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "items": { "description": "Represents one day of the week on which the shift hour is active.\n", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "timezone": { "description": "Represents the time zone in which the shift hours are scheduled. Use a valid IANA time zone identifier such as `Asia/Kolkata` or `America/New_York`.", "maxLength": 100, "type": "string" }, "users": { "description": "Lists the users assigned to the shift hour. ", "items": { "additionalProperties": false, "description": "Each object specifies the user and the date from which the assignment becomes effective.", "properties": { "effective_from": { "description": "Represents the date from which the user assignment to the shift hour becomes effective, in `YYYY-MM-DD` format. The date must be in the future and must not be more than six months ahead of the current date.", "format": "date", "type": "string" }, "email": { "description": "Represents the email address of the user assigned to the shift hour.", "format": "email", "type": "string" }, "id": { "description": "Represents the unique identifier of the user assigned to the shift hour.", "maxLength": 100, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ShiftHoursUsersId" }, "name": { "description": "Represents the full name of the user assigned to the shift hour.", "maxLength": 100, "type": "string" }, "role": { "additionalProperties": false, "description": "Represents the role information of the user assigned to the shift hour.", "properties": { "id": { "description": "Represents the unique identifier of the role assigned to the user.", "maxLength": 100, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "ShiftHoursRoleId" }, "name": { "description": "Represents the name of the role assigned to the user.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "zuid": { "description": "Represents the unique identifier of the user assigned to the shift hour.", "maxLength": 100, "type": "string" } }, "required": [ "role", "name", "id", "email", "zuid", "effective_from" ], "type": "object" }, "maxItems": 200, "type": [ "array", "null" ] }, "users_count": { "description": "Represents the number of users currently assigned to the shift hour.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "custom_timing", "users_count", "holidays", "daily_timing", "timezone", "name", "break_hours", "shift_days", "same_as_everyday", "id", "users" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "shift_count", "shift_hours" ], "type": "object", "x-zs-$id": "ShiftHoursGetResponse" } } }, "description": "Returned when the shift hour configurations are retrieved successfully." }, "204": { "$ref": "#/components/responses/ShiftHoursNoContentResponse" }, "403": { "$ref": "#/components/responses/ShiftHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.READ" ] } ], "summary": "Get shift hours", "tags": [ "shift_hours" ], "x-zoho-document": "shift_hours" }, "post": { "description": "Creates one or more shift hour configurations for the organization. Each shift hour specifies the name, time zone, active days, timing, optional break windows, optional holidays, and optional user assignments. The shift hour timing must fall within the configured business hours, and the request is rejected if business hours are not enabled for the org.", "operationId": "createShifts", "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Example request payload for creating a new shift hour configuration.", "summary": "An example of create shift hour request.", "value": { "shift_hours": [ { "break_hours": [], "daily_timing": [ "09:00", "18:00" ], "holidays": [], "name": "New Shift", "same_as_everyday": true, "shift_days": [ "Monday", "Tuesday" ], "timezone": "Asia/Kolkata", "users": [] } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for creating one or more shift hour configurations. Each entry in `shift_hours` defines a shift with its timing, break hours, optional holidays, and assigned users.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations to be created or updated in the request. Each entry specifies a shift hour with its timing, break hours, holidays, and assigned users.", "items": { "additionalProperties": false, "description": "Each object represents one shift hour configuration to be created or updated. Each entry captures the shift name, time zone, active days, timing, optional break hours, holidays, and assigned users.", "properties": { "break_hours": { "description": "Lists the break windows scheduled within the shift hour. Each entry specifies the days the break applies to and the break timing for those days. A shift can have at most two break windows.", "items": { "additionalProperties": false, "description": "Each object represents one break window scheduled within the shift hour, including the days it applies to and the break timing.", "properties": { "break_days": { "description": "Lists the days of the week on which the break applies.", "items": { "description": "Represents one day of the week on which the\nbreak applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "custom_timing": { "description": "Lists per-day break timing overrides. Each entry specifies the day of the week and the start and end time of the break on that day. This field is **mandatory** when the parent **same_as_everyday** is **false**. ", "items": { "additionalProperties": false, "description": "Represents the break timing override for a specific day of the week.", "properties": { "break_timing": { "description": "Represents the start and end time of the break on the specified day\nin `HH:MM` 24-hour format. A break must be\nlonger than 15 minutes and shorter than 2\nhours.\n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. The first array\nentry is the start time and the second\nis the end time.\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" }, "days": { "description": "Represents the day of the week to which\nthis custom break timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" } }, "required": [ "break_timing", "days" ], "type": "object" }, "maxItems": 50, "type": "array" }, "daily_timing": { "description": "Represents the start and end time of the break\nin `HH:MM` 24-hour format, applied uniformly to\nevery day the break is scheduled. This field is\n**mandatory** when the parent\n**same_as_everyday** is **true**. \n\n\n> **Note**\n\n> A day can have at most two breaks and the\ntotal break time on a day cannot exceed two\nhours.\n", "items": { "description": "Each string epresents the start time or end time of the window in\n`HH:MM` 24-hour format. The first array entry\nis the start time and the second is the end\ntime.\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": "array" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same timing on every active day. When the value is **true**, the **daily_timing** array becomes mandatory; when the value is **false**, the **custom_timing** array becomes mandatory.", "maxLength": 100, "type": "string" } }, "required": [ "same_as_everyday" ], "type": "object" }, "maxItems": 50, "type": "array" }, "custom_timing": { "description": "Lists per-day shift timing overrides. Each entry specifies the day of the week and the start and end time of the shift on that day. This field is mandatory when **same_as_everyday** is **false**.", "items": { "additionalProperties": false, "description": "Each object represents the shift timing override for a specific day of the week.", "properties": { "days": { "description": "Represents the day of the week to which this\ncustom shift timing applies.\n\n\nPossible values: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "shift_timing": { "description": "Represents the start and end time of the shift on the specified\nday in `HH:MM` in the 24-hour format. \n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. The first array entry\nis the start time and the second is the end\ntime.\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" } }, "required": [ "shift_timing", "days" ], "type": "object" }, "maxItems": 50, "type": "array" }, "daily_timing": { "description": "Represents the start and end time of the shift in `HH:MM` 24-hour\nformat, applied uniformly to every active day. This\nfield is **mandatory** when **same_as_everyday** is\n**true**.\n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. The first array entry is the\nstart time and the second is the end time.\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": "array" }, "holidays": { "description": "Lists the holidays observed during the shift hour. Each entry specifies the date and the name of the holiday. The holiday date must fall between the current and the next financial year.", "items": { "additionalProperties": false, "description": "Each object represents one holiday observed during the shift hour, including the date and name of the holiday.", "properties": { "date": { "description": "Represents the date of the holiday in `YYYY-MM-DD` format.", "format": "date", "type": "string" }, "name": { "description": "Represents the name of the holiday. The name must not contain the special characters.", "maxLength": 80, "type": "string" } }, "required": [ "name", "date" ], "type": "object" }, "maxItems": 50, "type": "array" }, "name": { "description": "Represents the name of the shift hour. The name must be unique within the organization and must not contain the special characters.", "maxLength": 80, "type": "string" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same\ntiming on every active day. \n\n\n**Possible values**:\n\n- `true` - the shift hour uses the same timing every\nday, and `daily_timing` becomes mandatory.\n\n- `false` - the shift hour uses different timing for\ndifferent days, and `custom_timing` becomes mandatory.\n", "type": "boolean" }, "shift_days": { "description": "Lists the days of the week on which the shift hour is active. You can set shift timing only on the days your organization operates.", "items": { "description": "Represents one day of the week on which the shift\nhour is active.\n\n\n**Possible values**: \n\n- Monday\n\n-Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "timezone": { "description": "Represents the time zone in which the shift hours are scheduled. Use a valid IANA time zone identifier such as `Asia/Kolkata` or `America/New_York`.", "maxLength": 100, "type": "string" }, "users": { "description": "Lists the users assigned to the shift hour. Each entry specifies the user and the date from which the assignment becomes effective.", "items": { "additionalProperties": false, "description": "Each object represents one user assigned to the shift hour, including the user details and the effective date of the assignment.", "properties": { "id": { "description": "Represents the unique identifier of the user assigned to the shift hour.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "name", "timezone", "same_as_everyday" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object" }, "x-zs-llm-examples": [ "Default" ] } }, "description": "The request body contains the data required to perform the operation. ", "required": true }, "responses": { "201": { "$ref": "#/components/responses/ShiftHoursSuccessResponse" }, "207": { "$ref": "#/components/responses/ShiftHoursMultiStatusResponse" }, "400": { "content": { "application/json": { "examples": { "Default": { "description": "Example error response returned when the operation fails validation.", "summary": "An example error response.", "value": { "shift_hours": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.shift_hours[0].name" }, "message": "Shift Name already exists", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the request or response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each entry represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "limit": { "description": "Represents the maximum number of shift hours\nthat can be configured.\n\nPossible values: **50**.\n", "enum": [ 50 ], "format": "int32", "type": "integer" }, "limit_due_to": { "description": "Lists the fields that caused the limit to be exceeded.", "items": { "additionalProperties": false, "description": "Each object represents one field that contributed to exceeding the configured limit.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "shift_hours" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "limit", "limit_due_to" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Shift hours Limit exceeds" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseLimitExceeded" }, { "additionalProperties": false, "description": "Represents the request or response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. Each entry represents one shift hour with its timing, break hours, holidays, and assigned users.", "items": { "additionalProperties": false, "description": "Each object represents one shift hour configuration with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Business hours is not enabled" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponse" }, { "additionalProperties": false, "description": "Represents the response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each entry represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "name" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].name" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Shift Name already exists" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledDuplicateData" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "timezone" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].timezone" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledMandatoryNotFoundTimezone" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each entry represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "name" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].name" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledMandatoryNotFound" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "same_as_everyday" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].same_as_everyday", "$.shift_hours[0].break_hours[0].same_as_everyday" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledMandatoryNotFoundSameAsEveryday" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the field that the failing field depends on.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Daily timing required for \"Same hours everyday\" mode" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledDependentFieldMissingDailyTiming" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the field that the failing field depends on.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledDependentFieldMissingShiftDays" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "shift_days" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].shift_days" ], "type": "string" }, "maximum_length": { "description": "Represents the maximum length permitted for the field that caused the error.", "enum": [ 7 ], "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseMoreThan7ShiftDays" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "ALREADY_USED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that\ncaused the error.\n\n\n**Possible values**: \n\n- shift_days\n\n- days\n\n- break_days\n", "enum": [ "shift_days", "days", "break_days" ], "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Represents the existing entry that the duplicate value conflicts with.", "properties": { "api_name": { "description": "Represents the API name of the field\nthat caused the error.\n\n\n**Possible values**: \n\n- shift_days\n\n- days\n\n- break_days\n", "enum": [ "shift_days", "days", "break_days" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].shift_days[0]", "$.shift_hours[0].custom_timing[0].days", "$.shift_hours[0].break_hours[0].custom_timing[0].days", "$.shift_hours[0].break_hours[0].break_days[0]" ], "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].shift_days[1]", "$.shift_hours[0].custom_timing[1].days", "$.shift_hours[0].break_hours[0].custom_timing[1].days", "$.shift_hours[0].break_hours[0].break_days[1]" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Please avoid duplicate days" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursDuplicateDaysErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the field that the failing field depends on.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Custom timing required for \"Different hours everyday\" mode" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "MultipleBusinessHoursErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that\ncaused the error.\n\n\n**Possible values**: \n\n- shift_timing\n\n- break_timing\n", "enum": [ "shift_timing", "break_timing" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].custom_timing[0].shift_timing", "$.shift_hours[0].break_hours[0].custom_timing[0].break_timing" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledDependentFieldMissingDailyTimings" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "days" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].custom_timing[0].days", "$.shift_hours[0].break_hours[0].custom_timing[0].days" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledDependentFieldMissingDays" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that\ncaused the error.\n\n\n**Possible values**: \n\n- custom_timing\n\n- shift_timing\n\n- break_timing\n", "enum": [ "custom_timing", "shift_timing", "break_timing" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].custom_timing[0].shift_timing", "$.shift_hours[0].custom_timing[0].shift_timing[0]", "$.shift_hours[0].custom_timing[0].shift_timing[1]", "$.shift_hours[0].custom_timing", "$.shift_hours[0].break_hours[0].custom_timing[0].break_timing", "$.shift_hours[0].break_hours[0].custom_timing[0].break_timing[0]" ], "type": "string" }, "maximum_length": { "description": "Represents the maximum length permitted for the field that caused the error.", "enum": [ 2, 7 ], "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum length required for the field that caused the error.", "enum": [ 2 ], "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Invalid Time given", "invalid_data", "invalid data", "INVALID_DATA", "Shift hours Not within BusinessHours time" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataShiftTiming" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "daily_timing" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].daily_timing", "$.shift_hours[0].daily_timing[0]", "$.shift_hours[0].daily_timing[1]", "$.shift_hours[0].break_hours[0].daily_timing", "$.shift_hours[0].break_hours[0].daily_timing[0]" ], "type": "string" }, "maximum_length": { "description": "Represents the maximum length permitted for the field that caused the error.", "enum": [ 2 ], "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum length required for the field that caused the error.", "enum": [ 2 ], "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Invalid Time given", "invalid_data", "Shift hours Not within BusinessHours time" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataDailyTiming" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "break_hours" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].break_hours[1]" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Break Hours timing is over lapped" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledDependentFieldsMissingDailyTiming" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "break_hours" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].break_hours" ], "type": "string" }, "maximum_length": { "description": "Represents the maximum length permitted for the field that caused the error.", "enum": [ 2 ], "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataBreakHoursOverlap" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "date" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$shift_hours[0].holidays[0].date" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Date Should be between current and next financial year" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataHolidayDate" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "name" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].holidays[0].name" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledMandatoryHolidayNameMissing" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "date" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].holidays[0].date" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledMandatoryHolidayDateMissing" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].users[0].id" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursMandatoryNotFoundUserID" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].users[0].id" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Invalid user id" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataUserId" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "effective_from" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].users[0].effective_from" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Effective from should be greater than current date" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataEffectiveFromCurrentDate" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "effective_from" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].users[0].effective_from" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Effective from should be less than 6 months" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataEffectiveFromSixMonths" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "name" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].name" ], "type": "string" }, "maximum_length": { "description": "Represents the maximum length permitted for the field that caused the error.", "enum": [ 80 ], "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataBreakHoursOverlaps" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "timezone" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].timezone" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation", "enum": [ "Invalid Timezone given" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataBreakHoursOverlapsTiming" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that\ncaused the error.\n\n\n**Possible values**: \n\n- shift_days\n\n- days\n\n- break_days\n\n- custom_timing\n", "enum": [ "shift_days", "days", "break_days", "custom_timing" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.`, `$.shift_hours[0].custom_timing[0].days`, `$.shift_hours[0].break_hours[0].break_days[0]`, `$.shift_hours[0].break_hours[0].break_days`, `$.shift_hours[0].break_hours[0].custom_timing[0].days`, `$.shift_hours[0].break_hours[0].custom_timing`.", "enum": [ "$.shift_hours[0].shift_days[0]", "$.shift_hours[0].custom_timing[0].days", "$.shift_hours[0].break_hours[0].break_days[0]", "$.shift_hours[0].break_hours[0].break_days", "$.shift_hours[0].break_hours[0].custom_timing[0].days", "$.shift_hours[0].break_hours[0].custom_timing" ], "type": "string" }, "supported_values": { "description": "Lists the values that are accepted for the field that caused the error.", "items": { "description": "Each string represents one value accepted\nfor the field that caused the error.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Invalid days", "invalid data" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataBreakHoursOverlapTimings" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that\ncaused the error.\n\n\n**Possible values** : \n\n- daily_timing\n\n- custom_timing\n\n- days\n", "enum": [ "daily_timing", "custom_timing", "days" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].break_hours[0].daily_timing", "$.shift_hours[0].break_hours[1].daily_timing", "$.shift_hours[0].break_hours[0].custom_timing[0].break_timing", "$.shift_hours[0].break_hours[0].custom_timing[0].days" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "The timing of the break hours fall outside the shift" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataBreakHoursOverlapTimingsDetails" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response.", "items": { "additionalProperties": false, "description": " Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that\ncaused the error.\n\n\n**Possible values**: \n\n- break_timing\n\n- daily_timing\n", "enum": [ "break_timing", "daily_timing" ], "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the field that the failing field depends on.", "properties": { "api_name": { "description": "Represents the API name of the field\nthat caused the error.\n\n\n**Possible values**: \n\n- break_timing\n\n- daily_timing\n", "enum": [ "break_timing", "daily_timing" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].break_hours[0].daily_timing[0]", "$.shift_hours[0].break_hours[0].custom_timing[0].break_timing[0]" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].break_hours[0].daily_timing[1]", "$.shift_hours[0].break_hours[0].custom_timing[0].break_timing[1]" ], "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "break timing should be greater than 15 minutes and less than 2 hours" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataBreakHoursOverlapsTimingDetails" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "enum": [ "name" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "enum": [ "$.shift_hours[0].name", "$.shift_hours[0].holidays[0].name" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Shift Name should not contain special characters:%, ^, &", "Holiday Name should not contain special characters:#, %, ^, &" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseBusinessHoursNotEnabledInvalidDataBreakHoursTimingOverlap" } ], "description": "Represents the request or response body for the operation.", "x-zs-$id": "ShiftHoursErrorResponses" } } }, "description": "Returned when the request fails validation. The response identifies the failing field and the reason." }, "403": { "$ref": "#/components/responses/ShiftHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.CREATE" ] } ], "summary": "Add shift hours", "tags": [ "shift_hours" ], "x-zoho-document": "shift_hours" }, "put": { "description": "Updates one or more shift hour configurations for the organization. Each entry in `shift_hours` identifies the shift hour to update and the fields to change, such as the time zone, active days, timing, break windows, holidays, or user assignments. The updated timing must fall within the configured business hours.", "operationId": "updateShiftHours", "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Example request payload for updating one or more shift hour configurations.", "summary": "An example response of successful update shift hours.", "value": { "shift_hours": [ { "break_hours": [], "daily_timing": [ "09:00", "18:00" ], "holidays": [], "name": "Updated Shift", "same_as_everyday": true, "shift_days": [ "Monday", "Tuesday" ], "timezone": "Asia/Kolkata", "users": [] } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for updating one or more shift hour configurations. Each entry in `shift_hours` updates an existing shift with its timing, break hours, optional holidays, and assigned users.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations to be created or updated in the request. ", "items": { "additionalProperties": false, "description": "Each object specifies a shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "break_hours": { "description": "Lists the break windows scheduled within the shift hour. A shift can have at most two break windows.", "items": { "additionalProperties": false, "description": "Each object specifies the days the break applies to and the break timing for those days.", "properties": { "break_days": { "description": "Lists the days of the week on which the break hour applies.", "items": { "description": "Represents one day of the week on which the\nbreak hour applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Thursday\n\n- Friday\n\n- Sunday\n\n- Wednesday\n\n- Tuesday\n\n- Saturday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "custom_timing": { "description": "Lists per-day break timing overrides. This field is **mandatory** when the parent **same_as_everyday** is **false**. A day can have at most two breaks and the total break time on a day cannot exceed two hours.", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the break on that day. ", "properties": { "break_timing": { "description": "Represents the start and end time of the break on the specified day\nin `HH:MM` 24-hour format. A break must be\nlonger than 15 minutes and shorter than 2\nhours.\n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" }, "days": { "description": "Represents the day of the week to which\nthis custom break timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "daily_timing": { "description": "Represents the start and end time of the break\nin `HH:MM` 24-hour format, applied uniformly to\nevery day the break is scheduled. \n\n\nThis field is **mandatory** when the parent\n**same_as_everyday** is **true**. A day can have\nat most two breaks and the total break time on a\nday cannot exceed two hours.\n", "items": { "description": "\"Represents the start time or end time of the window in `HH:MM`\n24-hour format. \"\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": "array" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same timing on every active day. When the value is **true**, the **daily_timing** array becomes mandatory; when the value is **false**, the **custom_timing** array becomes mandatory.", "maxLength": 100, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "custom_timing": { "description": "Lists per-day shift timing overrides. This field is **mandatory** when **same_as_everyday** is **false**.", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the shift on that day. ", "properties": { "days": { "description": "Represents the day of the week to which this\ncustom shift timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "shift_timing": { "description": "Represents the start and end time of the shift on the specified\nday in `HH:MM` 24-hour format. \n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "daily_timing": { "description": "Represents the start and end time of the shift in `HH:MM` 24-hour\nformat, applied uniformly to every active day. This\nfield is **mandatory** when **same_as_everyday** is\n**true**.\n", "items": { "description": "\"Represents the start time or end time of the window in `HH:MM`\n24-hour format. \"\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": "array" }, "holidays": { "description": "Lists the holidays observed during the shift hour. The holiday date must fall between the current and the next financial year.", "items": { "additionalProperties": false, "description": "Each object specifies the date and the name of the holiday. ", "properties": { "date": { "description": "Represents the date of the holiday in `YYYY-MM-DD` format.", "format": "date", "type": "string" }, "name": { "description": "Represents the name of the holiday. The name must not contain the special characters.", "maxLength": 80, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "name": { "description": "Represents the name of the shift hour. The name must be unique within the organization and must not contain the special characters.", "maxLength": 80, "type": "string" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same\ntiming on every active day. \n\n\n**Possible values**:\n\n- **true** - the shift hour uses the same timing every\nday, and **daily_timing** becomes mandatory.\n\n- **false** - the shift hour uses different timing for\ndifferent days, and **custom_timing** becomes\nmandatory.\n", "type": "boolean" }, "shift_days": { "description": "Lists the days of the week on which the shift hour is active. You can set shift timing only on the days your organization operates.", "items": { "description": "Each string represents one day of the week on which\nthe shift hour is active.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "timezone": { "description": "Represents the time zone in which the shift hours are scheduled. ", "maxLength": 100, "type": "string" }, "users": { "description": "Lists the users assigned to the shift hour.", "items": { "additionalProperties": false, "description": " Each object specifies the user and the date from which the assignment becomes effective.", "properties": { "id": { "description": "Represents the unique identifier of the user assigned to the shift hour.", "maxLength": 100, "type": "string" } }, "type": "object" }, "maxItems": 200, "type": "array" } }, "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object" }, "x-zs-llm-examples": [ "Default" ] } }, "description": "The request body contains the data required to perform the operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Example success response returned when the shift hour update completes successfully.", "summary": "Update shift hours response example", "value": { "shift_hours": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Success", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ShiftHoursSuccessResponse", "description": "Response body details" } } }, "description": "Returned when the shift hour update completes successfully." }, "207": { "$ref": "#/components/responses/ShiftHoursMultiStatusResponse" }, "400": { "content": { "application/json": { "examples": { "Default": { "description": "Example error response returned when the operation fails validation.", "summary": "An example of error response.", "value": { "shift_hours": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.shift_hours[0].name" }, "message": "Shift Name should not contain special characters:#, %, ^", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response.", "items": { "additionalProperties": false, "description": " Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "ALREADY_USED", "DEPENDENT_FIELD_MISSING", "DEPENDENT_MISMATCH", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursUpdateErrorResponse" } } }, "description": "Returned when the request fails validation. The response identifies the failing field and the reason." }, "403": { "$ref": "#/components/responses/ShiftHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.UPDATE" ] } ], "summary": "Update shift hours", "tags": [ "shift_hours" ], "x-zoho-document": "shift_hours" } }, "/crm/v8/settings/business_hours/shift_hours/{shift}": { "delete": { "description": "Deletes the shift hour identified by the `shift` path parameter. Once deleted, the shift hour configuration and all of its user assignments are removed.", "operationId": "deleteSingleShiftHour", "parameters": [ { "$ref": "#/components/parameters/Shift" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Example success response returned when the shift hour is deleted successfully.", "summary": "Delete shift hour response example", "value": { "shift_hours": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Success", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ShiftHoursSuccessResponse", "description": "Response body details" } } }, "description": "Returned when the shift hour is deleted successfully." }, "400": { "content": { "application/json": { "examples": { "Default": { "description": "Example error response returned when the operation fails validation.", "summary": "An example of an error response.", "value": { "code": "INVALID_DATA", "details": {}, "message": "Invalid ID", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the request or response body for the operation.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the outcome of the operation.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the path parameter that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "enum": [ "Invalid ID" ], "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ShiftHoursDeleteErrorResponse" } } }, "description": "Returned when the request fails validation. The response identifies the failing field and the reason." }, "403": { "$ref": "#/components/responses/ShiftHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.DELETE" ] } ], "summary": "Delete a shift hour", "tags": [ "shift_hours" ], "x-zoho-document": "shift_hours" }, "get": { "description": "Retrieves the configuration of the shift hour identified by the `shift` path parameter, including its timing, break hours, holidays, time zone, and the users assigned to it.", "operationId": "getSingleShiftHour", "parameters": [ { "$ref": "#/components/parameters/Shift" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Example response returned when retrieving a specific shift hour configuration.", "summary": "An example of successful shift hour response.", "value": { "shift_count": { "total_shift_with_user": 0 }, "shift_hours": [ { "break_hours": [], "custom_timing": [], "daily_timing": [ "09:00", "18:00" ], "holidays": [], "id": "1234567890", "name": "General Shift", "same_as_everyday": true, "shift_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata", "users": [], "users_count": 0 } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_count": { "additionalProperties": false, "description": "Represents aggregate counts that summarize the shift hour configurations returned in the response.", "properties": { "total_shift_with_user": { "description": "Represents the total number of shift hours that have at least one user assigned.", "format": "int32", "type": "integer" } }, "required": [ "total_shift_with_user" ], "type": "object" }, "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "break_hours": { "description": "Lists the break windows scheduled within the shift hour. A shift can have at most two break windows.", "items": { "additionalProperties": false, "description": "Each object specifies the days the break applies to and the break timing for those days. ", "properties": { "break_days": { "description": "Lists the days of the week on which the break hour applies.", "items": { "description": "Each string represents a day of the week on which the break hour applies.", "maxLength": 100, "type": "string" }, "maxItems": 7, "type": "array" }, "custom_timing": { "description": "Lists per-day break timing overrides. \n\n This field is **mandatory** when the parent **same_as_everyday** is **false**. A day can have at most two breaks and the total break time on a day cannot exceed two hours.", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the break on that day.", "properties": { "break_timing": { "description": "Represents the start and end time of the break on the specified day\nin `HH:MM` 24-hour format. A break must\nbe longer than 15 minutes and shorter\nthan 2 hours.\n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" }, "days": { "description": "Represents the day of the week to which\nthis custom break timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "maxLength": 100, "type": "string" } }, "required": [ "days", "break_timing" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "daily_timing": { "description": "Represents the start and end time of the break\nin `HH:MM` 24-hour format, applied uniformly\nto every day the break is scheduled. \n\n\nThis field is **mandatory** when the parent\n**same_as_everyday** is **true**. A day can\nhave at most two breaks and the total break\ntime on a day cannot exceed two hours.\n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": "array" }, "id": { "description": "Represents the unique identifier of the break hour within the shift hour.", "maxLength": 100, "type": "string", "x-zs-$id": "SingleShiftHourBreakHoursId" }, "same_as_everyday": { "description": "Indicates whether the break hour follows the\nsame timing on every day the break is\nscheduled. \n\n\n**Possible values**:\n\n- **true** - the break hour uses the same\ntiming every day, and **daily_timing** becomes\nmandatory.\n\n- **false** - the break hour uses different\ntiming for different days, and\n**custom_timing** becomes mandatory.\n", "type": "boolean" } }, "required": [ "same_as_everyday", "break_days", "daily_timing", "custom_timing", "id" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "custom_timing": { "description": "Lists per-day shift timing overrides. This field is **mandatory** when **same_as_everyday** is **false**.", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the shift on that day. ", "properties": { "days": { "description": "Represents the day of the week to which this\ncustom shift timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "maxLength": 100, "type": "string" }, "shift_timing": { "description": "Represents the start and end time of the shift on the specified\nday in `HH:MM` 24-hour format. \n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" } }, "required": [ "days", "shift_timing" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "daily_timing": { "description": "Represents the start and end time of the shift in `HH:MM` 24-hour\nformat, applied uniformly to every active day. This\nfield is **mandatory** when **same_as_everyday** is\n**true**.\n", "items": { "description": "Each object represents the start time or end time of the window in\n`HH:MM` 24-hour format.\n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": [ "array", "null" ] }, "holidays": { "description": "Lists the holidays observed during the shift hour. The holiday date must fall between the current and the next financial year.", "items": { "additionalProperties": false, "description": "Each object specifies the date and the name of the holiday.", "properties": { "date": { "description": "Represents the date of the holiday in `YYYY-MM-DD` format.", "format": "date", "type": "string" }, "id": { "description": "Represents the unique identifier of the holiday.", "maxLength": 100, "type": "string", "x-zs-$id": "ShiftHoursHolidaysId" }, "name": { "description": "Represents the name of the holiday. The name must not contain the special characters.", "maxLength": 80, "type": "string" }, "userFmt": { "description": "Represents the holiday date formatted using the date format configured for the requesting user.", "maxLength": 100, "type": "string" }, "year": { "additionalProperties": false, "description": "Represents the year of the holiday.", "type": "object" } }, "required": [ "date", "year", "name", "id", "userFmt" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "id": { "description": "Represents the unique identifier of the shift hour.", "maxLength": 100, "type": "string", "x-zs-$id": "SingleShiftHourId" }, "name": { "description": "Represents the name of the shift hour. The name must be unique within the organization and must not contain the special characters.", "maxLength": 80, "type": "string" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same\ntiming on every active day. \n\n\n**Possible values**:\n\n- **true** - the shift hour uses the same timing\nevery day, and **daily_timing** becomes mandatory.\n\n- **false** - the shift hour uses different timing\nfor different days, and **custom_timing** becomes\nmandatory.\n", "type": "boolean" }, "shift_days": { "description": "Lists the days of the week on which the shift hour is active. You can set shift timing only on the days your organization operates.", "items": { "description": "Represents the day of the week on which the shift\nhour is active.\n\n\n**Possible values**: \n\n- **Monday**\n\n- **Tuesday**\n\n- **Wednesday**\n\n- **Thursday**\n\n- **Friday**\n\n- **Saturday**\n\n- **Sunday**\n", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "timezone": { "description": "Represents the time zone in which the shift hours are scheduled. ", "maxLength": 100, "type": "string" }, "users": { "description": "Lists the users assigned to the shift hour. Each entry specifies the user and the date from which the assignment becomes effective.", "items": { "additionalProperties": false, "description": "Each object represents one user assigned to the shift hour, including the user details and the effective date of the assignment.", "properties": { "effective_from": { "description": "Represents the date from which the user assignment to the shift hour becomes effective, in `YYYY-MM-DD` format. The date must be in the future and must not be more than six months ahead of the current date.", "format": "date", "type": "string" }, "email": { "description": "Represents the email address of the user assigned to the shift hour.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the user assigned to the shift hour.", "maxLength": 100, "type": "string", "x-zs-$id": "SingleShiftHourUsersId" }, "name": { "description": "Represents the full name of the user assigned to the shift hour.", "maxLength": 100, "type": "string" }, "role": { "additionalProperties": false, "description": "Represents the role information of the user assigned to the shift hour.", "properties": { "id": { "description": "Represents the unique identifier of the role assigned to the user.", "maxLength": 100, "type": "string", "x-zs-$id": "SingleShiftHourRoleId" }, "name": { "description": "Represents the name of the role assigned to the user.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "zuid": { "description": "Represents the unique identifier of the user assigned to the shift hour.", "maxLength": 100, "type": "string" } }, "required": [ "role", "name", "id", "email", "zuid", "effective_from" ], "type": "object" }, "maxItems": 200, "type": [ "array", "null" ] }, "users_count": { "description": "Represents the number of users currently assigned to the shift hour.", "format": "int32", "type": "integer" } }, "required": [ "same_as_everyday", "shift_days", "daily_timing", "custom_timing", "id", "break_hours", "users", "holidays", "users_count", "timezone", "name" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "shift_hours", "shift_count" ], "type": "object", "x-zs-$id": "ShiftHoursSuccessResponseGetSingle" } } }, "description": "Returned when the requested shift hour configuration is retrieved successfully." }, "204": { "$ref": "#/components/responses/ShiftHoursNoContentResponse" }, "403": { "$ref": "#/components/responses/ShiftHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.READ" ] } ], "summary": "Get a shift hour", "tags": [ "shift_hours" ], "x-zoho-document": "shift_hours" }, "put": { "description": "Updates the configuration of the shift hour identified by the `shift` path parameter. The request body specifies the fields to change, such as the time zone, active days, timing, break windows, holidays, or user assignments. The updated timing must fall within the configured business hours.", "operationId": "updateSingleShiftHour", "parameters": [ { "$ref": "#/components/parameters/Shift" } ], "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Example request payload for updating the shift hour identified by the `shift` path parameter.", "summary": "An example of successful update single shift hour response.", "value": { "shift_hours": [ { "break_hours": [], "daily_timing": [ "09:00", "18:00" ], "holidays": [], "name": "Updated Shift", "same_as_everyday": true, "shift_days": [ "Monday", "Tuesday" ], "timezone": "Asia/Kolkata", "users": [] } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for updating one or more shift hour configurations. Each entry in `shift_hours` updates an existing shift with its timing, break hours, optional holidays, and assigned users.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations to be created or updated in the request. ", "items": { "additionalProperties": false, "description": "Each object specifies a shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "break_hours": { "description": "Lists the break windows scheduled within the shift hour. A shift can have at most two break windows.", "items": { "additionalProperties": false, "description": "Each object specifies the days the break applies to and the break timing for those days.", "properties": { "break_days": { "description": "Lists the days of the week on which the break hour applies.", "items": { "description": "Represents one day of the week on which the\nbreak hour applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "custom_timing": { "description": "Lists per-day break timing overrides. This field is **mandatory** when the parent **same_as_everyday** is **false**. A day can have at most two breaks and the total break time on a day cannot exceed two hours.", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the break on that day. ", "properties": { "break_timing": { "description": "Represents the start and end time of the break on the specified day\nin `HH:MM` 24-hour format. A break must be\nlonger than 15 minutes and shorter than 2\nhours.\n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" }, "days": { "description": "Represents the day of the week to which\nthis custom break timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "daily_timing": { "description": "Represents the start and end time of the break\nin `HH:MM` 24-hour format, applied uniformly to\nevery day the break is scheduled. \n\n\nThis field is **mandatory** when the parent\n**same_as_everyday** is **true**. A day can have\nat most two breaks and the total break time on a\nday cannot exceed two hours.\n", "items": { "description": "Each string epresents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": "array" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same timing on every active day. When the value is **true**, the **daily_timing** array becomes mandatory; when the value is **false**, the **custom_timing** array becomes mandatory.", "maxLength": 100, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "custom_timing": { "description": "Lists per-day shift timing overrides. This field is **mandatory** when **same_as_everyday** is **false**.", "items": { "additionalProperties": false, "description": "Each object specifies the day of the week and the start and end time of the shift on that day.", "properties": { "days": { "description": "Represents the day of the week to which this\ncustom shift timing applies.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "shift_timing": { "description": "Represents the start and end time of the shift on the specified\nday in `HH:MM` 24-hour format. \n", "items": { "description": "Each string represents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 7, "type": "array" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "daily_timing": { "description": "Represents the start and end time of the shift in `HH:MM` 24-hour\nformat, applied uniformly to every active day. This\nfield is **mandatory** when **same_as_everyday** is\n**true**.\n", "items": { "description": "Each string epresents the start time or end time of the window in\n`HH:MM` 24-hour format. \n", "maxLength": 5, "pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$", "type": "string" }, "maxItems": 50, "type": "array" }, "holidays": { "description": "Lists the holidays observed during the shift hour. The holiday date must fall between the current and the next financial year.", "items": { "additionalProperties": false, "description": "Each object specifies the date and the name of the holiday. ", "properties": { "date": { "description": "Represents the date of the holiday in `YYYY-MM-DD` format.", "format": "date", "type": "string" }, "name": { "description": "Represents the name of the holiday. The name must not contain the special characters.", "maxLength": 80, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "name": { "description": "Represents the name of the shift hour. The name must be unique within the organization and must not contain the special characters.", "maxLength": 80, "type": "string" }, "same_as_everyday": { "description": "Indicates whether the shift hour follows the same\ntiming on every active day. \n\n\n**Possible values**:\n\n- **true** - the shift hour uses the same timing every\nday, and **daily_timing** becomes mandatory.\n\n- **false** - the shift hour uses different timing for\ndifferent days, and **custom_timing** becomes\nmandatory.\n", "type": "boolean" }, "shift_days": { "description": "Lists the days of the week on which the shift hour is\nactive. You can set shift timing only on the days your\norganization operates.\n\n\n**Possible values**: \n\n- Monday\n\n- Tuesday\n\n- Wednesday\n\n- Thursday\n\n- Friday\n\n- Saturday\n\n- Sunday\n", "items": { "description": "Each string represents one day of the week on which the shift hour is active.\n\n", "enum": [ "Monday", "Thursday", "Friday", "Sunday", "Wednesday", "Tuesday", "Saturday" ], "type": "string" }, "maxItems": 7, "type": "array" }, "timezone": { "description": "Represents the time zone in which the shift hours are scheduled. ", "maxLength": 100, "type": "string" }, "users": { "description": "Lists the users assigned to the shift hour. ", "items": { "additionalProperties": false, "description": "Each object specifies the user and the date from which the assignment becomes effective.", "properties": { "id": { "description": "Represents the unique identifier of the user assigned to the shift hour.", "maxLength": 100, "type": "string" } }, "type": "object" }, "maxItems": 200, "type": "array" } }, "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object" }, "x-zs-llm-examples": [ "Default" ] } }, "description": "Represents the request body for updating one or more shift hour configurations. ", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Example success response returned when the shift hour update completes successfully.", "summary": "Update shift hours response example", "value": { "shift_hours": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Success", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ShiftHoursSuccessResponse", "description": "Response body details" } } }, "description": "Returned when the shift hour update completes successfully." }, "207": { "$ref": "#/components/responses/ShiftHoursMultiStatusResponse" }, "400": { "content": { "application/json": { "examples": { "Default": { "description": "Example error response returned when the operation fails validation.", "summary": "An example of error response.", "value": { "shift_hours": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.shift_hours[0].name" }, "message": "Shift Name already exists", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "shift_hours": { "description": "Lists the shift hour configurations returned in the response. ", "items": { "additionalProperties": false, "description": "Each object represents one shift hour with its timing, break hours, holidays, and assigned users.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "ALREADY_USED", "DEPENDENT_FIELD_MISSING", "DEPENDENT_MISMATCH", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the outcome of the operation.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "ShiftHoursErrorResponseUpdateSingle" }, { "additionalProperties": false, "description": "Represents the error response body for the operation.", "properties": { "code": { "description": "Represents the response code that identifies the outcome of the operation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the outcome of the operation.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the path parameter that caused the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ShiftHoursInvalidURLErrorResponse" } ], "description": "Represents the error response body for the operation.", "x-zs-$id": "ShiftHoursSingleUpdateErrorResponses" } } }, "description": "Returned when the request fails validation. The response identifies the failing field and the reason." }, "403": { "$ref": "#/components/responses/ShiftHoursForbiddenResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.UPDATE" ] } ], "summary": "Update a shift hour", "tags": [ "shift_hours" ], "x-zoho-document": "shift_hours" } }, "/crm/v8/settings/call_preferences": { "get": { "description": "To retrieve the current Call Preferences configuration for your Zoho CRM organization. The response reports whether the **From Number** and **To Number** fields are currently enabled on records in the Calls module.", "operationId": "getCallPreferences", "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the get Call Preferences response that reports both the **From Number** and **To Number** fields as currently enabled on records in the Calls module.", "summary": "Retrieved Call Preferences with both fields enabled", "value": { "call_preferences": { "show_from_number": true, "show_to_number": true } } } }, "schema": { "additionalProperties": false, "description": "Returned when the Call Preferences configuration is successfully retrieved. Contains the **call_preferences** object with the current visibility setting for each preference.", "properties": { "call_preferences": { "additionalProperties": false, "description": "Contains the current Call Preferences configuration for your Zoho CRM organization in the **Calls** module.", "properties": { "show_from_number": { "description": "Indicates whether the **From Number** field is currently enabled on records in the Calls module. \n**Possible values:**\n**true** - The **From Number** field is enabled and appears on Call records.\n**false** - The **From Number** field is disabled and is hidden from Call records.", "type": "boolean" }, "show_to_number": { "description": "Indicates whether the **To Number** field is currently enabled on records in the Calls module. \n**Possible values:**\n**true** - The **To Number** field is enabled and appears on Call records.\n**false** - The **To Number** field is disabled and is hidden from Call records.", "type": "boolean" } }, "required": [ "show_from_number", "show_to_number" ], "type": "object" } }, "type": "object", "x-zs-$id": "Successresponse" } } }, "description": "Returns the current Call Preferences configuration for the Zoho CRM organization, reporting whether the **From Number** and **To Number** fields are enabled on records in the Calls module." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "None", "summary": "None", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have permission to perform this operation.", "properties": { "code": { "description": "Represents the error code for the authorization failure. The value is **NO_PERMISSION**.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details with authorization information.", "properties": { "permissions": { "description": "Represents the list of permissions required for this operation.", "items": { "description": "Represents a required permission for the user.", "maxLength": 255, "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the authorization failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the error status. The value is **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "NoPermissionErrorResponse" } } }, "description": "The user does not have permission to access call preferences." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.read" ] } ], "summary": "Call Preferences", "tags": [ "call_preferences" ], "x-zoho-document": "call_preferences" }, "put": { "description": "To update the Call Preferences configuration for your Zoho CRM organization by enabling or disabling the **From Number** and **To Number** fields on records in the Calls module. A preference cannot be disabled when the corresponding field is marked as mandatory, when it is referenced by a Validation Rule, Layout Rule, Blueprint, or Workflow, or when the organization has an active telephony integration or active calendar booking for calls that depends on it.", "operationId": "updateCallPreferences", "requestBody": { "content": { "application/json": { "examples": { "RequestBody": { "description": "Shows an update Call Preferences request that enables both the **From Number** and **To Number** fields on records in the Calls module.", "summary": "Enable both From Number and To Number on Call records", "value": { "call_preferences": { "show_from_number": true, "show_to_number": true } } } }, "schema": { "additionalProperties": false, "description": "Specify the new visibility setting for the **From Number** field, the **To Number** field, or both.", "properties": { "call_preferences": { "additionalProperties": false, "description": "Specify the new visibility setting for one or both Call Preferences. Omit a preference from the object to leave its current setting unchanged.", "properties": { "show_from_number": { "description": "Specify whether the **From Number** field must appear on records in the Calls module. \n**Possible values:**\n**true** - Enable the **From Number** field on Call records.\n**false** - Disable the **From Number** field and hide it from Call records.", "type": "boolean" }, "show_to_number": { "description": "Specify whether the **To Number** field must appear on records in the Calls module. \n**Possible values:**\n**true** - Enable the **To Number** field on Call records.\n**false** - Disable the **To Number** field and hide it from Call records.", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "x-zs-llm-examples": [ "RequestBody" ] } }, "description": "The request body must contain a **call_preferences** object that specifies the new visibility setting for the **From Number** field, the **To Number** field, or both.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the successful update response that returns the SUCCESS code, confirming the Call Preferences update for the Zoho CRM organization.", "summary": "Call Preferences updated successfully", "value": { "call_preferences": { "code": "SUCCESS", "details": {}, "message": "calls preferences updated successfully", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Returned when the Call Preferences are successfully updated. Contains a **call_preferences** object that confirms the update outcome.", "properties": { "call_preferences": { "additionalProperties": false, "description": "Contains the update result for the Call Preferences configuration, including the result code, status, and message.", "properties": { "code": { "description": "Represents the result code of the update action. \n**Possible values:**\n**SUCCESS** - Reports successful update of the Call Preferences configuration.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional information about the update action. This object remains empty for a successful Call Preferences update.", "type": "object" }, "message": { "description": "Describes the update result in plain text so that it can be displayed to the developer.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the outcome of the request. \n**Possible values:**\n**success** - The request completed successfully.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" } }, "type": "object", "x-zs-$id": "PutSuccessresponse" } } }, "description": "Returns the result of the update action, confirming the Call Preferences update for the Zoho CRM organization." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the INVALID_DATA response returned when the value supplied for **show_from_number** is not a Boolean. The response identifies the offending preference and the expected data type.", "summary": "Preference value is not a Boolean", "value": { "call_preferences": { "code": "INVALID_DATA", "details": { "api_name": "show_from_number", "expected_data_type": "boolean", "json_path": "$.preferences.show_from_number" }, "message": "Invalid data", "status": "error" } } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the request payload itself is rejected, either because a supplied value is not the expected data type or because the targeted field cannot be disabled under the current Zoho CRM configuration.", "properties": { "call_preferences": { "additionalProperties": false, "description": "Contains the per-preference error variant returned when the update Call Preferences request payload fails validation.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Detail field: expected_data_type", "enum": [ "boolean" ], "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ValueOtherThanBooleanError" } }, "required": [ "call_preferences" ], "type": "object", "x-zs-$id": "Possibleerrors" }, { "additionalProperties": false, "description": "Returned when the request uses an HTTP method that is not supported on this endpoint.", "properties": { "call_preferences": { "additionalProperties": false, "description": "Error details wrapped under call_preferences key", "properties": { "code": { "description": "Error code", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with validation information", "properties": { "api_name": { "description": "Detail field: api_name", "enum": [ "show_from_number", "show_to_number" ], "type": "string" }, "json_path": { "description": "Detail field: json_path", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" } }, "required": [ "call_preferences" ], "type": "object", "x-zs-$id": "Integrationenablederror" }, { "additionalProperties": false, "description": "Invalid HTTP method to access the API URL.", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the error response", "type": "object" }, "message": { "description": "Error message", "maxLength": 255, "type": "string" }, "status": { "description": "Error Status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "InvalidHTTPmethodtoaccesstheAPIURL" } ], "description": "Returned when the update Call Preferences request fails validation. The response carries one of the per-request error variants, depending on the failure type.", "x-zs-$id": "PutErrorResponse400" } } }, "description": "The update Call Preferences request is invalid. Resolution: The request payload, the data types of the supplied values, and the eligibility of the targeted fields for disablement must all satisfy the operation's validation rules." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.update" ] } ], "summary": "Call Preferences", "tags": [ "call_preferences" ], "x-zoho-document": "call_preferences" } }, "/crm/v8/settings/custom_views": { "delete": { "description": "To delete one or more Custom Views from a specified module in your Zoho CRM organization.", "operationId": "deleteCustomView", "parameters": [ { "$ref": "#/components/parameters/CustomViewsIds" }, { "$ref": "#/components/parameters/CustomViewsModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a success response for the delete Custom View operation.", "summary": "Delete Custom View success response", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000004030016" }, "message": "deleted successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response schema for a successful Custom View deletion.", "properties": { "custom_views": { "description": "Represents the list of Custom Views deleted successfully.", "items": { "$ref": "#/components/schemas/CustomViewDeleteSuccess" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewDeleteSuccessResponse" } } }, "description": "Returns a success response indicating that all specified Custom Views were deleted." }, "207": { "content": { "application/json": { "examples": { "PartialSuccessResponse": { "description": "Shows a partial success and failure response for the delete Custom View operation.", "summary": "Partial delete success and failure", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000004030016" }, "message": "deleted successfully", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "12" }, "message": "The provided CustomView is either invalid or already Deleted", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response for the delete operation, containing a mix of success and failure items.", "properties": { "custom_views": { "allOf": [ { "description": "Represents a successful deletion item for a Custom View." }, { "description": "Represents a deletion failure item for a Custom View." } ], "description": "Represents the list of Custom View deletion results, including both successful and failed items.", "items": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewDeleteSuccess" }, { "$ref": "#/components/schemas/CustomViewDeleteFailure" } ], "description": "Represents a deletion result item, which can be either a success or a failure response." }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewDeleteMultiStatusFailureDetails" } } }, "description": "Returns a multi-status response when the deletion partially succeeded. Each item indicates whether the deletion succeeded or failed for that Custom View." }, "400": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows an error response when one or more Custom View IDs provided for deletion are invalid.", "summary": "Invalid Custom View ID error", "value": { "custom_views": [ { "code": "INVALID_DATA", "details": { "id": "12" }, "message": "The provided CustomView is either invalid or already Deleted", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/CustomViewDeleteItem", "description": "Wrapped error: per-item delete failures inside custom_views array" } ], "description": "Represents the error response for an invalid delete Custom View request.", "x-zs-$id": "DeleteCustomViewFailureResponse" } } }, "description": "The Custom View ID in the request is invalid or the view has already been deleted. Resolution: Verify that the Custom View IDs in the request are valid and the views have not already been deleted." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the delete Custom View operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the delete Custom View operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" }, { "$ref": "#/components/schemas/CvProfilePermissionError" } ], "description": "Represents the error response for an unauthorized delete Custom View request.", "x-zs-$id": "DeleteCustomViewUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.DELETE scope." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a permission denied response for the delete Custom View operation.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse", "x-zs-$id": "CustomViewDeleteForbiddenResponse" } } }, "description": "Permission denied to delete Custom Views for this module. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.DELETE" ] } ], "summary": "Delete Custom Views", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" }, "get": { "description": "To retrieve the list of all Custom Views configured for a specified module in your Zoho CRM organization.", "operationId": "getCustomViews", "parameters": [ { "$ref": "#/components/parameters/CustomViewsModule" }, { "$ref": "#/components/parameters/CustomViewsFilters" }, { "$ref": "#/components/parameters/CustomViewsPage" }, { "$ref": "#/components/parameters/CustomViewsPerPage" }, { "$ref": "#/components/parameters/CustomViewsIds" }, { "$ref": "#/components/parameters/Scope" }, { "$ref": "#/components/parameters/Favourite" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a list of Custom Views retrieved for a module with pagination metadata.", "summary": "Get all Custom Views success response", "value": { "custom_views": [ { "access_type": "only_to_me", "category": "created_by_me", "created_by": { "id": "2411194000000478001", "name": "Jess Moana" }, "created_time": "2025-11-17T09:55:04-02:00", "default": false, "display_value": "Character limit tooltip", "id": "2411194000003855598", "last_accessed_time": "2025-11-26T09:00:24-02:00", "locked": false, "modified_by": { "id": "2411194000000478001", "name": "Jess Moana" }, "modified_time": "2025-11-26T02:50:12-02:00", "name": "Character limit tooltip", "system_defined": false, "system_name": null } ], "info": { "count": 10, "default": "2411194000004030016", "more_records": false, "page": 1, "per_page": 200, "translation": { "created_by_me": "Created By Me", "other_users_views": "Other User's Views", "public_views": "Public Views", "shared_with_me": "Shared With Me" } } } } }, "schema": { "$ref": "#/components/schemas/GetAllCustomViewsResponse" } } }, "description": "Returns the list of Custom Views for the specified module, along with pagination metadata." }, "400": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows an error response when the request URL or module is invalid.", "summary": "Invalid request error", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/FilterInvalidParamDataType", "description": "Filter criteria error: invalid filter param data type" }, { "$ref": "#/components/schemas/FilterNotSupportedApiName", "description": "Filter criteria error: unsupported API name" }, { "$ref": "#/components/schemas/FilterFieldComparatorValueMissing", "description": "Filter criteria error: field comparator value missing" }, { "$ref": "#/components/schemas/FilterFieldComparatorMismatch", "description": "Filter criteria error: field comparator mismatch" }, { "$ref": "#/components/schemas/FilterFieldValueMismatch", "description": "Filter criteria error: field value mismatch" }, { "$ref": "#/components/schemas/FilterComparatorValueMismatch", "description": "Filter criteria error: comparator value mismatch" }, { "$ref": "#/components/schemas/FilterInvalidComparator", "description": "Filter criteria error: invalid comparator" }, { "$ref": "#/components/schemas/FilterEmptyFilterObject", "description": "Filter criteria error: empty filter object" }, { "$ref": "#/components/schemas/FilterMandatoryNotFound", "description": "Filter criteria error: mandatory field not found" } ], "description": "Represents the error response for an invalid get Custom Views request.", "x-zs-$id": "GetAllCustomViewsFailureResponse" } } }, "description": "The request URL or module is invalid. Resolution: A valid module API name must be provided in the **module** query parameter." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the get all Custom Views operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the get all Custom Views operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" } ], "description": "Represents the error response for an unauthorized get Custom Views request.", "x-zs-$id": "GetCustomViewsUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.READ scope." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a permission denied response for the get all Custom Views operation.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse" } } }, "description": "Permission denied to retrieve Custom Views for this module. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.READ" ] } ], "summary": "Get All Custom Views", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" }, "post": { "description": "To create one or more Custom Views for a specified module in your Zoho CRM organization.", "operationId": "createCustomView", "parameters": [ { "$ref": "#/components/parameters/CustomViewsModule" } ], "requestBody": { "content": { "application/json": { "examples": { "PostRequestBody": { "description": "Shows a create Custom View request body with a name, filter criteria, sort configuration, and field list.", "summary": "Create Custom View request body", "value": { "custom_views": [ { "access_type": "shared", "criteria": { "comparator": "contains", "field": { "api_name": "City", "id": "2411194000000000605" }, "type": "value", "value": "e" }, "cross_filters": [ { "criteria": { "group": [ { "comparator": "equal", "field": { "api_name": "Created_By", "id": "2411194000000000285" }, "type": "value", "value": { "id": "2411194000000478001", "name": "Jess Moana" } }, { "comparator": "equal", "field": { "api_name": "Parent_Id", "id": "2411194000000000283" }, "value": "${NOTEMPTY}" } ], "group_operator": "and" }, "include_objects": true, "relation": { "api_name": "Notes__r", "id": "2411194000000282522" } } ], "fields": [ { "_pin": false, "api_name": "First_Name", "id": "2411194000000000557" }, { "_pin": false, "api_name": "Last_Name", "id": "2411194000000000559" }, { "_pin": false, "api_name": "Company", "id": "2411194000000000555" }, { "_pin": false, "api_name": "Email", "id": "2411194000000000563" } ], "locked": false, "name": "crossfilter1", "shared_to": [ { "id": "2411194000000478001", "name": "Jess Moana", "subordinates": null, "type": "users" } ], "sort_by": { "api_name": "Created_Time", "id": "2411194000000000129" }, "sort_order": "desc", "wrap_text": true } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body envelope for creating one or more Custom Views.", "properties": { "custom_views": { "description": "Specify the list of Custom Views to create.", "items": { "$ref": "#/components/schemas/CustomViewPostItem" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object" } } }, "description": "The request body must contain a custom_views array with one or more objects, each specifying the configuration for a new Custom View.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "PostSuccessResponse": { "description": "Shows a success response for the create Custom View operation, including the ID of the created view.", "summary": "Custom view created successfully", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000004076067" }, "message": "custom view created", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the bulk create success response schema for Custom View creation.", "properties": { "custom_views": { "description": "Represents the list of Custom Views created successfully.", "items": { "$ref": "#/components/schemas/CustomViewPostSuccessResponse" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewBulkCreateSuccessResponse" } } }, "description": "Returns the details of the Custom Views created successfully." }, "207": { "content": { "application/json": { "examples": { "PostMultiStatusResponse": { "description": "Shows a bulk create multi-status response with both successful and failed items.", "summary": "Bulk create multi-status response", "value": { "custom_views": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.custom_views[0].name" }, "message": "duplicate data", "status": "error" }, { "code": "SUCCESS", "details": { "id": "2411194000004308079" }, "message": "custom view created", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response for bulk Custom View creation, containing a mix of success and failure items.", "properties": { "custom_views": { "allOf": [ { "description": "Represents a successful creation item for a Custom View." }, { "description": "Represents a creation failure item for a Custom View." } ], "description": "Represents the list of Custom View creation results, including both successful and failed items.", "items": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewPostSuccessResponse" }, { "$ref": "#/components/schemas/CustomViewCreateFailureItem" } ], "description": "Represents a creation result item, which can be either a success or a failure response." }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewCreateMultiStatusFailureDetails" } } }, "description": "Returns a multi-status response when the bulk creation partially succeeded. Each item indicates whether the creation succeeded or failed for that Custom View." }, "400": { "content": { "application/json": { "examples": { "PostErrorResponse": { "description": "Shows an error response when the create Custom View request contains invalid data.", "summary": "Create Custom View validation error", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "name" }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/CustomViewCreateFailureResponse", "description": "Wrapped error: per-item creation failures inside custom_views array" } ], "description": "Represents the error response for an invalid create Custom View request.", "x-zs-$id": "CustomViewCreateFailureResponseWrapper" } } }, "description": "The request contains invalid data or a required parameter is missing. Resolution: Verify that all required fields are present and contain valid values." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the create Custom View operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the create Custom View operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" }, { "$ref": "#/components/schemas/CvProfilePermissionError" } ], "description": "Represents the error response for an unauthorized create Custom View request.", "x-zs-$id": "CreateCustomViewUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.CREATE scope." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a permission denied response for the create Custom View operation.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "permission denied", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse" }, { "$ref": "#/components/schemas/ForbiddenErrorResponse" } ], "description": "Represents the error response for a forbidden create Custom View request.", "x-zs-$id": "CustomViewCreateForbiddenResponse" } } }, "description": "Permission denied to create Custom Views for this module. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.CREATE" ] } ], "summary": "CustomView creation", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" }, "put": { "description": "To update the configuration of one or more Custom Views in bulk for a specified module in your Zoho CRM organization.", "operationId": "updateCustomViewsBulk", "parameters": [ { "$ref": "#/components/parameters/CustomViewsModule" } ], "requestBody": { "content": { "application/json": { "examples": { "PutRequestBody": { "description": "Shows a bulk update request body with multiple Custom View configurations.", "summary": "Bulk update Custom Views request body", "value": { "custom_views": [ { "id": "2411194000004076067", "name": "test1" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body envelope for bulk updating one or more Custom Views.", "properties": { "custom_views": { "description": "Specify the list of Custom Views to update in bulk. Each object must include the Custom View ID and the fields to update.", "items": { "$ref": "#/components/schemas/CustomViewPutBulkItem" }, "maxItems": 200, "type": "array" } }, "type": "object" } } }, "description": "The request body must contain a custom_views array with one or more objects, each specifying the ID and updated configuration for a Custom View.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "PutRequestBody": { "description": "Shows a success response for the bulk update Custom Views operation.", "summary": "Bulk update success response", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000004076067" }, "message": "custom view updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CustomViewUpdateSuccessResponse" } } }, "description": "Returns a success response indicating that all specified Custom Views were updated successfully." }, "207": { "content": { "application/json": { "examples": { "PutRequestBody": { "description": "Shows a partial success and failure response for the bulk update operation.", "summary": "Bulk update partial success response", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000004076067" }, "message": "custom view updated", "status": "success" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.custom_views[0].name" }, "message": "duplicate data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response for the bulk update operation, containing a mix of success and failure items.", "properties": { "custom_views": { "allOf": [ { "description": "Represents a successful bulk update item for a Custom View." }, { "description": "Represents a bulk update failure item for a Custom View." } ], "description": "Represents the list of bulk update results, including both successful and failed items.", "items": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewUpdateSuccess" }, { "$ref": "#/components/schemas/CustomViewWrapFailure" }, { "$ref": "#/components/schemas/CustomViewUpdateFailureItem" } ], "description": "Represents a bulk update result item, which can be either a success or a failure response." }, "maxItems": 200, "minItems": 2, "type": "array" } }, "type": "object", "x-zs-$id": "CustomViewUpdateMultiStatusFailureDetails" } } }, "description": "Returns a multi-status response when the bulk update partially succeeded. Each item indicates whether the update succeeded or failed for that Custom View." }, "400": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows an error response when the bulk update request contains invalid data.", "summary": "Bulk update validation error", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "name" }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/CustomViewUpdateFailureDetails", "description": "Wrapped error: per-item update failures inside custom_views array" } ], "description": "Represents the error response for an invalid bulk update request.", "x-zs-$id": "CustomViewBulkUpdateFailureResponse" } } }, "description": "The request contains invalid data or a required field is missing. Resolution: Verify that all required fields are present and contain valid values, and that each object in the array includes a valid Custom View ID." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the bulk update operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the bulk update operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" }, { "$ref": "#/components/schemas/CvProfilePermissionError" } ], "description": "Represents the error response for an unauthorized bulk update request.", "x-zs-$id": "UpdateCustomViewsBulkUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.UPDATE scope." }, "403": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows a permission denied response for the bulk update operation.", "summary": "Permission denied", "value": { "custom_views": [ { "code": "NO_PERMISSION", "details": { "api_name": "id", "json_path": "$.custom_views[0].id" }, "message": "Permission denied. Locked custom views cannot be customized.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse" }, { "$ref": "#/components/schemas/ForbiddenErrorResponse" } ], "description": "Represents the error response for a forbidden bulk update request.", "x-zs-$id": "CustomViewBulkUpdateForbiddenResponse" } } }, "description": "Permission denied to update Custom Views for this module. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.UPDATE" ] } ], "summary": "Custom Views", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" } }, "/crm/v8/settings/custom_views/actions/change_sort": { "put": { "description": "To change the sort field and sort order for one or more Custom Views in the specified module of your Zoho CRM organization.", "operationId": "changeSort", "parameters": [ { "$ref": "#/components/parameters/CustomViewsModule" } ], "requestBody": { "content": { "application/json": { "examples": { "ChangeSortRequest": { "description": "Shows a change sort request body with a Custom View ID and sort order.", "summary": "Change sort order request body", "value": { "custom_views": [ { "id": "2411194000000091501", "sort_by": { "api_name": "Full_Name", "id": "2411194000000000597" }, "sort_order": "asc" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for changing the sort order of one or more Custom Views.", "properties": { "custom_views": { "description": "Specify the list of Custom Views for which to update the sort order.", "items": { "additionalProperties": false, "description": "Represents the sort order update details for a single Custom View.", "properties": { "id": { "description": "Specify the unique ID of the Custom View for which to update the sort order.", "format": "int64", "maxLength": 25, "type": "string" }, "sort_by": { "$ref": "#/components/schemas/CustomViewsFieldReference" }, "sort_order": { "description": "Specify the sort order for the Custom View.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "enum": [ "asc", "desc" ], "type": "string" } }, "required": [ "id", "sort_by", "sort_order" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "custom_views" ], "type": "object" } } }, "description": "The request body must contain a custom_views array with one or more objects, each specifying the Custom View ID and the new sort order.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a success response for the change sort operation.", "summary": "Change sort success response", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000000091501" }, "message": "custom view updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CustomViewUpdateSuccessResponse" } } }, "description": "Returns a success response indicating that all specified Custom Views received the updated sort order." }, "207": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows a partial success and failure response for the change sort operation.", "summary": "Partial success and failure response", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000003890058" }, "message": "custom view updated", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.custom_views[1].id" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response for the change sort operation, containing a mix of success and failure items.", "properties": { "custom_views": { "allOf": [ { "description": "Represents a successful sort update item for a Custom View." }, { "description": "Represents a sort update failure item for a Custom View." } ], "description": "Represents the list of Custom View sort update results, including both successful and failed items.", "items": { "anyOf": [ { "$ref": "#/components/schemas/CustomViewUpdateSuccess" }, { "$ref": "#/components/schemas/CustomViewSortFailureItem" } ], "description": "Represents a sort update result item, which can be either a success or a failure response." }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "custom_views" ], "type": "object", "x-zs-$id": "CustomViewChangeSortMultiStatusFailureDetails" } } }, "description": "Returns a multi-status response when the sort update partially succeeded. Each item in the response indicates whether the update succeeded or failed for that Custom View." }, "400": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows an error response when the sort field or sort order value is invalid.", "summary": "Invalid sort field or order error", "value": { "custom_views": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.custom_views[0].sort_by.api_name" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/CustomViewSortFailureDetails", "description": "Wrapped error: per-item sort failures inside custom_views array" } ], "description": "Represents the error response for an invalid sort request.", "x-zs-$id": "ChangeSortFailureResponse" } } }, "description": "The sort field or sort order value in the request is invalid. Resolution: The sort field must be a valid field API name and the sort order must be either **asc** or **desc**." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the change sort operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the change sort operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" } ], "description": "Represents the error response for an unauthorized sort request.", "x-zs-$id": "ChangeSortUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.UPDATE scope." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a permission denied response for the change sort operation.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse" } } }, "description": "Permission denied to change the sort order of Custom Views for this module. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.UPDATE" ] } ], "summary": "Sort Order", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" } }, "/crm/v8/settings/custom_views/{id}": { "get": { "description": "To retrieve the details of a specific Custom View for a module in your Zoho CRM organization, using the Custom View ID.", "operationId": "getCustomViewById", "parameters": [ { "$ref": "#/components/parameters/CustomViewsId" }, { "$ref": "#/components/parameters/CustomViewsModule" }, { "$ref": "#/components/parameters/CustomViewsInclude" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the full details of a Custom View retrieved by its ID, including filter criteria and field configuration.", "summary": "Get Custom View by ID success response", "value": { "custom_views": [ { "$modified_criteria": false, "access_type": "shared", "category": "created_by_me", "created_by": { "id": "2411194000000478001", "name": "Jess Moana" }, "created_time": "2025-11-27T07:37:52-02:00", "criteria": { "$disrupted": false, "comparator": "contains", "field": { "api_name": "Full_Name", "id": "2411194000000000597", "ui_type": 27 }, "type": "value", "value": "1" }, "cross_filters": [ { "criteria": { "group": [ { "$disrupted": false, "comparator": "contains", "field": { "api_name": "Note_Title", "id": "2411194000000000279", "ui_type": 20 }, "type": "value", "value": "e" }, { "$disrupted": false, "comparator": "equal", "field": { "api_name": "Parent_Id", "id": "2411194000000000283", "ui_type": 4 }, "type": "value", "value": "${NOTEMPTY}" } ], "group_operator": "AND" }, "include_objects": true, "relation": { "$disrupted": false, "api_name": "Notes__r", "id": "2411194000000282522" } } ], "default": true, "display_value": "crossfilter", "favorite": 7, "fields": [ { "_pin": false, "api_name": "First_Name", "id": "2411194000000000557" }, { "_pin": false, "api_name": "Last_Name", "id": "2411194000000000559" }, { "_pin": false, "api_name": "Company", "id": "2411194000000000555" }, { "_pin": false, "api_name": "Email", "id": "2411194000000000563" } ], "id": "2411194000004030016", "last_accessed_time": "2025-11-27T09:12:18-02:00", "locked": false, "modified_by": { "id": "2411194000000478001", "name": "Jess Moana" }, "modified_time": "2025-11-27T07:39:34-02:00", "name": "crossfilter", "shared_to": [ { "id": "2411194000000478001", "name": "Jess Moana", "subordinates": null, "type": "users" } ], "sort_by": null, "sort_order": null, "system_defined": false, "system_name": null } ], "info": { "translation": { "created_by_me": "Created By Me", "other_users_views": "Other User's Views", "public_views": "Public Views", "shared_with_me": "Shared With Me" } } } } }, "schema": { "$ref": "#/components/schemas/GetCustomViewByIdResponse" } } }, "description": "Returns the details of the specified Custom View, including its filter criteria, sort configuration, field list, and access control settings." }, "204": { "description": "No content - the given Custom View ID does not match any existing Custom View in the specified module." }, "400": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows an error response when the request URL or module is invalid.", "summary": "Invalid request error", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/ResourcePathIndexErrorResponse", "description": "Flat error: invalid resource path segment" } ], "description": "Represents the error response for an invalid get Custom View by ID request.", "x-zs-$id": "GetCustomViewByIdFailureResponse" } } }, "description": "The request URL or module is invalid. Resolution: A valid module API name and Custom View ID must be provided in the request." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the get Custom View by ID operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the get Custom View by ID operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" } ], "description": "Represents the error response for an unauthorized get Custom View by ID request.", "x-zs-$id": "GetCustomViewByIdUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.READ scope." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a permission denied response for the get Custom View by ID operation.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse" } } }, "description": "Permission denied to retrieve the specified Custom View. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.READ" ] } ], "summary": "Get Custom View By Id", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" }, "put": { "description": "To update the configuration of a specific Custom View in a module of your Zoho CRM organization, using the Custom View ID. Use the [Get Custom Views API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the custom view IDs.", "operationId": "updateCustomView", "parameters": [ { "$ref": "#/components/parameters/CustomViewsModule" }, { "$ref": "#/components/parameters/CustomViewsId" } ], "requestBody": { "content": { "application/json": { "examples": { "PutRequestBody": { "description": "Shows an update Custom View request body with the updated name, filter criteria, and sort configuration.", "summary": "Update Custom View request body", "value": { "custom_views": [ { "name": "updatedName" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body envelope for updating a specific Custom View by its ID.", "properties": { "custom_views": { "description": "Specify the list of Custom View configurations to update.", "items": { "$ref": "#/components/schemas/CustomViewPutByIdItem" }, "maxItems": 1, "type": "array" } }, "required": [ "custom_views" ], "type": "object" } } }, "description": "The request body must contain a custom_views array with one object specifying the updated configuration for the Custom View.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "PutSuccessResponse": { "description": "Shows a success response for the update Custom View operation, including the ID of the updated view.", "summary": "Custom view updated successfully", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000004076067" }, "message": "custom view updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CustomViewUpdateSuccessResponse" } } }, "description": "Returns a success response indicating that the Custom View update completed successfully." }, "400": { "content": { "application/json": { "examples": { "PutErrorResponse": { "description": "Shows an error response when the update Custom View request contains invalid data.", "summary": "Update Custom View validation error", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/CustomViewUpdateFailureDetails", "description": "Wrapped error: per-item update failures inside custom_views array" }, { "$ref": "#/components/schemas/ResourcePathIndexErrorResponse", "description": "Flat error: invalid resource path segment" } ], "description": "Represents the error response for an invalid update Custom View request.", "x-zs-$id": "CustomViewUpdateFailureResponse" } } }, "description": "The request contains invalid data or a required field is missing. Resolution: Verify that all required fields are present and contain valid values." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the update Custom View operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the update Custom View operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" }, { "$ref": "#/components/schemas/CvProfilePermissionError" } ], "description": "Represents the error response for an unauthorized update Custom View request.", "x-zs-$id": "UpdateCustomViewUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.UPDATE scope." }, "403": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows a permission denied response for the update Custom View operation.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": { "resource_path_index": 2 }, "message": "Permission denied. Locked custom views cannot be customized.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse" }, { "$ref": "#/components/schemas/ForbiddenByIdErrorResponse" } ], "description": "Represents the error response for a forbidden update Custom View request.", "x-zs-$id": "CustomViewUpdateForbiddenErrorResponse" } } }, "description": "Permission denied to update the specified Custom View. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.UPDATE" ] } ], "summary": "CustomView update", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" } }, "/crm/v8/settings/custom_views/{id}/actions/change_sort": { "put": { "description": "To change the sort field and sort order for a specific Custom View in the specified module of your Zoho CRM organization. Use the [Get Custom Views Metadata API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the custom view IDs.\"", "operationId": "changeSortById", "parameters": [ { "$ref": "#/components/parameters/CustomViewsModule" }, { "$ref": "#/components/parameters/CustomViewsId" } ], "requestBody": { "content": { "application/json": { "examples": { "ChangeSortRequest": { "description": "The request body must contain a custom_views array with one object specifying the new sort order for the Custom View.", "summary": "Change sort order by ID request body", "value": { "custom_views": [ { "sort_by": { "api_name": "Full_Name", "id": "2411194000000000597" }, "sort_order": "asc" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for changing the sort order of a specific Custom View.", "properties": { "custom_views": { "description": "Specify the sort order configuration to apply to the Custom View.", "items": { "additionalProperties": false, "description": "Represents the sort order configuration details.", "properties": { "sort_by": { "$ref": "#/components/schemas/CustomViewsFieldReference" }, "sort_order": { "description": "Specify the sort order for the Custom View.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "enum": [ "asc", "desc" ], "type": "string" } }, "required": [ "sort_by", "sort_order" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "custom_views" ], "type": "object" } } }, "description": "The request body must contain a custom_views array with one object specifying the new sort order for the Custom View.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a success response for the change sort by ID operation.", "summary": "Change sort by ID success response", "value": { "custom_views": [ { "code": "SUCCESS", "details": { "id": "2411194000000091501" }, "message": "custom view updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CustomViewUpdateSuccessResponse" } } }, "description": "Returns a success response indicating that the sort order update completed for the specified Custom View." }, "400": { "content": { "application/json": { "examples": { "FailureResponse": { "description": "Shows an error response when the sort order value is invalid.", "summary": "Invalid sort order error", "value": { "custom_views": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.custom_views[0].sort_by.api_name" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UrlErrorResponseForCustomView", "description": "Flat error: URL/module validation failures" }, { "$ref": "#/components/schemas/RequiredParameterMissingResponse", "description": "Flat error: required query parameter missing" }, { "$ref": "#/components/schemas/CustomViewSortByIdFailureDetails", "description": "Wrapped error: per-item sort-by-ID failures inside custom_views array" }, { "$ref": "#/components/schemas/ResourcePathIndexErrorResponse", "description": "Flat error: invalid resource path segment" } ], "description": "Represents the error response for an invalid sort by ID request.", "x-zs-$id": "ChangeSort400Response" } } }, "description": "The sort field or sort order value in the request is invalid. Resolution: The sort order must be either **asc** or **desc**." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows an authentication failure response for the change sort by ID operation.", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows an OAuth scope mismatch error for the change sort by ID operation.", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AuthenticationError" }, { "$ref": "#/components/schemas/UnauthorizedResponse" } ], "description": "Represents the error response for an unauthorized sort by ID request.", "x-zs-$id": "ChangeSortByIdUnauthorizedResponse" } } }, "description": "Authentication failed or the OAuth access token does not include the required scope. Resolution: A new access token must be generated with the ZohoCRM.settings.custom_views.UPDATE scope." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows a permission denied response for the change sort by ID operation.", "summary": "Permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleForbiddenErrorResponse" } } }, "description": "Permission denied to change the sort order of the specified Custom View. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.custom_views.UPDATE" ] } ], "summary": "Sort Order by ID", "tags": [ "custom_views" ], "x-zoho-document": "custom_views" } }, "/crm/v8/settings/data_sharing": { "get": { "description": "To retrieve your organization's default data-sharing permissions for modules.", "operationId": "getDataSharing", "responses": { "200": { "content": { "application/json": { "examples": { "DataSharingGetSuccessResponse": { "value": { "data_sharing": [ { "module": { "api_name": "Leads", "id": "111111000000002652" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Accounts", "id": "111111000000002656" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Contacts", "id": "111111000000002654" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Deals", "id": "111111000000002658" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Campaigns", "id": "111111000000002668" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Tasks", "id": "111111000000002676" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Events", "id": "111111000000002678" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Calls", "id": "111111000000002680" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Cases", "id": "111111000000002748" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Solutions", "id": "111111000000002754" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Products", "id": "111111000000002756" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "public_read_only" }, { "module": { "api_name": "Vendors", "id": "111111000000002758" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Price_Books", "id": "111111000000002760" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Quotes", "id": "111111000000002762" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Sales_Orders", "id": "111111000000002766" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Purchase_Orders", "id": "111111000000002770" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Invoices", "id": "111111000000002774" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" }, { "module": { "api_name": "Emails", "id": "111111000000002778" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "public" }, { "module": { "api_name": "Visits", "id": "111111000000002694" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "public" }, { "module": { "api_name": "Testing_Testing", "id": "111111000000119002" }, "public_in_portals": false, "rule_computation_running": false, "share_type": "private" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the organization's default data sharing settings.", "properties": { "data_sharing": { "description": "Contains the organization's default data-sharing permissions for each module.", "items": { "additionalProperties": false, "description": "Object containing the data-sharing permission details for a module.", "properties": { "module": { "additionalProperties": false, "description": "Specifies the module's API name and ID.", "properties": { "api_name": { "description": "Specifies the API name of the module.", "maxLength": 100, "type": "string" }, "id": { "description": "Specifies the unique ID of the module.", "maxLength": 19, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "public_in_portals": { "description": "Indicates whether the module is configured in public portals. **Possible values:** ** true** - The module is configured in public portals. **false** - The module is not configured in public portals.", "type": "boolean" }, "rule_computation_running": { "description": "Indicates whether a sharing rule computation is currently running for the module. If you rerun a rule configured for a module, this key is true until the process completes. If the value is false, no rules are currently running for the module. **Possible values:** **true** - A sharing rule computation is running for the module. **false** - No sharing rule computation is running for the module.", "type": "boolean" }, "share_type": { "description": "Represents the access level for the module. **Possible values:** **private** - Only the record owner and their superior can view the records in the module. **public_read_only** - Users can view others' records but cannot modify or delete them. **public_read_write** - Users can view and modify others' records but cannot delete them. **public** - Users can view, modify, and delete others' records.", "enum": [ "private", "public_read_write", "public", "public_read_only" ], "type": "string" } }, "required": [ "share_type", "public_in_portals", "module", "rule_computation_running" ], "type": "object" }, "maxItems": 600, "type": "array" } }, "required": [ "data_sharing" ], "type": "object", "x-zs-$id": "DataSharingGetResponse" } } }, "description": "The data sharing settings were retrieved successfully." }, "403": { "content": { "application/json": { "examples": { "DataSharingGetForbidden": { "summary": "Data Sharing Get Forbidden", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Data_Sharing" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the user does not have the Crm_Implied_Manage_Data_Sharing permission to retrieve data sharing settings.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional error details.", "properties": { "permissions": { "description": "Array containing the list of missing permissions required to perform the operation.", "items": { "description": "The name of the required permission.", "enum": [ "Crm_Implied_Manage_Data_Sharing" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "A message describing the error.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DataSharingGetForbidden" } } }, "description": "The user does not have the required permission to retrieve data sharing settings." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.data_sharing.READ" ] }, { "OAuth2": [ "ZohoCRM.settings.data_sharing.ALL" ] } ], "summary": "Data Sharing Settings", "tags": [ "data_sharing" ], "x-zoho-document": "data_sharing" }, "put": { "description": "To update your organization's default data-sharing permissions for modules. You can modify data-sharing access for both system-defined and custom modules.", "operationId": "updateDataSharing", "requestBody": { "content": { "application/json": { "examples": { "UpdateDataSharingRequestBody": { "summary": "Update Data Sharing Request Body", "value": { "data_sharing": [ { "module": { "api_name": "Leads", "id": "111111000000002652" }, "share_type": "private" } ] } } }, "schema": { "additionalProperties": false, "description": "Root request body for updating data sharing settings.", "properties": { "data_sharing": { "description": "Contains the details of your organization's default data-sharing permissions for modules.", "items": { "additionalProperties": false, "description": "Object containing the module and its data-sharing permission details.", "properties": { "module": { "additionalProperties": false, "description": "Contains the API name and ID of the module for which you want to change user access. Mandatory.", "properties": { "api_name": { "description": "Represents the API name of the module.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Represents the unique ID of the module.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } } }, "required": [ "id" ], "type": "object" }, "share_type": { "description": "Represents the access level you want to set for the module. **Possible values:** **private** - Only the record owner and their superior can view the records in the module. **public_read_only** - Users can view others' records but cannot modify or delete them. **public_read_write** - Users can view and modify others' records but cannot delete them. **public** - Users can view, modify, and delete others' records.", "enum": [ "private", "public_read_write", "public", "public_read_only" ], "type": "string" } }, "required": [ "share_type", "module" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data_sharing" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "UpdateDataSharingSuccessResponse": { "value": { "data_sharing": [ { "code": "SUCCESS", "details": { "module": "Leads" }, "message": "data sharing settings updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the update status for data sharing settings.", "properties": { "data_sharing": { "description": "Array containing the update status for each module's data sharing setting.", "items": { "additionalProperties": false, "description": "Object containing the update status details for a module's data sharing setting.", "properties": { "code": { "description": "The status code of the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional details about the updated module.", "properties": { "module": { "description": "The API name of the module whose data sharing setting was updated.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "A message describing the result of the operation.", "enum": [ "data sharing settings updated successfully" ], "type": "string" }, "status": { "description": "Indicates the operation status.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data_sharing" ], "type": "object", "x-zs-$id": "UpdateDataSharingResponse" } } }, "description": "The data sharing settings were updated successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataType": { "value": { "data_sharing": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.data_sharing[0].module.api_name" }, "message": "invalid data", "status": "error" } ] } }, "InvalidModuleId": { "value": { "data_sharing": [ { "code": "INVALID_DATA", "details": { "api_name": "module", "json_path": "$.data_sharing[0].module" }, "message": "invalid data", "status": "error" } ] } }, "InvalidSharingType": { "value": { "data_sharing": [ { "code": "INVALID_DATA", "details": { "api_name": "share_type", "json_path": "$.data_sharing[0].share_type", "regex": "private|public_read_only|public_read_write|public" }, "message": "invalid data", "status": "error" } ] } }, "PublicModuleInPortalsError": { "value": { "data_sharing": [ { "code": "NOT_ALLOWED", "details": { "api_name": "module", "json_path": "$.data_sharing[0].module" }, "message": "Cannot change the data sharing setting as module is made public in portals", "status": "error" } ] } }, "UpdateLimitExceeded": { "value": { "code": "INVALID_DATA", "details": { "api_name": "data_sharing", "json_path": "$.data_sharing", "maximum_length": 100 }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response containing an array of error details in the data_sharing key.", "properties": { "data_sharing": { "description": "Array containing the error details for each module's data sharing setting.", "items": { "additionalProperties": false, "description": "Object containing the error details for a module's data sharing setting.", "properties": { "code": { "description": "Represents the error code identifying the type of error. **INVALID_DATA**- Indicates invalid input such as an invalid share_type or module. **NOT_ALLOWED**- Indicates the module is public in portals and cannot be modified.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional details about the error, such as the field name and JSON path that caused the error.", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "The expected data type of the field.", "enum": [ "text", "bigint" ], "type": "string" }, "json_path": { "description": "The JSON path of the field that caused the error.", "maxLength": 2147483647, "type": "string" }, "regex": { "description": "The expected regex pattern for the field value.", "enum": [ "private|public_read_only|public_read_write|public" ], "type": "string" } }, "type": "object" }, "message": { "description": "A message describing the error.", "enum": [ "invalid data", "Cannot change the data sharing setting as module is made public in portals" ], "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateDataSharingErrorDetailsResponse" }, { "additionalProperties": false, "description": "Flat error response returned when the request exceeds the maximum number of data sharing settings or contains structurally invalid input.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional details about the error.", "properties": { "api_name": { "description": "The API name of the field that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "The JSON path of the field that caused the error.", "maxLength": 2147483647, "type": "string" }, "maximum_length": { "description": "The maximum number of items allowed in the request.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "A message describing the error.", "enum": [ "invalid data" ], "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "UpdateDataSharingErrorResponse" } ], "x-zs-$id": "UpdateDataSharingBadRequest" } } }, "description": "The request failed due to invalid data, missing mandatory fields, or an attempt to modify a module that is public in portals." }, "403": { "content": { "application/json": { "examples": { "DataSharingPutForbidden": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Data_Sharing" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the user does not have the Crm_Implied_Manage_Data_Sharing permission to update data sharing settings.", "properties": { "code": { "description": "The error code identifying the type of error.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional error details.", "properties": { "permissions": { "description": "Array containing the list of permissions required to perform the operation.", "items": { "description": "The name of the required permission.", "enum": [ "Crm_Implied_Manage_Data_Sharing" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "A message describing the error.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "The status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DataSharingPermissionDenied" } } }, "description": "The user does not have the required permission to update data sharing settings." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.data_sharing.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.settings.data_sharing.ALL" ] } ], "summary": "Data Sharing Settings", "tags": [ "data_sharing" ], "x-zoho-document": "data_sharing" } }, "/crm/v8/settings/duplicate_check_preference": { "delete": { "description": "To delete the duplicate check preference configured for the Leads module in your Zoho CRM organization.", "operationId": "deleteDuplicateCheckPreference", "parameters": [ { "$ref": "#/components/parameters/DuplicateCheckPreferenceModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "DuplicateCheckPreferenceForContacts": { "description": "Returns a success response confirming that duplicate checking for mapped_module_records was disabled successfully.", "summary": "Duplicate check preference for Contacts", "value": { "duplicate_check_preference": { "code": "SUCCESS", "details": {}, "message": "Duplicate check disabled for mapped_module_records successfully.", "status": "success" } } }, "DuplicateCheckPreferenceForConvertedLead": { "summary": "Duplicate check preference for converted Leads", "value": { "duplicate_check_preference": { "code": "SUCCESS", "details": {}, "message": "Duplicate check disabled for converted_records successfully.", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned after the API deletes the duplicate check preference.", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Details of the deleted duplicate check preference", "properties": { "code": { "description": "Response code indicating the result of the deletion", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the deletion operation", "type": "object" }, "message": { "description": "Represents the message confirming the deletion.", "maxLength": 1000, "type": "string" }, "status": { "description": "Status of the deletion operation", "enum": [ "success" ], "type": "string" } }, "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "DeleteDuplicateCheckPreferenceSuccess" } } }, "description": "Returns a success response confirming that the API deleted the duplicate check preference." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "NotSupported": { "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "the given module is not supported for this api", "status": "error" } }, "RequiredParamMissing": { "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error when required parameter is missing", "properties": { "code": { "description": "Error code", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error context", "properties": { "param_name": { "description": "Missing parameter name", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteDuplicateCheckPreferenceRequiredParamMissingError" }, { "additionalProperties": false, "description": "Error when the module is invalid", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error context", "properties": { "param_name": { "description": "Invalid parameter name", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteDuplicateCheckPreferenceInvalidModuleError" }, { "additionalProperties": false, "description": "Error when the module is not supported for this API", "properties": { "code": { "description": "Error code", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error context", "properties": { "param_name": { "description": "Name of the unsupported parameter", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteDuplicateCheckPreferenceNotSupportedError" } ], "x-zs-$id": "DeleteDuplicateCheckPreference400Response" } } }, "description": "Bad Request - Invalid or missing parameters" }, "403": { "content": { "application/json": { "examples": { "FeatureNotEnabled": { "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "The DuplicateCheckPreference for mapped_module_records feature is not yet enabled. Please enable it before doing this action.", "status": "error" } }, "NoPermission": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "the user doesn't have permission for that module.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "No permission error response", "properties": { "code": { "description": "Error code indicating permission denied", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "permissions": { "description": "List of required permissions", "items": { "description": "Permission name required to access this resource", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteNoPermissionErrorResponse" }, { "additionalProperties": false, "description": "Feature not enabled error response", "properties": { "code": { "description": "Error code indicating feature is not enabled", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details (typically empty)", "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteFeatureNotEnabledResponse" } ], "x-zs-$id": "DeleteDuplicateCheckPreference403Response" } } }, "description": "No permission or feature not enabled" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.duplicate_check_preference.DELETE" ] } ], "summary": "Delete Duplicate Check Preference", "tags": [ "duplicate_check_preference" ], "x-zoho-document": "duplicate_check_preference" }, "get": { "description": "To retrieve the duplicate check preference configured for the Leads module in your Zoho CRM organization.", "operationId": "getDuplicateCheckPreference", "parameters": [ { "$ref": "#/components/parameters/DuplicateCheckPreferenceModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "DuplicateCheckPreferenceForContacts": { "description": "Shows a get duplicate check preference response for the mapped_module_records type, including the field mappings between Leads and Contacts.", "summary": "Duplicate check preference for Contacts", "value": { "duplicate_check_preference": { "type": "mapped_module_records", "type_configurations": [ { "field_mappings": [ { "current_field": { "api_name": "Phone", "id": "1124664000000000565", "name": "Leads" }, "mapped_field": { "api_name": "Phone", "id": "1124664000000000457", "name": "Contacts" } } ], "mapped_module": { "api_name": "Contacts", "id": "1124664000000000129", "name": "Contacts" } } ] } } }, "DuplicateCheckPreferenceForConvertedLead": { "description": "Shows a get duplicate check preference response for the converted_records type with no type_configurations entries.", "summary": "Duplicate check preference for converted Leads", "value": { "duplicate_check_preference": { "type": "converted_records", "type_configurations": [] } } } }, "schema": { "$ref": "#/components/schemas/GetDuplicateCheckPreference", "x-zs-$id": "GetDuplicateCheckPreference" } } }, "description": "Returns the duplicate check preference configured for the specified module." }, "204": { "description": "Indicates that duplicate check preference is not enabled for the specified module." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "NotSupported": { "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "the given module is not supported for this api", "status": "error" } }, "RequiredParamMissing": { "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error when required parameter is missing", "properties": { "code": { "description": "Error code", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error context", "properties": { "param_name": { "description": "Missing parameter name", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetDuplicateCheckPreferenceRequiredParamMissingError" }, { "additionalProperties": false, "description": "Error when the module is invalid", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error context", "properties": { "param_name": { "description": "Invalid parameter name", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetDuplicateCheckPreferenceInvalidModuleError" }, { "additionalProperties": false, "description": "Error when the module is not supported for this API", "properties": { "code": { "description": "Error code", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error context", "properties": { "param_name": { "description": "Name of the unsupported parameter", "maxLength": 50, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetDuplicateCheckPreferenceNotSupportedError" } ], "x-zs-$id": "GetDuplicateCheckPreference400Response" } } }, "description": "Bad Request - Invalid or missing parameters" }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "value": { "code": "NO_PERMISSION", "details": {}, "message": "You don't have permission to perform this operation", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "No permission error response", "properties": { "code": { "description": "Error code indicating permission denied", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "permissions": { "description": "List of required permissions", "items": { "description": "Permission name required to access this resource", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NoPermissionErrorResponse" } } }, "description": "No permission to perform this operation" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.duplicate_check_preference.READ" ] } ], "summary": "Get Duplicate Check Preference", "tags": [ "duplicate_check_preference" ], "x-zoho-document": "duplicate_check_preference" }, "post": { "description": "To enable duplicate check preference for the Leads module in your Zoho CRM organization.", "operationId": "createDuplicateCheckPreference", "parameters": [ { "$ref": "#/components/parameters/DuplicateCheckPreferenceModule" } ], "requestBody": { "content": { "application/json": { "examples": { "DuplicateCheckPreferenceForContacts": { "description": "Shows a create duplicate check preference request that enables mapped-module duplicate checking for Leads against Contacts by mapping the Phone field.", "summary": "Duplicate check preference for Contacts", "value": { "duplicate_check_preference": { "type": "mapped_module_records", "type_configurations": [ { "field_mappings": [ { "current_field": { "api_name": "Phone", "id": "1124664000000000565", "name": "Leads" }, "mapped_field": { "api_name": "Phone", "id": "1124664000000000457", "name": "Contacts" } } ], "mapped_module": { "api_name": "Contacts", "id": "1124664000000000129", "name": "Contacts" } } ] } } }, "DuplicateCheckPreferenceForConvertedLead": { "description": "Shows a create duplicate check preference request that enables duplicate checking for converted Lead records with the converted_records type.", "summary": "Duplicate check preference for converted Leads", "value": { "duplicate_check_preference": { "type": "converted_records", "type_configurations": [] } } } }, "schema": { "$ref": "#/components/schemas/CreateDuplicateCheckPreferenceRequest" } } }, "description": "The request body must contain the duplicate_check_preference object. Set the type to converted_records or mapped_module_records, and include type_configurations when you configure mapped-module duplicate checking.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "DuplicateCheckPreferenceForContacts": { "description": "Returns a success response confirming that duplicate checking for mapped_module_records was enabled successfully.", "summary": "Duplicate check preference for Contacts", "value": { "duplicate_check_preference": { "code": "SUCCESS", "details": {}, "message": "Duplicate check enabled for mapped_module_records successfully.", "status": "success" } } }, "DuplicateCheckPreferenceForConvertedLead": { "description": "Returns a success response confirming that duplicate checking for converted_records was enabled successfully.", "summary": "Duplicate check preference for converted Leads", "value": { "duplicate_check_preference": { "code": "SUCCESS", "details": {}, "message": "Duplicate check enabled for converted_records successfully.", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Response wrapper object containing the duplicate check preference details.", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Details of the duplicate check preference configuration.", "properties": { "code": { "description": "Status code indicating the result of the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details related to the operation.", "type": "object" }, "message": { "description": "Represents the message providing additional information about the operation result.", "maxLength": 100, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "CreateDuplicateCheckPreferenceResponse" } } }, "description": "Returns a success response confirming that the duplicate check preference was enabled." }, "400": { "content": { "application/json": { "examples": { "AlreadyConfigured": { "description": "Shows the error response returned when the requested duplicate check preference is already configured for the module.", "summary": "Already configured error", "value": { "code": "ALREADY_CONFIGURED", "details": {}, "message": "already configured.", "status": "error" } }, "Ambiguity": { "description": "Shows the error response returned when different field identifiers in the same mapping entry resolve to two different CRM fields.", "summary": "Ambiguity during field mapping", "value": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.id" }, { "api_name": "api_name", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.api_name" } ] }, "message": "two different crm fields are found", "status": "error" } }, "DependentFieldMissing": { "description": "Shows the error response returned when a dependent field required for the duplicate check configuration is missing from the request.", "summary": "Dependent field missing error", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "field_api_name", "dependee": { "api_name": "field_api_name", "json_path": "$json_path" }, "json_path": "$json_path" }, "message": "Dependent Field missing", "status": "error" } }, "ExpectedFieldMissing": { "description": "Shows the error response returned when one or more expected fields are missing from the duplicate check field mapping.", "summary": "Expected field missing error", "value": { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.id" }, { "api_name": "api_name", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.api_name" } ] }, "message": "Specify at least one field.", "status": "error" } }, "FeatureNotSupportedForEdition": { "description": "Shows the error response returned when the current Zoho CRM edition does not support duplicate check preference.", "summary": "Feature not supported for this edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Your License does not support this feature.", "status": "error" } }, "FeatureNotSupportedForGivenModule": { "description": "Shows the error response returned when the duplicate check preference is requested for a module that does not support this feature.", "summary": "Feature not supported for this module", "value": { "code": "NOT_SUPPORTED", "details": { "api_name": "field_api_name", "json_path": "$json_path", "param_name": "module" }, "message": "The feature not avilable in the given module", "status": "error" } }, "InvalidModuleGiven": { "summary": "Invalid module error", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid.", "status": "error" } }, "MandatoryNotFound": { "description": "Shows the error response returned when the duplicate_check_preference object is missing from the request.", "summary": "Mandatory field missing error", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "duplicate_check_preference", "json_path": "$.data[0].duplicate_check_preference" }, "message": "required field not found", "status": "error" } }, "NotAllowed": { "summary": "Not allowed unique field mapping", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "field_api_name", "json_path": "$json_path" }, "message": "the given current_field API name is not a unique field API name.", "status": "error" } }, "RequestLevelError": { "description": "Shows the error response returned when the required module query parameter is missing from the request.", "summary": "Required parameter missing error", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the request-level error format returned when the module parameter is missing or malformed.", "properties": { "code": { "description": "Represents the error code for request-level failures.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual error details including field location.", "properties": { "param_name": { "description": "Represents the param_name that caused the error, for example, module.", "maxLength": 10, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RequiredParamMissingError" }, { "additionalProperties": false, "description": "Request-level error format (returned when feature not supported).", "properties": { "code": { "description": "Represents the error code for request-level failures.", "enum": [ "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual error details including field location.", "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Your License does not support this feature." ], "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "FeatureNotSupportedError" }, { "additionalProperties": false, "description": "Request-level error format (returned when feature not supported).", "properties": { "code": { "description": "Represents the error code for request-level failures.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual error details including field location.", "properties": { "api_name": { "description": "API name of the field with invalid data.", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath to the location of the invalid field.", "maxLength": 100, "type": "string" }, "param_name": { "description": "Represents the param_name that caused the error, for example, module.", "maxLength": 50, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 1000, "type": "string" }, "status": { "description": "Status indicator for error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, { "additionalProperties": false, "description": "Request-level error format (returned when feature not supported).", "properties": { "code": { "description": "Represents the error code for request-level failures.", "enum": [ "ALREADY_CONFIGURED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual error details including field location.", "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "already configured." ], "type": "string" }, "status": { "description": "Status indicator for error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "AlreadyConfiguredError" }, { "additionalProperties": false, "description": "AMBIGUITY_DURING_PROCESSING error response when conflicting parameters are provided (ids + api_names, or type + restricted_action).", "properties": { "code": { "description": "Error code indicating parameter ambiguity.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the ambiguous parameters.", "properties": { "ambiguity_due_to": { "description": "Array of conflicting parameters that caused the ambiguity.", "items": { "additionalProperties": false, "description": "Parameter that contributed to the ambiguity.", "properties": { "api_name": { "description": "Represents the API field name that caused the error, for example, tab_groups.", "maxLength": 10, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression locating the error, for example, $.tab_groups.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message explaining the ambiguity.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AmbiguityDuringProcessingError" }, { "additionalProperties": false, "description": "MANDATORY_NOT_FOUND error when required fields are missing", "properties": { "code": { "description": "Error code indicating a mandatory field is missing", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field location information", "properties": { "api_name": { "description": "Name of the required field that is missing", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating where the field should be in the request", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MandatoryNotFoundError" }, { "additionalProperties": false, "description": "DEPENDENT_FIELD_MISSING error when dependent configuration is missing", "properties": { "code": { "description": "Error code indicating a dependent field is missing", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field location information", "properties": { "api_name": { "description": "Name of the dependent field that is missing", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating where the field should be in the request", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing dependent field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DependentFieldMissingError" }, { "additionalProperties": false, "description": "EXPECTED_FIELD_MISSING error for missing expected fields", "properties": { "code": { "description": "Error code for missing expected field", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about missing expected fields", "properties": { "expected_fields": { "description": "List of fields that were expected but missing", "items": { "additionalProperties": false, "description": "Field location details", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location where field was expected", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ExpectedFieldMissingError" }, { "additionalProperties": false, "description": "INVALID_DATA error for data validation failures", "properties": { "code": { "description": "Error code indicating invalid or malformed data", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field information", "properties": { "api_name": { "description": "Name of the field with invalid data", "maxLength": 50, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating the invalid field in the request", "maxLength": 100, "type": "string" }, "maximum_length": { "description": "Maximum allowed length for the field", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid data.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataError" }, { "additionalProperties": false, "description": "NOT_ALLOWED error for operations that are not permitted", "properties": { "code": { "description": "Error code indicating operation is not allowed", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field location information", "properties": { "api_name": { "description": "Name of the field or operation that is not allowed", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating the not-allowed field or operation", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message explaining what is not allowed.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedError" }, { "additionalProperties": false, "description": "INVALID_MODULE error for unsupported operations", "properties": { "code": { "description": "Error code for unsupported operation", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details (typically empty)", "properties": { "param_name": { "description": "Represents the param_name that caused the error, for example, module.", "maxLength": 10, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceInvalidmoduleObject" }, { "additionalProperties": false, "description": "DEPENDENT_FIELD_MISSING error for unsupported operations", "properties": { "code": { "description": "Error code for unsupported operation", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details (typically empty)", "properties": { "api_name": { "description": "API name of the dependee field", "maxLength": 50, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the param_name that caused the error, for example, module.", "properties": { "api_name": { "description": "API name of the dependee field", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSON path of the dependee field", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path of the dependee field", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceDependentfieldmissingObject" }, { "additionalProperties": false, "description": "Field-level error wrapped under duplicate_check_preference root key", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Error details for the duplicate_check_preference field", "properties": { "code": { "description": "Error code for the field-level error", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "DEPENDENT_FIELD_MISSING", "EXPECTED_FIELD_MISSING", "NOT_ALLOWED", "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error context including field path", "properties": { "api_name": { "description": "API name of the field that caused the error", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Error context including field path", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location where field was expected", "maxLength": 100, "minLength": 1, "type": "string" } }, "type": "object" }, "expected_data_type": { "description": "Expected data type for the field that caused the error", "maxLength": 500, "type": "string" }, "expected_fields": { "description": "List of fields that were expected but missing", "items": { "additionalProperties": false, "description": "Field location details", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location where field was expected", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" }, "json_path": { "description": "JSON path to the field that caused the error", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "CreateDuplicateCheckPreferenceWrappedFieldError" } ], "x-zs-$id": "DuplicateCheckPreferenceErrorResponse" } } }, "description": "The request could not be processed because the duplicate check preference input is invalid or incomplete.\n**Resolution:** The module query parameter and request body fields must contain valid supported values for this API." }, "403": { "content": { "application/json": { "examples": { "FeatureNotEnabledForMappedModule": { "description": "Shows the error response returned when mapped_module resolves to a module other than Contacts.", "summary": "Mapped module is not supported", "value": { "duplicate_check_preference": { "code": "FEATURE_NOT_ENABLED", "details": { "api_name": "mapped_module", "json_path": "$.duplicate_check_preference[0].type_configurations.mapped_module.id" }, "message": "feature not support in this module", "status": "error" } } }, "NoPermission": { "value": { "code": "NO_PERMISSION", "details": {}, "message": "You don't have permission to perform this operation", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "No permission error response", "properties": { "code": { "description": "Error code indicating permission denied", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "permissions": { "description": "List of required permissions", "items": { "description": "Permission name required to access this resource", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PostNoPermissionErrorResponse" }, { "additionalProperties": false, "description": "Feature not enabled error wrapped under duplicate_check_preference, returned when the mapped module resolves to a module other than Contacts", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Error details for the duplicate_check_preference field", "properties": { "code": { "description": "Error code indicating feature is not enabled", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error context including field location", "properties": { "api_name": { "description": "API name of the field that caused the error", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field that caused the error", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "PostFeatureNotEnabledWrappedResponse" } ], "x-zs-$id": "PostDuplicateCheckPreference403Response" } } }, "description": "No permission or feature not enabled" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.duplicate_check_preference.CREATE" ] } ], "summary": "Create Duplicate Check Preference", "tags": [ "duplicate_check_preference" ], "x-zoho-document": "duplicate_check_preference" }, "put": { "description": "Update Duplicate Check Preference API is used to update duplicate check settings for a specific module in the CRM system. It allows users to define how duplicate records are identified and managed based on field mappings between the current module and a mapped module, such as Contacts. This API helps maintain data integrity by preventing the creation of duplicate records during data entry or import processes.", "operationId": "updateDuplicateCheckPreference", "parameters": [ { "$ref": "#/components/parameters/DuplicateCheckPreferenceModule" } ], "requestBody": { "content": { "application/json": { "examples": { "DuplicateCheckPreferenceForContacts": { "description": "Shows an update duplicate check preference request that changes the mapped-module configuration by mapping the Phone field between Leads and Contacts.", "summary": "Duplicate check preference for Contacts", "value": { "duplicate_check_preference": { "type": "mapped_module_records", "type_configurations": [ { "field_mappings": [ { "current_field": { "api_name": "Phone", "id": "1124664000000000565", "name": "Leads" }, "mapped_field": { "api_name": "Phone", "id": "1124664000000000457", "name": "Contacts" } } ], "mapped_module": { "api_name": "Contacts", "id": "1124664000000000129", "name": "Contacts" } } ] } } }, "DuplicateCheckPreferenceForConvertedLead": { "description": "Shows an update duplicate check preference request that sets the duplicate check type to converted_records for Leads.", "summary": "Duplicate check preference for converted Leads", "value": { "duplicate_check_preference": { "type": "converted_records", "type_configurations": [] } } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload used to update duplicate check preference.", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Duplicate Check Preference details", "properties": { "type": { "description": "Type of duplicate check preference", "enum": [ "mapped_module_records", "converted_records" ], "type": "string" }, "type_configurations": { "description": "Type configurations for duplicate check preference", "items": { "additionalProperties": false, "description": "Type configuration details", "properties": { "field_mappings": { "description": "Field mappings between the current module and the mapped module", "items": { "additionalProperties": false, "description": "Field mapping details", "properties": { "current_field": { "additionalProperties": false, "description": "Unique field in the current module to match on", "properties": { "api_name": { "description": "API name of the current module field. Validated when supplied, but the mapping is stored against id.", "example": "api_name30", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsApiName" }, { "operationId": "getFieldsWithID", "propertyId": "FieldsApiName" } ], "resource": "fields" } }, "id": { "description": "Field id of the current module field. The mapping is stored against this id, so it is mandatory.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" }, { "operationId": "getFieldsWithID", "propertyId": "FieldsId" } ], "resource": "fields" } }, "name": { "description": "Accepted for symmetry with the response and ignored by the API.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "mapped_field": { "additionalProperties": false, "description": "Unique field in the mapped module to match against", "properties": { "api_name": { "description": "Mapped field API name. Validated when supplied, but the mapping is stored against id.", "example": "api_name30", "maxLength": 50, "pattern": "^[A-Za-z][A-Za-z0-9_]*$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsApiName" }, { "operationId": "getFieldsWithID", "propertyId": "FieldsApiName" } ], "resource": "fields" } }, "id": { "description": "Represents the ID of the mapped field. The mapping is stored against this id, so it is mandatory.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" }, { "operationId": "getFieldsWithID", "propertyId": "FieldsId" } ], "resource": "fields" } }, "name": { "description": "Accepted for symmetry with the response and ignored by the API.", "maxLength": 50, "type": "string" }, "selected": { "description": "Send None to delete the existing mapping for this current_field. Any other value, or omitting the property, adds or updates the mapping.", "enum": [ "None" ], "maxLength": 4, "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "current_field", "mapped_field" ], "type": "object" }, "type": "array" }, "mapped_module": { "additionalProperties": false, "description": "Mapped module details", "properties": { "api_name": { "description": "Mapped module API name. Validated when supplied, but the module is resolved from id.", "maxLength": 50, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Represents the ID of the mapped module. The module must resolve to Contacts.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } }, "name": { "description": "Accepted for symmetry with the response and ignored by the API.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "field_mappings", "mapped_module" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "type", "type_configurations" ], "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object" } } }, "description": "The request body must contain the duplicate_check_preference object. To update mapped_module_records, you must include type_configurations with the field_mappings array and the mapped_module details.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "DuplicateCheckPreferenceForContacts": { "description": "Returns a success response confirming that the API updated duplicate checking for mapped_module_records successfully.", "summary": "Duplicate check preference for Contacts", "value": { "duplicate_check_preference": { "code": "SUCCESS", "details": {}, "message": "Updated fieldMapping for mapped_module_records successfully.", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned after the API updates the duplicate check preference.", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Duplicate Check Preference update response", "properties": { "code": { "description": "Response code for successful update", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the update operation", "type": "object" }, "message": { "description": "Represents the message regarding the update operation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Status of the update operation", "enum": [ "success" ], "type": "string" } }, "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "UpdateDuplicateCheckPreferenceSuccess" } } }, "description": "Returns a success response confirming that the API updated the duplicate check preference." }, "400": { "content": { "application/json": { "examples": { "Ambiguity": { "description": "Shows the error response returned when different field identifiers in the same mapping entry resolve to two different CRM fields.", "summary": "Ambiguity during field mapping", "value": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.id" }, { "api_name": "api_name", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.api_name" } ] }, "message": "two different crm fields are found", "status": "error" } }, "DependentFieldMissing": { "description": "Shows the error response returned when a dependent field required for the duplicate check configuration is missing from the request.", "summary": "Dependent field missing error", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "field_api_name", "dependee": { "api_name": "field_api_name", "json_path": "$json_path" }, "json_path": "$json_path" }, "message": "Dependent Field missing", "status": "error" } }, "ExpectedFieldMissing": { "description": "Shows the error response returned when one or more expected fields are missing from the duplicate check field mapping.", "summary": "Expected field missing error", "value": { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.id" }, { "api_name": "api_name", "json_path": "$.duplicate_check_preference[0].type_configurations.field_mappings[0].mapped_field.api_name" } ] }, "message": "Specify at least one field.", "status": "error" } }, "FeatureNotSupportedForEdition": { "description": "Shows the error response returned when the current Zoho CRM edition does not support duplicate check preference.", "summary": "Feature not supported for this edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Your License does not support this feature.", "status": "error" } }, "FeatureNotSupportedForGivenModule": { "description": "Shows the error response returned when the duplicate check preference is requested for a module that does not support this feature.", "summary": "Feature not supported for this module", "value": { "code": "NOT_SUPPORTED", "details": { "api_name": "field_api_name", "json_path": "$json_path", "param_name": "module" }, "message": "The feature not avilable in the given module.", "status": "error" } }, "InvalidModuleGiven": { "summary": "Invalid module error", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid.", "status": "error" } }, "MandatoryNotFound": { "description": "Shows the error response returned when the duplicate_check_preference object is missing from the request.", "summary": "Mandatory field missing error", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "duplicate_check_preference", "json_path": "$.data[0].duplicate_check_preference" }, "message": "required field not found", "status": "error" } }, "NotAllowed": { "summary": "Not allowed unique field mapping", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "field_api_name", "json_path": "$json_path" }, "message": "the given current_field API name is not a unique field API name.", "status": "error" } }, "RequestLevelError": { "description": "Shows the error response returned when the required module query parameter is missing from the request.", "summary": "Required parameter missing error", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the request-level error format returned when the module parameter is missing or malformed.", "properties": { "code": { "description": "Represents the error code for request-level failures.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual error details including field location.", "properties": { "param_name": { "description": "Represents the param_name that caused the error, for example, module.", "maxLength": 10, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Human-readable error message.", "enum": [ "One of the expected parameter is missing" ], "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceRequiredparammissingObject" }, { "additionalProperties": false, "description": "Request-level error format (returned when feature not supported).", "properties": { "code": { "description": "Represents the error code for request-level failures.", "enum": [ "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual error details including field location.", "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "Your License does not support this feature." ], "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceFeaturenotsupportedObject" }, { "additionalProperties": false, "description": "Request-level error format (returned when feature not supported).", "properties": { "code": { "description": "Represents the error code for request-level failures.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contextual error details including field location.", "properties": { "api_name": { "description": "API name of the field with invalid data.", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath to the location of the invalid field.", "maxLength": 100, "type": "string" }, "param_name": { "description": "Represents the param_name that caused the error, for example, module.", "maxLength": 10, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message.", "enum": [ "The feature not avilable in the given module", "the given module is not supported for this api" ], "type": "string" }, "status": { "description": "Status indicator for error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceNotsupportedObject" }, { "additionalProperties": false, "description": "AMBIGUITY_DURING_PROCESSING error response when conflicting parameters are provided (ids + api_names, or type + restricted_action).", "properties": { "code": { "description": "Error code indicating parameter ambiguity.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the ambiguous parameters.", "properties": { "ambiguity_due_to": { "description": "Array of conflicting parameters that caused the ambiguity.", "items": { "additionalProperties": false, "description": "Parameter that contributed to the ambiguity.", "properties": { "api_name": { "description": "Represents the API field name that caused the error, for example, tab_groups.", "maxLength": 10, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression locating the error, for example, $.tab_groups.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message explaining the ambiguity.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceAmbiguityduringprocessingObject" }, { "additionalProperties": false, "description": "MANDATORY_NOT_FOUND error when required fields are missing", "properties": { "code": { "description": "Error code indicating a mandatory field is missing", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field location information", "properties": { "api_name": { "description": "Name of the required field that is missing", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating where the field should be in the request", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceMandatorynotfoundObject" }, { "additionalProperties": false, "description": "DEPENDENT_FIELD_MISSING error when dependent configuration is missing", "properties": { "code": { "description": "Error code indicating a dependent field is missing", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field location information", "properties": { "api_name": { "description": "Name of the dependent field that is missing", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating where the field should be in the request", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing dependent field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceDependentfieldmissingObject2" }, { "additionalProperties": false, "description": "EXPECTED_FIELD_MISSING error for missing expected fields", "properties": { "code": { "description": "Error code for missing expected field", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about missing expected fields", "properties": { "expected_fields": { "description": "List of fields that were expected but missing", "items": { "additionalProperties": false, "description": "Field location details", "properties": { "api_name": { "description": "API name of the expected field", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location where field was expected", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceExpectedfieldmissingObject" }, { "additionalProperties": false, "description": "INVALID_DATA error for data validation failures", "properties": { "code": { "description": "Error code indicating invalid or malformed data", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field information", "properties": { "api_name": { "description": "Name of the field with invalid data", "maxLength": 50, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating the invalid field in the request", "maxLength": 100, "type": "string" }, "maximum_length": { "description": "Maximum allowed length for the field", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid data.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceInvaliddataObject" }, { "additionalProperties": false, "description": "NOT_ALLOWED error for operations that are not permitted", "properties": { "code": { "description": "Error code indicating operation is not allowed", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with field location information", "properties": { "api_name": { "description": "Name of the field or operation that is not allowed", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression locating the not-allowed field or operation", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message explaining what is not allowed.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceNotallowedObject" }, { "additionalProperties": false, "description": "INVALID_MODULE error for unsupported operations", "properties": { "code": { "description": "Error code for unsupported operation", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details (typically empty)", "properties": { "param_name": { "description": "Represents the param_name that caused the error, for example, module.", "maxLength": 10, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceInvalidmoduleObject2" }, { "additionalProperties": false, "description": "DEPENDENT_FIELD_MISSING error for unsupported operations", "properties": { "code": { "description": "Error code for unsupported operation", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details (typically empty)", "properties": { "api_name": { "description": "API name of the dependee field", "maxLength": 50, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the param_name that caused the error, for example, module.", "properties": { "api_name": { "description": "API name of the dependee field", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSON path of the dependee field", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path of the dependee field", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateCheckPreferenceDependentfieldmissingObject3" }, { "additionalProperties": false, "description": "Field-level error wrapped under duplicate_check_preference root key", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Error details for the duplicate_check_preference field", "properties": { "code": { "description": "Error code for the field-level error", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "DEPENDENT_FIELD_MISSING", "EXPECTED_FIELD_MISSING", "NOT_ALLOWED", "FEATURE_NOT_ENABLED", "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error context including field path", "properties": { "api_name": { "description": "API name of the field that caused the error", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Error context including field path", "properties": { "api_name": { "description": "API name of the dependee field that caused the error", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the dependee field that caused the error", "maxLength": 500, "type": "string" } }, "type": "object" }, "expected_data_type": { "description": "Expected data type for the field that caused the error", "maxLength": 500, "type": "string" }, "json_path": { "description": "JSON path to the field that caused the error", "maxLength": 500, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "UpdateDuplicateCheckPreferenceWrappedFieldError" } ], "x-zs-$id": "UpdateDuplicateCheckPreferenceBadrequest" } } }, "description": "The request could not be processed because the duplicate check preference input is invalid or incomplete.\n**Resolution:** The module query parameter and request body fields must contain valid supported values for this API." }, "403": { "content": { "application/json": { "examples": { "FeatureNotEnabled": { "value": { "duplicate_check_preference": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "The DuplicateCheckPreference for mapped_module_records feature is not yet enabled. Please enable it before doing this action.", "status": "error" } } }, "NoPermission": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [] }, "message": "the user doesn't have permission for that module.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "No permission error response", "properties": { "code": { "description": "Error code indicating permission denied", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "permissions": { "description": "List of required permissions", "items": { "description": "Permission name required to access this resource", "maxLength": 255, "type": "string" }, "maxItems": 25, "type": "array" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Status indicator for error", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PutNoPermissionErrorResponse" }, { "additionalProperties": false, "description": "Feature not enabled error wrapped under duplicate_check_preference", "properties": { "duplicate_check_preference": { "additionalProperties": false, "description": "Error details for the duplicate_check_preference field", "properties": { "code": { "description": "Error code indicating feature is not enabled", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details (typically empty)", "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "duplicate_check_preference" ], "type": "object", "x-zs-$id": "PutFeatureNotEnabledWrappedResponse" } ], "x-zs-$id": "PutDuplicateCheckPreference403Response" } } }, "description": "No permission or feature not enabled" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.duplicate_check_preference.UPDATE" ] } ], "summary": "Update Duplicate Check Preference", "tags": [ "duplicate_check_preference" ], "x-zoho-document": "duplicate_check_preference" } }, "/crm/v8/settings/email_templates": { "get": { "description": "To retrieve a paginated list of email templates accessible to the authenticated user in your Zoho CRM organization. The list can be scoped to a specific CRM module using the module parameter, filtered by category (such as favorite, draft, or created_by_me), and refined using a structured filter expression. Results are sortable by last_usage_time, modified_time, or name, and paginated using the page and per_page parameters.", "operationId": "getEmailTemplates", "parameters": [ { "$ref": "#/components/parameters/EmailTemplatesModule" }, { "$ref": "#/components/parameters/EmailTemplatesPerPage" }, { "$ref": "#/components/parameters/EmailTemplatesPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a paginated list response with one Email Template summary, including folder, module, editor mode, subject, usage statistics, and pagination metadata.", "summary": "Successful email templates list response", "value": { "email_templates": [ { "active": true, "associated": false, "attachments": [ { "file_id": "v3zom53c15d05e77e43749f5982313b711a61", "file_name": "4019123000001450001.csv", "id": "4019123000001797047", "size": "111" } ], "category": "normal", "consent_linked": false, "created_by": { "id": "4019123000001797444", "name": "Alice" }, "created_time": "2025-11-27T06:00:00Z", "editor_mode": "plain_text", "favorite": false, "folder": { "id": "4019123000001797060", "name": "Default" }, "id": "4019123000001797067", "last_usage_time": "2025-11-27T07:00:00Z", "last_version_statistics": { "bounced": 0, "clicked": 0, "delivered": 0, "opened": 0, "sent": 0, "tracked": 0 }, "modified_by": { "id": "4019123000001797123", "name": "Bob" }, "modified_time": "2025-11-27T07:00:00Z", "module": { "api_name": "Inventory", "id": "4019123000001797064" }, "name": "Abc12", "subject": "Template Subject" } ], "info": { "count": 1, "more_records": true, "page": 1, "per_page": 20 } } } }, "schema": { "$ref": "#/components/schemas/EmailTemplateListResponse" } } }, "description": "Returns a paginated list of email templates matching the specified criteria, along with pagination metadata." }, "204": { "description": "No Email Templates match the supplied criteria. The server returns no response body." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "description": "Shows an error response when the module API name provided in the request does not correspond to a valid or accessible CRM module.", "summary": "Invalid module name in request", "value": { "code": "INVALID_DATA", "details": { "param_name": "module" }, "message": "Module not found or not allowed", "status": "error" } }, "MissingParameter": { "description": "Shows an error response when the sort_order parameter value does not match the expected pattern.", "summary": "Invalid sort_order parameter value", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "sort_order" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/GetEmailTemplates400Error" } } }, "description": "The request contains an invalid parameter value or references a module that does not exist.\n**Resolution:** Verify that the sort_order value is one of the supported options, the module API name is valid, and all filter expressions conform to the required format." } }, "security": [ { "OAuth2": [ "ZohoCRM.templates.email.READ" ] } ], "summary": "Email Templates", "tags": [ "email_templates" ], "x-zoho-document": "email_templates" } }, "/crm/v8/settings/emails/actions/from_addresses": { "get": { "description": "To retrieve the list of email addresses configured as sender addresses for a user in your Zoho CRM organization.", "operationId": "getFromAddresses", "responses": { "200": { "content": { "application/json": { "examples": { "GetFromAddressesResponseExample": { "description": "Shows a successful response with a single from-address entry, including the email address, display name, and **default** flag set to **true**.", "summary": "Successful response with a single from-address entry", "value": { "from_addresses": [ { "default": true, "email": "example@zoho.com", "type": "user", "user_name": "Example User" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response body, containing the list of configured from-address entries.", "properties": { "from_addresses": { "description": "Represents the list of from-address entries configured for the user.", "items": { "additionalProperties": false, "description": "Represents a single from-address entry, including the email address, type, display name, unique identifier, and default status.", "properties": { "default": { "description": "Indicates whether this is the user's default from address.\nPossible values:\n**true** - This is the default sender address.\n**false** - This is not the default sender address.", "type": "boolean" }, "email": { "description": "Represents the email address of the from-address entry.", "maxLength": 254, "pattern": "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}", "type": "string", "x-zs-$id": "FromAddressEmail" }, "id": { "description": "Represents the unique identifier of the from-address entry.", "format": "int64", "type": [ "string", "null" ], "x-zs-$id": "FromAddressId" }, "type": { "description": "Represents the type of the from-address entry.", "maxLength": 32, "type": "string" }, "user_name": { "description": "Represents the display name of the user associated with the from-address entry.", "maxLength": 256, "type": "string" } }, "required": [ "email", "type", "user_name" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "from_addresses" ], "type": "object", "x-zs-$id": "GetFromAddressesResponse" } } }, "description": "Returns the list of from-address entries configured for the requested user." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.emails.READ" ] } ], "summary": "Get from addresses", "tags": [ "from_addresses" ], "x-zoho-document": "from_addresses" } }, "/crm/v8/settings/fields": { "get": { "description": "To retrieve the field metadata for the specified module in your Zoho CRM account, including standard, custom, subform, and linking module fields. The response includes fields from all layouts but does not contain layout-specific configurations such as mandatory flags or picklist values.", "operationId": "getFields", "parameters": [ { "$ref": "#/components/parameters/FieldsModule", "description": "Specify the API name of the module for which you want to retrieve field metadata. For example, the module name 'Leads'." }, { "$ref": "#/components/parameters/FieldsIncludes", "description": "Specify whether to include the allowed_permissions JSON object in the response" }, { "$ref": "#/components/parameters/FieldsType", "description": "Specify the type of fields to be retrieved. Example: 'used', 'unused', etc." } ], "responses": { "200": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Field metadata for a module retrieved successfully", "value": { "fields": [ { "additional_column": null, "address": { "type": "latitude" }, "api_name": "Address_1_Coordinates_Latitude", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF69", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2025-11-17T19:09:17+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory" ], "data_type": "double", "decimal_place": 9, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Address 1 - Latitude", "display_type": -1, "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Address 1 - Latitude", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000710341", "json_type": "double", "length": 50, "lookup": {}, "mass_update": false, "modified_time": "2025-11-17T19:09:17+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": { "api_name": "Address_1_Coordinates", "id": "4832675000000710334", "name": "Address 1 - Coordinates" }, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "rollup_summary": {}, "searchable": true, "separator": false, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 38, "unique": {}, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": { "type": "longitude" }, "api_name": "Address_1_Coordinates_Longitude", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF70", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2025-11-17T19:09:17+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory" ], "data_type": "double", "decimal_place": 9, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Address 1 - Longitude", "display_type": -1, "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Address 1 - Longitude", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000710342", "json_type": "double", "length": 50, "lookup": {}, "mass_update": false, "modified_time": "2025-11-17T19:09:17+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": { "api_name": "Address_1_Coordinates", "id": "4832675000000710334", "name": "Address 1 - Coordinates" }, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "rollup_summary": {}, "searchable": true, "separator": false, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 38, "unique": {}, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Owner", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": true, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "SMOWNERID", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "field_of_lookup" ], "data_type": "ownerlookup", "decimal_place": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Lead Owner", "display_type": -1, "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Lead Owner", "field_read_only": true, "filterable": true, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000000553", "json_type": "jsonobject", "layout_associations": [ { "api_name": "Standard__s", "id": "4832675000000095055", "name": "Standard" } ], "length": 120, "lookup": {}, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "rollup_summary": {}, "searchable": true, "separator": false, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 8, "unique": {}, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "Company", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "COMPANY", "convert_mapping": { "Accounts": "Account_Name", "Contacts": null, "Deals": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "unique", "removal", "private_field", "tooltip", "hipaa_field", "add_to_other_layouts" ], "data_type": "text", "decimal_place": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Company", "display_type": -1, "email_parser": { "fields_update_supported": true, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "Company", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000000555", "json_type": "string", "layout_associations": [ { "api_name": "Standard__s", "id": "4832675000000095055", "name": "Standard" } ], "length": 200, "lookup": {}, "mass_update": true, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "quick_sequence_number": "1", "range": null, "read_only": false, "rollup_summary": {}, "searchable": true, "separator": false, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 1, "unique": {}, "view_type": { "create": true, "edit": true, "quick_create": true, "view": true }, "virtual_field": false, "visible": true, "webhook": true }, { "additional_column": null, "address": null, "api_name": "First_Name", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "FIRSTNAME", "convert_mapping": { "Accounts": null, "Contacts": "First_Name", "Deals": null }, "created_source": "default", "created_time": null, "crypt": null, "currency": {}, "custom_field": false, "customizable_properties": [ "mandatory", "removal", "add_to_other_layouts" ], "data_type": "text", "decimal_place": null, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "First Name", "display_type": -1, "email_parser": { "fields_update_supported": false, "record_operations_supported": true }, "enable_colour_code": false, "external": null, "field_label": "First Name", "field_read_only": false, "filterable": true, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000000557", "json_type": "string", "layout_associations": [ { "api_name": "Standard__s", "id": "4832675000000095055", "name": "Standard" } ], "length": 40, "lookup": {}, "mass_update": false, "modified_time": null, "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": null, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "quick_sequence_number": "2", "range": null, "read_only": false, "rollup_summary": {}, "searchable": true, "separator": false, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 27, "unique": {}, "view_type": { "create": true, "edit": true, "quick_create": true, "view": false }, "virtual_field": false, "visible": true, "webhook": true } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the field metadata request, containing an array of field configuration objects.", "properties": { "fields": { "description": "Represents the list of field metadata objects retrieved for the specified module.", "items": { "$ref": "#/components/schemas/FieldsFieldSchema" }, "maxItems": 100, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "FieldsResponseSchema" } } }, "description": "Returns the field metadata for all fields in the specified module, including standard, custom, subform, and linking module fields." }, "204": { "description": "No content. The request was processed successfully, and the response body is empty." }, "400": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidModuleName" } } }, "description": "The module API name in the request is invalid. Resolution: The **module** query parameter must reference a valid module API name." }, "500": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsInternalServerError" } } }, "description": "An unexpected error occurred on the Zoho CRM server while processing the request. Resolution: Contact Zoho CRM support if the issue persists." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.READ" ] } ], "summary": "List fields metadata", "tags": [ "fields" ], "x-zoho-document": "fields", "x-zs-llm-description": "Use this operation to discover all available fields for a module before constructing create or update record payloads. The 'module' query parameter is required. Response includes api_name, data_type, and json_type for each field." }, "patch": { "description": "To update one or more custom fields in a module in your Zoho CRM account.", "operationId": "updateField", "parameters": [ { "$ref": "#/components/parameters/FieldsModule", "description": "Specify the API name of the module for which you want to update custom fields. For example, the module name 'Leads'." } ], "requestBody": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Bulk update of multiple field configurations", "value": { "fields": [ { "history_tracking": { "duration_configuration": "time", "followed_fields": [ { "_delete": null, "api_name": "Owner" }, { "api_name": "Company", "id": "5725767000000002591" } ], "related_list_name": "Region Tracker" }, "history_tracking_enabled": true }, { "global_picklist": { "api_name": "Market", "id": "2276164000002053035" }, "id": "2276164000002053013", "pick_list_values": [ { "_global_picklist_value": { "id": "2276164000002053039" }, "id": "2276164000002053012" }, { "_global_picklist_value": { "id": "2276164000002053041" }, "id": "2276164000002053014" } ] }, { "association_details": { "lookup_field": { "api_name": "Lookup_Field", "id": "4832675000000710334" }, "related_field": { "api_name": "City", "id": "4832675000000710341" } }, "field_label": "Updated Field Label", "id": "2276164000002053013", "length": 255 } ] } } }, "schema": { "$ref": "#/components/schemas/FieldUpdateRequestBodySchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "FullExample": { "summary": "All requested fields updated successfully", "value": { "fields": [ { "code": "SUCCESS", "details": { "id": "111112000000067259" }, "message": "field updated", "status": "success" }, { "code": "SUCCESS", "details": { "id": "11111200000006724" }, "message": "field updated", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111112000000067239" }, "message": "field updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateFieldsResponse" } } }, "description": "Returns the update status for each field submitted in the request, with the unique ID of each successfully updated field." }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "summary": "Partial success - one field updated, one failed", "value": { "fields": [ { "code": "SUCCESS", "details": { "id": "1947368000002460003" }, "message": "field updated", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "data_type", "json_path": "$.fields[1].data_type" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response for a bulk field update request, containing a mix of success and error results.", "properties": { "fields": { "description": "Represents the list of per-field results for the bulk update operation, where each item indicates either a successful update or a validation error.", "items": { "anyOf": [ { "$ref": "#/components/schemas/FieldCreationResult" }, { "$ref": "#/components/schemas/FieldsErrorResponse" } ] }, "maxItems": 25, "minItems": 2, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "PatchMultiStatusResponse" } } }, "description": "Returns a partial-success response where some fields were updated successfully and others failed validation, with per-field status information." }, "400": { "content": { "application/json": { "examples": { "FieldErrors": { "summary": "Invalid field data", "value": { "fields": [ { "code": "INVALID_DATA", "details": { "api_name": "group", "expected_data_type": "ArrayList", "json_path": "$.fields[0].lookup.query_details.criteria.group" }, "message": "invalid data", "status": "error" } ] } }, "FieldIndexedEncryptNotAllowed": { "summary": "Indexed field cannot be encrypted", "value": { "fields": [ { "code": "NOT_ALLOWED", "details": { "api_name": "crypt", "json_path": "$.fields[0].crypt" }, "message": "Indexed field cannot be encrypted", "status": "error" } ] } }, "SingleError": { "summary": "Invalid module", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldsErrorResponse" }, { "additionalProperties": false, "description": "Represents the 400 error response when multiple fields fail validation, returning an array of per-field error objects.", "properties": { "fields": { "description": "Represents the array of per-field error objects when validation fails for one or more fields in the update request.", "items": { "$ref": "#/components/schemas/FieldsErrorResponse" }, "maxItems": 25, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "PatchBadRequestWTOFieldobject" } ], "x-zs-$id": "PatchBadRequestResponse" } } }, "description": "The request to update one or more fields is invalid. Resolution: The request payload and module API name must be valid, every field object must include a valid field **id** and satisfy the schema for its declared **data_type**, and the field must not be system-defined, undergoing type conversion, or subject to association limits." }, "500": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsInternalServerError" } } }, "description": "An unexpected error occurred on the Zoho CRM server while processing the request. Resolution: Contact Zoho CRM support if the issue persists." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.UPDATE" ] } ], "summary": "Update custom fields", "tags": [ "fields" ], "x-zoho-document": "fields", "x-zs-llm-description": "Use this operation to bulk-update properties of multiple custom fields in a module. Each object in the 'fields' array must include the field's 'id' to identify which field to update." }, "post": { "description": "To create custom fields in a module in your Zoho CRM organization, where supported modules include Leads, Contacts, Accounts, Campaigns, Cases, Invoices, Deals, Price Books, Products, Purchase Orders, Quotes, Sales Orders, Solutions, Vendors, Calls, Tasks, Events, Users, and Custom modules.", "operationId": "createFields", "parameters": [ { "$ref": "#/components/parameters/FieldsModule", "description": "Specify the API name of the module for which you want to create custom fields. For example, the module name 'Leads'." } ], "requestBody": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Creates a single-line text field and a multi-line text area field in one request", "value": { "fields": [ { "crypt": { "mode": "decryption" }, "data_type": "text", "external": { "show": false, "type": "user" }, "field_label": "Your Name", "profiles": [ { "id": "2423488000000015972", "permission_type": "read_write" }, { "id": "2423488000000015975", "permission_type": "read_only" } ], "tooltip": { "name": "static_text", "value": "Enter your name" } }, { "data_type": "textarea", "field_label": "Name", "length": 50000, "profiles": [ { "id": "2423488000000015972", "permission_type": "read_write" }, { "id": "2423488000000015975", "permission_type": "read_write" } ], "textarea": { "type": "rich_text" }, "tooltip": { "name": "static_text", "value": "Enter your name" } }, { "crypt": { "mode": "decryption" }, "data_type": "email", "field_label": "Email address", "hipaa_compliance_enabled": true, "private": { "type": "High" }, "tooltip": { "name": "static_text", "value": "Enter email address" }, "unique": { "case_sensitive": false } }, { "association_details": { "lookup_field": { "reference_id": "{{ref8909}}" }, "related_field": { "api_name": "Phone", "id": "4832675000000710341" } }, "data_type": "phone", "field_label": "Phone" } ] } } }, "schema": { "$ref": "#/components/schemas/FieldRequestBodySchema" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Successful field creation response with IDs for each created field", "value": { "fields": [ { "code": "SUCCESS", "details": { "id": "111112000000067259" }, "message": "field created", "status": "success" }, { "code": "SUCCESS", "details": { "id": "11111200000006724" }, "message": "field created", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111112000000067239" }, "message": "field created", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateFieldsResponse" } } }, "description": "Returns a list of results confirming that all requested custom fields were created successfully." }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "summary": "Mixed result with one field created successfully and one rejected with INVALID_DATA", "value": { "fields": [ { "code": "SUCCESS", "details": { "id": "1947368000002460003" }, "message": "field created", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "data_type", "json_path": "$.fields[1].data_type" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents a multi-status response in which each entry in the fields array independently reflects either a successful field creation or a field-level error.", "properties": { "fields": { "description": "Represents the list of field creation results returned for the request. Each entry is either a success object or an error object, reflecting whether the corresponding field creation succeeded or failed.", "items": { "anyOf": [ { "$ref": "#/components/schemas/FieldCreationResult" }, { "$ref": "#/components/schemas/FieldsErrorResponse" } ] }, "maxItems": 25, "minItems": 2, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "PostMultiStatusResponse" } } }, "description": "Returns a mixed-status result in which at least one field creation succeeds and at least one field encounters an error, with each entry in the fields array carrying its own status." }, "400": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldsErrorResponse" }, { "additionalProperties": false, "description": "Represents an error response containing an array of field-level errors and supplementary context about the invalid request data.", "properties": { "fields": { "description": "Represents the list of error details for each field that could not be created. Each entry describes the specific error encountered during field creation.\n", "items": { "$ref": "#/components/schemas/FieldsErrorResponse" }, "maxItems": 25, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "PostBadRequestWTOFieldobject" } ], "x-zs-$id": "PostBadRequestResponse" } } }, "description": "Invalid data was submitted for one or more fields in the request.\n**Resolution:** The caller should verify that all required keys such as field_label and data_type are present and that field type values are valid before resubmitting the request." }, "500": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsInternalServerError" } } }, "description": "An unexpected server-side error occurred while processing the request.\n**Resolution:** The caller should wait briefly and retry the request; if the error persists, report the issue to Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.CREATE" ] } ], "summary": "Create custom fields in a module", "tags": [ "fields" ], "x-zoho-document": "fields", "x-zs-llm-description": "Use this operation to create one or more custom fields in a module. Each field object in the 'fields' array must include 'field_label' and 'data_type'. The 'api_name' is auto-generated from 'field_label' if not provided." } }, "/crm/v8/settings/fields/{fieldId}": { "delete": { "description": "To delete a custom field from a module in your Zoho CRM account. The field must not be used in workflows, approvals, scoring rules, or other configurations before deletion.", "operationId": "deleteCustomField", "parameters": [ { "description": "Specify the unique ID of the custom field to delete.", "in": "path", "name": "fieldId", "required": true, "schema": { "$ref": "#/components/schemas/FieldsId" } }, { "$ref": "#/components/parameters/FieldsModule", "description": "Module name passed as parameter is case insensitive. For example, the module name 'Leads'." } ], "responses": { "200": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Successful deletion of a single custom field", "value": { "fields": [ { "code": "SUCCESS", "details": { "id": "111112000000067259" }, "message": "field deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the field deletion operation, containing an array with one deletion result.", "properties": { "fields": { "description": "Represents the list of field deletion results, containing one entry with the unique ID of the deleted field.", "items": { "$ref": "#/components/schemas/FieldCreationResult" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteFieldResponseWithId" } } }, "description": "Returns the deletion status for the field, including its unique ID and confirmation of the successful deletion." }, "400": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "FieldUsedInIndex": { "summary": "Field is part of an active index and cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "The custom field has already used in other places", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsErrorResponse" } } }, "description": "The request to delete the custom field is invalid. Resolution: The **module** query parameter must reference a valid module API name, the **fieldId** path parameter must reference a valid field ID, and the field must not be system-defined or in use in workflows, approvals, scoring rules, or other configurations." }, "401": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsErrorResponse" } } }, "description": "Authentication failure or insufficient OAuth scope. Resolution: Verify that the access token is valid and includes the required scopes." }, "403": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsErrorResponse" } } }, "description": "Permission denied to delete fields in this module. Resolution: Verify the user's profile has the required permissions." }, "404": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsErrorResponse" } } }, "description": "The request URL is invalid or the specified field does not exist. Resolution: The **fieldId** path parameter must reference a valid field ID, and the request URL must follow the correct pattern." }, "500": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Please check logs for internal error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsInternalServerError" } } }, "description": "An unexpected error occurred on the Zoho CRM server while processing the request. Resolution: Contact Zoho CRM support if the issue persists." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.DELETE" ] } ], "summary": "Delete a custom field", "tags": [ "fields" ], "x-zoho-document": "fields", "x-zs-llm-description": "Use this operation to permanently delete a custom field by its field ID. Requires both 'fieldId' path parameter and 'module' query parameter. Only custom fields can be deleted; system-defined fields will return an error." }, "get": { "description": "To retrieve the metadata of a specific custom field in a module in your Zoho CRM account by its field ID.", "operationId": "getFieldsWithID", "parameters": [ { "$ref": "#/components/parameters/FieldsModule", "description": "Specify the API name of the module for which you want to retrieve field metadata. For example, the module name 'Leads'." }, { "description": "Specify the unique ID of the custom field to retrieve.", "in": "path", "name": "fieldId", "required": true, "schema": { "$ref": "#/components/schemas/FieldsId" } }, { "$ref": "#/components/parameters/FieldsIncludes", "description": "Specify whether to include the allowed_permissions JSON object in the response" }, { "$ref": "#/components/parameters/FieldsType", "description": "Specify the type of fields to be retrieved. Example: 'used', 'unused', etc." } ], "responses": { "200": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Metadata of a single field retrieved successfully", "value": { "fields": [ { "additional_column": null, "address": { "type": "latitude" }, "api_name": "Address_1_Coordinates_Latitude", "associated_module": null, "association_details": null, "auto_number": {}, "businesscard_supported": false, "child_fields": null, "colour_code_enabled_by_system": false, "column_name": "LEADCF69", "convert_mapping": { "Accounts": null, "Contacts": null, "Deals": null }, "created_source": "default", "created_time": "2025-11-17T19:09:17+05:30", "crypt": null, "currency": {}, "custom_field": true, "customizable_properties": [ "mandatory" ], "data_type": "double", "decimal_place": 9, "display_field": false, "display_format": null, "display_format_properties": null, "display_label": "Address 1 - Latitude", "display_type": -1, "email_parser": { "fields_update_supported": false, "record_operations_supported": false }, "enable_colour_code": false, "external": null, "field_label": "Address 1 - Latitude", "field_read_only": false, "filterable": false, "formula": {}, "global_picklist": null, "hipaa_compliance": null, "hipaa_compliance_enabled": false, "history_tracking": null, "history_tracking_enabled": false, "id": "4832675000000710341", "json_type": "double", "length": 50, "lookup": {}, "mass_update": false, "modified_time": "2025-11-17T19:09:17+05:30", "multi_module_lookup": {}, "multiselectlookup": {}, "operation_type": { "api_create": true, "api_update": true, "web_create": true, "web_update": true }, "parent_field": { "api_name": "Address_1_Coordinates", "id": "4832675000000710334", "name": "Address 1 - Coordinates" }, "pick_list_values": [], "pick_list_values_sorted_lexically": false, "private": null, "profiles": [ { "id": "4832675000000015972", "name": "Administrator", "permission_type": "read_write" }, { "id": "4832675000000015975", "name": "Standard", "permission_type": "read_write" } ], "public": false, "range": null, "read_only": false, "rollup_summary": {}, "searchable": true, "separator": false, "sortable": true, "system_mandatory": false, "tooltip": null, "type": "used", "ui_type": 38, "unique": {}, "view_type": { "create": true, "edit": true, "quick_create": false, "view": true }, "virtual_field": false, "visible": true, "webhook": true } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the single-field metadata request, containing an array with one field configuration object.", "properties": { "fields": { "description": "Represents the list of field metadata objects for the specified field, containing one entry.", "items": { "$ref": "#/components/schemas/FieldsFieldSchema" }, "maxItems": 1, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "FieldsResponseWithID" } } }, "description": "Returns the metadata for the custom field identified by the specified field ID." }, "400": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "The request is invalid. Resolution: The **module** query parameter must reference a valid module API name, and the **fieldId** path parameter must reference a valid field ID." }, "500": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsInternalServerError" } } }, "description": "An unexpected error occurred on the Zoho CRM server while processing the request. Resolution: Contact Zoho CRM support if the issue persists." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.READ" ] } ], "summary": "Get field metadata by ID", "tags": [ "fields" ], "x-zoho-document": "fields", "x-zs-llm-description": "Use this operation to retrieve metadata of a single custom field by its field ID. Requires both 'module' query parameter and 'fieldId' path parameter." }, "patch": { "description": "To update a specific custom field in a module in your Zoho CRM account by its unique field ID.", "operationId": "putFieldsWithId", "parameters": [ { "$ref": "#/components/parameters/FieldsModule", "description": "Module name passed as parameter is case insensitive. For example, the module name 'Leads'." }, { "description": "Specify the unique ID of the custom field to update.", "in": "path", "name": "fieldId", "required": true, "schema": { "$ref": "#/components/schemas/FieldsId" } } ], "requestBody": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Example of a field update for the Leads module", "value": { "fields": [ { "history_tracking": { "duration_configuration": "time", "followed_fields": [ { "_delete": null, "api_name": "Owner" }, { "api_name": "Company", "id": "5725767000000002591" } ], "related_list_name": "Region Tracker" }, "history_tracking_enabled": true }, { "global_picklist": { "api_name": "Market", "id": "2276164000002053035" }, "id": "2276164000002053013", "pick_list_values": [ { "_global_picklist_value": { "id": "2276164000002053039" }, "id": "2276164000002053012" }, { "_global_picklist_value": { "id": "2276164000002053041" }, "id": "2276164000002053014" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/FieldUpdateRequestBodySchema" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "FullExample": { "summary": "Example response of a text field update for the Leads module", "value": { "fields": [ { "code": "SUCCESS", "details": { "id": "111112000000067259" }, "message": "field updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the single-field update operation, containing an array with one update result.", "properties": { "fields": { "description": "Represents the list of field update results for the single-field update operation, containing one entry.", "items": { "$ref": "#/components/schemas/FieldCreationResult" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateFieldResponseWithId" } } }, "description": "Returns the update status for the field, including its unique ID and confirmation of the successful update." }, "400": { "content": { "application/json": { "examples": { "FieldErrors": { "summary": "Invalid field data", "value": { "fields": [ { "code": "INVALID_DATA", "details": { "api_name": "group", "expected_data_type": "ArrayList", "json_path": "$.fields[0].lookup.query_details.criteria.group" }, "message": "Invalid data", "status": "error" } ] } }, "FieldIndexedEncryptNotAllowed": { "summary": "Indexed field cannot be encrypted", "value": { "fields": [ { "code": "NOT_ALLOWED", "details": { "api_name": "crypt", "json_path": "$.fields[0].crypt" }, "message": "Indexed field cannot be encrypted", "status": "error" } ] } }, "SingleError": { "summary": "Invalid module", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldsErrorResponse" }, { "additionalProperties": false, "description": "Represents the 400 error response when validation fails for one or more properties of the field being updated, returning an array of per-field error objects.", "properties": { "fields": { "description": "Represents the array of per-field error objects when validation fails for one or more properties of the field being updated.", "items": { "$ref": "#/components/schemas/FieldsErrorResponse" }, "maxItems": 100, "type": "array" } }, "required": [ "fields" ], "type": "object", "x-zs-$id": "BadRequestWTOFieldobjectWithId" } ], "x-zs-$id": "PatchBadRequestResponseWithId" } } }, "description": "The request to update the custom field is invalid. Resolution: The request payload and module API name must be valid, and the field object must satisfy the schema for its declared **data_type**." }, "500": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsInternalServerError" } } }, "description": "An unexpected error occurred on the Zoho CRM server while processing the request. Resolution: Contact Zoho CRM support if the issue persists." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.UPDATE" ] } ], "summary": "Update a custom field", "tags": [ "fields" ], "x-zoho-document": "fields", "x-zs-llm-description": "Use this operation to update a single custom field by its field ID. Unlike updateField (PATCH /settings/fields) which updates multiple fields at once, this targets exactly one field using the 'fieldId' path parameter." } }, "/crm/v8/settings/fields/{fieldId}/actions/replace_pick_list_values": { "post": { "description": "Replace picklist value", "operationId": "postReplacePickListValues", "parameters": [ { "$ref": "#/components/parameters/PickListValuesModule" }, { "$ref": "#/components/parameters/FieldId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "replace_pick_list_values": [ { "delete_old_value": true, "new_value": { "display_value": "Option 2", "id": "1111130000001470030" }, "old_value": { "display_value": "Option 1", "id": "1111130000001470910" } } ] } } }, "schema": { "$ref": "#/components/schemas/PicklistReplaceRequestBody" } } }, "description": "Request body" }, "responses": { "202": { "content": { "application/json": { "examples": { "Success202": { "summary": "Success response for status 202", "value": { "replace_pick_list_values": [ { "code": "SCHEDULED", "details": { "job_id": "2423488000000732044" }, "message": "Picklist option replace operation scheduled successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PicklistReplaceResponse" } } }, "description": "Accepted - Request accepted for processing" }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse1": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: ambiguity while processing the old_value", "value": { "replace_pick_list_values": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.replace_pick_list_values[0].old_value.id" }, { "api_name": "display_value", "json_path": "$.replace_pick_list_values[0].old_value.display_value" } ] }, "message": "ambiguity while processing the old_value", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse2": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: ambiguity while processing the new_value", "value": { "replace_pick_list_values": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.replace_pick_list_values[0].new_value.id" }, { "api_name": "display_value", "json_path": "$.replace_pick_list_values[0].new_value.display_value" } ] }, "message": "ambiguity while processing the new_value", "status": "error" } ] } }, "DependentMismatchResponse1": { "summary": "Error response with code DEPENDENT_MISMATCH: old_value and new_value should not be the same (Field: new_value)", "value": { "replace_pick_list_values": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "new_value", "dependee": { "api_name": "old_value", "json_path": "$.replace_pick_list_values[0].old_value" }, "json_path": "$.replace_pick_list_values[0].new_value" }, "message": "old_value and new_value should not be the same", "status": "error" } ] } }, "ExpectedFieldMissingResponse1": { "summary": "Error response with code EXPECTED_FIELD_MISSING: specify atleast one field", "value": { "replace_pick_list_values": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.replace_pick_list_values[0].new_value.id" }, { "api_name": "display_value", "json_path": "$.replace_pick_list_values[0].new_value.display_value" } ] }, "message": "specify atleast one field", "status": "error" } ] } }, "ExpectedFieldMissingResponse2": { "summary": "Error response with code EXPECTED_FIELD_MISSING: specify atleast one field", "value": { "replace_pick_list_values": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.replace_pick_list_values[0].old_value.id" }, { "api_name": "display_value", "json_path": "$.replace_pick_list_values[0].old_value.display_value" } ] }, "message": "specify atleast one field", "status": "error" } ] } }, "FeatureNotSupportedResponse1": { "summary": "Error response with code FEATURE_NOT_SUPPORTED: Your License does not support this feature", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Your License does not support this feature", "status": "error" } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: The Field Id is Invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The Field Id is Invalid", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: invalid data type replace_pick_list_values object (Field: replace_pick_list_values)", "value": { "code": "INVALID_DATA", "details": { "api_name": "replace_pick_list_values", "json_path": "$.replace_pick_list_values", "maximum_length": 1 }, "message": "invalid data type replace_pick_list_values object", "status": "error" } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: The id given in old_value is invalid (Field: id)", "value": { "replace_pick_list_values": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.replace_pick_list_values[0].old_value.id" }, "message": "The id given in old_value is invalid", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: The id given in new_value is invalid (Field: id)", "value": { "replace_pick_list_values": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.replace_pick_list_values[0].new_value.id" }, "message": "The id given in new_value is invalid", "status": "error" } ] } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: The display_value given in new_value is invalid (Field: display_value)", "value": { "replace_pick_list_values": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.replace_pick_list_values[0].new_value.display_value" }, "message": "The display_value given in new_value is invalid", "status": "error" } ] } }, "InvalidDataResponse6": { "summary": "Error response with code INVALID_DATA: The delete_old_value boolean field type mismatch (Field: delete_old_value)", "value": { "replace_pick_list_values": [ { "code": "INVALID_DATA", "details": { "api_name": "delete_old_value", "expected_data_type": "boolean", "json_path": "$.replace_pick_list_values[0].delete_old_value" }, "message": "The delete_old_value boolean field type mismatch", "status": "error" } ] } }, "InvalidDataResponse7": { "summary": "Error response with code INVALID_DATA: old_value expected data type invalid (Field: old_value)", "value": { "replace_pick_list_values": [ { "code": "INVALID_DATA", "details": { "api_name": "old_value", "expected_data_type": "jsonobject", "json_path": "$.replace_pick_list_values[0].old_value" }, "message": "old_value expected data type invalid", "status": "error" } ] } }, "InvalidDataResponse8": { "summary": "Error response with code INVALID_DATA: new_value expected data type invalid (Field: new_value)", "value": { "replace_pick_list_values": [ { "code": "INVALID_DATA", "details": { "api_name": "new_value", "expected_data_type": "jsonobject", "json_path": "$.replace_pick_list_values[0].new_value" }, "message": "new_value expected data type invalid", "status": "error" } ] } }, "InvalidDataResponse9": { "summary": "Error response with code INVALID_DATA: invalid data type replace_pick_list_values object (Field: replace_pick_list_values)", "value": { "code": "INVALID_DATA", "details": { "api_name": "replace_pick_list_values", "json_path": "$.replace_pick_list_values", "minimum_length": 1 }, "message": "invalid data type replace_pick_list_values object", "status": "error" } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "MandatoryNotFoundResponse1": { "summary": "Error response with code MANDATORY_NOT_FOUND: old_value is mandatory (Field: old_value)", "value": { "replace_pick_list_values": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "old_value", "json_path": "$.replace_pick_list_values[0].old_value" }, "message": "old_value is mandatory", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "summary": "Error response with code MANDATORY_NOT_FOUND: new_value is mandatory (Field: new_value)", "value": { "replace_pick_list_values": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "new_value", "json_path": "$.replace_pick_list_values[0].new_value" }, "message": "new_value is mandatory", "status": "error" } ] } }, "NotAllowedResponse1": { "summary": "Error response with code NOT_ALLOWED: The picklist option is used in features (Field: id)", "value": { "replace_pick_list_values": [ { "code": "NOT_ALLOWED", "details": { "_associations": [ { "resources": [ { "_details": null, "id": "1560451000004719301", "name": "Lead Nurturing blueprint" } ], "type": "blueprint" }, { "resources": [ { "_details": null, "id": "1560451000004719986", "name": "CadenceTest1" } ], "type": "cadences" } ], "api_name": "id", "json_path": "$.replace_pick_list_values[0].old_value.id" }, "message": "The picklist option is used in features", "status": "error" } ] } }, "NotAllowedResponse2": { "summary": "Error response with code NOT_ALLOWED: Global picklist option cannot be replaced (Field: id)", "value": { "replace_pick_list_values": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.replace_pick_list_values[0].old_value.id" }, "message": "Global picklist option cannot be replaced", "status": "error" } ] } }, "NotAllowedResponse3": { "summary": "Error response with code NOT_ALLOWED: Restricted Option cannot be replaced (Field: id)", "value": { "replace_pick_list_values": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.replace_pick_list_values[0].old_value.id" }, "message": "Restricted Option cannot be replaced", "status": "error" } ] } }, "NotAllowedResponse4": { "summary": "Error response with code NOT_ALLOWED: PickList option replace not allowed", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "PickList option replace not allowed", "status": "error" } }, "NotAllowedResponse5": { "summary": "Error response with code NOT_ALLOWED: Cannot delete old_value for a picklist field", "value": { "replace_pick_list_values": [ { "code": "NOT_ALLOWED", "details": { "api_name": "delete_old_value", "json_path": "$.replace_pick_list_values[0].delete_old_value" }, "message": "Cannot delete old_value for a picklist field", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidFieldIdErrorResponse" }, { "$ref": "#/components/schemas/InvalidReplacePayloadTypeErrorResponse" }, { "additionalProperties": false, "description": "Wrapped error response with replace_pick_list_values", "properties": { "replace_pick_list_values": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidSourceOptionIdErrorResponse" }, { "$ref": "#/components/schemas/InvalidTargetOptionIdErrorResponse" }, { "$ref": "#/components/schemas/ReplaceBlockedOptionInUseErrorResponse" }, { "$ref": "#/components/schemas/GlobalPicklistOptionReplaceErrorResponse" }, { "$ref": "#/components/schemas/RestrictedPicklistOptionReplaceErrorResponse" }, { "$ref": "#/components/schemas/TargetOptionExpectedFieldMissingErrorResponse" }, { "$ref": "#/components/schemas/SourceOptionAmbiguityErrorResponse" }, { "$ref": "#/components/schemas/TargetOptionAmbiguityErrorResponse" }, { "$ref": "#/components/schemas/IdenticalSourceAndTargetErrorResponse" }, { "$ref": "#/components/schemas/SourceOptionMandatoryErrorResponse" }, { "$ref": "#/components/schemas/TargetOptionMandatoryErrorResponse" }, { "$ref": "#/components/schemas/InvalidTargetDisplayValueErrorResponse" }, { "$ref": "#/components/schemas/InvalidDeleteOldValueFlagErrorResponse" }, { "$ref": "#/components/schemas/InvalidSourceOptionObjectErrorResponse" }, { "$ref": "#/components/schemas/InvalidTargetOptionObjectErrorResponse" }, { "$ref": "#/components/schemas/DeleteOldValueNotAllowedErrorResponse" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "replace_pick_list_values" ], "type": "object", "x-zs-$id": "PostreplacepicklistvaluesError400Wrapper" }, { "$ref": "#/components/schemas/PickListValuesInvalidModuleErrorResponse" }, { "$ref": "#/components/schemas/RequiredModuleParameterMissingErrorResponse" }, { "$ref": "#/components/schemas/FeatureNotSupportedErrorResponse" }, { "$ref": "#/components/schemas/InvalidReplacePayloadTypeMinErrorResponse" }, { "$ref": "#/components/schemas/MultiselectPicklistReplaceNotAllowedErrorResponse" } ], "x-zs-$id": "PostreplacepicklistvaluesError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PermissionDeniedErrorResponse" } } }, "description": "Forbidden - The client does not have access rights to the content." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.UPDATE" ] } ], "summary": "Replace Pick list values", "tags": [ "pick_list_values" ], "x-zoho-document": "pick_list_values", "x-zs-llm-description": "This endpoint allows you to replace one or more picklist values in a specified field of a module. You can provide a old value to be replaced with new value, along with an option to delete the old values after replacement. The request body should contain the details of the old and new picklist values, including their IDs and display values. The response will indicate whether the replacement operation was scheduled successfully or if there were any errors during processing those respective errors will be mentioned." } }, "/crm/v8/settings/fields/{fieldId}/actions/scheduled_jobs": { "get": { "description": "To retrieve the status of scheduled jobs for picklist field operations in your Zoho CRM account, such as replace or delete picklist option jobs.", "operationId": "getScheduledJobs", "parameters": [ { "$ref": "#/components/parameters/ParamQueryJobId" }, { "$ref": "#/components/parameters/FieldsModule" }, { "$ref": "#/components/parameters/FieldsParamQueryPage" }, { "$ref": "#/components/parameters/FieldsParamQueryPerPage" }, { "$ref": "#/components/parameters/ParamPathFieldid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Scheduled jobs list retrieved successfully", "value": { "info": { "count": 10, "more_records": true, "page": 1, "per_page": 200 }, "scheduled_jobs": [ { "action": "REPLACE_PICKLIST_OPTION", "details": { "dashboard_criteria": { "failed": 0, "processed": 0, "total": 5 }, "field_dependency": { "failed": 0, "processed": 0, "total": 3 }, "records": { "failed": 0, "processed": 0, "total": 400 }, "workflow_rules": { "failed": 0, "processed": 0, "total": 10 } }, "job_id": "3759037000000570605", "message": "Job scheduled", "module": { "api_name": "Potentials", "id": "3759037000000570346" }, "status": "SCHEDULED" }, { "action": "DELETE_PICKLIST_OPTION", "details": { "dashboard_criteria": { "failed": 0, "processed": 5, "total": 5 }, "field_dependency": { "failed": 0, "processed": 2, "total": 2 }, "records": { "failed": 100, "processed": 300, "total": 400 }, "workflow_rules": { "failed": 0, "processed": 10, "total": 10 } }, "job_id": "3759037000000570606", "message": "Job completed", "module": { "api_name": "Leads", "id": "3759037000000570456" }, "status": "COMPLETED" } ] } } }, "schema": { "$ref": "#/components/schemas/FieldPicklistJobsResponse" } } }, "description": "Returns the list of scheduled jobs for the specified field, with their status, action type, and processing details." }, "204": { "description": "No content. The request was processed successfully, and no scheduled jobs are available for the specified field." }, "400": { "content": { "application/json": { "examples": { "FeatureNotSupportedResponse1": { "summary": "FEATURE_NOT_SUPPORTED when license does not support this feature", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Your License does not support this feature", "status": "error" } }, "InvalidDataResponse1": { "summary": "INVALID_DATA error for an invalid field ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The Field Id is Invalid", "status": "error" } }, "InvalidModuleResponse1": { "summary": "INVALID_MODULE error for an invalid module name", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "RequiredParamMissingResponse1": { "summary": "REQUIRED_PARAM_MISSING when a required parameter is absent", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FieldsInvalidModuleError" }, { "$ref": "#/components/schemas/InvalidFieldIdError" }, { "$ref": "#/components/schemas/FieldsFeatureNotSupportedError" }, { "$ref": "#/components/schemas/RequiredParameterMissingError" } ], "x-zs-$id": "GetscheduledjobsError400" } } }, "description": "The request is invalid. Resolution: Ensure the **module** query parameter is a valid module API name, the **fieldId** path parameter is a valid field ID, and required parameters are included." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "NO_PERMISSION error for insufficient profile permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Role_Prefix_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FieldsPermissionDeniedError", "x-zs-$id": "GetscheduledjobsError403" } } }, "description": "Permission denied to retrieve scheduled jobs for this field. Resolution: The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.READ" ] } ], "summary": "Get scheduled jobs for a field", "tags": [ "fields" ], "x-zoho-document": "fields", "x-zs-llm-description": "This endpoint allows you to retrieve the status of scheduled jobs for a specific field operation. You can use this to check the progress and outcome of operations such as replacing or deleting picklist values. The response will include details about the job, including its ID, action, module, and the status of various components involved in the operation." } }, "/crm/v8/settings/fields/{fieldId}/pick_list_values": { "get": { "description": "Returns the available pick list values for a specified field in a module, including display values (with translations if enabled), reference values, layout associations, and metadata. Returns 204 if the field exists but is not a pick list type. Does not support pagination.", "operationId": "getPickListValues", "parameters": [ { "$ref": "#/components/parameters/FieldId" }, { "$ref": "#/components/parameters/PickListValuesModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "MultiplePickListValues": { "summary": "Pick list with multiple values showing used/unused types and color codes", "value": { "pick_list_values": [ { "actual_value": "-None-", "colour_code": null, "display_value": "-None-", "id": "111111000000093642", "layout_associations": [ { "api_name": "test_1", "id": "111111000000081166", "name": "test 1" }, { "api_name": "Standard__s", "id": "111111000000003592", "name": "Standard" } ], "reference_value": "-None-", "sequence_number": 1, "type": "used" }, { "actual_value": "Option 1", "colour_code": "#fea36a", "display_value": "Option 1", "id": "111111000000093637", "layout_associations": [ { "api_name": "Standard__s", "id": "111111000000003592", "name": "Standard" }, { "api_name": "test_1", "id": "111111000000081166", "name": "test 1" } ], "reference_value": "Option 1", "sequence_number": 2, "type": "used" }, { "actual_value": "Option 2", "colour_code": "#c9651a", "display_value": "Option 2", "id": "111111000000093639", "layout_associations": null, "reference_value": "Option 2", "sequence_number": 3, "type": "unused" }, { "actual_value": "op 3", "colour_code": "#ced9ff", "display_value": "op 3", "id": "111111000000093683", "layout_associations": [ { "api_name": "test_1", "id": "111111000000081166", "name": "test 1" }, { "api_name": "Standard__s", "id": "111111000000003592", "name": "Standard" } ], "reference_value": "op 3", "sequence_number": 4, "type": "used" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the picklist values with metadata for the specified field, including display names, reference values, color codes, usage status, and layout associations.", "properties": { "pick_list_values": { "description": "Represents the list of picklist value objects retrieved for the specified field.", "items": { "additionalProperties": false, "description": "Pick list value object", "properties": { "actual_value": { "description": "Represents the actual internal value of the picklist option stored in the system.", "maxLength": 120, "type": "string" }, "colour_code": { "description": "Hexadecimal color code for UI rendering. Null if no color assigned.", "maxLength": 9, "pattern": "^#[0-9a-fA-F]{6}$", "type": [ "string", "null" ] }, "display_value": { "description": "Represents the translated display value of the picklist option shown to users. When translation is not enabled, this value matches **reference_value**.", "maxLength": 120, "type": "string" }, "id": { "description": "Represents the unique identifier of this pick list value", "format": "int64", "type": "string", "x-zs-$id": "PickListValuesId" }, "layout_associations": { "description": "Represents the layouts with which this picklist value is associated. Returns **null** if the value is unused or not associated with any layout. Always returned in the response. Refer to the [Get Layouts](layouts.json#$.paths./settings/layouts.get) endpoint for details. Layout IDs are unique within this array.", "items": { "additionalProperties": false, "description": "Layout association object", "properties": { "api_name": { "description": "Represents the API name of the associated layout.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique identifier of the associated layout", "format": "int64", "type": "string" }, "name": { "description": "Display name of the associated layout", "maxLength": 40, "type": "string" } }, "required": [ "api_name", "id", "name" ], "type": "object" }, "maxItems": 10, "type": [ "array", "null" ] }, "reference_value": { "description": "Represents the untranslated reference value of the picklist option used in API operations.", "maxLength": 120, "type": "string" }, "sequence_number": { "description": "Represents the display order position of the picklist value in the list.", "format": "int32", "minimum": 1, "type": "integer" }, "type": { "description": "Represents the usage status of the picklist value in the CRM field. Possible values: **used** - The picklist value is active and available for selection. **unused** - The picklist value is inactive and not available for selection. Always returned in the response.", "enum": [ "used", "unused" ], "type": "string" } }, "required": [ "actual_value", "colour_code", "display_value", "id", "layout_associations", "reference_value", "sequence_number", "type" ], "type": "object" }, "maxItems": 2000, "type": "array" } }, "required": [ "pick_list_values" ], "type": "object", "x-zs-$id": "PickListValuesResponse" } } }, "description": "Returns the list of picklist values for the specified field, including display values, reference values, color codes, usage status, and associated layouts." }, "204": { "description": "The specified field exists in the module but is not a picklist type. The API returns an empty response body." }, "400": { "content": { "application/json": { "examples": { "InvalidFieldId": { "summary": "Invalid field ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidModule": { "summary": "Invalid module API name in request", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "VersionNotSupported": { "summary": "Unsupported API version in request URL", "value": { "code": "VERSION_NOT_SUPPORTED", "details": {}, "message": "api version is not supported", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response when an invalid picklist field ID is provided in the request URL.", "properties": { "code": { "description": "Represents the error code returned when an invalid filed ID is provided in the request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the invalid field ID error, including the zero-based index of the invalid path parameter.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the invalid path parameter in the request URL, where 2 indicates the **fieldId** position. Always returned in the response.", "format": "int32", "maximum": 10, "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the request failed due to an invalid field ID.", "maxLength": 255, "minLength": 1, "type": "string" }, "status": { "description": "Represents the status of the response. **Possible values:** **error** - The request was not processed successfully.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidFieldIdError" }, { "additionalProperties": false, "description": "Invalid module name provided in query parameter", "properties": { "code": { "description": "Represents the error code returned when an invalid module API name is provided in the request. Possible values: **INVALID_MODULE** - The module API name in the request is invalid. Always returned in the response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional error context for this response. Returns an empty object for the **INVALID_MODULE** error. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message describing why the request failed due to an invalid module name.", "maxLength": 255, "minLength": 1, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error** - The request was not processed successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, { "additionalProperties": false, "description": "Represents the error response when the specified API version is not supported.", "properties": { "code": { "description": "Represents the error code returned when the specified API version is not supported. Possible values: **VERSION_NOT_SUPPORTED** - The API version specified in the request URL is not supported. Always returned in the response.", "enum": [ "VERSION_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional error context for this response. Returns an empty object for the **VERSION_NOT_SUPPORTED** error.", "type": "object" }, "message": { "description": "Represents the error message describing why the request failed due to an unsupported API version.", "maxLength": 255, "minLength": 1, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error** - The request was not processed successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "VersionNotSupportedError" } ], "x-zs-$id": "GetPickListValuesErrorResponse" } } }, "description": "The request failed due to an invalid field ID, an invalid module API name, or an unsupported API version. Resolution: Verify that the field ID in the request URL is valid, the module API name is correct, and the API version is supported." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "summary": "Missing required permission to access field metadata", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response when the user does not have the required permissions to access picklist field metadata.", "properties": { "code": { "description": "Represents the error code returned when permission to access field metadata is denied. Possible values: **NO_PERMISSION** - The user does not have the required permission to access this resource. Always returned in the response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the permission error, including the list of required permissions that are missing.", "properties": { "permissions": { "description": "Represents the list of CRM permissions required to perform this action that are missing from the user's profile. Always returned in the response. Array contains unique permission identifiers; order is not significant.", "items": { "description": "Represents a permission identifier required for this action.", "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 10, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Human-readable error message describing the permission denial", "maxLength": 255, "minLength": 1, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error** - The request was not processed successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NoPermissionError" } } }, "description": "Permission denied to access field metadata. Resolution: The CRM administrator must grant the required permission to the user's profile (Crm_Implied_Customize_Zoho_CRM permission)." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.READ" ] } ], "summary": "Picklist Values for a Field", "tags": [ "pick_list_values" ], "x-zoho-document": "pick_list_values", "x-zs-llm-description": "This endpoint retrieves the available pick list values for a specified field in a module. It provides detailed information about each pick list value, including its display value (with translations if enabled), reference value, layout associations, and metadata such as sequence number, color code, and usage status. If the specified field exists but is not of a pick list type, the endpoint will return a 204 No Content response. Note that this endpoint does not support pagination, so all pick list values will be returned in a single response." } }, "/crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId}": { "delete": { "description": "Delete picklist field option", "operationId": "deletePickListValuesByPickListValueid", "parameters": [ { "$ref": "#/components/parameters/PickListValuesModule" }, { "$ref": "#/components/parameters/FieldId" }, { "$ref": "#/components/parameters/ParamPathPickListValueId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "pick_list_values": [ { "code": "SUCCESS", "details": { "id": "111111000000004126" }, "message": "PickList Option deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DirectPicklistOptionDeletionResponse" } } }, "description": "OK - Picklist option deleted successfully" }, "202": { "content": { "application/json": { "examples": { "Success202": { "summary": "Success response for status 202", "value": { "pick_list_values": [ { "code": "SCHEDULED", "details": { "job_id": "1111130000001941380" }, "message": "Picklist Option deletion scheduled successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PicklistOptionDeletionResponse" } } }, "description": "Accepted - Request accepted for processing" }, "400": { "content": { "application/json": { "examples": { "FeatureNotSupportedResponse1": { "summary": "Error response with code FEATURE_NOT_SUPPORTED: Your License does not support this feature", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Your License does not support this feature", "status": "error" } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: pickList option is not available", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 4 }, "message": "pickList option is not available", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: The Field Id is Invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The Field Id is Invalid", "status": "error" } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "NotAllowedResponse1": { "summary": "Error response with code NOT_ALLOWED: Restricted Option cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 4 }, "message": "Restricted Option cannot be deleted", "status": "error" } }, "NotAllowedResponse2": { "summary": "Error response with code NOT_ALLOWED: The picklist option is used in features", "value": { "code": "NOT_ALLOWED", "details": { "_associations": [ { "resources": [ { "_details": null, "id": "1560451000004719301", "name": "Lead Nurturing blueprint" } ], "type": "blueprint" }, { "resources": [ { "_details": null, "id": "1560451000004719986", "name": "CadenceTest1" } ], "type": "cadences" } ], "resource_path_index": 4 }, "message": "The picklist option is used in features", "status": "error" } }, "NotAllowedResponse3": { "summary": "Error response with code NOT_ALLOWED: Global picklist option cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 4 }, "message": "Global picklist option cannot be deleted", "status": "error" } }, "NotAllowedResponse4": { "summary": "Error response with code NOT_ALLOWED: PickList field should have at least one option in the layouts", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 4 }, "message": "PickList field should have at least one option in the layouts", "status": "error" } }, "NotAllowedResponse5": { "summary": "Error response with code NOT_ALLOWED: PickList field should be in at most one layout or in unused state in all layouts", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 4 }, "message": "PickList field should be in at most one layout or in unused state in all layouts", "status": "error" } }, "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidPicklistOptionIdErrorResponse" }, { "$ref": "#/components/schemas/PickListValuesInvalidModuleErrorResponse" }, { "$ref": "#/components/schemas/InvalidFieldIdForPicklistValuesErrorResponse" }, { "$ref": "#/components/schemas/RestrictedPicklistOptionDeletionErrorResponse" }, { "$ref": "#/components/schemas/PicklistOptionInUseErrorResponse" }, { "$ref": "#/components/schemas/GlobalPicklistOptionDeletionErrorResponse" }, { "$ref": "#/components/schemas/MinimumPicklistOptionConstraintErrorResponse" }, { "$ref": "#/components/schemas/MultipleLayoutAssociationDeletionErrorResponse" }, { "$ref": "#/components/schemas/RequiredModuleParameterMissingErrorResponse" }, { "$ref": "#/components/schemas/FeatureNotSupportedErrorResponse" } ], "x-zs-$id": "DeletepicklistvaluesbypicklistvalueidError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PermissionDeniedErrorResponse" } } }, "description": "Forbidden - The client does not have access rights to the content." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.DELETE" ] } ], "summary": "Delete a picklist field option", "tags": [ "pick_list_values" ], "x-zoho-document": "pick_list_values", "x-zs-llm-description": "This endpoint allows you to delete a specific picklist field option by its unique identifier (pickListValueId) for a given field (fieldId) in a specified module. The deletion can be immediate or scheduled based on the system's processing capabilities. The response will indicate whether the deletion was successful, scheduled for later processing, or if there were any errors preventing the deletion, such as the option being in use or restricted." }, "get": { "description": "Picklist field option GET", "operationId": "getPickListValuesByPickListValueid", "parameters": [ { "$ref": "#/components/parameters/PickListValuesModule" }, { "$ref": "#/components/parameters/FieldId" }, { "$ref": "#/components/parameters/ParamPathPickListValueId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "pick_list_values": [ { "actual_value": "Referral", "colour_code": null, "display_value": "Referral", "id": "2423488000000002313", "layout_associations": [ { "api_name": "Standard__s", "id": "2423488000000095055", "name": "Standard" }, { "api_name": "testing_layout", "id": "2423488000000771002", "name": "testing layout" } ], "reference_value": "Referral", "sequence_number": 1, "type": "used" } ] } } }, "schema": { "$ref": "#/components/schemas/PicklistOptionLookupResponse" } } }, "description": "OK - Successful response" }, "204": { "description": "No Content - Successful response with no body" }, "400": { "content": { "application/json": { "examples": { "FeatureNotSupportedResponse1": { "summary": "Error response with code FEATURE_NOT_SUPPORTED: Your License does not support this feature", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Your License does not support this feature", "status": "error" } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: The Field Id is Invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The Field Id is Invalid", "status": "error" } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidFieldIdForPicklistValuesErrorResponse" }, { "$ref": "#/components/schemas/PickListValuesInvalidModuleErrorResponse" }, { "$ref": "#/components/schemas/RequiredModuleParameterMissingErrorResponse" }, { "$ref": "#/components/schemas/FeatureNotSupportedErrorResponse" } ], "x-zs-$id": "GetpicklistvaluesbypicklistvalueidError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PermissionDeniedErrorResponse" } } }, "description": "Forbidden - The client does not have access rights to the content." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fields.READ" ] } ], "summary": "get a picklist field option", "tags": [ "pick_list_values" ], "x-zoho-document": "pick_list_values", "x-zs-llm-description": "This endpoint retrieves a specific picklist field option by its unique identifier (pickListValueId) for a given field (fieldId) in a specified module. It returns the details of the picklist option, including its display value, reference value, color code, actual value, type (used or unused), and layout associations. If the picklist option does not exist or is not associated with the specified field, appropriate error responses will be returned." } }, "/crm/v8/settings/fiscal_year": { "get": { "description": "To retrieve the fiscal year settings configured for your Zoho CRM organization.", "operationId": "getFiscalYear", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Get fiscal year settings - custom calendar with surplus week", "value": { "fiscal_year": { "calendar_type": "custom", "display_based_on": "start_month", "id": "111111000000008761", "interval_display_option": "quarter", "past_surplus_weeks": null, "start_date": "2026-03-24", "start_month": "MARCH", "structure": "4-4-5", "surplus_week": { "period": 1, "quarter": 3, "year": 2027 } } } } }, "schema": { "$ref": "#/components/schemas/GetfiscalyearResponse200" } } }, "description": "Returns the fiscal year settings configured for the Zoho CRM organization." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailed": { "summary": "Authentication failure error", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "ScopeMismatch": { "summary": "OAuth scope mismatch error", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FiscalYearOAuthScopeMismatchError" }, { "$ref": "#/components/schemas/FiscalYearAuthenticationFailureError" } ], "description": "Contains one of the possible authentication error responses returned when the fiscal year settings cannot be retrieved.", "x-zs-$id": "FiscalYearGet401ErrorResponse" } } }, "description": "The request failed because the OAuth access token is missing, invalid, or does not include the required scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fiscal_year.READ" ] } ], "summary": "Get Fiscal Year Settings", "tags": [ "fiscal_year" ], "x-zoho-document": "fiscal_year" }, "put": { "description": "Updates the fiscal year configuration for the organization. Only administrators can update fiscal year settings.", "operationId": "updateFiscalYear", "requestBody": { "content": { "application/json": { "examples": { "SwitchToStandardFiscalYear": { "summary": "Switch from a custom fiscal year to a standard fiscal year", "value": { "fiscal_year": { "calendar_type": "gregorian" } } } }, "schema": { "$ref": "#/components/schemas/PutfiscalyearRequest" }, "x-zs-llm-examples": [ "SwitchToStandardFiscalYear" ] } }, "description": "The request body must contain a `fiscal_year` object with the settings to update. Specify a valid `start_month`, `display_based_on`, or both. fiscal_year JSON Object, mandatory To update the fiscal year settings you must specify a valid start_month or display_based_on value or both inside this JSON object. start_month string, optional Represents the start month of the year and the allowed values are valid month names (eg: January, February) display_based_on string, optional This value represents whether the name of the fiscal year is based on starting month or ending month of the fiscal period. For example, assume your fiscal year start in April 2023 and ends in March 2024. If you choose to name the year based on the start month (April) the fiscal year will be 2023; If you choose to name the year based on the end month (April) the fiscal year will be 2024" }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Fiscal year settings updated successfully", "value": { "fiscal_year": { "code": "SUCCESS", "details": { "id": "111111000000008761" }, "message": "The fiscal year configuration has been updated successfully", "status": "success" } } } }, "schema": { "$ref": "#/components/schemas/UpdateFiscalYearResponse" } } }, "description": "Returns the status and details of the updated fiscal year settings." }, "400": { "content": { "application/json": { "examples": { "AmbiguityIntervalDisplayOption": { "summary": "Ambiguity error — calendar_type gregorian sent with interval_display_option", "value": { "fiscal_year": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "calendar_type", "json_path": "$.fiscal_year.calendar_type" }, { "api_name": "interval_display_option", "json_path": "$.fiscal_year.interval_display_option" } ] }, "message": "Ambiguity while processing", "status": "error" } } }, "AmbiguityStartDate": { "summary": "Ambiguity error — calendar_type gregorian sent with start_date", "value": { "fiscal_year": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "calendar_type", "json_path": "$.fiscal_year.calendar_type" }, { "api_name": "start_date", "json_path": "$.fiscal_year.start_date" } ] }, "message": "Ambiguity while processing", "status": "error" } } }, "AmbiguityStructure": { "summary": "Ambiguity error — calendar_type gregorian sent with structure", "value": { "fiscal_year": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "calendar_type", "json_path": "$.fiscal_year.calendar_type" }, { "api_name": "structure", "json_path": "$.fiscal_year.structure" } ] }, "message": "Ambiguity while processing", "status": "error" } } }, "AmbiguitySurplusWeek": { "summary": "Ambiguity error — calendar_type gregorian sent with surplus_week", "value": { "fiscal_year": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "calendar_type", "json_path": "$.fiscal_year.calendar_type" }, { "api_name": "surplus_week", "json_path": "$.fiscal_year.surplus_week" } ] }, "message": "Ambiguity while processing", "status": "error" } } }, "Error400Response1": { "summary": "Invalid start_date error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "start_date", "json_path": "$.fiscal_year.start_date" }, "message": "Please give a valid start_date", "status": "error" } } }, "Error400Response10": { "summary": "Custom fiscal year start year restriction error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "start_date", "json_path": "$.fiscal_year.start_date" }, "message": "custom fiscal year can be configured only with current year", "status": "error" } } }, "Error400Response11": { "summary": "Surplus week year out-of-range error", "value": { "fiscal_year": { "code": "NOT_ALLOWED", "details": { "api_name": "year", "json_path": "$.fiscal_year.surplus_week.year", "supported_values": [ 2025, 2026 ] }, "message": "Surplus week can be updated only for current year and next year", "status": "error" } } }, "Error400Response12": { "summary": "Completed fiscal year surplus week edit error", "value": { "fiscal_year": { "code": "NOT_ALLOWED", "details": { "api_name": "year", "json_path": "$.fiscal_year.surplus_week.year" }, "message": "Cannot edit surplus week for completed fiscal year", "status": "error" } } }, "Error400Response13": { "summary": "Structure not allowed for gregorian calendar error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "structure", "json_path": "$.fiscal_year.structure" }, "message": "cannot configure structure for gregorian calendar", "status": "error" } } }, "Error400Response14": { "summary": "interval_display_option not allowed for gregorian calendar error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "interval_display_option", "json_path": "$.fiscal_year.interval_display_option" }, "message": "cannot configure interval_display_option for gregorian calendar", "status": "error" } } }, "Error400Response15": { "summary": "surplus_week not allowed for gregorian calendar error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "surplus_week", "json_path": "$.fiscal_year.surplus_week" }, "message": "cannot configure surplus week for gregorian calendar", "status": "error" } } }, "Error400Response16": { "summary": "start_date not allowed for gregorian calendar error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "start_date", "json_path": "$.fiscal_year.start_date" }, "message": "cannot configure start_date for gregorian calendar", "status": "error" } } }, "Error400Response17": { "summary": "Invalid start_month for the configured start_date error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "start_month", "json_path": "$.fiscal_year.start_month" }, "message": "Invalid start_month for the start_date configured", "status": "error" } } }, "Error400Response18": { "summary": "Delete surplus week for completed fiscal year error", "value": { "fiscal_year": { "code": "NOT_ALLOWED", "details": { "api_name": "year", "json_path": "$.fiscal_year.surplus_week.year" }, "message": "Cannot delete surplus week for completed fiscal year", "status": "error" } } }, "Error400Response19": { "summary": "Missing year in surplus_week error", "value": { "fiscal_year": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "year", "dependee": { "api_name": "surplus_week", "json_path": "$.fiscal_year.surplus_week" }, "json_path": "$.fiscal_year.surplus_week.year" }, "message": "Provide valid year for surplus week", "status": "error" } } }, "Error400Response2": { "summary": "Invalid structure error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "structure", "json_path": "$.fiscal_year.structure", "supported_values": [ "4-4-5", "4-5-4", "5-4-4", "3-3-3-4", "3-3-4-3", "3-4-3-3", "4-3-3-3" ] }, "message": "Please give a valid structure", "status": "error" } } }, "Error400Response20": { "summary": "Missing quarter in surplus_week error", "value": { "fiscal_year": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "quarter", "dependee": { "api_name": "surplus_week", "json_path": "$.fiscal_year.surplus_week" }, "json_path": "$.fiscal_year.surplus_week.quarter" }, "message": "Provide valid quarter for surplus week", "status": "error" } } }, "Error400Response21": { "summary": "Missing period in surplus_week error", "value": { "fiscal_year": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "period", "dependee": { "api_name": "surplus_week", "json_path": "$.fiscal_year.surplus_week" }, "json_path": "$.fiscal_year.surplus_week.period" }, "message": "Provide valid period for surplus week", "status": "error" } } }, "Error400Response22": { "summary": "Invalid quarter value in surplus_week error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "json_path": "$.fiscal_year.surplus_week.quarter", "supported_values": [ 1, 2, 3, 4 ] }, "message": "Provide valid quarter for surplus week", "status": "error" } } }, "Error400Response23": { "summary": "Invalid period value in surplus_week error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "json_path": "$.fiscal_year.surplus_week.period", "supported_values": [ 1, 2, 3 ] }, "message": "Provide valid period for surplus week", "status": "error" } } }, "Error400Response24": { "summary": "All fiscal year fields missing error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": {}, "message": "Please give a valid data", "status": "error" } } }, "Error400Response3": { "summary": "Invalid interval_display_option error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "interval_display_option", "json_path": "$.fiscal_year.interval_display_option", "supported_values": [ "year", "quarter" ] }, "message": "Please give a valid number_by display option", "status": "error" } } }, "Error400Response4": { "summary": "Mismatched start_date and start_month error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "start_date", "json_path": "$.fiscal_year.start_date" }, "message": "start_date does not match with start_month", "status": "error" } } }, "Error400Response5": { "summary": "Surplus week cannot be configured for gregorian calendar error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "surplus_week", "json_path": "$.fiscal_year.surplus_week" }, "message": "cannot configure surplus week for gregorian calendar", "status": "error" } } }, "Error400Response6": { "summary": "Invalid start_month error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "start_month", "json_path": "$.fiscal_year.start_month", "supported_values": [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "message": "Please give a valid month", "status": "error" } } }, "Error400Response7": { "summary": "Invalid display_based_on error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "display_based_on", "json_path": "$.fiscal_year.display_based_on", "supported_values": [ "start_month", "end_month" ] }, "message": "Please give a valid display based on", "status": "error" } } }, "Error400Response8": { "summary": "Invalid calendar_type value error", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "calendar_type", "json_path": "$.fiscal_year.calendar_type", "supported_values": [ "gregorian", "custom" ] }, "message": "Please give a valid calendar type", "status": "error" } } }, "Error400Response8b": { "summary": "Invalid calendar_type format error (non-alphabetic characters)", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "calendar_type", "expected_data_type": "text", "json_path": "$.fiscal_year.calendar_type" }, "message": "Please give a valid calendar type", "status": "error" } } }, "Error400Response9": { "summary": "End month display restriction error for January or February", "value": { "fiscal_year": { "code": "INVALID_DATA", "details": { "api_name": "display_based_on", "json_path": "$.fiscal_year.display_based_on" }, "message": "Cannot configure end month as display based option for January and February for custom calendar type", "status": "error" } } } }, "schema": { "additionalProperties": false, "description": "Represents a wrapped fiscal year error response containing the validation error details.", "properties": { "fiscal_year": { "anyOf": [ { "$ref": "#/components/schemas/FiscalInvalidStartDateError" }, { "$ref": "#/components/schemas/FiscalInvalidCalendarTypeError" }, { "$ref": "#/components/schemas/FiscalInvalidStructureError" }, { "$ref": "#/components/schemas/FiscalInvalidStartDateMonthError" }, { "$ref": "#/components/schemas/FiscalInvalidMonthError" }, { "$ref": "#/components/schemas/FiscalInvalidDisplayBasedOnError" }, { "$ref": "#/components/schemas/FiscalInvalidIntervalDisplayOptionError" }, { "$ref": "#/components/schemas/FiscalInvalidEndMonthConfigError" }, { "$ref": "#/components/schemas/FiscalInvalidStartYearError" }, { "$ref": "#/components/schemas/FiscalInvalidSurpluYearError" }, { "$ref": "#/components/schemas/FiscalCompletedSurplusError" }, { "$ref": "#/components/schemas/AmbiguityError" }, { "$ref": "#/components/schemas/FiscalSurplusWeekYearMissingError" }, { "$ref": "#/components/schemas/FiscalSurplusWeekQuarterMissingError" }, { "$ref": "#/components/schemas/FiscalSurplusWeekPeriodMissingError" }, { "$ref": "#/components/schemas/FiscalYearDependentFieldMissingError" }, { "$ref": "#/components/schemas/FiscalStructureNotAllowedForGregorianError" }, { "$ref": "#/components/schemas/FiscalIntervalDisplayOptionNotAllowedForGregorianError" }, { "$ref": "#/components/schemas/FiscalSurplusWeekNotAllowedForGregorianError" }, { "$ref": "#/components/schemas/FiscalStartDateNotAllowedForGregorianError" }, { "$ref": "#/components/schemas/FiscalInvalidStartMonthForConfiguredDateError" }, { "$ref": "#/components/schemas/FiscalDeleteCompletedSurplusError" }, { "$ref": "#/components/schemas/FiscalInvalidSurplusWeekQuarterValueError" }, { "$ref": "#/components/schemas/FiscalInvalidSurplusWeekPeriodValueError" }, { "$ref": "#/components/schemas/FiscalInvalidDataError" } ] } }, "required": [ "fiscal_year" ], "type": "object", "x-zs-$id": "UpdateFiscalYearErrorResponse" } } }, "description": "The fiscal year settings update request failed due to invalid field values or an unsupported configuration." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailed": { "summary": "Authentication failure error", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "ScopeMismatch": { "summary": "OAuth scope mismatch error", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/FiscalYearOAuthScopeMismatchError" }, { "$ref": "#/components/schemas/FiscalYearAuthenticationFailureError" } ], "description": "Contains one of the possible authentication error responses returned when the fiscal year settings cannot be updated.", "x-zs-$id": "FiscalYearPut401ErrorResponse" } } }, "description": "The request failed because the OAuth access token is missing, invalid, or does not include the required scope." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "summary": "Non-admin user attempted to update fiscal year settings", "value": { "fiscal_year": { "code": "NO_PERMISSION", "details": {}, "message": "Only Admin Users can modify the fiscal year settings", "status": "error" } } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/FiscalNoPermissionError" } ], "description": "Contains the forbidden error response returned when the fiscal year settings cannot be updated due to insufficient permissions.", "x-zs-$id": "UpdateFiscalYear403ErrorResponse" } } }, "description": "The request failed because the authenticated user does not have administrator privileges to update the fiscal year settings" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.fiscal_year.UPDATE" ] } ], "summary": "Update Fiscal Year Settings", "tags": [ "fiscal_year" ], "x-zoho-document": "fiscal_year", "x-zs-llm-description": "First call GET /settings/fiscal_year to check the current calendar_type. To update only display_based_on (works for both gregorian and custom orgs), use DisplayBasedOnFiscalYearUpdate. If calendar_type is 'gregorian', use StandardFiscalYearUpdate or SwitchToCustomFiscalYearUpdate. If 'custom', use CustomFiscalYearPartialUpdate or SwitchToStandardFiscalYearUpdate." } }, "/crm/v8/settings/global_picklists": { "delete": { "description": "Deletes a single global picklist by numeric id. This request is asynchronous: a 202 Accepted indicates deletion has been scheduled and the response includes a job_id in details. There is no status-check endpoint currently. If the provided id is not present or deletion has already been scheduled, a 400 Bad Request is returned with error details.", "operationId": "deleteGlobalPicklists", "parameters": [ { "description": "Numeric id of the global picklist to delete. Accepts a single numeric id (e.g. 12345).", "example": "111111000000055938", "in": "query", "name": "ids", "required": true, "schema": { "format": "int64", "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "examples": { "AcceptedExample": { "value": { "global_picklists": [ { "code": "SCHEDULED", "details": { "job_id": "job_01Fxxxxxx" }, "message": "Deletion scheduled", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for scheduled deletion of a global picklist.", "properties": { "global_picklists": { "description": "Array containing the scheduled deletion response.", "items": { "additionalProperties": false, "description": "Scheduled deletion response details.", "properties": { "code": { "description": "Response code indicating the operation was scheduled.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the scheduled deletion.", "properties": { "job_id": { "description": "Background job identifier for the scheduled deletion.", "maxLength": 100, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Human-readable message about the scheduled operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "DeleteGlobalPicklistSuccessResponseSchema" } } }, "description": "Accepted - deletion scheduled. Response contains job_id in details. No status endpoint is provided." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduled": { "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "id": "111111000000075039" }, "message": "global picklist deletion in progress.", "status": "error" } ] } }, "AssociatedTooMany": { "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "id": "111111000000068005" }, "message": "global set can't be deleted as it is associated to more than 15 fields", "status": "error" } ] } }, "ConversionInProgress": { "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "id": "111111000000075039" }, "message": "global picklist conversion in progress", "status": "error" } ] } }, "InvalidId": { "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "id": "111111000000055935" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "SystemDefined": { "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "id": "11111100000005593" }, "message": "Deletion of system defined global set is not allowed", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Error response object for bad request containing global picklist deletion errors.", "properties": { "global_picklists": { "description": "Array of global picklist deletion error details.", "items": { "additionalProperties": false, "description": "Global picklist deletion error object.", "properties": { "code": { "description": "Error code indicating the type of validation or constraint failure.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error-specific details.", "properties": { "id": { "description": "The id of the global picklist that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteGlobalPicklistErrorResponseSchema" } } }, "description": "Bad Request - canonical error shapes for invalid id, already scheduled, conversion in progress, association limits, or system-defined restrictions." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.DELETE" ] } ], "summary": "Delete a Global Picklist", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Asynchronous bulk delete returning 202 with `details.job_id`. The picklist enters the delete scheduler; subsequent GET / replace / associations calls return 400 `global_picklist_in_delete_scheduler` until the job completes. There is no public status-check API for the job." }, "get": { "description": "Fetches the list of global picklists available in the organization along with their details. pick_list_values, used_in_modules, and associated_fields_count can be included in the response based on the \"include\" query parameter. The response can be filtered in three ways: use the \"fields\" query parameter to filter by key, so that only the requested keys along with \"id\" are returned; use the \"filters\" query parameter to filter the global picklists themselves by the value of a key; and use the \"inner_details_filters\" query parameter to filter the inner details of the global picklists. A 204 is returned when no global picklists exist.", "operationId": "getBulkGlobalPicklists", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsInclude" }, { "$ref": "#/components/parameters/GlobalPicklistsIncludeInnerDetails" }, { "$ref": "#/components/parameters/GlobalPicklistsFields" }, { "$ref": "#/components/parameters/ParamQueryInnerDetailsFilters" }, { "$ref": "#/components/parameters/GlobalPicklistsFilters" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GlobalPicklistsBulkExpanded": { "summary": "Expanded response when include=pick_list_values,used_in_modules,associated_fields_count", "value": { "global_picklists": [ { "actual_label": "Team Member Role", "api_name": "team_member_role__s", "created_by": null, "created_time": "2023-10-01T09:00:00Z", "customizable": false, "description": null, "display_label": "Team Member Role", "id": "4793076000000560088", "modified_by": null, "modified_time": "2023-10-10T10:00:00Z", "pick_list_values": [ { "actual_value": "Owner", "display_value": "Owner", "id": "4793076000000564764", "reference_value": "Owner", "sequence_number": 1, "type": "used" }, { "actual_value": "Admin", "display_value": "Admin", "id": "4793076000000564765", "reference_value": "Admin", "sequence_number": 2, "type": "used" }, { "actual_value": "Member", "display_value": "Member", "id": "4793076000000564766", "reference_value": "Member", "sequence_number": 3, "type": "unused" } ], "pick_list_values_sorted_lexically": false, "presence": true, "source": "crm", "used_in_modules": [ { "api_name": "Preferred_Team_Members__s", "id": "4793076000000559061", "plural_label": "Preferred Team Members" }, { "api_name": "Team_Selling__s", "id": "4793076000000559062", "plural_label": "Team Selling" } ] }, { "actual_label": "Access", "api_name": "access__s", "created_by": null, "created_time": "2023-10-01T09:00:00Z", "customizable": false, "description": null, "display_label": "Access", "id": "4793076000000560089", "modified_by": null, "modified_time": "2023-10-10T10:00:00Z", "pick_list_values": [ { "actual_value": "Private", "display_value": "Private", "id": "4793076000000564770", "reference_value": "Private", "sequence_number": 1, "type": "used" }, { "actual_value": "Public Read Only", "display_value": "Public Read Only", "id": "4793076000000564771", "reference_value": "Public Read Only", "sequence_number": 2, "type": "used" }, { "actual_value": "Public Read/Write", "display_value": "Public Read/Write", "id": "4793076000000564772", "reference_value": "Public Read/Write", "sequence_number": 3, "type": "unused" } ], "pick_list_values_sorted_lexically": false, "presence": true, "source": "crm" } ] } }, "GlobalPicklistsBulkMinimal": { "summary": "Minimal successful response", "value": { "global_picklists": [ { "actual_label": "Team Member Role", "api_name": "team_member_role__s", "created_by": null, "created_time": "2023-10-01T09:00:00Z", "customizable": false, "description": null, "display_label": "Team Member Role", "id": "4793076000000560088", "modified_by": null, "modified_time": "2023-10-10T10:00:00Z", "pick_list_values_sorted_lexically": false, "presence": true, "source": "crm" }, { "actual_label": "Access", "api_name": "access__s", "created_by": null, "created_time": "2023-10-01T09:00:00Z", "customizable": false, "description": null, "display_label": "Access", "id": "4793076000000560089", "modified_by": null, "modified_time": "2023-10-10T10:00:00Z", "pick_list_values_sorted_lexically": false, "presence": true, "source": "crm" } ] } }, "GlobalPicklistsFilteredByKey": { "summary": "Response when fields=display_label,api_name,customizable", "value": { "global_picklists": [ { "api_name": "team_member_role__s", "customizable": false, "display_label": "Team Member Role", "id": "4793076000000560088" }, { "api_name": "access__s", "customizable": false, "display_label": "Access", "id": "4793076000000560089" }, { "api_name": "Industry", "customizable": true, "display_label": "Industry", "id": "4793076000000560090" } ] } }, "GlobalPicklistsFilteredByValue": { "summary": "Response when filters selects a single global picklist by api_name", "value": { "global_picklists": [ { "actual_label": "Industry", "api_name": "Industry", "created_by": null, "created_time": null, "customizable": true, "description": null, "display_label": "Industry", "id": "4793076000000560090", "modified_by": null, "modified_time": null, "pick_list_values_sorted_lexically": false, "presence": true, "source": "crm" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing an array of global picklists.", "properties": { "global_picklists": { "description": "Array of global picklists with their properties.", "items": { "additionalProperties": false, "description": "Global picklist object with details. Every key listed here is returned by default. When the 'fields' query parameter is used, only the requested keys along with 'id' are present in the response, hence 'id' is the only key that is always returned.", "properties": { "actual_label": { "description": "Actual label of the global picklist.", "maxLength": 50, "type": "string" }, "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName", "x-zs-$id": "GlobalPicklistsApiName" }, "associated_fields_count": { "description": "Number of fields associated with this global picklist.", "format": "int32", "type": "integer" }, "created_by": { "anyOf": [ { "additionalProperties": false, "description": "User object with name and id.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the user.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "UserObjectNameAndIDSchema" }, { "description": "Null if no user information is available.", "type": "null", "x-zs-$id": "NullCreatedByUserSchema" } ], "description": "User who created the global picklist." }, "created_time": { "description": "Creation timestamp of the global picklist.", "format": "date-time", "type": [ "string", "null" ] }, "customizable": { "description": "Indicates if the global picklist is customizable.", "type": "boolean" }, "description": { "description": "Description of the global picklist.", "maxLength": 1000, "type": [ "string", "null" ] }, "display_label": { "description": "Display label of the global picklist.", "maxLength": 50, "type": "string" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId", "x-zs-$id": "GlobalPicklistsId" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "User object with name and id.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the user.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "UserObjectSchema" }, { "description": "Null if no user information is available.", "type": "null", "x-zs-$id": "NullUserSchema" } ], "description": "User who last modified the global picklist." }, "modified_time": { "description": "Last modification timestamp of the global picklist.", "format": "date-time", "type": [ "string", "null" ] }, "pick_list_values": { "description": "Array of picklist values.", "items": { "additionalProperties": false, "description": "Picklist value object.", "properties": { "actual_value": { "$ref": "#/components/schemas/PickListActualValue" }, "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId", "x-zs-$id": "GlobalPicklistsPickListValuesId" }, "reference_value": { "$ref": "#/components/schemas/PickListReferenceValue" }, "sequence_number": { "description": "Sequence number of the picklist value.", "format": "int32", "type": "integer" }, "type": { "description": "Type of the picklist value (used or unused).", "enum": [ "unused", "used" ], "type": "string" } }, "required": [ "id", "sequence_number", "type", "display_value", "reference_value" ], "type": "object" }, "maxItems": 5000, "type": "array" }, "pick_list_values_sorted_lexically": { "description": "Indicates if picklist values are sorted lexically.", "type": "boolean" }, "presence": { "description": "Indicates if the global picklist is present. false if global picklist is in delete scheduler.", "type": "boolean" }, "source": { "description": "Source of the global picklist.", "enum": [ "crm", "platform_plugin", "marketplace_plugin" ], "maxLength": 50, "type": "string" }, "used_in_modules": { "description": "Array of modules using this global picklist.", "items": { "additionalProperties": false, "description": "Module object with details.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "plural_label": { "$ref": "#/components/schemas/ModulepluralLabel" } }, "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "GetBulkGlobalPicklistsResponseSchema" } } }, "description": "Fetches the list of global picklists available in the organization along with their details. pick_list_values, used_in_modules, and associated_fields_count can be included in the response based on the \"include\" query parameter. When the \"fields\" query parameter is given, only the requested keys along with \"id\" are returned. When the \"filters\" query parameter is given, only the global picklists matching the criteria are returned. A 204 is returned when no global picklists exist." }, "204": { "description": "No global picklists available. (No content)" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "summary": "Error response with code DEPENDENT_FIELD_MISSING: Dependent Field missing (Field: comparator)", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.inner_details_filters[0].filters.field" }, "json_path": "$.inner_details_filters[0].filters.comparator", "param_name": "inner_details_filters" }, "message": "Dependent Field missing", "status": "error" } }, "DependentMismatchResponse1": { "summary": "Error response with code DEPENDENT_MISMATCH: dependent mismatch (Field: value)", "value": { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "api_name", "json_path": "$.inner_details_filters[0].filters.field.api_name" }, "expected_data_type": "boolean", "json_path": "$.inner_details_filters[0].filters.value", "param_name": "inner_details_filters" }, "message": "dependent mismatch", "status": "error" } }, "FiltersComparatorMissing": { "summary": "comparator is not given along with field", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.filters.field" }, "json_path": "$.filters.comparator", "param_name": "filters" }, "message": "Dependent Field missing", "status": "error" } }, "FiltersComparatorNotSupported": { "summary": "Unsupported comparator given in filters", "value": { "code": "INVALID_DATA", "details": { "api_name": "comparator", "json_path": "$.filters.comparator", "param_name": "filters", "supported_values": [ "not_equal", "equal" ] }, "message": "The value given is not supported", "status": "error" } }, "FiltersComparatorNotSupportedForBooleanKey": { "summary": "Unsupported comparator given for a boolean key in filters", "value": { "code": "INVALID_DATA", "details": { "api_name": "comparator", "json_path": "$.filters.comparator", "param_name": "filters", "supported_values": [ "equal" ] }, "message": "The value given is not supported", "status": "error" } }, "FiltersFieldApiNameNotFound": { "summary": "api_name is not given inside filters.field", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.filters.field.api_name", "param_name": "filters" }, "message": "required field not found", "status": "error" } }, "FiltersFieldApiNameNotSupported": { "summary": "The key given in filters.field.api_name cannot be filtered", "value": { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.filters.field.api_name", "param_name": "filters" }, "message": "The value given is not supported", "status": "error" } }, "FiltersFieldNotFound": { "summary": "field is not given inside filters", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.filters.field", "param_name": "filters" }, "message": "required field not found", "status": "error" } }, "FiltersGroupFieldApiNameNotSupported": { "summary": "The key given inside a group criteria cannot be filtered", "value": { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.filters.group[1].field.api_name", "param_name": "filters" }, "message": "The value given is not supported", "status": "error" } }, "FiltersGroupFieldNotAJsonObject": { "summary": "field inside a group criteria is not a JSON object", "value": { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.filters.group[1].field", "param_name": "filters" }, "message": "invalid data", "status": "error" } }, "FiltersGroupFieldNotFound": { "summary": "field is not given inside a group criteria", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.filters.group[1].field", "param_name": "filters" }, "message": "required field not found", "status": "error" } }, "FiltersGroupNotAJsonArray": { "summary": "filters.group is not a JSON array", "value": { "code": "INVALID_DATA", "details": { "api_name": "group", "expected_data_type": "jsonarray", "json_path": "$.filters.group", "param_name": "filters" }, "message": "invalid data", "status": "error" } }, "FiltersGroupNotFound": { "summary": "group_operator is given without group", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "group", "json_path": "$.filters.group", "param_name": "filters" }, "message": "required field not found", "status": "error" } }, "FiltersGroupOperatorNotFound": { "summary": "group is given without group_operator", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "group_operator", "json_path": "$.filters.group_operator", "param_name": "filters" }, "message": "required field not found", "status": "error" } }, "FiltersGroupOperatorNotSupported": { "summary": "Unsupported group_operator given in filters", "value": { "code": "INVALID_DATA", "details": { "api_name": "group_operator", "json_path": "$.filters.group_operator", "param_name": "filters", "supported_values": [ "and", "or" ] }, "message": "invalid data", "status": "error" } }, "FiltersNotAJsonObject": { "summary": "filters is empty", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "jsonobject", "param_name": "filters" }, "message": "invalid data", "status": "error" } }, "FiltersValueDataTypeMismatch": { "summary": "filters.value is not a string for a string key", "value": { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "api_name", "json_path": "$.filters.field.api_name" }, "expected_data_type": "string", "json_path": "$.filters.value", "param_name": "filters" }, "message": "dependent mismatch", "status": "error" } }, "FiltersValueMissing": { "summary": "value is not given along with field", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "value", "dependee": { "api_name": "field", "json_path": "$.filters.field" }, "json_path": "$.filters.value", "param_name": "filters" }, "message": "Dependent Field missing", "status": "error" } }, "FiltersValueNotABoolean": { "summary": "filters.value is not a boolean for a boolean key", "value": { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "api_name", "json_path": "$.filters.field.api_name" }, "expected_data_type": "boolean", "json_path": "$.filters.value", "param_name": "filters" }, "message": "dependent mismatch", "status": "error" } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "jsonarray", "param_name": "inner_details_filters" }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: invalid data (Field: api_name)", "value": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.inner_details_filters[0].api_name", "param_name": "inner_details_filters" }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: invalid data (Field: filters)", "value": { "code": "INVALID_DATA", "details": { "api_name": "filters", "expected_data_type": "jsonobject", "json_path": "$.inner_details_filters[0].filters", "param_name": "inner_details_filters" }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: The value given is not supported (Field: comparator)", "value": { "code": "INVALID_DATA", "details": { "api_name": "comparator", "json_path": "$.inner_details_filters[0].filters.comparator", "param_name": "inner_details_filters", "supported_values": [ "equal", "not_equal" ] }, "message": "The value given is not supported", "status": "error" } }, "InvalidGroupOperatorResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: group_operator)", "value": { "code": "INVALID_DATA", "details": { "api_name": "group_operator", "json_path": "$.inner_details_filters[0].filters.group_operator", "param_name": "inner_details_filters", "supported_values": [ "and", "or" ] }, "message": "invalid data", "status": "error" } }, "MandatoryNotFoundResponseApiName": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: api_name)", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.inner_details_filters[0].api_name", "param_name": "inner_details_filters" }, "message": "required field not found", "status": "error" } }, "MandatoryNotFoundResponseField": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: field)", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "field", "json_path": "$.inner_details_filters[0].filters.field", "param_name": "inner_details_filters" }, "message": "required field not found", "status": "error" } }, "MandatoryNotFoundResponseFieldApiName": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: field.api_name)", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.inner_details_filters[0].filters.field.api_name", "param_name": "inner_details_filters" }, "message": "required field not found", "status": "error" } }, "MandatoryNotFoundResponseFilters": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: filters)", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "filters", "json_path": "$.inner_details_filters[0].filters", "param_name": "inner_details_filters" }, "message": "required field not found", "status": "error" } }, "NotSupportedFieldResponse1": { "summary": "Error response with code NOT_SUPPORTED: The value given is not supported (Field: api_name)", "value": { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.inner_details_filters[0].filters.field.api_name", "param_name": "inner_details_filters" }, "message": "The value given is not supported", "status": "error" } }, "NotSupportedFieldResponse2": { "summary": "Error response with code NOT_SUPPORTED: The value given is not supported (Field: api_name in nested group)", "value": { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.inner_details_filters[0].filters.group[1].field.api_name", "param_name": "inner_details_filters" }, "message": "The value given is not supported", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/GlobalPicklistsInvalidFilterParamError" }, { "$ref": "#/components/schemas/GlobalPicklistsMandatoryApiNameMissingError" }, { "$ref": "#/components/schemas/GlobalPicklistsInvalidApiNameError" }, { "$ref": "#/components/schemas/GlobalPicklistsInvalidFiltersError" }, { "$ref": "#/components/schemas/GlobalPicklistsUnsupportedComparatorError" }, { "$ref": "#/components/schemas/GlobalPicklistsDependentTypeMismatchError" }, { "$ref": "#/components/schemas/GlobalPicklistsMissingComparatorForFieldError" }, { "$ref": "#/components/schemas/GlobalPicklistsNotSupportedFieldError" }, { "$ref": "#/components/schemas/GlobalPicklistsInvalidGroupOperatorError" } ], "x-zs-$id": "GetbulkglobalpicklistsError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax, or the \"filters\" or \"inner_details_filters\" query parameter is malformed, holds an unsupported key, comparator or value, or a mandatory/dependent key inside it is missing." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.READ" ] } ], "summary": "Get All Global Picklists", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Lists every global picklist in the org. Use the \"include\" query (pick_list_values, used_in_modules, associated_fields_count) to expand inner details; pick_list_values triggers the heavier getGlobalFieldsWithOptions fetch internally. Use \"fields\" to restrict the response to specific keys — only the requested keys along with \"id\" are returned, and a key repeated in the list is processed once. Use \"filters\" to select the global picklists by the value of a key — either a single criteria (field/comparator/value) or a group of criteria combined with group_operator — and \"inner_details_filters\" to filter the inner details of the global picklists. Only api_name, source and customizable can be filtered on in \"filters\" (customizable is boolean and takes only equal); anything else returns 400 NOT_SUPPORTED. Internal/private global sets are filtered out unless the caller is explicitly entitled. Returns 204 when the feature is unavailable and no internal sets are requested." }, "patch": { "description": "Updates an existing global picklist. You can update display_label, api_name, description, pick_list_values_sorted_lexically, and pick_list_values. Backend-generated properties (actual_label, customizable, modified_by, created_by, presence) cannot be updated. For pick_list_values, you can add new values, update existing values (using id), move values between used/unused (one at a time), or delete values (one at a time using _delete: true). Bulk operations for moving to unused or deletion are not allowed.", "operationId": "updateGlobalPicklist", "requestBody": { "content": { "application/json": { "examples": { "AddPicklistValue": { "summary": "Add new picklist value", "value": { "global_picklists": [ { "id": "111111000000055935", "pick_list_values": [ { "display_value": "Critical", "type": "used" } ] } ] } }, "DeletePicklistValue": { "summary": "Delete one picklist value", "value": { "global_picklists": [ { "id": "111111000000055935", "pick_list_values": [ { "_delete": true, "id": "111111000000055938" } ] } ] } }, "MoveToUnused": { "summary": "Move one value to unused", "value": { "global_picklists": [ { "id": "111111000000055935", "pick_list_values": [ { "id": "111111000000055938", "type": "unused" } ] } ] } }, "UpdateDisplayLabel": { "summary": "Update display label", "value": { "global_picklists": [ { "display_label": "Updated Priority Level", "id": "111111000000055935" } ] } }, "UpdatePicklistValue": { "summary": "Update existing picklist value", "value": { "global_picklists": [ { "id": "111111000000055935", "pick_list_values": [ { "display_value": "High Priority", "id": "111111000000055938" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for updating a global picklist.", "properties": { "global_picklists": { "description": "Array containing the global picklist to update.", "items": { "additionalProperties": false, "description": "Global picklist object with update details.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "description": { "description": "Updated description of the global picklist.", "maxLength": 1000, "type": [ "string", "null" ] }, "display_label": { "description": "Updated display label of the global picklist.", "maxLength": 50, "type": "string" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "pick_list_values": { "description": "Array of picklist values to add, update, or delete. For updates, include id and fields to update. For deletion, include id and _delete: true. Only one value can be moved to unused or deleted per request.", "items": { "additionalProperties": false, "description": "Picklist value object for update/add/delete.", "properties": { "_delete": { "description": "Set to true to delete this picklist value. Only one value can be deleted per request.", "type": "boolean" }, "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "reference_value": { "$ref": "#/components/schemas/PickListReferenceValue" }, "type": { "description": "Type of the picklist value (used or unused). Only one value can be moved to unused per request.", "enum": [ "unused", "used" ], "type": "string" } }, "type": "object" }, "maxItems": 5000, "type": "array" }, "pick_list_values_sorted_lexically": { "description": "Indicates if picklist values should be sorted lexically.", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object" }, "x-zs-llm-examples": [ "AddPicklistValue", "DeletePicklistValue", "MoveToUnused", "UpdateDisplayLabel", "UpdatePicklistValue" ] } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "summary": "Successful update response", "value": { "global_picklists": [ { "code": "SUCCESS", "details": { "id": "111111000000055935" }, "message": "global picklist updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for successful update of a global picklist.", "properties": { "global_picklists": { "description": "Array containing the updated global picklist response.", "items": { "additionalProperties": false, "description": "Updated global picklist response details.", "properties": { "code": { "description": "Response code indicating successful update.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the updated global picklist.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable success message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "UpdateGlobalPicklistSuccessResponseSchema" } } }, "description": "OK - Global picklist updated successfully." }, "400": { "content": { "application/json": { "examples": { "AddMoreThan50Values": { "summary": "Adding >50 values when >15 fields", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 50, "limit_due_to": { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[50]" } }, "message": "Adding more than 50 values in a single save is not allowed when they are associated with more than 15 fields.", "status": "error" } ] } }, "BulkDeletion": { "summary": "Bulk deletion not allowed", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1, "limit_due_to": { "api_name": "_delete", "json_path": "$.global_picklists[0].pick_list_values[1]._delete" } }, "message": "More than one picklist value cannot be deleted", "status": "error" } ] } }, "BulkUnusedMovement": { "summary": "Bulk unused movement not allowed", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1, "limit_due_to": [ { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[1].type" } ] }, "message": "More than one picklist value cannot be moved to unused type", "status": "error" } ] } }, "DeleteMoreThan15Fields": { "summary": "Cannot delete when associated with >15 fields", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[0]._delete" }, "message": "option can't be deleted as global set is associated to more than 15 fields", "status": "error" } ] } }, "DeletionInProgress": { "summary": "Deletion in progress", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "global_picklists", "json_path": "$.global_picklists[0]" }, "message": "global picklist deletion in progress.", "status": "error" } ] } }, "DescriptionMaxLength": { "summary": "description exceeds 1000 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.global_picklists[0].description", "maximum_length": 1000 }, "message": "invalid data", "status": "error" } ] } }, "DisplayLabelMaxLength": { "summary": "display_label exceeds 50 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "DisplayValueEmpty": { "summary": "display_value is empty or null", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "Display value in pick list values cannot be empty or null", "status": "error" } ] } }, "DisplayValueMaxLength": { "summary": "display_value exceeds 120 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value", "maximum_length": 120 }, "message": "invalid data", "status": "error" } ] } }, "DuplicateApiName": { "summary": "Duplicate api_name", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.global_picklists[0].api_name" }, "message": "Duplicate Api name found, enter a unique Api name.", "status": "error" } ] } }, "DuplicateDisplayLabel": { "summary": "Duplicate display_label", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "Duplicate name found, enter a unique name.", "status": "error" } ] } }, "DuplicateDisplayValue": { "summary": "Duplicate display_value in pick_list_values", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Duplicate option found. Enter a unique option.", "status": "error" } ] } }, "DuplicateReferenceValue": { "summary": "Duplicate reference_value in pick_list_values", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Duplicate reference option found. Enter a unique reference option.", "status": "error" } ] } }, "EmojiInDisplayLabel": { "summary": "Emoji in display_label", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "INVALID_FIELD_LABEL", "status": "error" } ] } }, "EmptyApiName": { "summary": "Empty api_name", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.global_picklists[0].api_name" }, "message": "Api Name cannot be empty", "status": "error" } ] } }, "EmptyDisplayLabel": { "summary": "display_label is empty", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "required field not found", "status": "error" } ] } }, "InvalidApiNameFormat": { "summary": "Invalid api_name format", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.global_picklists[0].api_name" }, "message": "Api Name should start with English alphabets followed by numbers or alphabets or underscore and should not end with underscore", "status": "error" } ] } }, "InvalidId": { "summary": "Invalid global picklist id", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "id": "11111100000005593", "json_path": "$.global_picklists[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidOptionId": { "summary": "Invalid picklist value id", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.global_picklists[0].pick_list_values[503].id" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryDisplayValueForUpdate": { "summary": "Missing display_value for update", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryIdNotFound": { "summary": "Missing id field", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.global_picklists[0].id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryPickListValues": { "summary": "Missing pick_list_values", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "required field not found", "status": "error" } ] } }, "MoveMoreThan50ToUsed": { "summary": "Moving >50 values to used when >15 fields", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 50, "limit_due_to": [ { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[50].type" } ] }, "message": "Moving more than 50 values to the used section in a single save is not allowed when they are associated with more than 15 fields.", "status": "error" } ] } }, "NoUsedOption": { "summary": "No used option in picklist values", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Values in the pick list field cannot be empty.", "status": "error" } ] } }, "OptionDeleteNotAllowed": { "summary": "Option delete not allowed", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values[1]" }, "message": "Option delete not allowed", "status": "error" } ] } }, "ReferenceValueEmpty": { "summary": "reference_value is empty or null", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value" }, "message": "Actual value in pick list values cannot be empty or null", "status": "error" } ] } }, "ReferenceValueMaxLength": { "summary": "reference_value exceeds 120 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value", "maximum_length": 120 }, "message": "invalid data", "status": "error" } ] } }, "ReplaceInProgress": { "summary": "Replace process in progress", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Some values can not be modified since they are being deleted from the system through replacing process.", "status": "error" } ] } }, "SpecialCharactersDisplayLabel": { "summary": "Special characters in display_label", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "Special characters in name", "status": "error" } ] } }, "SpecialCharactersDisplayValue": { "summary": "Special characters in display_value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "Special characters are not allowed in Options", "status": "error" } ] } }, "SpecialCharactersReferenceValue": { "summary": "Special characters in reference_value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value" }, "message": "Special characters are not allowed in Options", "status": "error" } ] } }, "SystemDefinedUpdate": { "summary": "System defined global set update not allowed", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "id": "11111100000005593", "json_path": "$.global_picklists[0].id" }, "message": "Updation of system defined global set is not allowed", "status": "error" } ] } }, "UnusedOptionsLimitExceeded": { "summary": "Unused options limit exceeded (500)", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 500, "limit_due_to": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" } }, "message": "Sorry, you have reached the limit of 500 unused values added for this pick list field.", "status": "error" } ] } }, "UsedOptionsLimitExceeded": { "summary": "Used options limit exceeded (1000)", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1000, "limit_due_to": [ { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" } ] }, "message": "Sorry, you have reached the limit of 1000 values added for this pick list field.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Error response object for bad request containing global picklist update errors.", "properties": { "global_picklists": { "description": "Array of global picklist update error details.", "items": { "additionalProperties": false, "description": "Global picklist update error object.", "properties": { "code": { "description": "Error code indicating the type of validation or constraint failure.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "MANDATORY_NOT_FOUND", "LIMIT_EXCEEDED", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error-specific details.", "properties": { "api_name": { "description": "Name of the field causing the error.", "maxLength": 100, "type": "string" }, "id": { "description": "ID of the resource causing the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing the error.", "maxLength": 255, "type": "string" }, "limit": { "description": "The maximum allowed limit that has been exceeded.", "format": "int32", "type": "integer" }, "limit_due_to": { "anyOf": [ { "description": "Array of fields that caused the limit to be exceeded.", "items": { "additionalProperties": false, "description": "Field causing limit exceeded error.", "properties": { "api_name": { "description": "API name of the field causing limit issue.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing limit issue.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array", "x-zs-$id": "LimitDueToArraySchema" }, { "additionalProperties": false, "description": "Single field that caused the limit to be exceeded.", "properties": { "api_name": { "description": "API name of the field causing limit issue.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing limit issue.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "LimitDueToSingleObjectSchema" } ] }, "maximum_length": { "description": "Maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "UpdateGlobalPicklistErrorResponseSchema" } } }, "description": "Bad Request - Invalid data, missing required fields, duplicate values, special characters, length exceeded, limit exceeded, reserved keywords, or operation not allowed." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.UPDATE" ] } ], "summary": "Update a Global Picklist", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Bulk update one global picklist via top-level body. Editable: `display_label`, `description`, `api_name` (only when `isAPINameUpdateAllowed()` is true), `pick_list_values_sorted_lexically`, and `pick_list_values` (add / update / delete / move-to-unused). Adding values is bounded by `FIELD_ASSOCIATION_LIMIT` / `OPTION_ASSOCIATION_THRESHOLD` enforced in `validateOptionsCount`. Pick the request example that matches your intent (`AddPicklistValue`, `DeletePicklistValue`, `MoveToUnused`, `UpdateDisplayLabel`, `UpdatePicklistValue`)." }, "post": { "description": "Creates a new global picklist with the specified display label, API name, description, and picklist values. The actual_label, customizable, modified_by, created_by, and presence properties are generated by the backend. In pick_list_values, only display_value and type are considered.", "operationId": "createGlobalPicklist", "requestBody": { "content": { "application/json": { "examples": { "CreateGlobalPicklistExample": { "summary": "Example request to create a global picklist", "value": { "global_picklists": [ { "api_name": "priority_level__s", "description": "Priority levels for tasks and activities", "display_label": "Priority Level", "pick_list_values": [ { "display_value": "High", "type": "used" }, { "display_value": "Medium", "type": "used" }, { "display_value": "Low", "type": "unused" } ], "pick_list_values_sorted_lexically": false } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for creating a new global picklist.", "properties": { "global_picklists": { "description": "Array containing the global picklist to create.", "items": { "additionalProperties": true, "description": "Global picklist object with creation details.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "description": { "description": "Description of the global picklist.", "maxLength": 1000, "type": [ "string", "null" ] }, "display_label": { "description": "Display label of the global picklist.", "maxLength": 50, "type": "string" }, "pick_list_values": { "description": "Array of picklist values. Only display_value and type are considered.", "items": { "additionalProperties": true, "description": "Picklist value object for creation.", "properties": { "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "type": { "description": "Type of the picklist value (used or unused).", "enum": [ "unused", "used" ], "type": "string" } }, "required": [ "display_value", "type" ], "type": "object" }, "maxItems": 5000, "type": "array" }, "pick_list_values_sorted_lexically": { "description": "Indicates if picklist values should be sorted lexically.", "type": "boolean" } }, "required": [ "display_label", "pick_list_values" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object" }, "x-zs-llm-examples": [ "CreateGlobalPicklistExample" ] } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessExample": { "summary": "Successful creation response", "value": { "global_picklists": [ { "code": "SUCCESS", "details": { "id": "4793076000000560088" }, "message": "global picklist added successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for successful creation of a global picklist.", "properties": { "global_picklists": { "description": "Array containing the created global picklist response.", "items": { "additionalProperties": false, "description": "Created global picklist response details.", "properties": { "code": { "description": "Response code indicating successful creation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the created global picklist.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable success message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "CreateGlobalPicklistSuccessResponseSchema" } } }, "description": "Created - Global picklist created successfully." }, "400": { "content": { "application/json": { "examples": { "DescriptionMaxLength": { "summary": "description exceeds 1000 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.global_picklists[0].description", "maximum_length": 1000 }, "message": "invalid data", "status": "error" } ] } }, "DisplayLabelMaxLength": { "summary": "display_label exceeds 50 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "DisplayValueEmpty": { "summary": "display_value is empty or null", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "Display value in pick list values cannot be empty or null", "status": "error" } ] } }, "DisplayValueMaxLength": { "summary": "display_value exceeds 120 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value", "maximum_length": 120 }, "message": "invalid data", "status": "error" } ] } }, "DuplicateDisplayLabel": { "summary": "Duplicate display_label error", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "Duplicate name found, enter a unique name.", "status": "error" } ] } }, "DuplicateDisplayValue": { "summary": "Duplicate display_value in pick_list_values", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Duplicate option found. Enter a unique option.", "status": "error" } ] } }, "DuplicateReferenceValue": { "summary": "Duplicate reference_value in pick_list_values", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Duplicate reference option found. Enter a unique reference option.", "status": "error" } ] } }, "EmojiInDisplayLabel": { "summary": "Emoji in display_label", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "invalid data", "status": "error" } ] } }, "GlobalPicklistsLimitExceeded": { "summary": "Global picklists limit exceeded", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 10, "limit_due_to": [ { "api_name": "global_picklists", "json_path": "$.global_picklists[0]" } ] }, "message": "global picklists limit exceeded", "status": "error" } ] } }, "InvalidType": { "summary": "Invalid type value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[1].type", "regex": "used|unused" }, "message": "invalid data", "status": "error" } ] } }, "LargeGlobalPicklistsLimitExceeded": { "summary": "Large global picklists limit exceeded", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 10, "limit_due_to": [ { "api_name": "global_picklists", "json_path": "$.global_picklists[0]" } ] }, "message": "Large global picklists limit exceeded", "status": "error" } ] } }, "MandatoryDisplayLabel": { "summary": "display_label not provided", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryDisplayValueInPickList": { "summary": "display_value not provided in first pick_list_values", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryPickListValues": { "summary": "Missing pick_list_values", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "required field not found", "status": "error" } ] } }, "NoUsedOption": { "summary": "No used option in picklist values", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Values in the pick list field cannot be empty.", "status": "error" } ] } }, "NoneInDisplayValue": { "summary": "-None- in display_value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values.display_value" }, "message": "invalid data", "status": "error" } ] } }, "ReferenceValueEmpty": { "summary": "reference_value is empty or null", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value" }, "message": "Reference value in pick list values cannot be empty or null", "status": "error" } ] } }, "ReferenceValueMaxLength": { "summary": "reference_value exceeds 120 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value", "maximum_length": 120 }, "message": "invalid data", "status": "error" } ] } }, "ReservedKeyword": { "summary": "System keyword not allowed in global set label", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "System keyword not allowed in global set label", "status": "error" } ] } }, "SpecialCharactersDisplayLabel": { "summary": "Special characters in display_label", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "Special characters in name", "status": "error" } ] } }, "SpecialCharactersDisplayValue": { "summary": "Special characters in display_value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "Special characters are not allowed in Options", "status": "error" } ] } }, "SpecialCharactersReferenceValue": { "summary": "Special characters in reference_value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value" }, "message": "Special characters are not allowed in Options", "status": "error" } ] } }, "UnusedOptionsLimitExceeded": { "summary": "Unused options limit exceeded (500)", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 500, "limit_due_to": [ { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" } ] }, "message": "Sorry, you have reached the limit of 500 unused values added for this pick list field.", "status": "error" } ] } }, "UsedOptionsLimitExceeded": { "summary": "Used options limit exceeded (1000)", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1000, "limit_due_to": [ { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" } ] }, "message": "Sorry, you have reached the limit of 1000 values added for this pick list field.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Error response object for bad request containing global picklist creation errors.", "properties": { "global_picklists": { "description": "Array of global picklist creation error details.", "items": { "additionalProperties": false, "description": "Global picklist creation error object.", "properties": { "code": { "description": "Error code indicating the type of validation or constraint failure.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "MANDATORY_NOT_FOUND", "LIMIT_EXCEEDED", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error-specific details.", "properties": { "api_name": { "description": "Name of the field causing the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing the error.", "maxLength": 255, "type": "string" }, "limit": { "description": "The maximum allowed limit that has been exceeded.", "format": "int32", "type": "integer" }, "limit_due_to": { "description": "List of fields that caused the limit to be exceeded.", "items": { "additionalProperties": false, "description": "Field causing limit exceeded error.", "properties": { "api_name": { "description": "API name of the field causing limit issue.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing limit issue.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array" }, "maximum_length": { "description": "Maximum allowed length for the global field label, description, or picklist value.", "format": "int32", "type": "integer" }, "regex": { "description": "Expected regex pattern for the field value.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "CreateGlobalPicklistErrorResponseSchema" } } }, "description": "Bad Request - Invalid data, missing required fields, duplicate values, special characters, length exceeded, limit exceeded, or reserved keywords." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.CREATE" ] } ], "summary": "Create a Global Picklist", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Creates a single global picklist. Required: `display_label` and at least one entry in `pick_list_values`. `api_name` is auto-generated from `display_label` when omitted and must not collide with restricted labels such as `country__s` or `state__s`. Special characters from the legacy field-name restriction set are rejected in `api_name`. Backend-managed fields (`actual_label`, `customizable`, `presence`, `created_by`, `modified_by`, timestamps) must not be sent. The new record id is returned at `global_picklists[].details.id`." } }, "/crm/v8/settings/global_picklists/{id}": { "delete": { "description": "Deletes a single global picklist identified by the path parameter \\{id\\}. This request is asynchronous: a 202 Accepted indicates deletion has been scheduled and the response contains a job_id in details. There is no status-check endpoint. A 400 Bad Request is returned for invalid id, deletion already scheduled, conversion in progress, association limits, or system-defined restrictions. When an error refers to a position in a multi-resource request/path, details.resource_path_index is provided.", "operationId": "deleteGlobalPicklist", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsId" } ], "responses": { "202": { "content": { "application/json": { "examples": { "AcceptedExample": { "value": { "global_picklists": [ { "code": "SCHEDULED", "details": { "job_id": "job_01Fxxxxxx" }, "message": "Deletion scheduled", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for scheduled deletion of a global picklist.", "properties": { "global_picklists": { "description": "Array containing the scheduled deletion response.", "items": { "additionalProperties": false, "description": "Scheduled deletion response details.", "properties": { "code": { "description": "Response code indicating the operation was scheduled.", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the scheduled deletion.", "properties": { "job_id": { "description": "Background job identifier for the scheduled deletion.", "maxLength": 100, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Human-readable message about the scheduled operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "DeleteGlobalPicklistScheduledResponseSchema" } } }, "description": "Accepted - deletion scheduled. Response contains job_id in details. No status endpoint is provided." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduled": { "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global picklist deletion in progress.", "status": "error" } }, "AssociatedTooMany": { "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global set can't be deleted as it is associated to more than 15 fields", "status": "error" } }, "ConversionInProgress": { "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global picklist conversion in progress", "status": "error" } }, "InvalidIdURL": { "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "SystemDefined": { "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Deletion of system defined global set is not allowed", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object for bad request containing code, message, details, and status.", "properties": { "code": { "description": "Error code indicating the type of validation or constraint failure.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error-specific details.", "properties": { "resource_path_index": { "description": "Index in the request path or array indicating the failing resource position.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteIdGlobalPicklistErrorResponseSchema" } } }, "description": "Bad Request - canonical error shapes (top-level or array-form). See examples for common cases. All variants include code, details, message, and status." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.DELETE" ] } ], "summary": "Delete a Global Picklist by ID", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Asynchronous delete by path `{id}` returning 202 with `details.job_id`. Same scheduler-blocking behavior as the bulk variant: while the job is pending, dependent endpoints (`replace_picklist_values`, `associations`, `replaced_values`) return 400 `global_picklist_in_delete_scheduler`." }, "get": { "description": "Fetches the global picklist for given id along with their pick_list_values. used_in_modules, and associated_fields_count can be included in the response based on the 'include' query parameter. Use the `fields` query parameter to filter the response by key, so that only the requested keys along with `id` are returned. A 204 is returned when no global picklists exist.", "operationId": "getSingleGlobalPicklists", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsId" }, { "$ref": "#/components/parameters/GlobalPicklistsInclude" }, { "$ref": "#/components/parameters/GlobalPicklistsIncludeInnerDetails" }, { "$ref": "#/components/parameters/GlobalPicklistsFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GlobalPicklistsExpanded": { "summary": "Expanded response when include=pick_list_values,used_in_modules,associated_fields_count", "value": { "global_picklists": [ { "actual_label": "Team Member Role", "api_name": "team_member_role__s", "created_by": null, "created_time": "2023-10-01T09:00:00Z", "customizable": false, "description": null, "display_label": "Team Member Role", "id": "4793076000000560088", "modified_by": null, "modified_time": "2023-10-10T10:00:00Z", "pick_list_values": [ { "actual_value": "Owner", "display_value": "Owner", "id": "4793076000000564764", "reference_value": "Owner", "sequence_number": 1, "type": "used" }, { "actual_value": "Admin", "display_value": "Admin", "id": "4793076000000564765", "reference_value": "Admin", "sequence_number": 2, "type": "used" }, { "actual_value": "Member", "display_value": "Member", "id": "4793076000000564766", "reference_value": "Member", "sequence_number": 3, "type": "unused" } ], "pick_list_values_sorted_lexically": false, "presence": true, "source": "crm", "used_in_modules": [ { "api_name": "Preferred_Team_Members__s", "id": "4793076000000559061", "plural_label": "Preferred Team Members" }, { "api_name": "Team_Selling__s", "id": "4793076000000559062", "plural_label": "Team Selling" } ] } ] } }, "GlobalPicklistsFilteredByKey": { "summary": "Response when fields=display_label,api_name,customizable", "value": { "global_picklists": [ { "api_name": "team_member_role__s", "customizable": false, "display_label": "Team Member Role", "id": "4793076000000560088" } ] } }, "GlobalPicklistsMinimal": { "summary": "Minimal successful response", "value": { "global_picklists": [ { "actual_label": "Team Member Role", "api_name": "team_member_role__s", "created_by": null, "created_time": "2023-10-01T09:00:00Z", "customizable": false, "description": null, "display_label": "Team Member Role", "id": "4793076000000560088", "modified_by": null, "modified_time": "2023-10-10T10:00:00Z", "pick_list_values": [ { "actual_value": "Owner", "display_value": "Owner", "id": "4793076000000564764", "reference_value": "Owner", "sequence_number": 1, "type": "used" }, { "actual_value": "Admin", "display_value": "Admin", "id": "4793076000000564765", "reference_value": "Admin", "sequence_number": 2, "type": "used" }, { "actual_value": "Member", "display_value": "Member", "id": "4793076000000564766", "reference_value": "Member", "sequence_number": 3, "type": "unused" } ], "pick_list_values_sorted_lexically": false, "presence": true, "source": "crm" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing an array of global picklists.", "properties": { "global_picklists": { "description": "Array of global picklists with their properties.", "items": { "additionalProperties": false, "description": "Global picklist object with details. Every key listed here is returned by default. When the 'fields' query parameter is used, only the requested keys along with 'id' are present in the response, hence 'id' is the only key that is always returned.", "properties": { "actual_label": { "description": "Actual label of the global picklist.", "maxLength": 50, "type": "string" }, "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "associated_fields_count": { "description": "Number of fields associated with this global picklist.", "format": "int32", "type": "integer" }, "created_by": { "anyOf": [ { "additionalProperties": false, "description": "User object with name and id.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the user.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "GetSingleGlobalPicklistCreatedByUserSchema" }, { "description": "Null if no user information is available.", "type": "null", "x-zs-$id": "GetSingleGlobalPicklistCreatedByNullSchema" } ], "description": "User who created the global picklist." }, "created_time": { "description": "Creation timestamp of the global picklist.", "format": "date-time", "type": [ "string", "null" ] }, "customizable": { "description": "Indicates if the global picklist is customizable.", "type": "boolean" }, "description": { "description": "Description of the global picklist.", "maxLength": 1000, "type": [ "string", "null" ] }, "display_label": { "description": "Display label of the global picklist.", "maxLength": 50, "type": "string" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "User object with name and id.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the user.", "maxLength": 255, "type": "string" } }, "type": "object", "x-zs-$id": "GetSingleGlobalPicklistModifiedByUserSchema" }, { "description": "Null if no user information is available.", "type": "null", "x-zs-$id": "GetSingleGlobalPicklistModifiedByNullSchema" } ], "description": "User who last modified the global picklist." }, "modified_time": { "description": "Last modification timestamp of the global picklist.", "format": "date-time", "type": [ "string", "null" ] }, "pick_list_values": { "description": "Array of picklist values.", "items": { "additionalProperties": false, "description": "Picklist value object.", "properties": { "actual_value": { "$ref": "#/components/schemas/PickListActualValue" }, "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "reference_value": { "$ref": "#/components/schemas/PickListReferenceValue" }, "sequence_number": { "description": "Sequence number of the picklist value.", "format": "int32", "type": "integer" }, "type": { "description": "Type of the picklist value (used or unused).", "enum": [ "unused", "used" ], "type": "string" } }, "required": [ "id", "sequence_number", "type", "display_value", "reference_value" ], "type": "object" }, "maxItems": 5000, "type": "array" }, "pick_list_values_sorted_lexically": { "description": "Indicates if picklist values are sorted lexically.", "type": "boolean" }, "presence": { "description": "Indicates if the global picklist is present. false if global picklist is in delete scheduler.", "type": "boolean" }, "source": { "description": "Source of the global picklist.", "enum": [ "crm", "platform_plugin", "marketplace_plugin" ], "maxLength": 50, "type": "string" }, "used_in_modules": { "description": "Array of modules using this global picklist.", "items": { "additionalProperties": false, "description": "Module object with details.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "plural_label": { "$ref": "#/components/schemas/ModulepluralLabel" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "GetSingleGlobalPicklistResponseSchema" } } }, "description": "Fetches the global picklist for given id along with their pick_list_values. used_in_modules, and associated_fields_count can be included in the response based on the 'include' query parameter. When the 'fields' query parameter is given, only the requested keys along with 'id' are returned. A 204 is returned when no global picklists exist." }, "204": { "description": "No global picklists available. (No content)" }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.READ" ] } ], "summary": "Get a Single Global Picklist by ID", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Fetches one global picklist by numeric `id`. Always returns `pick_list_values` (internally calls `getGlobalFieldsWithOptions`). Use `include` to expand `used_in_modules` and `associated_fields_count`, and `fields` to restrict the response to specific keys — only the requested keys along with `id` are returned. Returns 204 when the row is hidden from the caller (e.g. feature unavailable and the record is not marked private)." }, "patch": { "description": "Updates an existing global picklist identified by the path parameter \\{id\\}. You can update display_label, api_name, description, pick_list_values_sorted_lexically, and pick_list_values. Backend-generated properties (actual_label, customizable, modified_by, created_by, presence) cannot be updated. For pick_list_values, you can add new values, update existing values (using id), move values between used/unused (one at a time), or delete values (one at a time using _delete: true). Bulk operations for moving to unused or deletion are not allowed.", "operationId": "updateGlobalPicklistById", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsId" } ], "requestBody": { "content": { "application/json": { "examples": { "AddPicklistValue": { "summary": "Add new picklist value", "value": { "global_picklists": [ { "pick_list_values": [ { "display_value": "Critical", "type": "used" } ] } ] } }, "DeletePicklistValue": { "summary": "Delete one picklist value", "value": { "global_picklists": [ { "pick_list_values": [ { "_delete": true, "id": "111111000000055938" } ] } ] } }, "MoveToUnused": { "summary": "Move one value to unused", "value": { "global_picklists": [ { "pick_list_values": [ { "id": "111111000000055938", "type": "unused" } ] } ] } }, "UpdateApiName": { "summary": "Update API name", "value": { "global_picklists": [ { "api_name": "updated_priority_level__s" } ] } }, "UpdateDisplayLabel": { "summary": "Update display label", "value": { "global_picklists": [ { "display_label": "Updated Priority Level" } ] } }, "UpdatePicklistValue": { "summary": "Update existing picklist value", "value": { "global_picklists": [ { "pick_list_values": [ { "display_value": "High Priority", "id": "111111000000055938" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for updating a global picklist.", "properties": { "global_picklists": { "description": "Array containing the global picklist to update.", "items": { "additionalProperties": false, "description": "Global picklist object with update details.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "description": { "description": "Updated description of the global picklist.", "maxLength": 1000, "type": [ "string", "null" ] }, "display_label": { "description": "Updated display label of the global picklist.", "maxLength": 50, "type": "string" }, "pick_list_values": { "description": "Array of picklist values to add, update, or delete. For updates, include id and fields to update. For deletion, include id and _delete: true. Only one value can be moved to unused or deleted per request.", "items": { "additionalProperties": false, "description": "Picklist value object for update/add/delete.", "properties": { "_delete": { "description": "Set to true to delete this picklist value. Only one value can be deleted per request.", "type": "boolean" }, "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "reference_value": { "$ref": "#/components/schemas/PickListReferenceValue" }, "type": { "description": "Type of the picklist value (used or unused). Only one value can be moved to unused per request.", "enum": [ "unused", "used" ], "type": "string" } }, "type": "object" }, "maxItems": 5000, "type": "array" }, "pick_list_values_sorted_lexically": { "description": "Indicates if picklist values should be sorted lexically.", "type": "boolean" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object" }, "x-zs-llm-examples": [ "AddPicklistValue", "DeletePicklistValue", "MoveToUnused", "UpdateApiName", "UpdateDisplayLabel", "UpdatePicklistValue" ] } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "summary": "Successful update response", "value": { "global_picklists": [ { "code": "SUCCESS", "details": { "id": "111111000000055935" }, "message": "global picklist updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for successful update of a global picklist.", "properties": { "global_picklists": { "description": "Array containing the updated global picklist response.", "items": { "additionalProperties": false, "description": "Updated global picklist response details.", "properties": { "code": { "description": "Response code indicating successful update.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the updated global picklist.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable success message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "UpdateGlobalPicklistResponseSchema" } } }, "description": "OK - Global picklist updated successfully." }, "400": { "content": { "application/json": { "examples": { "AddMoreThan50Values": { "summary": "Adding >50 values when >15 fields", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 50, "limit_due_to": { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[50]" } }, "message": "Adding more than 50 values in a single save is not allowed when they are associated with more than 15 fields.", "status": "error" } ] } }, "BulkDeletion": { "summary": "Bulk deletion not allowed", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1, "limit_due_to": { "api_name": "_delete", "json_path": "$.global_picklists[0].pick_list_values[1]._delete" } }, "message": "More than one picklist value cannot be deleted", "status": "error" } ] } }, "BulkUnusedMovement": { "summary": "Bulk unused movement not allowed", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1, "limit_due_to": [ { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[1].type" } ] }, "message": "More than one picklist value cannot be moved to unused type", "status": "error" } ] } }, "DeleteMoreThan15Fields": { "summary": "Cannot delete when associated with >15 fields", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[0]._delete" }, "message": "option can't be deleted as global set is associated to more than 15 fields", "status": "error" } ] } }, "DeletionInProgress": { "summary": "Deletion in progress", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global picklist deletion in progress.", "status": "error" } }, "DescriptionMaxLength": { "summary": "description exceeds 1000 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.global_picklists[0].description", "maximum_length": 1000 }, "message": "invalid data", "status": "error" } ] } }, "DisplayLabelMaxLength": { "summary": "display_label exceeds 50 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "DisplayValueEmpty": { "summary": "display_value is empty or null", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "Display value in pick list values cannot be empty or null", "status": "error" } ] } }, "DisplayValueMaxLength": { "summary": "display_value exceeds 120 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value", "maximum_length": 120 }, "message": "invalid data", "status": "error" } ] } }, "DuplicateApiName": { "summary": "Duplicate api_name", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.global_picklists[0].api_name" }, "message": "Duplicate Api name found, enter a unique Api name.", "status": "error" } ] } }, "DuplicateDisplayLabel": { "summary": "Duplicate display_label", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "Duplicate name found, enter a unique name.", "status": "error" } ] } }, "DuplicateDisplayValue": { "summary": "Duplicate display_value in pick_list_values", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Duplicate option found. Enter a unique option.", "status": "error" } ] } }, "DuplicateReferenceValue": { "summary": "Duplicate reference_value in pick_list_values", "value": { "global_picklists": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Duplicate reference option found. Enter a unique reference option.", "status": "error" } ] } }, "EmojiInDisplayLabel": { "summary": "Emoji in display_label", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "INVALID_FIELD_LABEL", "status": "error" } ] } }, "EmptyApiName": { "summary": "Empty api_name", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.global_picklists[0].api_name" }, "message": "Api Name cannot be empty", "status": "error" } ] } }, "EmptyDisplayLabel": { "summary": "display_label is empty", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "required field not found", "status": "error" } ] } }, "InvalidApiNameFormat": { "summary": "Invalid api_name format", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.global_picklists[0].api_name" }, "message": "Api Name should start with English alphabets followed by numbers or alphabets or underscore and should not end with underscore", "status": "error" } ] } }, "InvalidIdInPath": { "summary": "Invalid ID in path parameter", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidOptionId": { "summary": "Invalid picklist value id", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.global_picklists[0].pick_list_values[503].id" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryDisplayValueForUpdate": { "summary": "Missing display_value for update", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryPickListValues": { "summary": "Missing pick_list_values", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "required field not found", "status": "error" } ] } }, "MoveMoreThan50ToUsed": { "summary": "Moving >50 values to used when >15 fields", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 50, "limit_due_to": [ { "api_name": "type", "json_path": "$.global_picklists[0].pick_list_values[50].type" } ] }, "message": "Moving more than 50 values to the used section in a single save is not allowed when they are associated with more than 15 fields.", "status": "error" } ] } }, "NoUsedOption": { "summary": "No used option in picklist values", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Values in the pick list field cannot be empty.", "status": "error" } ] } }, "OptionDeleteNotAllowed": { "summary": "Option delete not allowed", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values[1]" }, "message": "Option delete not allowed", "status": "error" } ] } }, "ReferenceValueEmpty": { "summary": "reference_value is empty or null", "value": { "global_picklists": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value" }, "message": "Actual value in pick list values cannot be empty or null", "status": "error" } ] } }, "ReferenceValueMaxLength": { "summary": "reference_value exceeds 120 characters", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value", "maximum_length": 120 }, "message": "invalid data", "status": "error" } ] } }, "ReplaceInProgress": { "summary": "Replace process in progress", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" }, "message": "Some values can not be modified since they are being deleted from the system through replacing process.", "status": "error" } ] } }, "SpecialCharactersDisplayLabel": { "summary": "Special characters in display_label", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_label", "json_path": "$.global_picklists[0].display_label" }, "message": "Special characters in name", "status": "error" } ] } }, "SpecialCharactersDisplayValue": { "summary": "Special characters in display_value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "display_value", "json_path": "$.global_picklists[0].pick_list_values[0].display_value" }, "message": "Special characters are not allowed in Options", "status": "error" } ] } }, "SpecialCharactersReferenceValue": { "summary": "Special characters in reference_value", "value": { "global_picklists": [ { "code": "INVALID_DATA", "details": { "api_name": "reference_value", "json_path": "$.global_picklists[0].pick_list_values[0].reference_value" }, "message": "Special characters are not allowed in Options", "status": "error" } ] } }, "SystemDefinedUpdate": { "summary": "System defined global set update not allowed", "value": { "global_picklists": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "id": "11111100000005593", "json_path": "$.global_picklists[0].id" }, "message": "Updation of system defined global set is not allowed", "status": "error" } ] } }, "UnusedOptionsLimitExceeded": { "summary": "Unused options limit exceeded (500)", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 500, "limit_due_to": { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" } }, "message": "Sorry, you have reached the limit of 500 unused values added for this pick list field.", "status": "error" } ] } }, "UsedOptionsLimitExceeded": { "summary": "Used options limit exceeded (1000)", "value": { "global_picklists": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 1000, "limit_due_to": [ { "api_name": "pick_list_values", "json_path": "$.global_picklists[0].pick_list_values" } ] }, "message": "Sorry, you have reached the limit of 1000 values added for this pick list field.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Top-level error response with resource_path_index for invalid ID in path.", "properties": { "code": { "description": "Error code indicating the type of validation or constraint failure.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error-specific details.", "properties": { "resource_path_index": { "const": 2, "description": "Index in the resource path indicating the error location.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateIdGlobalPicklistErrorResponseResourcePathIndexSchema" }, { "additionalProperties": false, "description": "Error response array format for request body validation errors.", "properties": { "global_picklists": { "description": "Array of global picklist update error details.", "items": { "additionalProperties": false, "description": "Global picklist update error object.", "properties": { "code": { "description": "Error code indicating the type of validation or constraint failure.", "enum": [ "INVALID_DATA", "DUPLICATE_DATA", "MANDATORY_NOT_FOUND", "LIMIT_EXCEEDED", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error-specific details.", "properties": { "api_name": { "description": "Name of the field causing the error.", "maxLength": 100, "type": "string" }, "id": { "description": "ID of the resource causing the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing the error.", "maxLength": 255, "type": "string" }, "limit": { "description": "The maximum allowed limit that has been exceeded.", "format": "int32", "type": "integer" }, "limit_due_to": { "anyOf": [ { "description": "Array of fields that caused the limit to be exceeded.", "items": { "additionalProperties": false, "description": "Field causing limit exceeded error.", "properties": { "api_name": { "description": "API name of the field causing limit issue.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing limit issue.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "type": "array", "x-zs-$id": "UpdateGlobalPicklistLimitDueToArraySchema" }, { "additionalProperties": false, "description": "Single field that caused the limit to be exceeded.", "properties": { "api_name": { "description": "API name of the field causing limit issue.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing limit issue.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateGlobalPicklistLimitDueToObjectSchema" } ] }, "maximum_length": { "description": "Maximum allowed length for the field.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable message describing the error.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "global_picklists" ], "type": "object", "x-zs-$id": "UpdateIdGlobalPicklistErrorResponseArraySchema" } ], "x-zs-$id": "UpdateIdGlobalPicklistErrorResponseSchema" } } }, "description": "Bad Request - Invalid data, missing required fields, duplicate values, special characters, length exceeded, limit exceeded, reserved keywords, or operation not allowed." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.UPDATE" ] } ], "summary": "Update a Global Picklist by ID", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Update one global picklist by path `{id}`. Same body contract as the bulk PATCH but scoped to a single record. `api_name` updates are gated by `isAPINameUpdateAllowed()` and not allowed in older versions. Use the example that matches the action (`AddPicklistValue`, `DeletePicklistValue`, `MoveToUnused`, `UpdateApiName`, `UpdateDisplayLabel`, `UpdatePicklistValue`)." } }, "/crm/v8/settings/global_picklists/{id}/actions/associations": { "get": { "description": "Retrieves associations of picklist values with modules, fields, and layouts for a given global picklist ID.", "operationId": "getGlobalPickListFieldAssociations", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsId" }, { "$ref": "#/components/parameters/GlobalPicklistsPage" }, { "$ref": "#/components/parameters/GlobalPicklistsPerPage" }, { "description": "Comma-separated list of nested details to include (e.g., `module.plural_label,module.module_name,layouts.status`). Allowed values: module.plural_label, module.module_name, layouts.status.", "example": [ "module.plural_label", "module.module_name", "layouts.status" ], "explode": false, "in": "query", "name": "include_inner_details", "required": false, "schema": { "items": { "description": "Allowed values for including nested details in the response.", "enum": [ "module.plural_label", "module.module_name", "layouts.status" ], "type": "string" }, "maxItems": 3, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "summary": "Example response for associations", "value": { "associations": [ { "field": { "api_name": "Pick_List_10", "id": "1385208000000973001" }, "layouts": [ { "id": "1385208000000095055", "name": "Standard", "status": "active" } ], "module": { "api_name": "Leads", "id": "1385208000000000125", "module_name": "Leads", "plural_label": "tranPlur" } } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "additionalProperties": false, "description": "Response object containing associations of global picklist fields and modules.", "properties": { "associations": { "description": "List of associations between global picklist and fields/modules/layouts.", "items": { "additionalProperties": false, "description": "Association object for a global picklist field.", "properties": { "field": { "additionalProperties": false, "description": "Field details associated with the global picklist.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "field_label": { "$ref": "#/components/schemas/FieldLabel" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "layouts": { "description": "List of layouts associated with the field.", "items": { "additionalProperties": false, "description": "Layout details.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "$ref": "#/components/schemas/LayoutName" }, "status": { "description": "Layout status.", "example": "active", "maxLength": 20, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "module": { "additionalProperties": false, "description": "Module details associated with the field.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "module_name": { "$ref": "#/components/schemas/GlobalPicklistsModuleName" }, "plural_label": { "$ref": "#/components/schemas/ModulepluralLabel" } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "field", "module", "layouts" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "info": { "additionalProperties": false, "description": "Pagination and record info for associations response.", "properties": { "count": { "description": "Number of records returned.", "example": 6, "format": "int32", "type": "integer" }, "more_records": { "description": "Whether more records are available.", "example": false, "type": "boolean" }, "page": { "description": "Current page number.", "example": 1, "format": "int32", "type": "integer" }, "per_page": { "description": "Number of records per page.", "example": 200, "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "associations", "info" ], "type": "object", "x-zs-$id": "GetPickListFieldAssociationsResponseSchema" } } }, "description": "Successful response containing picklist associations." }, "204": { "description": "if there is no picklist field associated with the global picklist." }, "400": { "content": { "application/json": { "examples": { "DeletionInProgress": { "summary": "Deletion in progress example", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global picklist deletion in progress.", "status": "error" } }, "InvalidaId": { "summary": "Invalid ID example", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object containing code, message, details, and status.", "properties": { "code": { "description": "Error code indicating the failure reason. Possible values: INVALID_DATA, NOT_ALLOWED.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error.", "properties": { "resource_path_index": { "const": 2, "description": "This value is always 2.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Describes the reason for the failure. Examples: 'the id given seems to be invalid' or 'global picklist deletion in progress.'", "example": "the id given seems to be invalid", "maxLength": 250, "type": "string" }, "status": { "description": "Status of the error response.", "example": "error", "maxLength": 100, "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "GetPickListFieldAssociationsErrorResponseSchema" } } }, "description": "Bad Request - Invalid data or not allowed action." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.READ" ] } ], "summary": "Get Field Associations", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Lists the CRM fields, modules and layouts that use this global picklist; call this before delete or replace flows to understand impact. `include` accepts dotted paths (`field.field_label`, `module.plural_label`, `module.module_name`, `layouts.status`). Paginated (`per_page` defaults to 200, `startIndex` capped at 100). Subform fields are normalized to their parent module/layout in the response." } }, "/crm/v8/settings/global_picklists/{id}/actions/pick_list_values_associations": { "get": { "description": "To the list of features like blueprints, workflows create, workflow convert, workflow task, ABM, etc in which a particular picklist value is used.", "operationId": "getPickListValuesAssociations", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsId" }, { "description": "The ID of the picklist value to retrieve associations for. Use the [Get All Global Picklists](global_picklists.yaml#$.paths./settings/global_picklists.get) resource to retrieve picklist value IDs.\n", "in": "query", "name": "picklist_value_id", "required": true, "schema": { "example": "1385208000000973001", "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "summary": "Example response with picklist value associations", "value": { "pick_list_values_associations": [ { "resources": [ { "details": [ { "id": "111113000000045665", "name": "Big Deal Rule", "type": "Workflow" } ], "id": "111113000000071003", "name": "dddddd" }, { "details": [], "id": "111113000000064001", "name": "Testt" } ], "type": "field_update" }, { "resources": [ { "details": [ { "id": "111113000000047921", "name": "Qualify Leads through Call - V1", "transition": { "id": "111113000000048457", "name": "Create Lead" }, "type": "Orchestration" } ], "id": "111113000000072027", "name": "Another" } ], "type": "task" }, { "resources": [ { "details": { "module": { "api_name": "Leads", "id": "111113000000000050", "plural_label": "Leads" } }, "id": "111113000000077032", "name": "sss" } ], "type": "blueprint" }, { "resources": [ { "details": { "actions": [ { "id": "111113000000082133", "module": { "api_name": "Leads", "id": "111113000000000042" }, "transition": { "id": "111113000000048457", "name": "Create Lead" }, "type": "CreateRecord" } ] }, "id": "111113000000047921", "name": "Qualify Leads through Call - V1" } ], "type": "orchestration" }, { "resources": [ { "details": { "actions": [ { "id": "111113000000072001", "module": { "api_name": "Deals", "id": "111113000000000048" }, "type": "CreateRecord" } ] }, "id": "111113000000045665", "name": "Big Deal Rule" } ], "type": "workflow" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing picklist value associations.", "properties": { "pick_list_values_associations": { "description": "Array of picklist value associations grouped by association type.", "items": { "additionalProperties": false, "description": "Association group for a specific type of feature.", "properties": { "resources": { "description": "Array of resources associated with the picklist value.", "items": { "additionalProperties": false, "description": "Resource object containing association details.", "properties": { "details": { "anyOf": [ { "additionalProperties": false, "description": "Blueprint details with module information.", "properties": { "module": { "additionalProperties": false, "description": "Module details for blueprint.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "plural_label": { "$ref": "#/components/schemas/ModulepluralLabel" } }, "required": [ "api_name", "id", "plural_label" ], "type": "object" } }, "required": [ "module" ], "type": [ "object", "null" ], "x-zs-$id": "GetPickListValuesAssociationsBlueprintDetailsSchema" }, { "additionalProperties": false, "description": "Orchestration or workflow details with actions.", "properties": { "actions": { "description": "Array of actions associated with the orchestration or workflow.", "items": { "additionalProperties": false, "description": "Action object with module and optional transition details.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "module": { "additionalProperties": false, "description": "Module details for the action.", "properties": { "api_name": { "$ref": "#/components/schemas/GlobalPicklistsApiName" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" } }, "required": [ "api_name", "id" ], "type": "object" }, "transition": { "additionalProperties": false, "description": "Transition details for orchestration actions.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the transition.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "type": { "description": "Type of action.", "maxLength": 100, "type": "string" } }, "required": [ "module", "id", "type" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "actions" ], "type": "object", "x-zs-$id": "GetPickListValuesAssociationsWorkflowOrchestrationDetailsSchema" }, { "description": "Array of task or field update associations.", "items": { "additionalProperties": false, "description": "Task or field update association object.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the task or field update.", "maxLength": 255, "type": "string" }, "transition": { "additionalProperties": false, "description": "Transition details for orchestration tasks.", "properties": { "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the transition.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "type": { "description": "Type of association (Workflow, Orchestration, etc.).", "maxLength": 100, "type": "string" } }, "required": [ "name", "id", "type" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "GetPickListValuesAssociationsTaskFieldUpdateDetailsSchema" } ], "description": "Details about the resource associations." }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" }, "name": { "description": "Name of the resource.", "maxLength": 255, "type": "string" } }, "required": [ "name", "details", "id" ], "type": "object" }, "maxItems": 100, "type": "array" }, "type": { "description": "Type of association (field_update, task, blueprint, orchestration, workflow, etc.).", "maxLength": 100, "type": "string" } }, "required": [ "resources", "type" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "pick_list_values_associations" ], "type": "object", "x-zs-$id": "GetPickListValuesAssociationsResponseSchema" } } }, "description": "Successful response containing picklist value associations with various features like blueprints, workflows, orchestrations, etc." }, "204": { "description": "if the picklist value is not associated with any features." }, "400": { "content": { "application/json": { "examples": { "DeletionInProgress": { "summary": "Deletion already in progress", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global picklist deletion in progress.", "status": "error" } }, "InvalidId": { "summary": "Invalid ID in path", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidParameterValue": { "summary": "Invalid parameter value", "value": { "code": "INVALID_DATA", "details": { "param_name": "picklist_value_id" }, "message": "the id given seems to be invalid", "status": "error" } }, "MissingParameter": { "summary": "Required parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "picklist_value_id" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response for invalid ID or not allowed actions with resource_path_index.", "properties": { "code": { "description": "Error code indicating the type of error.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error.", "properties": { "resource_path_index": { "const": 2, "description": "Index in the resource path indicating the error location.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetPickListValuesAssociationsInvalidIdOrNotAllowedErrorResponseSchema" }, { "additionalProperties": false, "description": "Error response for missing required parameter.", "properties": { "code": { "description": "Error code indicating missing parameter.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the missing parameter.", "properties": { "param": { "description": "Name of the missing parameter.", "maxLength": 100, "type": "string" } }, "required": [ "param" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetPickListValuesAssociationsMissingParameterErrorResponseSchema" }, { "additionalProperties": false, "description": "Error response for invalid parameter value.", "properties": { "code": { "description": "Error code indicating invalid data.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the invalid parameter.", "properties": { "param_name": { "description": "Name of the invalid parameter.", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetPickListValuesAssociationsInvalidParameterValueErrorResponseSchema" } ], "x-zs-$id": "GetPickListValuesAssociationsErrorResponseSchema" } } }, "description": "Bad Request - Invalid data, missing parameters, or not allowed actions." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.ALL" ] } ], "summary": "Get Picklist Value Associations", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Lists features that consume a specific picklist option value: blueprints, workflows (create / convert / task), ABM, and similar. Requires `picklist_value_id`; the parent picklist must not be in the delete scheduler. Use `include` to control inner detail expansion." } }, "/crm/v8/settings/global_picklists/{id}/actions/replace_picklist_values": { "post": { "description": "Schedules or executes replacement of picklist values for the specified global picklist. You can specify either `id`, `display_value`, or both for `old_value` and `new_value`. If both are provided, the system validates them for consistency. The `from` (old) value can be non-existent in the current picklist, but the `to` (new) value must be in the **used** state of the picklist option.", "operationId": "replacePicklistValues", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsId" } ], "requestBody": { "content": { "application/json": { "examples": { "ReplacedValuesExample": { "value": { "replace_picklist_values": [ { "new_value": { "display_value": "def", "id": "111111000000055948" }, "old_value": { "display_value": "abc", "id": "111111000000055938" } } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for replacing picklist values in a global picklist.", "properties": { "replace_picklist_values": { "description": "Array of picklist value replacement pairs.", "items": { "additionalProperties": false, "description": "Represents a single picklist value replacement pair.", "properties": { "new_value": { "additionalProperties": false, "description": "The new picklist value that will replace the old one.", "properties": { "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" } }, "type": "object" }, "old_value": { "additionalProperties": false, "description": "The existing picklist value to be replaced.", "properties": { "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "id": { "$ref": "#/components/schemas/GlobalPicklistsId" } }, "type": "object" } }, "required": [ "old_value", "new_value" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "replace_picklist_values" ], "type": "object" }, "x-zs-llm-examples": [ "ReplacedValuesExample" ] } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "ImmediateCompletionExample": { "value": { "replace_picklist_values": [ { "code": "SUCCESS", "details": {}, "message": "success", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for immediate replacement completion.", "properties": { "replace_picklist_values": { "description": "Array of replacement operation results.", "items": { "additionalProperties": false, "description": "Replacement operation result object.", "properties": { "code": { "description": "Indicates that the replacement operation completed successfully.", "example": "SUCCESS", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the replacement operation.", "example": {}, "type": "object" }, "message": { "description": "Human-readable message about the replacement operation.", "example": "success", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the replacement operation.", "example": "success", "maxLength": 50, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "replace_picklist_values" ], "type": "object", "x-zs-$id": "ReplacePicklistValuesImmediateResponseSchema" } } }, "description": "OK - Replacement completed immediately since the global set is not associated with any fields." }, "202": { "content": { "application/json": { "examples": { "ScheduledReplacementExample": { "value": { "replace_picklist_values": [ { "code": "SCHEDULED", "details": { "job_id": "111111000000084605" }, "message": "success", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "response object for scheduled replacement of picklist values.", "properties": { "replace_picklist_values": { "description": "Array of replacement operation results.", "items": { "additionalProperties": false, "description": "Replacement operation result object.", "properties": { "code": { "description": "Indicates that the replacement operation has been scheduled.", "example": "SCHEDULED", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the replacement operation.", "properties": { "job_id": { "description": "The ID of the scheduled replacement job.", "example": "111111000000084605", "maxLength": 100, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Human-readable message about the replacement operation.", "example": "success", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the replacement operation.", "example": "success", "maxLength": 50, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "replace_picklist_values" ], "type": "object", "x-zs-$id": "ReplacePicklistValuesScheduledResponseSchema" } } }, "description": "Accepted - Replacement scheduled successfully for associated fields." }, "400": { "content": { "application/json": { "examples": { "InvalidDataExample": { "summary": "Invalid data error", "value": { "replace_picklist_values": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.replace_picklist_values[0].old_value.id" }, "message": "The given value seems to be invalid", "status": "error" } ] } }, "TopLevelErrorExample": { "summary": "Top-level error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global picklist deletion in progress.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response with array of replacement operation errors.", "properties": { "replace_picklist_values": { "description": "Array of replacement operation error details.", "items": { "additionalProperties": false, "description": "Replacement operation error object.", "properties": { "code": { "description": "Error code indicating the type of validation or constraint failure.", "enum": [ "INVALID_DATA", "AMBIGUITY_DURING_PROCESSING", "MANDATORY_NOT_FOUND", "EXPECTED_FIELD_MISSING", "NOT_ALLOWED", "LIMIT_EXCEEDED" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error-specific details.", "properties": { "ambiguity_due_to": { "description": "if both id and display_value are provided and they don't match", "example": [ { "api_name": "display_value", "json_path": "$.replace_picklist_values[0].old_value.display_value" }, { "api_name": "id", "json_path": "$.replace_picklist_values[0].old_value.id" } ], "items": { "additionalProperties": false, "description": "Field causing ambiguity.", "properties": { "api_name": { "description": "name of the ambiguous field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the ambiguous field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 30, "type": "array" }, "api_name": { "description": "name of the field causing the error.", "example": "id", "maxLength": 100, "type": "string" }, "expected_fields": { "description": "List of expected fields that are missing.", "example": [ { "api_name": "display_value", "json_path": "$.replace_picklist_values[0].new_value.display_value" }, { "api_name": "id", "json_path": "$.replace_picklist_values[0].new_value.id" } ], "items": { "additionalProperties": false, "description": "Expected field information.", "properties": { "api_name": { "description": "name of the expected field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to where the field is expected.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" }, "json_path": { "description": "JSON path to the field causing the error.", "example": "$.replace_picklist_values[0].old_value.id", "maxLength": 255, "type": "string" }, "limit": { "description": "The maximum allowed limit that has been exceeded. if this exists in details, limit_due_to will also be present.", "example": 500, "format": "int32", "type": "integer" }, "limit_due_to": { "description": "List of picklist values that caused the limit to be exceeded.", "example": [ { "api_name": "old_value", "json_path": "$.replace_picklist_values[0].old_value" } ], "items": { "additionalProperties": false, "description": "Field causing limit exceeded error.", "properties": { "api_name": { "description": "API name of the field causing limit issue.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the field causing limit issue.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Human-readable message describing the error.", "example": "The given value seems to be invalid", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "enum": [ "error" ], "example": "error", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "replace_picklist_values" ], "type": "object", "x-zs-$id": "ReplacePicklistValuesArrayErrorResponseSchema" }, { "additionalProperties": false, "description": "Top-level validation or system restriction errors.", "properties": { "code": { "description": "Error code indicating invalid data or disallowed action.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "example": "NOT_ALLOWED", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the top-level error.", "properties": { "resource_path_index": { "description": "Index in the resource path indicating the error location.", "enum": [ 2 ], "example": 2, "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message describing the issue.", "example": "global picklist deletion in progress.", "maxLength": 255, "type": "string" }, "status": { "description": "Status of the error response.", "example": "error", "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "ReplacePicklistValuesTopLevelErrorResponseSchema" } ], "x-zs-$id": "ReplacePicklistValuesErrorResponseSchema" } } }, "description": "Bad Request - Invalid data, missing fields, ambiguity, or disallowed actions, or if limits exceeded." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.ALL" ] } ], "summary": "Replace Picklist Values", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Schedules a replace for one or more option values inside the given global picklist. Each `old_value` / `new_value` pair may carry `id` and/or `display_value`; when both are present the `id` wins. Blocked with 400 `global_picklist_in_delete_scheduler` when the parent picklist is being deleted. After scheduling, poll `getReplacedValues` to observe in-flight replacements." } }, "/crm/v8/settings/global_picklists/{id}/actions/replaced_values": { "get": { "description": "Retrieves picklist values that are currently being replaced through a replace scheduler for the given global picklist ID.", "operationId": "getReplacedValues", "parameters": [ { "$ref": "#/components/parameters/GlobalPicklistsId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ReplacedValuesExample": { "summary": "Example response with replaced values", "value": { "replaced_values": [ { "display_value": "Cold", "reference_value": "Colder" }, { "display_value": "Warm", "reference_value": "Warmer" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing picklist values that are currently being replaced.", "properties": { "replaced_values": { "description": "Array of picklist values that are currently being replaced.", "items": { "additionalProperties": false, "description": "Object representing a replaced picklist value.", "properties": { "display_value": { "$ref": "#/components/schemas/PickListDisplayValue" }, "reference_value": { "$ref": "#/components/schemas/PickListReferenceValue" } }, "required": [ "display_value", "reference_value" ], "type": "object" }, "maxItems": 500, "type": "array" } }, "required": [ "replaced_values" ], "type": "object", "x-zs-$id": "GetReplacedPicklistValuesResponseSchema" } } }, "description": "OK - Replace scheduler in progress. Returns values which are currently being replaced." }, "204": { "description": "No Content - No replace scheduler is currently in progress for the given picklist." }, "400": { "content": { "application/json": { "examples": { "DeletionInProgress": { "summary": "Deletion in progress example", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "global picklist deletion in progress.", "status": "error" } }, "InvalidaId": { "summary": "Invalid ID example", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object containing code, message, details, and status.", "properties": { "code": { "description": "Error code indicating the failure reason. Possible values: INVALID_DATA, NOT_ALLOWED.", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "example": "INVALID_DATA", "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the error, including the resource path index.", "properties": { "resource_path_index": { "description": "This value is always 2.", "enum": [ 2 ], "example": 2, "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Describes the reason for the failure. Examples: 'the id given seems to be invalid' or 'global picklist deletion in progress.'", "example": "the id given seems to be invalid", "maxLength": 250, "type": "string" }, "status": { "description": "Status of the error response.", "example": "error", "maxLength": 100, "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "GetReplacedPicklistValuesErrorResponseSchema" } } }, "description": "Bad Request - Invalid data or not allowed action." }, "403": { "$ref": "#/components/responses/GlobalPicklistsForbidden" }, "500": { "$ref": "#/components/responses/GlobalPicklistsInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.global_picklist.READ" ] } ], "summary": "Get Replaced Picklist Values", "tags": [ "global_picklists" ], "x-zoho-document": "global_picklists", "x-zs-llm-description": "Returns option values currently in progress on the replace scheduler for `{id}`. Returns 204 when nothing is queued, 400 `global_picklist_in_delete_scheduler` when the parent is in delete, and 400 `invalid_data` when `{id}` is unknown." } }, "/crm/v8/settings/holidays": { "get": { "description": "To retrieve the list of holidays configured in Zoho CRM. Business holidays apply to all users, while shift holidays are specific to configured shift schedules. Returns paginated results.", "operationId": "getHolidays", "parameters": [ { "$ref": "#/components/parameters/Year" }, { "$ref": "#/components/parameters/HolidaysType" }, { "$ref": "#/components/parameters/ShiftId" }, { "description": "Specify the page number for paginated results. Defaults to 1.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the response when no holidays match the specified filter criteria.", "summary": "Default response with empty holidays list", "value": { "holidays": [] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body containing the list of holidays and pagination metadata.", "properties": { "holidays": { "description": "Contains the list of holidays matching the specified filter criteria. ", "items": { "additionalProperties": false, "description": "Represents a single holiday record in the response.", "properties": { "date": { "description": "Represents the date of the holiday in **YYYY-MM-DD** format. ", "format": "date", "type": "string" }, "id": { "description": "Represents the unique identifier of the holiday record. ", "maxLength": 255, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "HolidaysId" }, "name": { "description": "Represents the name of the holiday. ", "maxLength": 80, "minLength": 1, "pattern": "^[^#%^&*]+$", "type": "string" }, "shift_hour": { "additionalProperties": false, "description": "Represents the shift hour associated with this holiday. Contains null for business holidays. ", "properties": { "id": { "description": "Represents the unique identifier of the shift hour. Always present when the shift_hour object is included in the response.", "maxLength": 255, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "HolidaysShiftHourId" }, "name": { "description": "Represents the name of the shift hour. Always present when the shift_hour object is included in the response.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "type": { "description": "The type of holiday that you want to fetch. The possible values are **business_holiday** and **shift_holiday**.", "enum": [ "business_holiday", "shift_holiday" ], "type": "string" }, "year": { "description": "Represents the year in which the holiday falls. ", "format": "int32", "maximum": 2100, "minimum": 2000, "type": "integer" } }, "required": [ "name", "date", "type", "shift_hour", "id", "year" ], "type": "object" }, "maxItems": 100, "type": "array" }, "info": { "additionalProperties": false, "description": "Contains pagination metadata for the response.", "properties": { "count": { "description": "Represents the total number of holiday records returned in this page of results.", "format": "int32", "minimum": 0, "type": "integer" }, "more_records": { "description": "Indicates whether more holiday records are available on subsequent pages.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated results. Page numbers begin at one.", "format": "int32", "minimum": 1, "type": "integer" }, "per_page": { "description": "Represents the number of holiday records returned per page.", "format": "int32", "minimum": 1, "type": "integer" } }, "type": "object" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysSuccessResponseDeleteSingle" } } }, "description": "Returns a paginated list of holidays matching the specified filter criteria." }, "204": { "description": "No holidays were found matching the specified filter criteria." }, "400": { "content": { "application/json": { "examples": { "PatternNotMatched": { "description": "Shows the error response when a query parameter contains an invalid value.", "summary": "Invalid query parameter value", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "type" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when a query parameter value fails validation.", "properties": { "code": { "description": "Indicates the validation error type. Possible values: **PATTERN_NOT_MATCHED**.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the validation error, such as the affected parameter name.", "type": "object" }, "message": { "description": "Describes the specific validation error that occurred.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "HolidaysErrorResponse" } } }, "description": "One or more query parameter values do not match the expected format. **Resolution** The request must include valid values for all query parameters." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.READ" ] } ], "summary": "Holidays", "tags": [ "holidays" ], "x-zoho-document": "holidays" }, "post": { "description": "To create one or more business or shift holidays in Zoho CRM. Business holidays apply to all users, while shift holidays must specify a valid shift_hour identifier.", "operationId": "createHolidays", "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the response the API returns after creating the holidays successfully.", "summary": "Default success response after creating holidays", "value": { "holidays": [ { "date": "2025-01-01", "name": "New Year", "type": "business_holiday" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body schema for creating holidays.", "properties": { "holidays": { "description": "Specify the list of holidays to create. At least **one** holiday object is required.", "items": { "additionalProperties": false, "description": "Specify the details for a single holiday to create.", "properties": { "date": { "description": "Specify the date of the holiday in **YYYY-MM-DD** format.", "format": "date", "type": "string" }, "name": { "description": "Specify the name of the holiday.", "maxLength": 80, "minLength": 1, "pattern": "^[^#%^&*]+$", "type": "string" }, "shift_hour": { "additionalProperties": false, "description": "Specify the shift hour associated with this holiday. Required when the type field is set to **shift_holiday**.", "properties": { "id": { "description": "Specify the unique identifier of the shift hour. Use the [Get Shift Hours API](shift_hours.yaml#$.paths./settings/business_hours/shift_hours.get) to get the ID of the shift hour.", "maxLength": 255, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Specify the name of the shift hour.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "type": { "description": "Specify the type of holiday. Possible values: **business_holiday**, **shift_holiday**.", "enum": [ "business_holiday", "shift_holiday" ], "type": "string" } }, "required": [ "name", "date", "type" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "info": { "additionalProperties": false, "description": "Contains optional pagination context included in the request schema.", "properties": { "count": { "description": "Specify the total count of records.", "format": "int32", "type": "integer" }, "more_records": { "description": "Specify whether more records are available on subsequent pages.", "type": "boolean" }, "page": { "description": "Specify the page number to retrieve.", "format": "int32", "type": "integer" }, "per_page": { "description": "Specify the number of records to include per page.", "format": "int32", "type": "integer" } }, "type": "object" } }, "required": [ "holidays" ], "type": "object" }, "x-zs-llm-examples": [ "Default" ] } }, "description": "The request body must contain a holidays array. You can include a maximum of **100** objects per request.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Default": { "description": "Shows a sample 400 error response returned when holiday validation fails.", "summary": "Default 400 error response for holiday creation", "value": { "holidays": [] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body the API returns after creating one or more holidays.", "properties": { "holidays": { "description": "Contains the result for each holiday submitted in the create request. ", "items": { "additionalProperties": false, "description": "Represents the creation result for a single holiday.", "properties": { "code": { "description": "Indicates the result code for this holiday creation. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the created holiday record. ", "properties": { "id": { "description": "Represents the unique identifier assigned to the created holiday.", "maxLength": 255, "type": "string", "x-zs-$id": "HolidaysDetailsId" } }, "type": "object" }, "message": { "description": "Describes the result of the holiday creation operation. ", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the holiday creation. Possible values: success. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysSuccessResponseCreate" } } }, "description": "Returns the result for each holiday submitted in the create request." }, "207": { "$ref": "#/components/responses/HolidaysMultiStatusResponse" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissing": { "description": "Shows the error when a required dependent field is missing for the **shift_holiday** type.", "summary": "Missing dependent field for shift holiday", "value": { "holidays": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "shift_hour", "dependee": { "api_name": "type", "json_path": "$.holidays[0].type" }, "json_path": "$.holidays[0].shift_hour" }, "message": "Shift id is required for shift holidays", "status": "error" } ] } }, "DuplicateData": { "description": "Shows the error when a holiday with the same name already exists.", "summary": "Duplicate holiday name and date combination", "value": { "holidays": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataDateFormat": { "description": "Shows an error when the date field does not conform to the expected date format.", "summary": "Holiday date in invalid format", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "date", "expected_data_type": "date", "json_path": "$.holidays[0].date" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataDateRange": { "description": "Shows the error when the holiday date falls outside the allowed financial year range.", "summary": "Holiday date outside allowed range", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "date", "json_path": "$.holidays[0].date" }, "message": "Date Should be between current and next financial year", "status": "error" } ] } }, "InvalidDataMaxLength": { "description": "Shows the error when the holiday name exceeds the maximum allowed length.", "summary": "Holiday name exceeds maximum length", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name", "maximum_length": 80 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataShiftId": { "description": "Shows the error when the shift_hour ID value is not valid.", "summary": "Invalid shift hour ID value", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.holidays[0].shift_hour.id" }, "message": "Invalid shift id", "status": "error" } ] } }, "InvalidDataSpecialChars": { "description": "Shows the error when the holiday name contains disallowed special characters.", "summary": "Holiday name contains invalid special characters", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name" }, "message": "Holiday Name should not contain special characters:#, %, ^, &, *", "status": "error" } ] } }, "InvalidDataType": { "description": "Shows the error when the type field contains an unsupported value.", "summary": "Invalid holiday type value", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.holidays[0].type", "supported_values": [ "business_holiday", "shift_holiday" ] }, "message": "Invalid type", "status": "error" } ] } }, "LimitExceeded": { "description": "Shows the error when the maximum holiday limit for the specified type is exceeded.", "summary": "Holiday limit exceeded for the specified type", "value": { "holidays": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 52, "limit_due_to": [ { "api_name": "type", "json_path": "$.holidays[0].type" } ] }, "message": "Holidays limit exceeds", "status": "error" } ] } }, "MissingDate": { "description": "Shows the error when the date field is missing from the holiday object.", "summary": "Missing required date field", "value": { "holidays": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "date", "json_path": "$.holidays[0].date" }, "message": "required field not found", "status": "error" } ] } }, "MissingName": { "description": "Shows the error when the name field is missing from the holiday object.", "summary": "Missing required name field", "value": { "holidays": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.holidays[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MissingType": { "description": "Shows the error when the type field is missing from the holiday object.", "summary": "Missing required type field", "value": { "holidays": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.holidays[0].type" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when one or more holidays fail validation.", "properties": { "holidays": { "description": "Contains the validation error result for each holiday submitted in the request.", "items": { "additionalProperties": false, "description": "Represents the validation error result for a single holiday.", "properties": { "code": { "description": "Indicates the validation error type for this holiday. Possible values: **MANDATORY_NOT_FOUND, LIMIT_EXCEEDED, DUPLICATE_DATA, DEPENDENT_FIELD_MISSING, INVALID_DATA**.", "enum": [ "MANDATORY_NOT_FOUND", "LIMIT_EXCEEDED", "DUPLICATE_DATA", "DEPENDENT_FIELD_MISSING", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the validation error, such as the affected field name and JSON path.", "type": "object" }, "message": { "description": "Describes the specific validation error that occurred for this holiday.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the response status for this holiday. Possible values: **error.**", "enum": [ "error" ], "type": "string" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "HolidaysErrorResponse400Create" } } }, "description": "One or more holidays in the request failed validation. **Resolution** Each holiday must include the required fields (name, date, type) with valid values." }, "403": { "$ref": "#/components/responses/HolidaysForbiddenError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.CREATE" ] } ], "summary": "Holidays", "tags": [ "holidays" ], "x-zoho-document": "holidays" }, "put": { "description": "To update one or more existing holiday records in Zoho CRM by providing each holiday ID with the updated field values.", "operationId": "updateHolidays", "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Shows a sample request body for updating multiple holidays.", "summary": "Default request body for bulk holiday update", "value": { "holidays": [ { "id": "4150868000011382033", "name": "New Year Updated" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the request body containing the array of holidays to update.", "properties": { "holidays": { "description": "Specify the list of holidays to update. Each entry must include the holiday **ID**.", "items": { "additionalProperties": false, "description": "Specify the updated details for a single holiday.", "properties": { "date": { "description": "Specify the updated date for the holiday in **YYYY-MM-DD** format.", "format": "date", "type": "string" }, "id": { "description": "Specify the unique identifier of the holiday to update.", "maxLength": 255, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Specify the updated name for the holiday.", "maxLength": 80, "minLength": 1, "pattern": "^[^#%^&*]+$", "type": "string" }, "shift_hour": { "additionalProperties": false, "description": "Specify the updated shift hour associated with this holiday. Required when the type field is set to shift_holiday.", "properties": { "id": { "description": "Specify the unique identifier of the shift hour. Use the [Get Shift Hours API](shift_hours.yaml#$.paths./settings/business_hours/shift_hours.get) to get the ID of the shift hour.", "maxLength": 255, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Specify the name of the shift hour.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "type": { "description": "Specify the updated type of holiday. Possible values: **business_holiday, shift_holiday**.", "enum": [ "business_holiday", "shift_holiday" ], "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "info": { "additionalProperties": false, "description": "Contains optional pagination context included in the request schema.", "properties": { "count": { "description": "Specify the total count of records.", "format": "int32", "type": "integer" }, "more_records": { "description": "Specify whether more records are available on subsequent pages.", "type": "boolean" }, "page": { "description": "Specify the page number to retrieve.", "format": "int32", "type": "integer" }, "per_page": { "description": "Specify the number of records to include per page.", "format": "int32", "type": "integer" } }, "type": "object" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysSuccessResponseUpdate" } ], "description": "Represents the request body schema for bulk updating holidays." }, "x-zs-llm-examples": [ "Default" ] } }, "description": "The request body must contain a holidays array. You can include a maximum of **100** objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the response the API returns after updating one or more holidays successfully.", "summary": "Default success response after updating holidays", "value": { "holidays": [] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body the API returns after updating one or more holidays.", "properties": { "holidays": { "description": "Contains the operation result for each holiday submitted in the update request. ", "items": { "additionalProperties": false, "description": "Represents the update result for a single holiday.", "properties": { "code": { "description": "Indicates the validation error type. Possible values: DUPLICATE_DATA, DEPENDENT_FIELD_MISSING, INVALID_DATA.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the update operation result.", "properties": { "id": { "description": "Represents the unique identifier of the updated holiday.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Describes the result of the update operation for this holiday.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the update operation for this holiday.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysSuccessResponseUpdateBulk" } } }, "description": "Returns the result of the bulk holiday update operation." }, "207": { "$ref": "#/components/responses/HolidaysMultiStatusResponse" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissing": { "description": "Shows the error when a required dependent field is missing for the shift_holiday type.", "summary": "Missing dependent field for shift holiday in bulk update", "value": { "holidays": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "shift_hour", "dependee": { "api_name": "type", "json_path": "$.holidays[0].type" }, "json_path": "$.holidays[0].shift_hour" }, "message": "Shift id is required for shift holidays", "status": "error" } ] } }, "DuplicateData": { "description": "Shows the error when a holiday with the same name already exists.", "summary": "Duplicate holiday name in bulk update", "value": { "holidays": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataDateFormat": { "description": "Shows the error when the date field does not conform to the expected date format.", "summary": "Holiday date in invalid format in bulk update", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "date", "expected_data_type": "date", "json_path": "$.holidays[0].date" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataDateRange": { "description": "Shows the error when the holiday date falls outside the allowed financial year range.", "summary": "Holiday date outside allowed range in bulk update", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "date", "json_path": "$.holidays[0].date" }, "message": "Date Should be between current and next financial year", "status": "error" } ] } }, "InvalidDataMaxLength": { "description": "Shows the error when the holiday name exceeds the maximum allowed length.", "summary": "Holiday name exceeds maximum length in bulk update", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name", "maximum_length": 80 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataShiftId": { "description": "Shows the error when the shift_hour ID value is not valid.", "summary": "Invalid shift hour ID in bulk update", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.holidays[0].shift_hour.id" }, "message": "Invalid shift id", "status": "error" } ] } }, "InvalidDataSpecialChars": { "description": "Shows the error when the holiday name contains disallowed special characters.", "summary": "Holiday name contains invalid special characters in bulk update", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name" }, "message": "Holiday Name should not contain special characters:#, %, ^, &, *", "status": "error" } ] } }, "InvalidDataType": { "description": "Shows the error when the type field contains an unsupported value.", "summary": "Invalid holiday type value in bulk update", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.holidays[0].type", "supported_values": [ "business_holiday", "shift_holiday" ] }, "message": "Invalid type", "status": "error" } ] } }, "InvalidHolidayId": { "description": "Shows the error when a holiday ID in the request does not correspond to an existing holiday record.", "summary": "Invalid holiday ID in bulk update", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "long", "json_path": "$.holidays[0].id" }, "message": "Invalid holiday id", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body when one or more holidays fail validation during the bulk update.", "properties": { "holidays": { "description": "Contains the validation error result for each holiday in the request.", "items": { "additionalProperties": false, "description": "Represents the validation error result for a single holiday.", "properties": { "code": { "description": "Indicates the validation error type. Possible values: DUPLICATE_DATA, DEPENDENT_FIELD_MISSING, INVALID_DATA.", "enum": [ "DUPLICATE_DATA", "DEPENDENT_FIELD_MISSING", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the validation error, such as the affected field name and JSON path.", "type": "object" }, "message": { "description": "Describes the specific validation error for this holiday.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the response status for this holiday. Possible values: error.", "enum": [ "error" ], "type": "string" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "HolidaysErrorResponse400UpdateBulk" } } }, "description": "One or more holidays in the request failed validation. **Resolution** Each holiday must include a valid ID, and all updated field values must conform to the expected format and constraints." }, "403": { "$ref": "#/components/responses/HolidaysForbiddenError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.UPDATE" ] } ], "summary": "Multiple Holidays", "tags": [ "holidays" ], "x-zoho-document": "holidays" } }, "/crm/v8/settings/holidays/{holidayId}": { "delete": { "description": "To permanently delete a holiday from Zoho CRM using its unique identifier. The deletion cannot be undone.", "operationId": "deleteHoliday", "parameters": [ { "$ref": "#/components/parameters/HolidayId" }, { "$ref": "#/components/parameters/Year" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the response the API returns after deleting the holiday successfully.", "summary": "Default response confirming holiday deletion", "value": { "holidays": [] } } }, "schema": { "$ref": "#/components/schemas/HolidaysSuccessResponse" } } }, "description": "Returns the result of the delete operation." }, "400": { "content": { "application/json": { "examples": { "InvalidId": { "description": "Shows the error response when the provided holiday ID does not correspond to an existing holiday.", "summary": "Invalid holiday ID in request path", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "Invalid ID", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when the holiday ID fails validation.", "properties": { "code": { "description": "Indicates the validation error type. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the validation error, including the path index of the invalid resource identifier.", "type": "object" }, "message": { "description": "Describes the specific validation error that occurred.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "HolidaysErrorResponses400Delete" } } }, "description": "Invalid holiday ID. **Resolution** The holiday ID in the request path must be a valid identifier of an existing holiday record." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.DELETE" ] } ], "summary": "Holiday", "tags": [ "holidays" ], "x-zoho-document": "holidays" }, "get": { "description": "To retrieve the complete details of a specific holiday record from Zoho CRM using its unique identifier.", "operationId": "getHoliday", "parameters": [ { "$ref": "#/components/parameters/HolidayId" }, { "$ref": "#/components/parameters/Year" }, { "$ref": "#/components/parameters/HolidaysType" }, { "$ref": "#/components/parameters/ShiftId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the response the API returns after retrieving the holiday by its unique identifier.", "summary": "Default response with holiday details", "value": { "holidays": [] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body containing the details of the requested holiday record.", "properties": { "holidays": { "description": "Contains the holiday record matching the specified identifier. ", "items": { "additionalProperties": false, "description": "Specifies a single holiday record in the response.", "properties": { "date": { "description": "Represents the date of the holiday in **YYYY-MM-DD** format. ", "format": "date", "type": "string" }, "id": { "description": "Represents the unique identifier of the holiday record. ", "maxLength": 255, "type": "string", "x-zs-$id": "HolidayId" }, "name": { "description": "Represents the name of the holiday. ", "maxLength": 80, "type": "string" }, "shift_hour": { "additionalProperties": false, "description": "Represents the shift hour associated with this holiday. Contains null for business holidays. ", "properties": { "id": { "description": "Specifies the unique identifier of the shift hour. Always present when the shift_hour object is included in the response.", "maxLength": 255, "type": "string", "x-zs-$id": "HolidayShiftHourId" }, "name": { "description": "Represents the name of the shift hour. Always present when the shift_hour object is included in the response.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "type": { "description": "Indicates the type of holiday. Possible values: **business_holiday, shift_holiday**. ", "enum": [ "business_holiday", "shift_holiday" ], "type": "string" }, "year": { "description": "Specifies the year in which the holiday falls. ", "format": "int32", "type": "integer" } }, "required": [ "name", "date", "type", "shift_hour", "id", "year" ], "type": "object" }, "maxItems": 100, "type": "array" }, "info": { "additionalProperties": false, "description": "Contains pagination metadata for the response.", "properties": { "count": { "description": "Represents the total number of holiday records returned in this page of results.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether more holiday records are available on subsequent pages.", "type": "boolean" }, "page": { "description": "Indicates the current page number in the paginated results. Page numbers begin at one.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of holiday records returned per page.", "format": "int32", "type": "integer" } }, "type": "object" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysSuccessResponseGet" } } }, "description": "Returns the details of the requested holiday record." }, "204": { "description": "No holiday was found for the specified identifier." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.READ" ] } ], "summary": "A specific holiday", "tags": [ "holidays" ], "x-zoho-document": "holidays" }, "put": { "description": "To update the name or date of a specific holiday record in Zoho CRM using its unique identifier.", "operationId": "updateHoliday", "parameters": [ { "$ref": "#/components/parameters/HolidayId" } ], "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the request body used to update the holiday record.", "summary": "Default success response after updating a holiday", "value": {} } }, "schema": { "additionalProperties": false, "description": "Represents the request body schema for updating a single holiday.", "properties": { "holidays": { "description": "Specify the updated details for the holiday.", "items": { "additionalProperties": false, "description": "Specify the fields to update for the holiday.", "properties": { "date": { "description": "Specify the new date for the holiday in **YYYY-MM-DD** format.", "format": "date", "type": [ "string", "null" ] }, "name": { "description": "Specify the new name for the holiday.", "maxLength": 80, "minLength": 1, "pattern": "^[^#%^&*]+$", "type": [ "string", "null" ] } }, "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "type": "object" }, "x-zs-llm-examples": [ "Default" ] } }, "description": "The request body must contain a holidays array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows a sample 400 error response when holiday update validation fails.", "summary": "Default 400 error response for holiday update", "value": { "holidays": [] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body the API returns after updating the holiday.", "properties": { "holidays": { "description": "Contains the result for the updated holiday. ", "items": { "additionalProperties": false, "description": "Represents the update result for the holiday record.", "properties": { "code": { "description": "Indicates the result code for the holiday update. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the updated holiday, including its unique identifier. ", "properties": { "id": { "description": "Represents the unique identifier of the updated holiday.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Describes the result of the holiday update operation. ", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the status of the holiday update. Possible values: success. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysSuccessResponseUpdateSingle" } } }, "description": "Returns the result of the holiday update operation." }, "400": { "content": { "application/json": { "examples": { "DuplicateData": { "description": "Shows the error when the updated holiday name already exists for another holiday.", "summary": "Duplicate holiday name", "value": { "holidays": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataDateFormat": { "description": "Shows the error when the updated date does not conform to the expected date format.", "summary": "Holiday date in invalid format", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "date", "expected_data_type": "date", "json_path": "$.holidays[0].date" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataDateRange": { "description": "Shows the error when the updated date falls outside the allowed financial year range.", "summary": "Holiday date outside allowed range", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "date", "json_path": "$.holidays[0].date" }, "message": "Date Should be between current and next financial year", "status": "error" } ] } }, "InvalidDataMaxLength": { "description": "Shows the error when the updated holiday name exceeds the maximum allowed length.", "summary": "Holiday name exceeds maximum length", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name", "maximum_length": 80 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataSpecialChars": { "description": "Shows the error when the updated holiday name contains disallowed special characters.", "summary": "Holiday name contains invalid special characters", "value": { "holidays": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.holidays[0].name" }, "message": "Holiday Name should not contain special characters:#, %, ^, &, *", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response body when a bulk update is attempted for a single holiday endpoint.", "properties": { "holidays": { "description": "Contains the validation errors for holidays in the request. ", "items": { "$ref": "#/components/schemas/InvalidDataResponse" }, "maxItems": 100, "type": "array" } }, "required": [ "holidays" ], "type": "object", "x-zs-$id": "HolidaysErrorResponse400Update" }, { "$ref": "#/components/schemas/InvalidDataResponse" } ], "description": "Represents the error response body returned when the holiday update fails validation.", "x-zs-$id": "HolidaysErrorResponses" } } }, "description": "One or more holiday fields in the request failed validation. **Resolution** All field values must conform to the expected format and constraints." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.business_hours.UPDATE" ] } ], "summary": "A specific holiday", "tags": [ "holidays" ], "x-zoho-document": "holidays" } }, "/crm/v8/settings/inventory_templates": { "get": { "description": "To retrieve a paginated list of inventory templates configured in your Zoho CRM organization, with optional filtering by module, category, and field criteria, and sorting by name or usage and modification timestamps.", "operationId": "getInventoryTemplates", "parameters": [ { "$ref": "#/components/parameters/InventoryTemplatesModule" }, { "$ref": "#/components/parameters/InventoryTemplatesPerPage" }, { "$ref": "#/components/parameters/InventoryTemplatesPage" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTemplateListResponse" } } }, "description": "Returns the paginated list of inventory templates matching the specified criteria, along with pagination metadata." }, "204": { "description": "No inventory templates match the specified filter criteria. The response body is empty." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the module name provided in the request is invalid, with the param_name field identifying the invalid parameter.", "summary": "Invalid module name in request", "value": { "code": "INVALID_DATA", "details": { "param_name": "module" }, "message": "The module name provided is invalid.", "status": "error" } }, "PatternNotMatched": { "description": "Shows the error response when the sort_order parameter value does not match the required pattern, with the param_name field identifying the offending parameter.", "summary": "Invalid sort_order parameter value", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "sort_order" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/GetInventoryTemplates400Error" } } }, "description": "The request contains invalid parameters or an invalid module name.\n**Resolution:** The module API name and all query parameter values must be valid before retrying the request." } }, "security": [ { "OAuth2": [ "ZohoCRM.templates.inventory.READ" ] } ], "summary": "Inventory templates", "tags": [ "inventory_templates" ], "x-zoho-document": "inventory_templates" } }, "/crm/v8/settings/inventory_templates/{templateId}": { "get": { "description": "Retrieves a single inventory template by its ID with complete details including content and all metadata.", "operationId": "getInventoryTemplateById", "parameters": [ { "description": "Inventory template ID.", "in": "path", "name": "templateId", "required": true, "schema": { "maxLength": 64, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "value": { "inventory_templates": [ { "category": "normal", "content": "

Type your text here... ${!Quotes.Subject}

", "created_by": { "id": "2922375000000512001", "name": "Jess Moana" }, "created_time": "2026-02-17T17:00:44+05:30", "editor_mode": "gallery", "favorite": false, "folder": { "id": "2922375000000647131", "name": "new foldasfcasfawesdflkmarwlfmqewofmqp2o34wekrdsfv" }, "id": "2922375000004671074", "last_usage_time": null, "modified_by": { "id": "2922375000000512001", "name": "Jess Moana" }, "modified_time": "2026-02-17T17:01:51+05:30", "module": { "api_name": "Quotes", "id": "2922375000000000169" }, "name": "New inv templ" } ] } } }, "schema": { "$ref": "#/components/schemas/InventoryTemplateDetailResponse" } } }, "description": "OK - single inventory template with all details" }, "204": { "description": "No Content - template not found" } }, "security": [ { "OAuth2": [ "ZohoCRM.templates.inventory.READ" ] } ], "summary": "Inventory Template", "tags": [ "inventory_templates" ], "x-zoho-document": "inventory_templates" } }, "/crm/v8/settings/layouts": { "get": { "description": "To retrieve the layout configurations for a specified module in your Zoho CRM organization. **Note:** - The **profiles** array is **null** if the user does not have the Module Customization permission in their profile. - For the Deals module, when the pipeline feature is enabled, multiple layouts exist per pipeline, each with its own set of layouts. - Score and Visit Summary sections are system-generated and read-only. - The API returns all layouts for the module in a single response; pagination is not supported.", "operationId": "getLayouts", "parameters": [ { "$ref": "#/components/parameters/ModuleParameter" }, { "$ref": "#/components/parameters/ModeParameter" }, { "$ref": "#/components/parameters/LayoutsIncludes" }, { "$ref": "#/components/parameters/LayoutsIncludeInnerDetails" }, { "$ref": "#/components/parameters/MirrorComponentParameter" } ], "responses": { "200": { "$ref": "#/components/responses/LayoutSuccessResponse" }, "400": { "$ref": "#/components/responses/LayoutsBadRequest" }, "401": { "$ref": "#/components/responses/LayoutsUnauthorizedResponse" }, "404": { "$ref": "#/components/responses/LayoutsNotFound" }, "500": { "$ref": "#/components/responses/LayoutsInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.layouts.READ" ] } ], "summary": "Get layouts metadata", "tags": [ "layouts" ], "x-zoho-document": "layouts" } }, "/crm/v8/settings/layouts/{id}": { "delete": { "description": "To delete a custom layout from a module in your Zoho CRM organization. When the layout being deleted has associated records, a target layout must be specified to receive the transferred records and profile associations. If the layout has an associated pipeline, the target pipeline and stage must also be provided. Specifying a transfer target is optional only when the layout is deactivated and has no associated records. Only one custom layout can be deleted per API call, and the standard layout cannot be deleted.", "operationId": "deleteLayout", "parameters": [ { "$ref": "#/components/parameters/LayoutIdParameter" }, { "$ref": "#/components/parameters/ModuleParameter" }, { "$ref": "#/components/parameters/TransferToParameter" }, { "$ref": "#/components/parameters/PipelineParameter" }, { "$ref": "#/components/parameters/StageParameter" } ], "responses": { "200": { "$ref": "#/components/responses/DeleteLayoutSuccessResponse" }, "400": { "$ref": "#/components/responses/DeleteLayoutBadRequestResponse" }, "401": { "$ref": "#/components/responses/LayoutsUnauthorizedResponse" }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Returned when the authenticated user's profile lacks the CRM customization permission required to delete layouts. The response includes a list of the missing permissions.", "summary": "User lacks permission to delete the layout", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/LayoutsErrorResponse" } } }, "description": "Permission denied to delete the layout. **Resolution:** The Zoho CRM administrator grants the user's profile the CRM customization permission required to delete layouts." }, "500": { "$ref": "#/components/responses/LayoutsInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.layouts.DELETE" ] } ], "summary": "Delete a custom layout", "tags": [ "layouts" ], "x-zoho-document": "layouts" }, "get": { "description": "To retrieve the details of a specific layout by its layout ID for a specified module in your Zoho CRM account. **Important Notes:** - The `profiles` array is `null` when the user does not have \"Module Customization\" permission in their profile. - For Deals module: When the pipeline feature is enabled, multiple layouts exist per pipeline. Each pipeline can have its own set of layouts. - The `mode` parameter filters the layout by mode. Possible values: **all**, **business_card**, **quick_create**. - Score and Visit Summary sections are system-generated and read-only. **Prerequisite:** The layout ID can be obtained from the Get All Layouts API.", "operationId": "getLayoutById", "parameters": [ { "$ref": "#/components/parameters/LayoutIdParameter" }, { "$ref": "#/components/parameters/ModuleParameter" }, { "$ref": "#/components/parameters/ModeParameter" }, { "$ref": "#/components/parameters/LayoutsIncludes" }, { "$ref": "#/components/parameters/LayoutsIncludeInnerDetails" }, { "$ref": "#/components/parameters/MirrorComponentParameter" } ], "responses": { "200": { "$ref": "#/components/responses/LayoutSuccessResponse" }, "204": { "description": "Indicates that the request was processed successfully, but no layout data matches the specified criteria." }, "400": { "$ref": "#/components/responses/LayoutsBadRequest" }, "401": { "$ref": "#/components/responses/LayoutsUnauthorizedResponse" }, "500": { "$ref": "#/components/responses/LayoutsInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.layouts.READ" ] } ], "summary": "Get layout by ID", "tags": [ "layouts" ], "x-zoho-document": "layouts" }, "patch": { "description": "To update a custom layout in your Zoho CRM organization, including renaming it, modifying profile permissions, enabling or disabling the business card display, and creating, updating, or deleting sections and fields within sections.", "operationId": "updateLayout", "parameters": [ { "$ref": "#/components/parameters/LayoutIdParameter" }, { "$ref": "#/components/parameters/ModuleParameter" } ], "requestBody": { "content": { "application/json": { "examples": { "AddFieldToSection": { "description": "Shows a layout update request that places an existing CRM field into a designated section. The field is referenced by its identifier and positioned within the section's field sequence without creating a new field definition.", "summary": "Adding an existing field to a layout section", "value": { "layouts": [ { "sections": [ { "fields": [ { "id": "3722469000001347394" } ], "id": "3722469000001374014" } ] } ] } }, "AddMirrorComponentToSection": { "description": "Shows a layout update request that adds a mirror field component to a section. A mirror component reflects the value of a field from a related module, allowing users to view cross-module data directly within the layout.", "summary": "Adding a mirror field component to a layout section", "value": { "layouts": [ { "sections": [ { "fields": [ { "element_type": "mirror_field", "id": "3359388011000000523", "lookup_field": { "api_name": "Account_Name", "id": "3359388000000000523" }, "sequence_number": 3 } ], "id": "3722469000001374014" } ] } ] } }, "AddProfilePermission": { "description": "Shows a layout update request that grants a CRM profile access to the specified layout. The profile is associated with the layout so that users assigned to that profile can view and interact with it when working on records.", "summary": "Granting a CRM profile access to a layout", "value": { "layouts": [ { "profiles": [ { "id": "111111000000000395" } ] } ] } }, "CreateCustomSection": { "description": "Shows a layout update request that introduces a new custom section into the layout structure. The section is defined with a name and display configuration, providing a dedicated grouping area for fields within the layout.", "summary": "Creating a new custom section within a layout", "value": { "layouts": [ { "sections": [ { "column_count": 1, "display_label": "Custom Section 2", "name": "Custom Section 2", "sequence_number": 6, "tab_traversal": "left_to_right" } ] } ] } }, "CreateFieldWithAssociation": { "description": "Shows a layout update request that creates a new field inline and establishes a Field-Of-Lookup (FOL) mapping to a related field in another module. This association allows the field to surface data from a linked record via an existing lookup field, connecting the two modules at the field level.", "summary": "Creating a new field with a Field-Of-Lookup association", "value": { "layouts": [ { "sections": [ { "fields": [ { "association_details": { "lookup_field": { "api_name": "Account_Lookup", "id": "3722469000001347500" }, "related_field": { "api_name": "Annual_Revenue", "id": "3722469000001347600" } }, "data_type": "integer", "field_label": "Account Revenue", "length": 9 } ], "id": "3722469000001347180" } ] } ] } }, "CreateNewField": { "description": "Demonstrates adding a new custom field definition to an existing section of a layout. The request specifies the field type, label, and target section, creating a field that did not previously exist in the layout.", "summary": "Adds a new custom field definition to a layout section", "value": { "layouts": [ { "sections": [ { "fields": [ { "data_type": "text", "field_label": "CF1", "length": 16, "sequence_number": 1 } ], "id": "3722469000001347180" } ] } ] } }, "DeleteSection": { "description": "Demonstrates permanently removing an entire section from a layout. Unlike moving fields to unused, this operation irreversibly eliminates the section and all of its field assignments from the layout.", "summary": "Permanently removes a section and its field assignments from a layout", "value": { "layouts": [ { "sections": [ { "_delete": { "permanent": true }, "id": "3722469000001374014" } ] } ] } }, "MoveFieldToUnused": { "description": "Demonstrates relocating a field to the unused items section of a layout without permanently deleting it. The field is preserved and can be reassigned to an active section at a later time.", "summary": "Relocates a field to the unused items section without deleting it", "value": { "layouts": [ { "sections": [ { "fields": [ { "_delete": { "permanent": false }, "id": "3722469000001347394" } ], "id": "3722469000001347180" } ] } ] } }, "MultipleFieldsAcrossSections": { "description": "Demonstrates adding up to five fields distributed across two or more distinct layout sections within a single request. This approach reduces round-trips when populating several sections simultaneously, subject to the five-field-per-request limit.", "summary": "Adds up to five fields spread across multiple layout sections in one request", "value": { "layouts": [ { "sections": [ { "fields": [ { "id": "3722469000001347394" }, { "id": "3722469000001347395" } ], "id": "3722469000001374014" }, { "fields": [ { "id": "3722469000001347396" }, { "id": "3722469000001347397" }, { "id": "3722469000001347398" } ], "id": "3722469000001374015" } ] } ] } }, "RemoveProfilePermission": { "description": "Demonstrates revoking a CRM profile's access to a layout by setting the delete flag on the profile entry. This removes the profile's visibility and usage rights for the layout without affecting other profiles assigned to it.", "summary": "Revokes a CRM profile's access to a layout via the delete flag", "value": { "layouts": [ { "profiles": [ { "_delete": true, "id": "111111000000000393" } ] } ] } }, "RenameLayout": { "description": "Demonstrates renaming a custom layout by supplying a new name value in the request body. The existing layout identified by the path parameter retains all other configuration; only the display name changes.", "summary": "Rename an existing custom layout", "value": { "layouts": [ { "name": "Updated CL1" } ] } }, "ToggleBusinessCard": { "description": "Illustrates toggling the business card display setting on a layout by setting the business card display property to the desired Boolean state. All other layout properties remain unchanged while only the business card visibility is modified.", "summary": "Toggle the business card display setting on a layout", "value": { "layouts": [ { "show_business_card": false } ] } }, "UpdateFieldSequence": { "description": "Shows how to reorder a field within its section by specifying the target field identifier alongside a new sequence or position value. The updated ordering is applied to the named section without altering any other field configuration.", "summary": "Reorder a field's position within a layout section", "value": { "layouts": [ { "sections": [ { "fields": [ { "id": "3722469000001347394", "sequence_number": 2 } ], "id": "3722469000001374014" } ] } ] } }, "UpdateFieldWithAssociation": { "description": "Demonstrates attaching a Field-Of-Lookup (FOL) association to an existing layout field by providing the field identifier together with association details that reference the lookup field and its related field. This pattern links two fields so that the layout can derive values from the specified lookup relationship.", "summary": "Attach a Field-Of-Lookup association to an existing layout field", "value": { "layouts": [ { "sections": [ { "fields": [ { "association_details": { "lookup_field": { "id": "3722469000001347500" }, "related_field": { "id": "3722469000001347600" } }, "id": "3722469000001347394" } ], "id": "3722469000001347180" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateLayoutRequest" }, "x-zs-llm-examples": [ "RenameLayout", "CreateNewField", "CreateCustomSection", "MoveFieldToUnused" ] } }, "description": "The request body must contain a layouts array with one object. You can include a maximum of five sections per request, with no more than five fields in total across all sections.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "summary": "Layout updated successfully with confirmation details", "value": { "layouts": [ { "code": "SUCCESS", "details": { "id": "3722469000001346011" }, "message": "layout updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateLayoutSuccessResponse" } } }, "description": "Returns a layouts array containing the result of the update operation, including a SUCCESS status code and the ID of the updated layout." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingRelatedField": { "description": "Returned when both ID and api_name are provided for related_field but resolve to different fields, triggering error code AMBIGUITY_DURING_PROCESSING with message \"ambiguity while processing the related_field\".", "summary": "Ambiguity detected when both ID and api_name identify different related_fields", "value": { "layouts": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.layouts[0].sections[0].fields[0].association_details.related_field.id" }, { "api_name": "api_name", "json_path": "$.layouts[0].sections[0].fields[0].association_details.related_field.api_name" } ] }, "message": "ambiguity while processing the related_field", "status": "error" } ] } }, "DependentFieldMissingForField": { "summary": "Field ID or field_label absent during a field operation", "value": { "layouts": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.layouts[0].sections[0].fields[0].id" }, { "api_name": "field_label", "json_path": "$.layouts[0].sections[0].fields[0].field_label" } ] }, "message": "should contain either id or field_label", "status": "error" } ] } }, "DependentFieldMissingForSection": { "summary": "Section ID or api_name absent during a section operation", "value": { "layouts": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "api_name", "dependee": { "api_name": "_delete", "json_path": "$.layouts[0].sections[0]._delete" }, "json_path": "$.layouts[0].sections[0].api_name" }, "message": "section id or api_name is missing", "status": "error" } ] } }, "DependentMismatchFieldLength": { "description": "Returned when the field length and related field length are incompatible during a Field-of-Lookup (FoL) mapping operation, triggering error code DEPENDENT_MISMATCH with message \"Field length mismatch for FOL mapping\".", "summary": "Field length and related field length incompatible for FoL mapping", "value": { "layouts": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "id", "dependee": { "api_name": "length", "json_path": "$.layouts[0].sections[0].fields[0].length" }, "json_path": "$.layouts[0].sections[0].fields[0].association_details.related_field.id" }, "message": "Field length mismatch for FOL mapping", "status": "error" } ] } }, "ExpectedFieldMissingRelatedField": { "description": "Returned when neither ID nor api_name is provided for the related_field within association_details, triggering error code EXPECTED_FIELD_MISSING with message \"One of the required fields is missing\".", "summary": "No ID or api_name supplied for related_field in association_details", "value": { "layouts": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.layouts[0].sections[0].fields[0].association_details.related_field.id" }, { "api_name": "api_name", "json_path": "$.layouts[0].sections[0].fields[0].association_details.related_field.api_name" } ] }, "message": "One of the required fields is missing", "status": "error" } ] } }, "FeatureNotSupportedAssociationDetails": { "description": "Returned when the user's license does not support Field-of-Lookup mapping. Zoho CRM responds with code FEATURE_NOT_SUPPORTED and the message \"Your License does not support this feature\".", "summary": "License does not support Field-of-Lookup feature", "value": { "layouts": [ { "code": "FEATURE_NOT_SUPPORTED", "details": { "api_name": "association_details", "json_path": "$.layouts[0].sections[0].fields[0].association_details" }, "message": "Your License does not support this feature", "status": "error" } ] } }, "InvalidFieldId": { "summary": "Invalid field ID provided", "value": { "layouts": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.layouts[0].sections[0].fields[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidModule": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidSectionIdOrApiName": { "summary": "Section missing required ID or display label", "value": { "layouts": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.layouts[0].sections[0].id" }, { "api_name": "display_label", "json_path": "$.layouts[0].sections[0].display_label" } ] }, "message": "should contain either id or display_label", "status": "error" } ] } }, "InvalidTabTraversal": { "summary": "Invalid data type for tab traversal value", "value": { "layouts": [ { "code": "INVALID_DATA", "details": { "api_name": "tab_traversal", "expected_data_type": "text", "json_path": "$.layouts[0].sections[0].tab_traversal" }, "message": "invalid data", "status": "error" } ] } }, "LimitExceededFoLMapping": { "description": "Returned when the maximum number of Field-of-Lookup mappings permitted for a lookup has been reached. Zoho CRM responds with code LIMIT_EXCEEDED and the message \"Field of Lookup mapping limit is reached for the lookup\".", "summary": "Field-of-Lookup mapping limit reached for lookup", "value": { "layouts": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 5, "limit_due_to": [ { "api_name": "id", "json_path": "$.layouts[0].sections[0].fields[0].association_details.lookup_field.id" } ] }, "message": "Field of Lookup mapping limit is reached for the lookup", "status": "error" } ] } }, "NotAllowedRelatedFieldLengthHigher": { "description": "Returned when the related field's length exceeds the target field's length during a Field-of-Lookup mapping operation. Zoho CRM responds with code NOT_ALLOWED and the message \"related field length is higher\".", "summary": "Related field length exceeds target field length in FoL mapping", "value": { "layouts": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.layouts[0].sections[0].fields[0].association_details.related_field.id" }, "message": "related field length is higher", "status": "error" } ] } }, "NotSupportedAssociationDetails": { "description": "Returned when association_details is provided for a field that does not support Field-of-Lookup mapping. Zoho CRM responds with code NOT_SUPPORTED and the message \"Field of lookup association is not supported for this field\".", "summary": "Field-of-Lookup association not supported for the specified field", "value": { "layouts": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "association_details", "json_path": "$.layouts[0].sections[0].fields[0].association_details" }, "message": "Field of lookup association is not supported for this field", "status": "error" } ] } }, "RequiredParamMissing": { "summary": "Required module parameter missing from request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } }, "SystemKeywordNotAllowed": { "description": "Returned when the layout name contains a reserved system keyword. Zoho CRM responds with code INVALID_DATA and the message \"System keyword not allowed in layout label\".", "summary": "Layout name contains a reserved system keyword", "value": { "layouts": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.layouts[0].name" }, "message": "System keyword not allowed in layout label", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateLayoutErrorResponse" } } }, "description": "Invalid data or parameters in the request. **Resolution:** The caller must verify that the layout ID, module name, and all required fields and section identifiers in the request body are valid and present." }, "401": { "$ref": "#/components/responses/LayoutsUnauthorizedResponse" }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Returned when the requesting user does not have the CRM profile permission required to update layouts. Zoho CRM responds with code NO_PERMISSION and the message \"permission denied\".", "summary": "CRM profile lacks permission to update layouts", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/LayoutsErrorResponse" } } }, "description": "Permission denied. **Resolution:** The user does not have permission to update the layout. The administrator must grant the required CRM profile permissions." }, "405": { "content": { "application/json": { "examples": { "InvalidMethod": { "summary": "Invalid HTTP method used for this endpoint", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/LayoutsErrorResponse" } } }, "description": "The HTTP request method is not valid for this endpoint. **Resolution:** The caller must specify a valid HTTP request method for the API URL." }, "500": { "$ref": "#/components/responses/LayoutsInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.layouts.UPDATE" ] } ], "summary": "Update a custom layout", "tags": [ "layouts" ], "x-zoho-document": "layouts" } }, "/crm/v8/settings/layouts/{id}/actions/activate": { "delete": { "description": "Deactivates an active layout and transfers its configuration (profile associations, permissions, field mappings) to another active layout within the same module. At least one active layout must remain in the module. This operation is idempotent - attempting to deactivate an already deactivated layout returns an error (ALREADY_DEACTIVATED).", "operationId": "layoutDeactivate", "parameters": [ { "$ref": "#/components/parameters/LayoutsActivateDeactivateId" }, { "$ref": "#/components/parameters/LayoutsActivateDeactivateModule" }, { "description": "Specify the unique identifier of an active layout within the same module to which the deactivated layout's profile associations and configuration will be transferred. The target layout must be different from the layout being deactivated. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource for valid values.", "examples": { "DifferentModuleLayout": { "summary": "Another target layout in the same module", "value": "4831139000000655999" }, "TransferLayoutId": { "summary": "Target layout ID for configuration transfer", "value": "4831139000000655703" } }, "in": "query", "name": "transfer_to", "required": true, "schema": { "description": "Target layout ID for configuration transfer", "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDeactivation": { "description": "Shows the success response returned when an active layout is successfully deactivated with its configuration transferred to the target layout.", "summary": "Layout deactivated successfully", "value": { "layouts": [ { "code": "SUCCESS", "details": { "id": "4831139000000653980" }, "message": "layout deactivated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned when a layout is successfully deactivated.", "properties": { "layouts": { "description": "Array containing the result of the layout deactivation operation. Always returned in the response.", "items": { "additionalProperties": false, "description": "Represents the result details for the deactivated layout.", "properties": { "code": { "description": "Represents the operation result code. Possible values: **SUCCESS** - Indicates the layout was deactivated successfully. Always returned in the response.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the deactivated layout. Always returned in the response.", "properties": { "id": { "description": "Represents the unique identifier of the deactivated layout. Always returned in the response.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the confirmation message for the deactivation operation. Always returned in the response.", "examples": [ "layout deactivated" ], "maxLength": 200, "type": "string" }, "status": { "description": "Represents the overall operation status. Possible values: **success** - Indicates the deactivation completed without errors. Always returned in the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "LayoutDeactivateResponse" } } }, "description": "Returns the deactivation confirmation for the layout, including the result code and the deactivated layout ID." }, "400": { "content": { "application/json": { "examples": { "AlreadyDeactivated": { "description": "Shows the ALREADY_DEACTIVATED error returned when the specified layout is already in inactive state.", "summary": "Layout is already deactivated", "value": { "code": "ALREADY_DEACTIVATED", "details": { "resource_path_index": 2 }, "message": "Cannot deactivate already deactive layout", "status": "error" } }, "FlatAssociationsExist": { "description": "Cannot deactivate the layout as it is being used in some places; returned as a flat top-level object rather than wrapped in a layouts array", "summary": "Layout has associations (flat response)", "value": { "code": "ASSOCIATIONS_EXIST", "details": { "id": "1000000118778" }, "message": "Cannot deactivate layout as it is being used in some places", "status": "error" } }, "InvalidLayoutId": { "description": "Shows the INVALID_DATA error returned when the layout ID in the request path does not exist in the specified module.", "summary": "Invalid layout ID provided", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "No layout found with given id", "status": "error" } }, "LayoutHasAssociations": { "description": "Shows the ASSOCIATIONS_EXIST error returned when the layout has existing dependencies that must be resolved before deactivation.", "summary": "Layout cannot be deactivated due to existing associations", "value": { "layouts": [ { "code": "ASSOCIATIONS_EXIST", "details": { "id": "111111000000101446" }, "message": "Cannot deactivate layout as it is being used in some places", "status": "error" } ] } }, "MissingModuleParam": { "description": "Shows the REQUIRED_PARAM_MISSING error returned when the module query parameter is not included in the request.", "summary": "Required module parameter missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } }, "TransferToSameLayout": { "description": "Shows the NOT_ALLOWED error returned when the transfer_to parameter references the same layout ID as the one being deactivated.", "summary": "Cannot transfer configuration to the layout being deactivated", "value": { "code": "NOT_ALLOWED", "details": { "param_name": "transfer_to" }, "message": "Cannot transfer to the deactivated layout", "status": "error" } } }, "schema": { "additionalProperties": true, "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when the module name provided in the request is invalid.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **INVALID_MODULE** - Indicates the module name provided in the request is invalid. Always returned in the response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the invalid module error. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message indicating the module name is invalid. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, { "additionalProperties": false, "description": "Represents the error response returned when the provided layout ID or parameter value is invalid.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **INVALID_DATA** - Indicates the provided layout ID or parameter value is invalid. Always returned in the response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "anyOf": [ { "additionalProperties": false, "description": "Represents the error details returned when an invalid parameter value causes the request to fail.", "properties": { "param_name": { "description": "Represents the name of the parameter that contains the invalid value. Always returned in the response.", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "InvalidParameterErrorDetails" }, { "additionalProperties": false, "description": "Represents the error details returned when an invalid resource path index is encountered in the request.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the error occurred.", "format": "int32", "type": "integer" } }, "type": "object", "x-zs-$id": "ResourcePathErrorDetails" } ], "description": "Contains additional context about the invalid data error. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message describing the invalid data. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataIdErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned when a required parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **REQUIRED_PARAM_MISSING** - Indicates a required parameter is missing from the request. Always returned in the response.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the name of the missing required parameter. Always returned in the response.", "properties": { "param_name": { "description": "Represents the name of the missing required parameter. Always returned in the response.", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message indicating the missing required parameter. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RequiredParamMissingError" }, { "additionalProperties": false, "description": "Represents the error response returned when the layout cannot be deactivated because it has existing dependencies.", "properties": { "layouts": { "description": "Array of error details for each layout that cannot be deactivated due to existing associations. Always returned in the response.", "items": { "additionalProperties": false, "description": "Represents the error details for a layout that has existing associations preventing deactivation.", "properties": { "code": { "description": "Represents the error code for the layout deactivation failure. Possible values: **ASSOCIATIONS_EXIST** - Indicates the layout has existing dependencies that must be resolved before deactivation. Always returned in the response.", "enum": [ "ASSOCIATIONS_EXIST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the identifier of the layout that has existing associations. Always returned in the response.", "properties": { "id": { "description": "Represents the unique identifier of the layout that has existing associations preventing deactivation. Always returned in the response.", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message describing the association constraint that prevents deactivation. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the layout deactivation did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "LayoutHasAssociationsError" }, { "additionalProperties": false, "description": "Represents the error response returned when the transfer target layout is the same as the layout being deactivated.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **NOT_ALLOWED** - Indicates the transfer target layout is the same as the layout being deactivated. Always returned in the response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the name of the parameter that caused the restriction. Always returned in the response.", "properties": { "param_name": { "description": "Represents the name of the parameter that caused the NOT_ALLOWED error. Always returned in the response.", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message explaining why the operation is not allowed. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "TransferToSameLayoutError" }, { "additionalProperties": false, "description": "Represents the error response returned when the specified layout is already in inactive state.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **ALREADY_DEACTIVATED** - Indicates the specified layout is already in an inactive state. **NOT_ALLOWED** - Indicates the operation is not allowed. Always returned in the response.", "enum": [ "ALREADY_DEACTIVATED", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the already-deactivated layout error. Always returned in the response.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the error occurred.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message indicating the layout is already in inactive state. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "AlreadyDeactivatedError" }, { "additionalProperties": false, "description": "Layout cannot be deactivated because it has existing associations (flat response, not wrapped in layouts array)", "properties": { "code": { "description": "Error code indicating the layout has existing associations preventing deactivation", "enum": [ "ASSOCIATIONS_EXIST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the layout with existing associations", "properties": { "id": { "description": "The unique identifier of the layout that has existing associations", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable error message explaining why deactivation is blocked", "maxLength": 500, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FlatAssociationsExistError" } ], "description": "Represents the error response for bad request scenarios during layout deactivation, covering invalid module names, invalid layout IDs, missing parameters, association constraints, and layout state violations.", "type": "object", "x-zs-$id": "LayoutDeactivateErrorResponse" } } }, "description": "The request could not be processed due to invalid parameters, missing required parameters, layout state violations, or association constraints. Resolution: Inspect the **code** field in the response body to identify the specific cause, and verify the layout ID, module name, and the **transfer_to** parameter value." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response returned when the authenticated user does not have the **Customize Zoho CRM** permission required to deactivate a layout.", "summary": "User lacks the required layout customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user lacks the CRM customization permission required to deactivate a layout.", "properties": { "code": { "description": "Represents the error code indicating that the user does not have the permission required to deactivate the layout. Possible values: **NO_PERMISSION** - The user's CRM profile is missing the layout customization permission.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the permissions the user's profile is missing.", "properties": { "permissions": { "description": "Represents the list of permissions the user's profile must be granted to deactivate the layout.", "items": { "description": "Represents the API name of a permission the user's profile must be granted to deactivate the layout.", "maxLength": 100, "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the human-readable error message describing the missing permission.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeactivateNoPermissionErrorResponse" } } }, "description": "The authenticated user does not have the CRM customization permission required to deactivate the layout. **Resolution:** The CRM administrator must grant the layout customization permission (**Customize Zoho CRM**) to the user's profile before retrying." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the INTERNAL_ERROR response returned when an unexpected error occurs during layout deactivation.", "summary": "Internal server error during deactivation", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when an unexpected internal server error occurs during layout deactivation.", "properties": { "code": { "description": "Represents the error code for the internal server error. Possible values: **INTERNAL_ERROR** - Indicates an unexpected error occurred while processing the request. Always returned in the response.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "description": "Represents the error message describing the internal server error. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request failed due to an internal server error. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InternalError" } } }, "description": "An unexpected error occurred while processing the layout deactivation request. Resolution: Retry the request. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.layouts.DELETE" ] } ], "summary": "Deactivate Layout", "tags": [ "layouts_activate_deactivate" ], "x-zoho-document": "layouts_activate_deactivate" }, "post": { "description": "Activates a single deactivated layout, making it available for use within the specified module. Optionally allows adding or removing profile associations during activation. Only one layout can be activated per request. This operation is idempotent - attempting to activate an already active layout returns an error (ALREADY_ACTIVATED). The status key in the response from the [Get Layouts API](layouts.yaml#$.paths./settings/layouts.get) indicates whether the layout is active or inactive.", "operationId": "activateLayout", "parameters": [ { "$ref": "#/components/parameters/LayoutsActivateDeactivateId" }, { "$ref": "#/components/parameters/LayoutsActivateDeactivateModule" } ], "requestBody": { "content": { "application/json": { "examples": { "SingleLayoutAddProfilesOnly": { "description": "Shows a layout activation request that adds multiple profiles without removing any existing associations.", "summary": "Activate layout with profile additions only", "value": { "layouts": [ { "id": "4831139000000673152", "profiles": [ { "id": "4831139000000650385" }, { "id": "4831139000000653716" }, { "id": "4831139000001234567" } ] } ] } }, "SingleLayoutMixedProfiles": { "description": "Shows a layout activation request that adds two profiles and removes one existing profile association using the **_delete** flag.", "summary": "Activate layout with profile additions and removals", "value": { "layouts": [ { "id": "4831139000000673152", "profiles": [ { "id": "4831139000000650385" }, { "id": "4831139000000653716" }, { "_delete": true, "id": "4831139000000015972" } ] } ] } }, "SingleLayoutNoProfiles": { "description": "Shows a layout activation request with an empty profiles array, preserving all existing profile associations.", "summary": "Activate layout without profile modifications", "value": { "layouts": [ { "id": "4831139000000673152", "profiles": [] } ] } }, "SingleLayoutRemoveProfilesOnly": { "description": "Shows a layout activation request that removes specific profile associations using the **_delete** flag.", "summary": "Activate layout with profile removals only", "value": { "layouts": [ { "id": "4831139000000673152", "profiles": [ { "_delete": true, "id": "4831139000000015972" }, { "_delete": true, "id": "4831139000000015973" } ] } ] } }, "SingleLayoutWithoutProfilesKey": { "description": "Shows a layout activation request that omits the profiles key entirely, preserving all existing profile associations.", "summary": "Activate layout omitting the profiles key", "value": { "layouts": [ { "id": "4831139000000673152" } ] } } }, "schema": { "$ref": "#/components/schemas/LayoutActivateRequest" }, "x-zs-llm-examples": [ "SingleLayoutMixedProfiles", "SingleLayoutWithoutProfilesKey" ] } }, "description": "Request body for activating a single layout with optional profile association modifications. The layout can specify profile associations to add (default) or remove (using _delete flag). Profile modifications are optional - layout can be activated without any profile changes. At least one profile must remain associated with the layout after all operations are applied.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulActivation": { "description": "Shows the success response returned when a deactivated layout is successfully activated.", "summary": "Layout activated successfully", "value": { "layouts": [ { "code": "SUCCESS", "details": { "id": "4831139000000673152" }, "message": "layout activated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned when a layout is successfully activated.", "properties": { "layouts": { "description": "Array containing the result of the layout activation operation. Always returned in the response.", "items": { "additionalProperties": false, "description": "Represents the result details for the activated layout.", "properties": { "code": { "description": "Represents the operation result code. Possible values: **SUCCESS** - Indicates the layout was activated successfully. Always returned in the response.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the activated layout. Always returned in the response.", "properties": { "id": { "description": "Represents the unique identifier of the activated layout. Always returned in the response.", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the confirmation message for the activation operation. Always returned in the response.", "examples": [ "layout activated" ], "maxLength": 200, "type": "string" }, "status": { "description": "Represents the overall operation status. Possible values: **success** - Indicates the activation completed without errors. Always returned in the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "LayoutActivateResponse" } } }, "description": "Returns the activation confirmation for the layout, including the result code and the activated layout ID." }, "400": { "content": { "application/json": { "examples": { "AlreadyActivated": { "description": "Shows the ALREADY_ACTIVATED error returned when the specified layout is already in active state.", "summary": "Layout is already activated", "value": { "code": "ALREADY_ACTIVATED", "details": { "resource_path_index": 2 }, "message": "Cannot activate already active layout", "status": "error" } }, "InvalidLayoutId": { "description": "Shows the INVALID_DATA error returned when the layout ID in the request path does not exist in the specified module.", "summary": "Invalid layout ID provided", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "No layout found with given id", "status": "error" } }, "LastProfileRemoval": { "description": "Shows the NOT_ALLOWED error returned when attempting to remove the only remaining profile association from the layout.", "summary": "Cannot remove the only associated profile", "value": { "layouts": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profiles", "json_path": "$.layouts[0].profiles" }, "message": "Cannot remove association with profile as it is the only profile associated with layout.", "status": "error" } ] } }, "LiteProfileOnIntegrationLayout": { "description": "Shows the NOT_ALLOWED error returned when a lite profile is assigned to an integration layout.", "summary": "Lite profile cannot be assigned to integration layout", "value": { "layouts": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.layouts[0].profiles[0].id" }, "message": "Integration layout cannot be assigned a lite profile.", "status": "error" } ] } }, "MaxLayoutLimitReached": { "description": "Cannot activate the layout because the module has already reached the maximum limit of 4 active layouts", "summary": "Maximum active layout limit reached for the module", "value": { "layouts": [ { "code": "CANNOT_PROCESS", "details": {}, "message": "Sorry, but you can't activate this layout, as you have already reached the maximum limit of 4 layouts per module.", "status": "error" } ] } }, "MaximumLayoutsExceeded": { "description": "Shows the INVALID_DATA error returned when the layouts array in the request body contains more than one object.", "summary": "Maximum layouts array length exceeded", "value": { "code": "INVALID_DATA", "details": { "api_name": "layouts", "json_path": "$.layouts", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "PermissionUpdateNotAllowed": { "description": "Shows the NOT_ALLOWED error returned when profile permission modifications are not supported during activation of the specified layout.", "summary": "Permission updates not allowed on layout", "value": { "layouts": [ { "code": "NOT_ALLOWED", "details": { "action": "set_layout_permissions", "id": "4831139000000673152" }, "message": "Cannot perform permission updates as it is not allowed on the layout.", "status": "error" } ] } }, "ProfileNotAssociatedWithModule": { "description": "Shows the NOT_ALLOWED error returned when a profile ID in the request is not associated with the specified module.", "summary": "Profile not associated with the module", "value": { "layouts": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.layouts[0].profiles[0].id" }, "message": "Only profiles associated with the module can be assigned for the layout.", "status": "error" } ] } }, "ProfileRequiresActiveLayout": { "description": "Shows the NOT_ALLOWED error returned when removing a profile would leave it with no active layout association.", "summary": "Profile must have at least one active layout", "value": { "layouts": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.layouts[0].profiles[0].id" }, "message": "Profile must have at least one active layout associated to it.", "status": "error" } ] } } }, "schema": { "additionalProperties": true, "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when the layout ID in the request path is invalid or does not exist in the specified module.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **INVALID_DATA** - Indicates the layout ID provided in the request is invalid. **INVALID_MODULE** - Indicates the specified module is invalid. Always returned in the response.", "enum": [ "INVALID_DATA", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the invalid data error. Always returned in the response.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the error occurred.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid data. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidLayoutIdError" }, { "additionalProperties": false, "description": "Represents the error response returned when the specified layout is already in active state.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **ALREADY_ACTIVATED** - Indicates the layout is already in active state. Always returned in the response.", "enum": [ "ALREADY_ACTIVATED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the already-activated layout error. Always returned in the response.", "properties": { "resource_path_index": { "description": "Represents the index in the resource path where the error occurred.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message indicating the layout is already in active state. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "AlreadyActivatedError" }, { "additionalProperties": false, "description": "Represents the error response returned when profile association operations are not permitted or violate layout constraints during activation.", "properties": { "layouts": { "description": "Array of error details for each layout that encountered a profile association or permission error. Always returned in the response.", "items": { "additionalProperties": false, "description": "Represents the error details for an individual layout operation failure.", "properties": { "code": { "description": "Error code indicating operation is not permitted", "enum": [ "NOT_ALLOWED", "INVALID_DATA", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "anyOf": [ { "additionalProperties": false, "description": "Represents the error details returned when profile permission updates are not allowed on the layout.", "properties": { "action": { "description": "Represents the action that is not permitted on the layout. Possible values: **set_layout_permissions** - Indicates that profile permission modification is not allowed on this layout. Always returned in the response.", "enum": [ "set_layout_permissions" ], "type": "string" }, "id": { "description": "Represents the unique identifier of the layout on which the action is restricted. Always returned in the response.", "maxLength": 20, "minLength": 1, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "action", "id" ], "type": "object", "x-zs-$id": "PermissionUpdateRestrictionDetails" }, { "additionalProperties": false, "description": "Represents the error details returned when a profile association request fails validation, including the field name and its location in the request.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the profile association validation error. Always returned in the response.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSONPath location in the request body where the profile association validation error occurred. Always returned in the response.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ProfileAssociationValidationDetails" } ], "description": "Additional context about the error", "type": "object" }, "message": { "description": "Represents the error message explaining the profile association or permission violation. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the layout operation did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "LayoutProfileAssociationErrors" }, { "additionalProperties": false, "description": "Represents the error response returned when the request body contains invalid data, such as a layouts array that exceeds the maximum allowed length.", "properties": { "code": { "description": "Represents the error code for the request failure. Possible values: **INVALID_DATA** - Indicates the request body contains invalid data, such as an array that exceeds the maximum length. Always returned in the response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains validation error details, including the field name and its constraint violation. Always returned in the response.", "properties": { "api_name": { "description": "Represents the API name of the field that violated the constraint. Always returned in the response.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSONPath location of the invalid data in the request body. Always returned in the response.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the array field that was exceeded. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request did not complete successfully. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataError" }, { "additionalProperties": false, "description": "Layout activation cannot be processed due to a module-level constraint (e.g., maximum active layout limit reached)", "properties": { "layouts": { "description": "Array of layout-specific error details", "items": { "additionalProperties": false, "description": "Individual layout error information", "properties": { "code": { "description": "Error code indicating the operation cannot be processed", "enum": [ "CANNOT_PROCESS" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context about the error (may be empty)", "type": "object" }, "message": { "description": "Human-readable error message explaining why the layout cannot be activated", "maxLength": 500, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "layouts" ], "type": "object", "x-zs-$id": "CannotProcessError" } ], "description": "Represents the error response for bad request scenarios during layout activation, covering invalid layout IDs, layout state violations, and profile association errors.", "type": "object", "x-zs-$id": "LayoutActivateErrorResponse" } } }, "description": "The request could not be processed due to invalid parameters, layout constraints, or business rule violations. Resolution: Inspect the **code** field in the response body to identify the specific cause, and verify the layout ID, module name, and profile IDs in the request." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "The authenticated user does not have the necessary CRM customization permissions", "summary": "User lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the user lacks required permissions to activate layouts", "properties": { "code": { "description": "Error code indicating insufficient permissions", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the required permissions", "properties": { "permissions": { "description": "List of permissions required to perform this operation", "items": { "description": "Permission identifier", "maxLength": 100, "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 200, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NoPermissionErrorResponse" } } }, "description": "User does not have permission to perform this operation" }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the INTERNAL_ERROR response returned when an unexpected error occurs during layout activation.", "summary": "Internal server error during activation", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when an unexpected internal server error occurs during layout activation.", "properties": { "code": { "description": "Represents the error code for the internal server error. Possible values: **INTERNAL_ERROR** - Indicates an unexpected error occurred while processing the request. Always returned in the response.", "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "description": "Represents the error message describing the internal server error. Always returned in the response.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status indicator. Possible values: **error** - Indicates the request failed due to an internal server error. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InternalErrorResponse" } } }, "description": "An unexpected error occurred while processing the layout activation request. Resolution: Retry the request. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.layouts.CREATE" ] } ], "summary": "Activate Layout", "tags": [ "layouts_activate_deactivate" ], "x-zoho-document": "layouts_activate_deactivate" } }, "/crm/v8/settings/layouts/{id}/convert_mapping": {}, "/crm/v8/settings/layouts/{layoutId}/map_dependency": { "get": { "description": "To retrieve the list of field dependencies configured for a specific layout in your Zoho CRM organization.", "operationId": "getMapDependency", "parameters": [ { "$ref": "#/components/parameters/MapDependencyLayoutId" }, { "$ref": "#/components/parameters/MapDependencyModule" }, { "$ref": "#/components/parameters/MapDependencyPage" }, { "$ref": "#/components/parameters/MapDependencyPerPage" }, { "$ref": "#/components/parameters/MapDependencyFilters" } ], "responses": { "200": { "content": { "application/json": { "examples": { "InactiveDependencyResponse": { "description": "Shows a field dependency where the child field has been moved to the unused fields list of the layout, making the dependency inactive (active is **false**).", "summary": "Example of a successful response containing an inactive field dependency.", "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 }, "map_dependency": [ { "active": false, "category": 0, "child": { "api_name": "Industry", "id": "1043386000000003402" }, "id": "1043386000020283009", "internal": false, "parent": { "api_name": "Salutation", "id": "1043386000000002601" }, "source": 1, "sub_module": null } ] } }, "SuccessResponse": { "description": "Shows two field dependencies - one for a standard module field pair and one for a subform field pair - along with pagination details.", "summary": "Example of a successful response with field dependencies.", "value": { "info": { "count": 2, "more_records": false, "page": 1, "per_page": 200 }, "map_dependency": [ { "active": true, "category": 0, "child": { "api_name": "Lead_Status", "id": "1043386000000002611" }, "id": "1043386000020283001", "internal": false, "parent": { "api_name": "Lead_Source", "id": "1043386000000002609" }, "source": 1, "sub_module": null }, { "active": true, "category": 0, "child": { "api_name": "Pick_List_2", "id": "1043386000019791245" }, "id": "1043386000020283005", "internal": false, "parent": { "api_name": "Pick_List_1", "id": "1043386000019791055" }, "source": 1, "sub_module": { "api_name": "Subform_3", "id": "1043386000016645081" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response containing the list of field dependencies and pagination details for the specified layout.", "properties": { "info": { "additionalProperties": false, "description": "Contains the pagination details for the response. ", "properties": { "count": { "description": "Represents the number of records returned on the current page. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional pages of records are available. Possible values: **true**, **false**. \n", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the maximum number of records included on each page. ", "format": "int32", "type": "integer" } }, "required": [ "page", "per_page", "count", "more_records" ], "type": "object" }, "map_dependency": { "description": "Contains the list of field dependency objects for the specified layout. ", "items": { "additionalProperties": false, "description": "Represents a field dependency object, including the parent and child field references, dependency metadata, and activity status.", "properties": { "active": { "description": "Indicates whether the dependency is active in the layout. Possible values: **true**, **false**. \n", "enum": [ true, false ], "type": "boolean" }, "category": { "description": "Represents the category of the dependency. Possible values: **0**. **0** represents the default category. \n", "enum": [ 0 ], "format": "int32", "type": "integer" }, "child": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Details of the child field." }, "id": { "description": "Represents the unique identifier of the field dependency. ", "format": "int64", "type": "string" }, "internal": { "description": "Indicates whether the dependency was defined by the system or created by the user. Possible values: **true**, **false**. \n", "enum": [ true, false ], "type": "boolean" }, "parent": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Details of the parent field." }, "source": { "description": "Represents the source of the dependency. Possible values: **1**. It indicates Zoho CRM as the source. \n", "enum": [ 1 ], "format": "int32", "type": "integer" }, "sub_module": { "anyOf": [ { "description": "Indicates that the dependency applies to the main module fields and is not associated with any subform.", "type": "null", "x-zs-$id": "SubModuleNull" }, { "additionalProperties": false, "description": "Represents the details of the subform module when the dependency applies to a subform field.", "properties": { "api_name": { "description": "Represents the API name of the subform module. ", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the subform module. Make a [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the details of the subform module. ", "format": "int64", "type": "string" } }, "required": [ "id", "api_name" ], "type": "object", "x-zs-$id": "SubModuleObject" } ], "description": "The API name and ID of the field that is mapped as the parent in the subform of the module. For non-subforms, this value is **null**. This key is present only when you fetch all the mapped dependencies in a module." } }, "required": [ "parent", "child", "sub_module", "internal", "active", "id", "source", "category" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "map_dependency", "info" ], "type": "object", "x-zs-$id": "GetMapDependencySuccessResponse" } } }, "description": "Returns the list of field dependencies configured for the specified layout." }, "204": { "description": "No field dependencies are configured for the specified layout." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissing": { "description": "Shows an error returned when the **comparator** filter attribute is specified without the required **field** attribute.", "summary": "Example of dependent field missing in filter.", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.field" }, "json_path": "$.comparator", "param_name": "filters" }, "message": "Dependent Field missing", "status": "error" } }, "InvalidComparator": { "description": "Shows an error returned when the **comparator** value in the filter is invalid. Supported values are **equal** and **in**.", "summary": "Example of invalid filter comparator value.", "value": { "code": "INVALID_DATA", "details": { "api_name": "comparator", "json_path": "$.comparator", "param_name": "filters", "supported_values": [ "equal", "in" ] }, "message": "The value given is invalid", "status": "error" } }, "InvalidFilterValue": { "description": "Shows an error returned when the **filters** parameter value is not valid JSON.", "summary": "Example of an invalid filters parameter value.", "value": { "code": "INVALID_DATA", "details": { "api_name": "filters", "json_path": "$", "param_name": "filters" }, "message": "the value given is invalid", "status": "error" } }, "InvalidLayoutId": { "description": "Shows an error returned when the layout ID in the request path is invalid.", "summary": "Example of invalid layout ID.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "Invalid Layout Id", "status": "error" } }, "InvalidModule": { "description": "Shows an error returned when the module API name provided is not recognized.", "summary": "Example of invalid module name.", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "LayoutDeactivated": { "description": "Shows an error returned when the specified layout has been deactivated.", "summary": "Example of deactivated layout.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The layout is deactivated", "status": "error" } }, "MandatoryNotFound": { "description": "Shows an error returned when a required property in the filter object, such as **api_name**, is missing.", "summary": "Example of mandatory filter field missing.", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.field.api_name", "param_name": "filters" }, "message": "Required field not found", "status": "error" } }, "RequiredParamMissing": { "description": "Shows an error returned when a required parameter, such as **module**, is not included in the request.", "summary": "Example of required parameter missing.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the request contains invalid parameters or data.", "properties": { "code": { "description": "Represents the error code for the request error. Possible values: **REQUIRED_PARAM_MISSING**, **INVALID_MODULE**, **NOT_SUPPORTED**, **INVALID_DATA**, **DEPENDENT_FIELD_MISSING**, **MANDATORY_NOT_FOUND**. \n", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_MODULE", "NOT_SUPPORTED", "INVALID_DATA", "DEPENDENT_FIELD_MISSING", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error. ", "type": "object" }, "message": { "description": "Describes the error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "GetMapDependencyErrorResponse" } } }, "description": "The request contains invalid parameters or data.\n**Resolution:** Verify the module API name and layout ID in the request, and ensure all required parameters are included and all filter criteria are valid JSON.\n" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "500": { "$ref": "#/components/responses/MapDependencyInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.map_dependency.read" ] } ], "summary": "Get field dependencies for a layout", "tags": [ "map_dependency" ], "x-zoho-document": "map_dependency", "x-zs-llm-description": "Returns all picklist field dependencies for a layout. Use the Fields API to resolve parent and child field IDs and api_names. Each dependency maps a parent picklist field's values to allowed child picklist field values via the pick_list_values array. Dependencies where internal is true are system-defined and read-only." }, "post": { "description": "To create a field dependency between a parent picklist field and a child picklist field for a specific layout in your Zoho CRM organization.\n\n**Prerequisites**\n\n- The selected layout must contain at least two option-based fields.\n- Supported field types are Picklist, Radio Button, and Multi-select Picklist.\n- Multi-select Picklist fields can be used only as child fields.\n- Parent and child fields must belong to the selected layout.\n- When using subform fields, the parent and child fields must belong to the same subform.\nTo create a field dependency between a parent picklist field and a child picklist field for a specific layout in your Zoho CRM organization.", "operationId": "createMapDependency", "parameters": [ { "$ref": "#/components/parameters/MapDependencyModule" }, { "$ref": "#/components/parameters/MapDependencyLayoutId" } ], "requestBody": { "content": { "application/json": { "examples": { "CreateDependency": { "description": "Shows the request body that maps **Lead_Source** as the parent field to **Lead_Status** as the child field, with two parent picklist value entries.", "summary": "Example of creating a field dependency.", "value": { "map_dependency": [ { "child": { "api_name": "Lead_Status", "id": "111111000000004109" }, "parent": { "api_name": "Lead_Source", "id": "111111000000004107" }, "pick_list_values": [ { "actual_value": "-None-", "display_value": "-None-", "id": "111111000000016273", "maps": [ { "actual_value": "Contacted", "display_value": "Contacted", "id": "111111000000016330" }, { "actual_value": "Contact in Future", "display_value": "Contact in Future", "id": "111111000000016333" } ] }, { "actual_value": "Advertisement", "display_value": "Advertisement", "id": "111111000000016276", "maps": [ { "actual_value": "Pre-Qualified", "display_value": "Pre-Qualified", "id": "111111000000016327" }, { "actual_value": "Not Qualified", "display_value": "Not Qualified", "id": "111111000000016351" } ] } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for creating a field dependency between picklist fields in a layout.", "properties": { "map_dependency": { "description": "Specify the field dependency configuration to create.", "items": { "additionalProperties": false, "description": "Specify the configuration for the field dependency to create, including parent field, child field, and picklist value mappings.", "properties": { "child": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Child field details" }, "parent": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Parent field details" }, "pick_list_values": { "description": "Each JSON object in this array corresponds to a specific picklist value in the parent field, and consists of the following keys:\n- **display_value** - string, optional - The display name of the picklist value of the parent field.\n- **actual_value** - string, optional - The actual name of the picklist value of the parent field.\n- **id** - string, mandatory - The unique ID of the picklist value of the parent field.\n- **maps** - JSON array, mandatory - The **display_value**, **actual_value**, and id of the picklist value of the child field that should be mapped with the parent field.\n", "items": { "$ref": "#/components/schemas/PicklistMappingCreate" }, "maxItems": 2000, "type": "array" } }, "required": [ "parent", "child", "pick_list_values" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object" }, "x-zs-llm-examples": [ "CreateDependency" ] } }, "description": "The request body contains the data required to perform the operation.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the success response containing the unique identifier of the newly created field dependency.", "summary": "Example of field dependency created successfully.", "value": { "map_dependency": [ { "code": "SUCCESS", "details": { "id": "111111000000064003" }, "message": "map dependency created", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned after the field dependency is successfully created.", "properties": { "map_dependency": { "description": "Contains the result of the create operation. ", "items": { "$ref": "#/components/schemas/MapDependencySuccessResponse" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object", "x-zs-$id": "CreateMapDependencySuccessResponse" } } }, "description": "Returns the result of the create operation, including the unique identifier of the newly created field dependency." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "description": "Shows an error returned when both **ID** and **api_name** are provided for the same field, causing ambiguity during processing.", "summary": "Example of ambiguity in request field data.", "value": { "map_dependency": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.map_dependency[0].parent.id" }, { "api_name": "api_name", "json_path": "$.map_dependency[0].parent.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "AssociatedWithLayoutRule": { "description": "Shows an error returned when the specified parent and child fields are already associated with a Layout Rule.", "summary": "Example of fields associated with a Layout Rule.", "value": { "map_dependency": [ { "code": "NOT_ALLOWED", "details": {}, "message": "The given parent and child field are Associated with Layout Rule", "status": "error" } ] } }, "ChildFieldUnused": { "description": "Shows an error returned when the child field ID refers to a field in the layout's unused fields list.", "summary": "Example of child field in unused fields list.", "value": { "map_dependency": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.map_dependency[0].child.id" }, "message": "Child fieldid is in unused fields list of the layout", "status": "error" } ] } }, "DependencyLoop": { "description": "Shows an error returned when adding the specified parent-child relationship would create a circular dependency loop.", "summary": "Example error of dependency creating a loop.", "value": { "map_dependency": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.map_dependency[0].child.id" }, "message": "The given child field when associated with this parent field will result in loop", "status": "error" } ] } }, "InvalidApiName": { "description": "Shows an error returned when the API name provided for the parent or child field is invalid.", "summary": "Example of invalid field API name.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.map_dependency[0].parent.api_name" }, "message": "The given api name is invalid", "status": "error" } ] } }, "InvalidChildFieldId": { "description": "Shows an error returned when the child field ID is not valid for the specified layout.", "summary": "Example of invalid child field ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].child.id" }, "message": "invalid child fieldid", "status": "error" } ] } }, "InvalidChildOptionId": { "description": "Shows an error returned when a child picklist option ID in the **maps** array is invalid.", "summary": "Example of invalid child picklist option ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].pick_list_values[0].maps[1].id" }, "message": "Invalid child option id", "status": "error" } ] } }, "InvalidLayoutId": { "description": "Shows an error returned when the layout ID in the request path is invalid.", "summary": "Example of an invalid layout ID.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "Invalid Layout Id", "status": "error" } }, "InvalidModule": { "description": "Shows an error returned when the module API name provided is not recognized.", "summary": "Example of an invalid module name.", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidParentFieldId": { "description": "Shows an error returned when the parent field ID is not valid for the specified layout.", "summary": "Example of invalid parent field ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].parent.id" }, "message": "invalid parent fieldid", "status": "error" } ] } }, "InvalidParentOptionId": { "description": "Shows an error returned when a parent picklist option ID in the **pick_list_values** array is invalid.", "summary": "Example of invalid parent picklist option ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].pick_list_values[0].id" }, "message": "Invalid parent option id", "status": "error" } ] } }, "LayoutDeactivated": { "description": "Shows an error returned when the specified layout has been deactivated.", "summary": "Example of deactivated layout.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The given layout is deactivated", "status": "error" } }, "MandatoryNotFound": { "description": "Shows an error returned when a required field, such as **ID** in the **maps** array, is missing from the request.", "summary": "Example of required field not found.", "value": { "map_dependency": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.map_dependency[0].pick_list_values[0].maps[1].id" }, "message": "required field not found", "status": "error" } ] } }, "MappingAlreadyExists": { "description": "Shows an error returned when a dependency between the specified parent and child fields already exists in this layout.", "summary": "Example of already existing dependency mapping error. ", "value": { "map_dependency": [ { "code": "MAPPING_ALREADY_EXISTS", "details": { "dependency": [ { "id": "123467634333580", "json_path": "$.map_dependency[0].parent.id" }, { "id": "123467634333590", "json_path": "$.map_dependency[0].child.id" } ], "id": "1234687624378284" }, "message": "The given parent and child fields are already associated in another map dependency in this layout", "status": "error" } ] } }, "MapsNotFound": { "description": "Shows an error returned when the **maps** array is missing from a **pick_list_values** entry.", "summary": "Example of maps field missing.", "value": { "map_dependency": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "maps", "json_path": "$.map_dependency[0].pick_list_values[0].maps" }, "message": "required field not found", "status": "error" } ] } }, "MaxLengthExceeded": { "description": "Shows an error returned when more than one dependency is included in the **map_dependency** array.", "summary": "Example of map_dependency array with exceeding length. ", "value": { "code": "INVALID_DATA", "details": { "api_name": "map_dependency", "json_path": "$.map_dependency", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "ParentChildSame": { "description": "Shows an error returned when the parent and child field IDs refer to the same field.", "summary": "Example error for providing the same parent and child field.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].child.id" }, "message": "The parent and child fieldid cannot be same", "status": "error" } ] } }, "ParentFieldUnused": { "description": "Shows an error returned when the parent field ID refers to a field in the layout's unused fields list.", "summary": "Example of parent field in unused fields list.", "value": { "map_dependency": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.map_dependency[0].parent.id" }, "message": "Parent fieldid is in unused fields list of the layout", "status": "error" } ] } }, "PickListValuesNotFound": { "description": "Shows an error returned when the required **pick_list_values** array is missing from the request.", "summary": "Example of pick_list_values array missing.", "value": { "map_dependency": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "pick_list_values", "json_path": "$.map_dependency[0].pick_list_values" }, "message": "required field not found", "status": "error" } ] } }, "RequiredParamMissing": { "description": "Shows an error returned when a required parameter, such as **module**, is not included in the request.", "summary": "Example of a required parameter missing.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents a root-level error returned when the request itself is invalid, such as an invalid module or a missing required parameter.", "properties": { "code": { "description": "Represents the error code for the root-level request error. Possible values: **REQUIRED_PARAM_MISSING**, **INVALID_MODULE**, **NOT_SUPPORTED**, **INVALID_DATA**. \n", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_MODULE", "NOT_SUPPORTED", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the root-level error. ", "type": "object" }, "message": { "description": "Describes the root-level error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "CreateMapDependencyRootErrorResponse" }, { "additionalProperties": false, "description": "Represents a field-level error returned when the dependency data is invalid, such as duplicate mappings or invalid field references.", "properties": { "map_dependency": { "description": "Contains the field-level error details for each dependency in the request. ", "items": { "additionalProperties": false, "description": "Represents the error details for a specific field in the dependency request.", "properties": { "code": { "description": "Represents the error code for the field-level error. \nPossible values: \n**MANDATORY_NOT_FOUND**, **INVALID_DATA**, **MAPPING_ALREADY_EXISTS**, **NOT_ALLOWED**, **AMBIGUITY_DURING_PROCESSING**. \n", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "MAPPING_ALREADY_EXISTS", "NOT_ALLOWED", "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains field-specific details about the error. ", "type": "object" }, "message": { "description": "Describes the field-level error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the field-level response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object", "x-zs-$id": "CreateMapDependencyFieldLevelErrorResponse" } ], "description": "Represents the error response when the create request fails. It returns either a root-level error or a field-level error.", "x-zs-$id": "CreateMapDependencyErrorResponse" } } }, "description": "The request contains invalid data or violates a dependency rule.\n**Resolution:** Verify that the parent and child field IDs are valid, the dependency does not already exist or create a circular reference, and all required fields in **pick_list_values** are provided.\n" }, "403": { "$ref": "#/components/responses/MapDependencyForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "500": { "$ref": "#/components/responses/MapDependencyInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.map_dependency.create" ] } ], "summary": "Create a field dependency for a layout", "tags": [ "map_dependency" ], "x-zoho-document": "map_dependency", "x-zs-llm-description": "Creates a picklist field dependency. The parent and child must be picklist-type fields from the Fields API. A child field can only appear in one dependency per layout. The pick_list_values array maps each parent value's display_value to its allowed child values in the maps array." } }, "/crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}": { "delete": { "description": "To delete a specific field dependency from a layout in your Zoho CRM organization.", "operationId": "deleteMapDependency", "parameters": [ { "$ref": "#/components/parameters/MapDependencyModule" }, { "$ref": "#/components/parameters/MapDependencyLayoutId" }, { "$ref": "#/components/parameters/DependencyId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the success response containing the unique identifier of the deleted field dependency.", "summary": "Example of field dependency deleted successfully.", "value": { "map_dependency": [ { "code": "SUCCESS", "details": { "id": "111111000000058515" }, "message": "map dependency deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned after the field dependency is successfully deleted.", "properties": { "map_dependency": { "description": "Contains the result of the delete operation. ", "items": { "$ref": "#/components/schemas/MapDependencySuccessResponse" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object", "x-zs-$id": "DeleteMapDependencySuccessResponse" } } }, "description": "Returns the result of the delete operation, including the unique identifier of the deleted field dependency." }, "400": { "content": { "application/json": { "examples": { "InternalDependencyNotModifiable": { "description": "Shows an error returned when the specified dependency is system-defined and cannot be deleted.", "summary": "Example of internal dependency cannot be deleted.", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 4 }, "message": "Internal Map Dependency cannot be deleted", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the request contains invalid parameters or data.", "properties": { "code": { "description": "Represents the error code for the request error. Possible values: **REQUIRED_PARAM_MISSING**, **INVALID_MODULE**, **INVALID_DATA**, **NOT_ALLOWED**. \n", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_MODULE", "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error. ", "type": "object" }, "message": { "description": "Describes the error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DeleteMapDependencyErrorResponse" } } }, "description": "The request contains invalid parameters or data.\n**Resolution:** Verify the dependency ID, module API name, and layout ID in the request. Note that internal dependencies cannot be deleted.\n" }, "403": { "$ref": "#/components/responses/MapDependencyForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "500": { "$ref": "#/components/responses/MapDependencyInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.map_dependency.delete" ] } ], "summary": "Delete a field dependency", "tags": [ "map_dependency" ], "x-zoho-document": "map_dependency", "x-zs-llm-description": "Permanently deletes a picklist field dependency from a layout. After deletion, the child picklist field will show all its values regardless of the parent field's selection. Dependencies where internal is true cannot be deleted." }, "get": { "description": "To retrieve the complete details of a specific field dependency from a layout in your Zoho CRM organization, including all picklist value mappings.", "operationId": "getMapDependencyById", "parameters": [ { "$ref": "#/components/parameters/MapDependencyModule" }, { "$ref": "#/components/parameters/MapDependencyLayoutId" }, { "$ref": "#/components/parameters/DependencyId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the complete details of a field dependency, including the parent and child field references and the full picklist value mapping.", "summary": "Example of single field dependency with picklist mappings.", "value": { "map_dependency": [ { "active": true, "category": 0, "child": { "api_name": "Lead_Status", "id": "1043386000000002611" }, "id": "1043386000020283001", "internal": false, "parent": { "api_name": "Lead_Source", "id": "1043386000000002609" }, "pick_list_values": [ { "actual_value": "-None-", "display_value": "-None-", "id": "1043386000000016273", "maps": [ { "actual_value": "Contacted", "display_value": "Contacted", "id": "1043386000000016330" }, { "actual_value": "Contact in Future", "display_value": "Contact in Future", "id": "1043386000000016333" } ] } ], "source": 1 } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response containing the complete details of the specified field dependency, including all picklist value mappings.", "properties": { "map_dependency": { "description": "Contains the field dependency details for the specified dependency ID. ", "items": { "additionalProperties": false, "description": "Each object represents the field dependency object with complete parent and child field references, picklist value mappings, and dependency metadata.", "properties": { "active": { "description": "Indicates whether the dependency is active in the layout. Possible values: **true**, **false**. \n", "enum": [ true, false ], "type": "boolean" }, "category": { "description": "Represents the category of the dependency. Possible values: **0**. **0** represents the default category. \n", "enum": [ 0 ], "format": "int32", "type": "integer" }, "child": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Details of the child field" }, "id": { "description": "Represents the unique identifier of the field dependency. ", "format": "int64", "type": "string" }, "internal": { "description": "Indicates whether the dependency was defined by the system or created by the user. Possible values: **true**, **false**. \n", "enum": [ true, false ], "type": "boolean" }, "parent": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Parent field details" }, "pick_list_values": { "description": "Contains the complete mapping of parent picklist options to their corresponding child picklist options. ", "items": { "$ref": "#/components/schemas/PicklistMappingRead" }, "maxItems": 2000, "type": "array" }, "source": { "description": "Represents the source of the dependency. Possible values: **1**. It indicates Zoho CRM as the source. \n", "enum": [ 1 ], "format": "int32", "type": "integer" } }, "required": [ "parent", "child", "pick_list_values", "internal", "active", "id", "source", "category" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object", "x-zs-$id": "GetMapDependencyByIdSuccessResponse" } } }, "description": "Returns the complete details of the specified field dependency, including all picklist value mappings." }, "204": { "description": "The specified field dependency was not found in the layout.\n**Resolution**: Use the [Get Layouts API](layouts.yaml#$.paths./settings/layouts.get) to provide a valid ID in the request.\n" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "description": "Represents the error response returned when the request contains invalid parameters or data.", "properties": { "code": { "description": "Represents the error code for the request error. Possible values: **REQUIRED_PARAM_MISSING**, **INVALID_MODULE**, **NOT_SUPPORTED**. \n", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_MODULE", "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error. ", "type": "object" }, "message": { "description": "Describes the error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "GetMapDependencyByIdErrorResponse" } } }, "description": "The request contains invalid parameters or data.\n**Resolution:** Verify the module API name and ensure all required parameters are included. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the details of a module.\n" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "500": { "$ref": "#/components/responses/MapDependencyInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.map_dependency.read" ] } ], "summary": "Get a field dependency by ID", "tags": [ "map_dependency" ], "x-zoho-document": "map_dependency", "x-zs-llm-description": "Returns a single picklist field dependency with full value mappings. The parent and child objects contain field IDs and api_names from the Fields API. The pick_list_values array shows which child picklist values are allowed for each parent value." }, "put": { "description": "Updates the picklist value mappings for an existing field dependency. Use \\\"_delete\\\": null to remove specific mappings.\n", "operationId": "updateMapDependency", "parameters": [ { "$ref": "#/components/parameters/MapDependencyModule" }, { "$ref": "#/components/parameters/MapDependencyLayoutId" }, { "$ref": "#/components/parameters/DependencyId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateDependency": { "description": "Shows a PUT request body that updates the picklist value mappings for a **Lead_Source** to **Lead_Status** dependency, including removing one mapping using **_delete: null**.\n", "summary": "Example of updating a field dependency.", "value": { "map_dependency": [ { "active": true, "category": 0, "child": { "api_name": "Lead_Status", "id": "111111000000004109" }, "id": "111111000000058515", "internal": false, "parent": { "api_name": "Lead_Source", "id": "111111000000004107" }, "pick_list_values": [ { "actual_value": "-None-", "display_value": "-None-", "id": "111111000000016273", "maps": [ { "actual_value": "Contacted", "display_value": "Contacted", "id": "111111000000016330" }, { "actual_value": "Contact in Future", "display_value": "Contact in Future", "id": "111111000000016333" } ] }, { "actual_value": "Cold Call", "display_value": "Cold Call", "id": "111111000000016279", "maps": [ { "actual_value": "Pre-Qualified", "display_value": "Pre-Qualified", "id": "111111000000016327" }, { "_delete": null, "actual_value": "Not Qualified", "display_value": "Not Qualified", "id": "111111000000016351" } ] } ], "source": 1 } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for updating a field dependency between picklist fields in a layout.", "properties": { "map_dependency": { "description": "Specify the field dependency configuration to update.", "items": { "additionalProperties": false, "description": "Each object specifies the updated configuration for the field dependency, including the parent field, child field, and picklist value mappings.", "properties": { "active": { "description": "Specify whether the dependency should be active in the layout. Possible values: **true**, **false**.\n", "type": "boolean" }, "category": { "description": "Specify the category of the dependency. Possible values: **0**.\n", "enum": [ 0 ], "format": "int32", "type": "integer" }, "child": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Child field details" }, "id": { "description": "Specify the unique identifier of the dependency to update.", "format": "int64", "type": "string" }, "internal": { "description": "Specify whether the dependency is system-defined or user-created. Possible values: **true**, **false**.\n", "type": "boolean" }, "parent": { "$ref": "#/components/schemas/MapDependencyFieldReference", "description": "Parent field details" }, "pick_list_values": { "description": "Specify the updated picklist value mappings. Set **_delete** to **null** on a child option entry to remove that specific mapping.", "items": { "$ref": "#/components/schemas/PicklistMappingUpdate" }, "maxItems": 2000, "type": "array" }, "source": { "description": "Specify the source for the dependency. Possible values: **1**. It represents Zoho CRM.\n", "enum": [ 1 ], "format": "int32", "type": "integer" } }, "required": [ "parent", "child", "pick_list_values" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateDependency" ] } }, "description": "The request body contains the data required to perform the operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the success response containing the unique identifier of the updated field dependency.", "summary": "Example of field dependency updated successfully.", "value": { "map_dependency": [ { "code": "SUCCESS", "details": { "id": "111111000000064003" }, "message": "map dependency updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned after the field dependency is successfully updated.", "properties": { "map_dependency": { "description": "Contains the result of the update operation. ", "items": { "$ref": "#/components/schemas/MapDependencySuccessResponse" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object", "x-zs-$id": "UpdateMapDependencySuccessResponse" } } }, "description": "Returns the result of the update operation, including the unique identifier of the updated field dependency." }, "400": { "content": { "application/json": { "examples": { "ChildFieldUnused": { "description": "Shows an error returned when the child field ID refers to a field in the layout's unused fields list.", "summary": "Example of child field in unused fields list.", "value": { "map_dependency": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.map_dependency[0].child.id" }, "message": "Child fieldid is in unused fields list of the layout", "status": "error" } ] } }, "InternalDependencyNotModifiable": { "description": "Shows an error returned when the specified dependency is system-defined and cannot be modified.", "summary": "Example of an internal dependency cannot be modified.", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 4 }, "message": "Internal Map Dependency cannot be modified", "status": "error" } }, "InvalidChildFieldId": { "description": "Shows an error returned when the child field ID is not valid for the specified layout.", "summary": "Example of an invalid child field ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].child.id" }, "message": "invalid child fieldid", "status": "error" } ] } }, "InvalidChildOptionId": { "description": "Shows an error returned when a child picklist option ID in the **maps** array is invalid.", "summary": "Example of an invalid child picklist option ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].pick_list_values[0].maps[1].id" }, "message": "Invalid child option id", "status": "error" } ] } }, "InvalidLayoutId": { "description": "Shows an error returned when the layout ID in the request path is invalid.", "summary": "Example of an invalid layout ID.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "Invalid Layout Id", "status": "error" } }, "InvalidModule": { "description": "Shows an error returned when the module API name provided is not recognized.", "summary": "Example of an invalid module name.", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidParentFieldId": { "description": "Shows an error returned when the parent field ID is not valid for the specified layout.", "summary": "Example of an invalid parent field ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].parent.id" }, "message": "invalid parent fieldid", "status": "error" } ] } }, "InvalidParentOptionId": { "description": "Shows an error returned when a parent picklist option ID in the **pick_list_values** array is invalid.", "summary": "Example of an invalid parent picklist option ID.", "value": { "map_dependency": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.map_dependency[0].pick_list_values[0].id" }, "message": "Invalid parent option id", "status": "error" } ] } }, "LayoutDeactivated": { "description": "Shows an error returned when the specified layout has been deactivated.", "summary": "Example of deactivated layout.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The given layout is deactivated", "status": "error" } }, "MandatoryNotFound": { "description": "Shows an error returned when a required field, such as **ID** in the **maps** array, is missing from the request.", "summary": "Example of required field not found.", "value": { "map_dependency": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.map_dependency[0].pick_list_values[0].maps[1].id" }, "message": "required field not found", "status": "error" } ] } }, "MapsNotFound": { "description": "Shows an error returned when the **maps** array is missing from a **pick_list_values** entry.", "summary": "Example of maps field missing.", "value": { "map_dependency": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "maps", "json_path": "$.map_dependency[0].pick_list_values[0].maps" }, "message": "required field not found", "status": "error" } ] } }, "MaxLengthExceeded": { "description": "Shows an error returned when more than one dependency is included in the **map_dependency** array.", "summary": "Example of a map_dependency array exceeding length.", "value": { "code": "INVALID_DATA", "details": { "api_name": "map_dependency", "json_path": "$.map_dependency", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "ParentFieldUnused": { "description": "Shows an error returned when the parent field ID refers to a field in the layout's unused fields list.", "summary": "Example of parent field in unused fields list.", "value": { "map_dependency": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.map_dependency[0].parent.id" }, "message": "Parent fieldid is in unused fields list of the layout", "status": "error" } ] } }, "PickListValuesNotFound": { "description": "Shows an error returned when the required **pick_list_values** array is missing from the request.", "summary": "Example of pick_list_values array missing.", "value": { "map_dependency": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "pick_list_values", "json_path": "$.map_dependency[0].pick_list_values" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents a root-level error returned when the request itself is invalid, such as an invalid module, missing required parameter, or an attempt to modify an internal dependency.", "properties": { "code": { "description": "Represents the error code for the root-level request error. \nPossible values: **REQUIRED_PARAM_MISSING**, **INVALID_MODULE**, **NOT_SUPPORTED**, **INVALID_DATA**, **NOT_ALLOWED**. \n", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_MODULE", "NOT_SUPPORTED", "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the root-level error. ", "type": "object" }, "message": { "description": "Describes the root-level error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UpdateMapDependencyRootError" }, { "additionalProperties": false, "description": "Represents a field-level error returned when the dependency data is invalid, such as invalid field references or missing required picklist mappings.", "properties": { "map_dependency": { "description": "Contains the field-level error details for each dependency in the request. ", "items": { "additionalProperties": false, "description": "Represents the error details for a specific field in the dependency request.", "properties": { "code": { "description": "Represents the error code for the field-level error. \nPossible values: **MANDATORY_NOT_FOUND**, **INVALID_DATA**, **NOT_ALLOWED**. \n", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains field-specific details about the error. ", "type": "object" }, "message": { "description": "Describes the field-level error that occurred. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the field-level response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "map_dependency" ], "type": "object", "x-zs-$id": "UpdateMapDependencyFieldLevelError" } ], "description": "Represents the error response when the update request fails. Returns either a root-level error or a field-level error wrapped in the **map_dependency** array.", "x-zs-$id": "UpdateMapDependencyErrorResponse" } } }, "description": "The request contains invalid data or violates an update rule.\n**Resolution:** Verify that the dependency ID, parent and child field IDs, and all picklist option IDs are valid. Internal dependencies cannot be modified.\n" }, "403": { "$ref": "#/components/responses/MapDependencyForbiddenError" }, "404": { "$ref": "#/components/responses/NotFoundError" }, "500": { "$ref": "#/components/responses/MapDependencyInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.map_dependency.update" ] } ], "summary": "Update an existing field dependency", "tags": [ "map_dependency" ], "x-zoho-document": "map_dependency", "x-zs-llm-description": "Updates value mappings for an existing picklist field dependency. To remove a specific parent-to-child mapping, include the mapping entry with \"_delete\": null. Only the pick_list_values mappings can be changed; the parent and child fields cannot be reassigned. Dependencies where internal is true cannot be modified." } }, "/crm/v8/settings/module/{moduleid}/actions/generate_link": { "get": { "description": "To generate the configured web-tab link for a specific module in your Zoho CRM organization. The moduleid path parameter must be the module's API name (e.g., Leads, Contacts, Custom_Module_1).", "operationId": "getGenerateLink", "parameters": [ { "$ref": "#/components/parameters/ParamPathModuleid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Successful generation of web-tab link for a module", "value": { "generate_link": { "id": "111111000000066002", "name": "WebTab1", "web_link": "https://www.wikipedia.org/" } } } }, "schema": { "$ref": "#/components/schemas/ModuleWebTabLinkResponse" } } }, "description": "Returns the generated web-tab link for the specified module." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleName": { "description": "Shows a 400 INVALID_DATA response returned when the module API name provided in the path does not match any existing module.", "summary": "Invalid module name provided in path parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the provided module API name is invalid.", "properties": { "code": { "description": "Represents the error code returned for the request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the cause of the error.", "properties": { "param_name": { "description": "Represents the name of the invalid parameter in the request.", "enum": [ "module" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue with the request.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetGenerateLinkResponse400" } } }, "description": "The module name given seems to be invalid.\n**Resolution:** The module API name in the request path must match the API name of an existing module." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.READ" ] } ], "summary": "Generate web-tab link for a module", "tags": [ "modules" ], "x-zoho-document": "modules" } }, "/crm/v8/settings/modules": { "get": { "description": "Retrieves the list of all modules available in the Zoho CRM account, including standard, custom, subform, and linking (MxN) modules. Supports optional filtering by `status`, `feature_name`, and `include` to control the scope and depth of the response. When both `status` and `feature_name` are provided, modules must satisfy both criteria. Returns all matching modules in a single response without pagination.", "operationId": "getModules", "parameters": [ { "$ref": "#/components/parameters/ModulesStatus" }, { "$ref": "#/components/parameters/FeatureName" }, { "$ref": "#/components/parameters/ModulesInclude" }, { "$ref": "#/components/parameters/ModulesParamQueryFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "AllModulesWithVariations": { "description": "Comprehensive response showing all module types including standard, custom, subform, and web-tab modules with their full metadata.", "summary": "Complete module list with all variations", "value": { "modules": [ { "access_type": "org_based", "actual_plural_label": "Home", "actual_singular_label": "Home", "api_name": "Home", "api_supported": false, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": false, "deletable": false, "description": null, "editable": false, "feeds_required": false, "generated_type": "default", "global_search_supported": false, "has_more_profiles": false, "id": "111111000000002646", "isBlueprintSupported": false, "lookupable": false, "modified_by": null, "modified_time": null, "module_name": "Home", "parent_module": {}, "plural_label": "Home", "presence_sub_menu": false, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": false, "sequence_number": 1, "show_as_tab": true, "singular_label": "Home", "status": "visible", "sub_menu_available": false, "viewable": true, "visibility": 1, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "Leads", "actual_singular_label": "Lead", "api_name": "Leads", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": true, "creatable": true, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "default", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000002648", "isBlueprintSupported": true, "lookupable": true, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-11T11:29:45+05:30", "module_name": "Leads", "parent_module": {}, "plural_label": "Leads", "presence_sub_menu": true, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": true, "quick_create": true, "recycle_bin_on_delete": true, "sequence_number": 2, "show_as_tab": true, "singular_label": "Lead", "status": "visible", "sub_menu_available": true, "viewable": true, "visibility": 1, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "Subform 2", "actual_singular_label": "Subform 2", "api_name": "Subform_2", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": true, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "static_subform", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000270418", "isBlueprintSupported": false, "lookupable": false, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-21T15:10:43+05:30", "module_name": "LinkingModule2", "parent_module": { "api_name": "CM", "id": "111111000000257585" }, "plural_label": "Subform 2", "presence_sub_menu": false, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": true, "sequence_number": 25, "show_as_tab": false, "singular_label": "Subform 2", "static_subform_properties": { "fields": [ { "api_name": "Pick_List_1", "id": "111111000000271161" } ] }, "status": "visible", "sub_menu_available": false, "viewable": true, "visibility": 2, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "webtab", "actual_singular_label": "webtab", "api_name": "webtab", "api_supported": false, "arguments": [ { "name": "id", "value": "users.recordId" }, { "name": "name", "value": "users.first_name" }, { "name": "id", "value": "users.recordId" } ], "business_card_field_limit": 5, "convertable": false, "creatable": false, "deletable": false, "description": null, "editable": false, "feeds_required": false, "generated_type": "webtab_link", "global_search_supported": false, "has_more_profiles": false, "id": "111111000000265237", "isBlueprintSupported": false, "lookupable": false, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-20T02:10:35+05:30", "module_name": "WebTab1", "parent_module": {}, "plural_label": "webtab", "presence_sub_menu": false, "private_profile": null, "profile_count": 1, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": false, "sequence_number": 122, "show_as_tab": true, "singular_label": "webtab", "status": "visible", "sub_menu_available": false, "viewable": true, "visibility": 1, "web_link": "https://www.youtube.com/watch?v=-pE5fXPHbdo##wtab##?id=${Users.recordId}&name=${Users.111111000000000107}&id=${Users.recordId}" }, { "access_type": "team_based", "actual_plural_label": "sdfvg", "actual_singular_label": "sdfvgdfvsg", "api_name": "sdfvg", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": true, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "custom", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000268896", "isBlueprintSupported": true, "lookupable": true, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-21T12:12:26+05:30", "module_name": "CustomModule3", "parent_module": {}, "plural_label": "sdfvg", "presence_sub_menu": true, "private_profile": { "id": "111111000000000501", "name": "Admins" }, "profile_count": 5, "profiles": [ { "id": "111111000000000501", "name": "Admins" } ], "public_fields_configured": false, "quick_create": true, "recycle_bin_on_delete": true, "sequence_number": 125, "show_as_tab": true, "singular_label": "sdfvgdfvsg", "status": "visible", "sub_menu_available": true, "viewable": true, "visibility": 1, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "Custom Modules", "actual_singular_label": "Custom Module", "api_name": "CM1", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": true, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "custom", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000242167", "isBlueprintSupported": true, "lookupable": true, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-20T15:50:22+05:30", "module_name": "CustomModule2", "parent_module": {}, "plural_label": "Custom Modules", "presence_sub_menu": true, "private_profile": null, "profile_count": 3, "profiles": [ { "id": "111111000000000497", "name": "Administrator" }, { "id": "111111000000000499", "name": "Standard" }, { "id": "111111000000263146", "name": "Team User" } ], "public_fields_configured": false, "quick_create": true, "recycle_bin_on_delete": true, "sequence_number": 115, "show_as_tab": true, "singular_label": "Custom Module", "status": "visible", "sub_menu_available": true, "viewable": true, "visibility": 1, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "Notes", "actual_singular_label": "Note", "api_name": "Notes", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": true, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "default", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000002676", "isBlueprintSupported": false, "lookupable": false, "modified_by": null, "modified_time": null, "module_name": "Notes", "parent_module": {}, "plural_label": "Notes", "presence_sub_menu": false, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": true, "sequence_number": 32, "show_as_tab": false, "singular_label": "Note", "status": "system_hidden", "sub_menu_available": false, "viewable": true, "visibility": 1, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "Feeds", "actual_singular_label": "Feeds", "api_name": "Feeds", "api_supported": false, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": false, "deletable": false, "description": null, "editable": false, "feeds_required": false, "generated_type": "default", "global_search_supported": false, "has_more_profiles": false, "id": "111111000000002662", "isBlueprintSupported": false, "lookupable": false, "modified_by": null, "modified_time": null, "module_name": "Feeds", "parent_module": {}, "plural_label": "Feeds", "presence_sub_menu": false, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": false, "sequence_number": 15, "show_as_tab": true, "singular_label": "Feeds", "status": "user_hidden", "sub_menu_available": false, "viewable": true, "visibility": 1, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "Stage History", "actual_singular_label": "Stage History", "api_name": "DealHistory", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": false, "deletable": false, "description": null, "editable": false, "feeds_required": false, "generated_type": "field_tracker", "global_search_supported": false, "has_more_profiles": false, "id": "111111000000002792", "isBlueprintSupported": false, "lookupable": false, "modified_by": null, "modified_time": null, "module_name": "DealHistory", "parent_module": { "api_name": "Deals", "id": "111111000000002654" }, "plural_label": "Stage History", "presence_sub_menu": false, "private_profile": null, "profile_count": 2, "profiles": [ { "id": "111111000000000499", "name": "Standard" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": false, "sequence_number": 38, "show_as_tab": false, "singular_label": "Stage History", "status": "system_hidden", "sub_menu_available": false, "track_current_data": true, "viewable": false, "visibility": 2, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "Calendar Bookings", "actual_singular_label": "Calendar Booking", "api_name": "CalendarBookings__s", "api_supported": false, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": false, "deletable": true, "description": null, "editable": false, "feeds_required": false, "generated_type": "default", "global_search_supported": false, "has_more_profiles": false, "id": "111111000000002824", "isBlueprintSupported": false, "lookupable": false, "modified_by": null, "modified_time": null, "module_name": "CalendarBookings", "parent_module": {}, "plural_label": "Calendar Bookings", "presence_sub_menu": false, "private_profile": null, "profile_count": 3, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": true, "sequence_number": 53, "show_as_tab": false, "singular_label": "Calendar Booking", "status": "visible", "sub_menu_available": false, "viewable": false, "visibility": 14316, "web_link": null }, { "access_type": "org_based", "actual_plural_label": "File Upload 1", "actual_singular_label": "File Upload 1", "api_name": "File_Upload_1__s", "api_supported": false, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": false, "deletable": false, "description": null, "editable": false, "feeds_required": false, "generated_type": "default", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000225531", "isBlueprintSupported": false, "lookupable": false, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-10T16:28:58+05:30", "module_name": "Fileupload1", "parent_module": {}, "plural_label": "File Upload 1", "presence_sub_menu": false, "private_profile": null, "profile_count": 0, "profiles": [], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": false, "sequence_number": 111, "show_as_tab": true, "singular_label": "File Upload 1", "status": "visible", "sub_menu_available": true, "viewable": false, "visibility": 2046, "web_link": null } ] } } }, "schema": { "additionalProperties": false, "description": "Response body containing the array of module metadata objects.", "properties": { "modules": { "description": "Array of module metadata objects returned for the Zoho CRM account, up to 600 entries, each containing configuration, capabilities, fields, layouts, profiles, and permissions.", "items": { "additionalProperties": false, "description": "Complete metadata for a single Zoho CRM module, including configuration, capabilities, fields, layouts, profiles, and related lists.", "properties": { "access_type": { "description": "Access control type for the module; `org_based` grants organization-wide access and `team_based` grants team-specific access. This value is immutable after module creation and cannot be updated via PUT operations.", "enum": [ "org_based", "team_based" ], "type": "string" }, "actual_plural_label": { "description": "Original plural label of the module as stored in the database, without any translation applied.", "maxLength": 50, "type": "string" }, "actual_singular_label": { "description": "Original singular label of the module as stored in the database, without any translation applied.", "maxLength": 50, "type": "string" }, "api_name": { "description": "Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores.", "maxLength": 50, "type": "string", "x-zs-$id": "ModulesApiName" }, "api_supported": { "description": "Whether API operations are supported for this module.", "type": "boolean" }, "arguments": { "description": "Array of argument objects used to substitute dynamic parameters in web tab URLs; for example, `https://...&id=${Users.User Id}&name=${Users.First Name}`. Duplicates are allowed, up to 50 entries.", "items": { "additionalProperties": false, "description": "Argument object that defines a URL parameter substitution, with a name (template key) and a value (field reference expression).", "properties": { "name": { "description": "Key used in the web tab URL template to identify the substitution parameter.", "maxLength": 50, "type": "string" }, "value": { "description": "Field substitution reference expression (for example, `users.recordId`) resolved at runtime for web tab URL parameter substitution.", "maxLength": 100, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "business_card_field_limit": { "description": "Maximum number of fields that can be displayed on the business card view for this module; must be a non-negative integer.", "format": "int32", "minimum": 0, "type": "integer" }, "cc_enabled": { "description": "Whether CommandCenter functionality is enabled for email communications in this module; exposed only for orchestration modules and not applicable for API-supported modules.", "type": "boolean" }, "convertable": { "description": "Whether records in this module can be converted to another module type.", "type": "boolean" }, "creatable": { "description": "Indicates if new records can be created in this module.", "type": "boolean" }, "deletable": { "description": "Indicates whether records in this module can be deleted.", "type": "boolean" }, "description": { "description": "User-defined description of the module, up to 255 characters; null when no description has been set.", "maxLength": 255, "type": [ "string", "null" ] }, "editable": { "description": "Whether records in this module can be edited by users.", "type": "boolean" }, "emailTemplate_support": { "description": "Indicates whether Email Templates functionality is supported for this module.", "type": "boolean" }, "email_parser_supported": { "description": "Indicates whether email parsing is supported for this module.", "type": "boolean" }, "feeds_required": { "description": "Indicates whether activity feeds are required for this module.", "type": "boolean" }, "filter_supported": { "description": "Indicates whether records in this module can be filtered.", "type": "boolean" }, "generated_type": { "description": "Method by which this module was generated or created.", "enum": [ "field_tracker", "default", "web", "linking", "custom", "picklisttracker", "subform", "static_subform", "webtab_link" ], "type": "string" }, "global_search_supported": { "description": "Indicates whether global search functionality is supported for this module.", "type": "boolean" }, "has_more_profiles": { "description": "Indicates whether more profiles exist beyond those returned in the current response.", "type": "boolean" }, "id": { "description": "Represents the unique identifier for the module.", "format": "int64", "type": "string", "x-zs-$id": "ModulesId" }, "inventory_template_supported": { "description": "Indicates whether inventory templates are supported for this module.", "type": "boolean" }, "isBlueprintSupported": { "description": "Indicates whether Blueprint (process automation) is supported for this module.", "type": "boolean" }, "lookupable": { "description": "Indicates whether this module can be used as a lookup target in other modules.", "type": "boolean" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "User object representing the user who last modified the module.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified the module.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who last modified the module.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ModulesModifiedByObjectResponse" }, { "description": "Null value indicating the module has never been modified.", "type": "null", "x-zs-$id": "ModulesModifiedByNullResponse" } ] }, "modified_time": { "description": "Timestamp of the most recent modification to the module, returned as a timezone-aware date-time string; null if the module has never been modified.", "format": "date-time", "type": [ "string", "null" ] }, "module_name": { "description": "Represents the display name of the module.", "maxLength": 50, "type": "string" }, "module_type": { "description": "Represents the type classification of the module; exposed only for pathfinder and orchestration modules. Possible values: `CONFIGURATION_ENTITIES`, `ENTITIES`.", "enum": [ "CONFIGURATION_ENTITIES", "ENTITIES" ], "type": "string" }, "parent_module": { "additionalProperties": false, "description": "Reference to the parent module if this is a child or related module; an empty object `{}` for standalone modules, `null` in some cases, or an object with `api_name` and `id` for child modules.", "properties": { "api_name": { "description": "Represents the API name of the parent module.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the parent module.", "format": "int64", "type": "string" } }, "required": [], "type": [ "object", "null" ] }, "plural_label": { "description": "Plural display label for the module; returns the translated label when translation is enabled, otherwise matches `actual_plural_label`.", "maxLength": 50, "type": "string" }, "presence_sub_menu": { "description": "Indicates whether this module has a presence submenu option.", "type": "boolean" }, "private_profile": { "additionalProperties": false, "description": "Private profile configuration for the module, containing the profile identifier and name.", "properties": { "id": { "description": "Unique identifier of the private profile associated with the module.", "format": "int64", "type": "string" }, "name": { "description": "Name of the private profile associated with the module.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "profile_count": { "description": "Represents the number of profiles associated with this module; 0 indicates no profile assignments.", "format": "int32", "type": "integer" }, "profiles": { "description": "List of profiles that have permission to view this module; may be empty for certain module types, with up to 203 entries.", "items": { "additionalProperties": false, "description": "Represents the profile object containing the profile identifier and display name.", "properties": { "id": { "description": "Represents the unique identifier of the profile.", "format": "int64", "type": "string" }, "name": { "description": "Represents the display name of the profile.", "maxLength": 50, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "maxItems": 203, "type": "array" }, "public_fields_configured": { "description": "Indicates whether public fields have been configured for this module.", "type": "boolean" }, "quick_create": { "description": "Indicates whether the quick create form is available for this module.", "type": "boolean" }, "recycle_bin_on_delete": { "description": "Indicates whether deleted records are moved to the recycle bin instead of being permanently deleted.", "type": "boolean" }, "scoring_supported": { "description": "Indicates whether lead or record scoring functionality is supported for this module.", "type": "boolean" }, "sequence_number": { "description": "Represents the display order of the module in the navigation list.", "format": "int32", "type": "integer" }, "show_as_tab": { "description": "Indicates whether the module appears as a tab in the main navigation.", "type": "boolean" }, "singular_label": { "description": "Singular display label for the module; returns the translated label when translation is enabled, otherwise matches `actual_singular_label`.", "maxLength": 50, "type": "string" }, "static_subform_properties": { "additionalProperties": false, "description": "Configuration properties for static subform modules, including the list of field references.", "properties": { "fields": { "description": "Array of field references included in the static subform, up to 25 entries.", "items": { "additionalProperties": false, "description": "Represents the field reference object containing the field API name and unique identifier.", "properties": { "api_name": { "description": "Represents the API name of the static subform field.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the static subform field.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "fields" ], "type": [ "object", "null" ] }, "status": { "description": "Lifecycle state of the module. Possible values: `visible`, `user_hidden`, `system_hidden`, `scheduled_for_deletion`. This status is separate from the numeric bitwise `visibility` flags. It does not itself enable/disable individual features.", "enum": [ "visible", "scheduled_for_deletion", "user_hidden", "system_hidden" ], "type": "string" }, "sub_menu_available": { "description": "Whether a submenu is available for this module in the navigation.", "type": "boolean" }, "territory": { "additionalProperties": false, "description": "Territory assignment for the module, containing the territory identifier, name, and subordinates flag.", "properties": { "id": { "description": "Unique identifier of the territory; 0 indicates the special \"All Territories\" territory.", "format": "int64", "type": "string" }, "name": { "description": "Name of the territory; for example, \"All Territories\" when the ID is 0.", "maxLength": 100, "type": "string" }, "subordinates": { "description": "Whether subordinate territories are included in this territory assignment.", "type": "boolean" } }, "required": [ "name", "id", "subordinates" ], "type": [ "object", "null" ] }, "track_current_data": { "description": "Whether current data tracking is enabled for this module.", "type": "boolean" }, "triggers_supported": { "description": "Whether workflow triggers are supported for this module.", "type": "boolean" }, "viewable": { "description": "Whether records in this module can be viewed.", "type": "boolean" }, "visibility": { "description": "Bitwise feature visibility flags for the module; the base value 1 indicates fully visible. Add flag values to hide specific features: 2=WEBUIHIDDEN, 4=TABMENU, 8=LOOKUP, 16=RELATEDLIST, 32=MULTISELECTLOOKUP, 64=MODULE_SETTING, 128=AUTOMATION, 256=TEMPLATES, 512=IMPORT, 1024=EXPORT, 4096=REPORT, 8192=API.", "format": "int32", "type": "integer" }, "web_link": { "description": "URL for web tab modules; supports dynamic parameter substitution via the arguments array.", "type": [ "string", "null" ] }, "webform_supported": { "description": "Whether webform integration is supported for this module.", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "maxItems": 600, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesGet200Response" } } }, "description": "Returns all modules in the Zoho CRM account with their configuration details, permissions, fields, layouts, and related lists. All matching modules are included in a single response without pagination." }, "204": { "description": "No modules match the specified filter criteria." }, "400": { "content": { "application/json": { "examples": { "InvalidFeatureName": { "description": "Shows the error response returned when the **feature_name** parameter is provided as an empty string.", "summary": "Empty or invalid feature_name parameter", "value": { "code": "INVALID_DATA", "details": {}, "message": "the given feature name is invalid", "status": "error" } }, "InvalidStatus": { "description": "Shows the error response returned when the **status** parameter contains an unsupported value.", "summary": "Invalid status parameter value", "value": { "code": "INVALID_DATA", "details": { "index": 0, "param_name": "status", "supported_values": [ "visible", "user_hidden", "system_hidden", "scheduled_for_deletion" ] }, "message": "The status given is invalid.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response returned when the `status` parameter contains an unsupported value.", "properties": { "code": { "description": "Error code indicating invalid data in the request. Always `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the validation error, including the parameter name, the invalid value index, and the list of supported values.", "properties": { "index": { "description": "Zero-based index of the invalid value in the comma-separated `status` parameter.", "format": "int32", "type": "integer" }, "param_name": { "description": "Name of the parameter that contains the invalid value. Always `status` for this error variant.", "enum": [ "status" ], "type": "string" }, "supported_values": { "description": "Unordered list of valid status values; each value appears exactly once, up to 10 entries.", "items": { "description": "A valid status value accepted by the API.", "maxLength": 50, "type": "string" }, "maxItems": 10, "type": "array", "uniqueItems": true } }, "required": [ "index", "supported_values", "param_name" ], "type": "object" }, "message": { "description": "A message describing the validation failure for the invalid status parameter.", "maxLength": 1000, "type": "string" }, "status": { "description": "Status of the request. Always `error` for failed requests.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesGet400ResponseInvalidStatus" }, { "additionalProperties": false, "description": "Error response returned when the `feature_name` parameter is provided as an empty string.", "properties": { "code": { "description": "Error code indicating invalid data in the request. Always `INVALID_DATA`.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Empty details object returned when the `feature_name` parameter is provided as an empty string.", "type": "object" }, "message": { "description": "A message describing the validation failure for the empty feature_name parameter.", "maxLength": 1000, "type": "string" }, "status": { "description": "Status of the request. Always `error` for failed requests.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesGet400ResponseInvalidFeatureName" } ], "description": "Contains the error response when the request contains invalid parameter values.", "x-zs-$id": "ModulesGet400Response" } } }, "description": "Bad request returned when the `status` parameter contains unsupported values or when `feature_name` is provided as an empty string." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.READ" ] } ], "summary": "Retrieve modules", "tags": [ "modules" ], "x-zoho-document": "modules" }, "post": { "description": "To create a custom module in your Zoho CRM organization. Only one module can be created per request. The required permission depends on the access type: **Crm_Implied_Customize_Zoho_CRM** for org-based modules and **Crm_Implied_Create_Team_Module** for team-based modules. Submitting the same api_name multiple times will result in validation errors. The optional access_type controls module access model (org_based/team_based).", "operationId": "createModules", "requestBody": { "content": { "application/json": { "examples": { "MinimalModule": { "description": "Shows a minimal POST request body with only the required fields: **singular_label** and **plural_label**.", "summary": "Create a custom module with required fields only", "value": { "modules": [ { "api_name": "CustomModule1", "plural_label": "CM123456", "profiles": [ { "id": "111111000000000497" } ], "singular_label": "CM123465" } ] } }, "ModuleWithAutonumber": { "description": "Shows a POST request body for a module with an auto-number display field, including prefix, start number, and suffix configuration.", "summary": "Create a module with an auto-number display field including prefix and suffix", "value": { "modules": [ { "api_name": "CustomModule3", "display_field": { "auto_number": { "prefix": "M", "start_number": "21", "suffix": "H" }, "data_type": "autonumber", "field_label": "fieldLabel" }, "plural_label": "CM21", "profiles": [ { "id": "111111000000000497" } ], "singular_label": "CM21" } ] } }, "ModuleWithTextDisplay": { "description": "Shows a POST request body for a module with a text-based display field configuration.", "summary": "Create a module with a text display field", "value": { "modules": [ { "api_name": "CustomModule2", "display_field": { "data_type": "text", "field_label": "fieldLabel" }, "plural_label": "CM1", "profiles": [ { "id": "111111000000000497" } ], "singular_label": "CM1" } ] } }, "TeamBasedModule": { "description": "Shows a POST request body for creating a team-based module with the **access_type** set to **team_based** and no profile assignments.", "summary": "Create a team-based custom module", "value": { "modules": [ { "access_type": "team_based", "api_name": "TeamModule1", "plural_label": "TeamModule1", "singular_label": "TeamModule1" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body structure for creating a custom module, containing the module definition in the **modules** array.", "properties": { "modules": { "description": "Specify the module definitions to create. Only one module definition object can be included per request.", "items": { "additionalProperties": false, "allOf": [ { "description": "Specifies the fields available for defining a new custom module, including name labels, API name, and optional display field configuration." } ], "description": "Specify the details of the Module definition object containing module metadata, optional access_type, profiles (not applicable for team_based), and optional display field configuration", "properties": { "access_type": { "default": "org_based", "description": "Specify the access type for the module.Defaults to org_based when omitted. Use team_based to create a team module.\nPossible values:\n**org_based** - The module is accessible based on organizational profile settings.\n**team_based** - The module is restricted to team-based access.", "enum": [ "org_based", "team_based" ], "type": "string" }, "api_name": { "description": "Specify the unique API name for the module. The name must begin with an English alphabet character, must not end with an underscore, and must not contain two consecutive underscores. If omitted, the system generates the API name from the **plural_label** value.", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "display_field": { "additionalProperties": false, "description": "Specify the details of the display field for the module. This is optional, but if provided, either field_label or data_type is mandatory. Supported data types are **autonumber** and **text**. If this is not specified, the system generates a text display field. If data_type is 'autonumber', then auto_number configuration with start_number is mandatory. ", "properties": { "auto_number": { "additionalProperties": false, "description": "Specify the auto-number configuration for the display field. Required when **data_type** is **autonumber**.", "properties": { "prefix": { "description": "Specify the prefix to prepend to each auto-generated number value in the display field.", "maxLength": 50, "type": "string" }, "start_number": { "description": "Specify the starting number for the auto-number sequence. Only numeric characters are allowed.", "maxLength": 16, "pattern": "^[0-9]+$", "type": "string" }, "suffix": { "description": "Specify the suffix to append to each auto-generated number value in the display field.", "maxLength": 50, "type": "string" } }, "required": [ "start_number" ], "type": "object" }, "data_type": { "description": "Specify the data type of the display field.\nPossible values:\n**autonumber** - Automatically generates a unique number sequence for each record.\n**text** - Allows users to enter text values manually.", "enum": [ "autonumber", "text" ], "type": "string" }, "field_label": { "description": "Specify the unique display label of the field used as the module's display field. Either this property or **data_type** must be provided when specifying the display field.", "maxLength": 100, "minLength": 1, "type": "string" } }, "type": "object" }, "plural_label": { "description": "Specify the unique plural name of the module. Only letters, numbers, and spaces are supported.", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "profiles": { "description": "Specify the array of profile IDs that determine which user profiles can access this module. Required for org_based modules. Do not pass this key for team_based modules. Duplicate profile IDs are not allowed.", "items": { "additionalProperties": false, "description": "Specify the details of a profile to be granted access to the module.", "properties": { "id": { "description": "Specify the unique ID of the profile to be granted access to the module.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 203, "minItems": 1, "type": "array", "uniqueItems": true }, "singular_label": { "description": "Specify the unique singular name of the module. Only letters, numbers, and spaces are supported.", "maxLength": 50, "minLength": 1, "pattern": "^[a-zA-Z0-9]+$", "type": "string" } }, "required": [ "singular_label", "plural_label" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object" } } }, "description": "The request body must contain a modules array with one object. Only single module creation is supported per request. access_type is optional and defaults to org_based. For team_based modules, do not pass profiles.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessfulCreation": { "description": "Shows the response after successfully creating a custom module, with the new module ID returned in the details object.", "summary": "Custom module created successfully", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000123456" }, "message": "module created successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body returned when a custom module is successfully created, containing the resulting module details in a modules array.", "properties": { "modules": { "description": "Represents the array containing the result of the single module creation request. Contains exactly one item for each module creation request.", "items": { "additionalProperties": false, "description": "Represents the result of the module creation request, including the status, message, and identifier of the created module.", "properties": { "code": { "description": "Represents the status code of the module creation operation.\nPossible values:\n**SUCCESS** - The module creation completed successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the created module, including its unique identifier.", "properties": { "id": { "description": "Represents the unique identifier of the newly created module.", "format": "int64", "type": "string", "x-zs-$id": "ModuleDetailsId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the confirmation message for the module creation operation.\nPossible values:\n**module created successfully** - The module creation completed without errors.", "enum": [ "module created successfully" ], "type": "string" }, "status": { "description": "Represents the overall status of the module creation operation.\nPossible values:\n**success** - The module creation completed successfully.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPost201Response" } } }, "description": "Returns the success result of the module creation, including the unique identifier of the newly created module." }, "400": { "content": { "application/json": { "examples": { "ApiVersionNotSupported": { "description": "Returned when the request targets an API version lower than version 6, which is the minimum supported version for this operation.", "summary": "Unsupported API version used in request", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_version": 6 }, "message": "api version is not supported", "status": "error" } }, "DependentFieldMissing": { "description": "Returned when the request specifies an **autonumber** data type for the display field but does not include the required **auto_number** configuration.", "summary": "Missing auto_number configuration for autonumber display field", "value": { "modules": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "auto_number", "json_path": "$.modules[0].auto_number" }, "message": "autonumber data is not found", "status": "error" } ] } }, "DuplicateApiName": { "description": "Returned when the request attempts to create a module with an api_name that already exists in the organization.", "summary": "Duplicate api_name value in module creation request", "value": { "modules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.modules[0].api_name" }, "message": "A module with the provided api_name already exists. Please use a unique api_name.", "status": "error" } ] } }, "DuplicateSingularLabel": { "description": "Returned when the request uses a **singular_label** value that is already in use by another module in the organization.", "summary": "Duplicate singular_label value in module creation request", "value": { "code": "DUPLICATE_DATA", "details": { "api_name": "singular_label", "json_path": "$.modules[0].singular_label" }, "message": "A module with this singular label already exists. Please use a unique singular_label.", "status": "error" } }, "FieldLengthExceeded": { "description": "Returned when a field value in the request exceeds the maximum allowed character length.", "summary": "Field value exceeds maximum allowed length", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "field_label", "json_path": "$.modules[0].display_field.field_label", "maximum_length": 50 }, "message": "The value for 'field_label' exceeds the maximum allowed length of 50 characters.", "status": "error" } ] } }, "InvalidApiName": { "description": "Returned when the **api_name** value violates the required naming conventions, such as starting with a non-alphabetic character or containing disallowed characters.", "summary": "Invalid api_name naming convention", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.modules[0].api_name" }, "message": "The api_name format is invalid. It must follow CRM naming conventions.", "status": "error" } ] } }, "InvalidDataType": { "description": "Returned when a field value is provided with an incorrect data type, such as a string where a number is expected.", "summary": "Incorrect data type for a request field", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "plural_label", "expected_data_type": "text", "json_path": "$.modules[0].plural_label" }, "message": "The field 'plural_label' expects a text value.", "status": "error" } ] } }, "InvalidProfileDatatype": { "description": "Returned when the profile ID value is provided with an incorrect data type(expected is bigint), such as a number where a string is expected.", "summary": "Profile ID provided with incorrect data type", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.modules[0].profile[0].id" }, "message": "The field 'id' expects a bigint value for the profile ID.", "status": "error" } ] } }, "InvalidProfileId": { "description": "Returned when the provided profile ID does not correspond to an existing profile in the organization.", "summary": "Profile ID does not exist in the organization", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.modules[0].profiles[0].id" }, "message": "The provided profile ID is invalid or does not exist.", "status": "error" } ] } }, "LimitExceeded": { "description": "Returned when the organization has reached the maximum number of custom modules allowed for the current edition.", "summary": "Module creation limit has been reached", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 10 }, "message": "The maximum number of custom modules (10) for your current edition has been reached.", "status": "error" } }, "LiteProfileLimit": { "description": "Returned when the request attempts to enable more lite profiles than the edition allows. The caller must reduce the number of enabled lite profiles or upgrade to a higher edition before retrying.", "summary": "Lite profile limit exceeded for custom module", "value": { "modules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.modules.profiles.id" }, "message": "Only 10 modules can be enabled for Lite Profile.", "status": "error" } ] } }, "MissingAutoNumberStart": { "description": "Returned when the request specifies an **autonumber** display field but does not include the required **start_number** value in the **auto_number** configuration.", "summary": "Missing start_number in auto-number display field configuration", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "start_number", "json_path": "$.modules[0].display_field.auto_number.start_number" }, "message": "required field not found", "status": "error" } ] } }, "MissingProfileId": { "description": "Returned when the profile ID field is absent from a profile entry in the **profiles** array.", "summary": "Profile entry missing required ID field", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.modules[0].profiles[0].id" }, "message": "The required field 'id' is missing from the profile configuration.", "status": "error" } ] } }, "MissingProfiles": { "description": "Returned when the required **profiles** field is absent from the request body for an **org_based** module.", "summary": "Required profiles field not provided in request", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "profiles", "json_path": "$.modules[0].profiles" }, "message": "The required field 'profiles' is missing from the request.", "status": "error" } ] } }, "MissingRequiredField": { "description": "Returned when a mandatory field such as **singular_label** is not included in the module creation request.", "summary": "Returned when a mandatory field is missing from the request", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "singular_label", "json_path": "$.modules[0].singular_label" }, "message": "The required field 'singular_label' is missing from the request.", "status": "error" } ] } }, "NullApiName": { "description": "Returned when the **api_name** field is submitted as null or an empty string. The **api_name** must contain a non-empty value to create a custom module.", "summary": "api_name submitted as null or empty string", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.modules[0].api_name" }, "message": "The field 'api_name' cannot be null or empty. Please provide a valid api_name.", "status": "error" } ] } }, "ReservedKeyword": { "description": "Returned when the **api_name** value uses a reserved system keyword that cannot be used as a module API name.", "summary": "Reserved system keyword used as api_name", "value": { "modules": [ { "code": "RESERVED_KEYWORD_NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.modules[0].api_name" }, "message": "The api_name contains a reserved system keyword. Please choose a different name.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the array of error responses for validation failures.", "properties": { "modules": { "description": "Represents the array of error responses for each module that failed validation", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error object returned when the module creation request contains a duplicate value for a unique constraint field such as **api_name**, **singular_label**, or **plural_label**.", "properties": { "code": { "description": "Represents the error code returned when the request contains duplicate data.\nPossible values:\n**DUPLICATE_DATA** - A duplicate value was found for **singular_label**, **plural_label**, or **api_name**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details identifying the field that caused the duplicate data error, including its API name and location in the request.", "properties": { "api_name": { "description": "Represents the API name of the field for which a duplicate value was found.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression identifying the location of the duplicate field in the request body.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the duplicate data constraint violation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed due to a duplicate data constraint.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPost400ResponseDuplicateData" }, { "additionalProperties": false, "description": "Represents the error object returned when a required field is absent from the module creation request.", "properties": { "code": { "description": "Represents the error code returned when a mandatory field is absent from the request.\nPossible values:\n**MANDATORY_NOT_FOUND** - A required field is missing from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information identifying the mandatory field that is missing, including its API name and location in the request.", "properties": { "api_name": { "description": "Represents the API name of the mandatory field that is missing from the request.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression identifying the location in the request where the mandatory field should be specified.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing mandatory field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed due to a missing mandatory field.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponseMandatoryNotFound" }, { "additionalProperties": false, "description": "Represents the error object returned when a dependent configuration field required by the specified settings is missing from the request.", "properties": { "code": { "description": "Represents the error code returned when a required dependent field is missing from the request.\nPossible values:\n**DEPENDENT_FIELD_MISSING** - A dependent field required by the specified configuration is absent.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information identifying the dependent field that is missing, including its API name and location in the request.", "properties": { "api_name": { "description": "Represents the API name of the dependent field that is missing from the request.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression identifying the location in the request where the dependent field should be specified.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing dependent field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed due to a missing dependent field.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponsesDependentFieldMissing" }, { "additionalProperties": false, "description": "Represents the error object returned when the request contains invalid data, such as an incorrect data type, invalid profile ID, or a field value that exceeds allowed limits.", "properties": { "code": { "description": "Represents the error code returned when the request contains invalid or malformed data.\nPossible values:\n**INVALID_DATA** - The request contains an invalid data type, invalid profile ID, or values that exceed allowed field lengths.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the invalid field, including its API name, location in the request, expected data type, and maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field that contains invalid data.", "maxLength": 50, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that contains invalid data.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression identifying the location of the invalid field in the request body.", "maxLength": 100, "type": "string" }, "maximum_length": { "description": "Represents the maximum number of characters allowed for the field that exceeded the length constraint.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid data that caused the request to fail.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed due to invalid or malformed data.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponsesInvalidData" }, { "additionalProperties": false, "description": "Represents the error object returned when the request attempts an operation that is not permitted for the specified module configuration.", "properties": { "code": { "description": "Represents the error code returned when the requested operation is not permitted.\nPossible values:\n**NOT_ALLOWED** - The operation is not allowed.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the error, including the location of the field or operation that is not allowed.", "properties": { "api_name": { "description": "Represents the API name of the field or operation that is not allowed.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression identifying the location of the disallowed field or operation in the request body.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation is not allowed.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed because the operation is not permitted.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponsesNotAllowed" }, { "additionalProperties": false, "description": "Represents the error object returned when a reserved system keyword appears as the value of a field such as **api_name**.", "properties": { "code": { "description": "Represents the error code returned when a reserved system keyword appears in the **api_name** field.\nPossible values:\n**RESERVED_KEYWORD_NOT_ALLOWED** - The value contains a reserved system keyword.", "enum": [ "RESERVED_KEYWORD_NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information identifying the field that contains the reserved keyword, including its API name and location in the request.", "properties": { "api_name": { "description": "Represents the API name of the field containing the reserved keyword.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression identifying the location of the field containing the reserved keyword in the request body.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the reserved keyword violation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed due to a reserved keyword violation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponsesReservedKeywordNotAllowed" } ], "description": "Represents the validation error details for a single module request, including the error code, message, and field location." }, "maxItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPost400ResponseBatchError" }, { "additionalProperties": false, "description": "Represents an API_NOT_SUPPORTED error returned when the requested operation is not supported in the current API version.", "properties": { "code": { "description": "Represents the error code returned when the API version used is not supported.\nPossible values:\n**API_NOT_SUPPORTED** - The requested API version is not supported.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the API version incompatibility, including the minimum supported version.", "properties": { "supported_version": { "description": "Represents the minimum API version that supports this operation.", "format": "int32", "type": "integer" } }, "required": [ "supported_version" ], "type": "object" }, "message": { "description": "Represents the error message describing the API version incompatibility.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed because the API version is not supported.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponsesApiNotSupported" }, { "additionalProperties": false, "description": "Represents a DUPLICATE_DATA error returned when a submitted field value conflicts with an existing record in the organization.", "properties": { "code": { "description": "Represents the error code returned when the request contains a duplicate value for a unique field.\nPossible values:\n**DUPLICATE_DATA** - A duplicate value was found for **singular_label**, **plural_label**, or **api_name**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information identifying the field that caused the duplicate data error, including its API name and location in the request.", "properties": { "api_name": { "description": "Represents the API name of the field for which a duplicate value was found.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression that locates the duplicate field within the request payload.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the duplicate data constraint violation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed due to a duplicate data constraint.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPostResponseDuplicateData" }, { "additionalProperties": false, "description": "Represents a RESERVED_KEYWORD_NOT_ALLOWED error returned when a field value in the request uses a reserved system keyword.", "properties": { "code": { "description": "Represents the error code returned when a reserved system keyword appears in the **api_name** field at the top level.\nPossible values:\n**RESERVED_KEYWORD_NOT_ALLOWED** - The value contains a reserved keyword.", "enum": [ "RESERVED_KEYWORD_NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the field that uses the reserved keyword, including its API name and location.", "properties": { "api_name": { "description": "Represents the API name of the field containing the reserved keyword.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSONPath expression identifying the location of the reserved keyword field in the request.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the reserved keyword violation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed due to a reserved keyword violation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPostResponseReservedKeywordNotAllowed" }, { "additionalProperties": false, "description": "Represents a LIMIT_EXCEEDED error returned when the organization has reached the maximum number of custom modules allowed for the current edition.", "properties": { "code": { "description": "Represents the error code returned when the module creation limit for the current edition has been reached.\nPossible values:\n**LIMIT_EXCEEDED** - The maximum number of custom modules allowed for this edition has been reached.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the exceeded module creation limit for the current edition.", "properties": { "limit": { "description": "Represents the maximum number of custom modules allowed for the current edition.", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the module creation limit exceeded.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed because the edition limit has been reached.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPostResponseLimitExceeded" } ], "description": "Contains the error response when the module creation request fails validation.", "x-zs-$id": "CreateModulesErrorResponses" } } }, "description": "The request failed validation.\n**Resolution:** Verify that all required fields are provided with valid values. Returned when input data fails validation (invalid module properties, duplicate api_name, missing required fields, field length exceeded, unsupported operations, or mandatory fields not found). All modules in the batch must be valid; no partial success occurs." }, "401": { "content": { "application/json": { "examples": { "OAuthScopeMismatch": { "description": "Returned when the OAuth access token does not include the **ZohoCRM.settings.modules.CREATE** scope required for this operation.", "summary": "OAuth token missing required ZohoCRM.settings.modules.CREATE scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when the OAuth access token does not include the required scope for this operation.", "properties": { "code": { "description": "Represents the error code returned when the OAuth token does not include the required scope.\nPossible values:\n**OAUTH_SCOPE_MISMATCH** - The access token does not include the required scope for this operation.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the OAuth scope issue encountered during the request.", "type": "object" }, "message": { "description": "Represents the error message describing the OAuth scope mismatch.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed because the OAuth token lacks the required scope.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponsesOAuthScopeMismatch" } } }, "description": "The access token does not include the required scope for this operation.\n**Resolution:** A new access token must be generated with the **ZohoCRM.settings.modules.CREATE** scope." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Returned when the user's CRM profile lacks the **Crm_Implied_Customize_Zoho_CRM** permission required to create an org-based custom module.", "summary": "User lacks Crm_Implied_Customize_Zoho_CRM permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "NoPermissionTeamBased": { "description": "Returned when the user's CRM profile lacks the **Crm_Implied_Create_Team_Module** permission required to create a team-based custom module.", "summary": "User lacks permission to create a team-based module", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Create_Team_Module" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when the user's CRM profile lacks the required permission to create a custom module. Crm_Implied_Customize_Zoho_CRM is required for org_based creation, and Crm_Implied_Create_Team_Module is required for team_based creation.", "properties": { "code": { "description": "Represents the error code returned when the user lacks the required CRM permission to create a custom module.\nPossible values:\n**NO_PERMISSION** - The user's profile does not have the required permission for this operation.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the missing permissions required to create the module.", "properties": { "permissions": { "description": "Represents the list of permission identifiers that the user lacks for the requested access type.\nPossible values:\n**Crm_Implied_Customize_Zoho_CRM** - Required for org-based module creation.\n**Crm_Implied_Create_Team_Module** - Required for team-based module creation.", "items": { "description": "Represents a permission identifier required to create the module for the requested access type.\nPossible values:\n**Crm_Implied_Customize_Zoho_CRM** - Required for org-based modules.\n**Crm_Implied_Create_Team_Module** - Required for team-based modules.", "enum": [ "Crm_Implied_Customize_Zoho_CRM", "Crm_Implied_Create_Team_Module" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission denial.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the error status of the response.\nPossible values:\n**error** - The module creation request failed because the user lacks the required permission.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateModulesErrorResponsesNoPermission" } } }, "description": "No permission to create custom modules.\n**Resolution:** The CRM administrator must grant the required module-creation permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.CREATE" ] } ], "summary": "Create a custom module", "tags": [ "modules" ], "x-zoho-document": "modules" }, "put": { "description": "Updates existing modules in the CRM. Allows modification of module labels (`singular_label`, `plural_label`) and profile assignments. Supports batch updates of up to 100 modules per request. Returns 200 when all modules update successfully, or 207 Multi-Status when some succeed and others fail. Module `access_type` cannot be updated and must not be included in the request body. This operation is idempotent - submitting the same request multiple times produces the same result.", "operationId": "updateModules", "requestBody": { "content": { "application/json": { "examples": { "BatchUpdateMixedOperations": { "description": "Updates two modules in a single request. The first module adds admin profile and removes standard profile and the second module updates only labels without profile changes.", "summary": "Batch update with label changes and profile modifications", "value": { "modules": [ { "id": "111111000000263276", "plural_label": "CMUpdated", "profiles": [ { "id": "111111000000000497" }, { "_delete": null, "id": "111111000000000499" } ], "singular_label": "CMUpdated" }, { "id": "111111000000258973", "plural_label": "CM2Updated", "singular_label": "CM2Updated" } ] } }, "RemoveAndAddProfile": { "description": "Demonstrates removing an existing profile assignment (admin) and adding a new profile (standard) to a custom module while updating labels. The _delete field marks a profile for removal.", "summary": "Remove admin profile and add standard profile for a custom module", "value": { "modules": [ { "id": "111111000000263276", "plural_label": "CMUpdated", "profiles": [ { "_delete": null, "id": "111111000000000497" }, { "id": "111111000000000499" } ], "singular_label": "CMUpdated" } ] } }, "RemoveProfileOnly": { "description": "Removes admin profile access from a module without changing module labels. Use _delete field to mark profiles for removal.", "summary": "Remove profile access without updating labels", "value": { "modules": [ { "id": "111111000000002654", "profiles": [ { "_delete": null, "id": "111111000000000497" } ] } ] } }, "UpdateLabelsOnly": { "description": "Updates singular and plural labels for the Deals module without modifying profile assignments. Demonstrates that profile updates are optional when only label changes are needed.", "summary": "Update module labels without changing profiles", "value": { "modules": [ { "id": "111111000000002654", "plural_label": "DealsUpdated", "singular_label": "DealUpdated" } ] } } }, "schema": { "additionalProperties": false, "description": "Batch update request containing an array of module objects to update. Each module requires `id`; other fields are optional.", "properties": { "modules": { "description": "Array of module objects to update, with one to 100 unique entries. Each entry must include `id`; `singular_label`, `plural_label`, and `profiles` are optional.", "items": { "additionalProperties": false, "description": "Module update definition containing labels, module ID, and accessible profiles.", "properties": { "id": { "description": "Unique identifier of the module to update. Must be a valid existing module ID.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } }, "plural_label": { "description": "Plural display label for the module shown in the UI while referring to multiple records (for example, `Contacts` or `Deals`). Must contain only alphanumeric characters and underscores, with no consecutive underscores, and cannot be empty.", "maxLength": 50, "minLength": 1, "type": "string" }, "profiles": { "description": "Optional list of user profiles to add or remove from this module using delta semantics. Profiles without `_delete` are added; profiles with `_delete: null` are removed. Omit this to leave profile assignments unchanged.Each profile ID represents a permission set determining which users can view, create, edit, or delete records in this module.", "items": { "additionalProperties": false, "description": "Profile identifier object.", "properties": { "_delete": { "description": "Deletion marker. Set to `null` to remove this profile from the module's access list. Omit to add or retain the profile.", "type": "null" }, "id": { "description": "Unique numeric identifier of the user profile.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 203, "minItems": 1, "type": "array", "uniqueItems": true }, "singular_label": { "description": "Singular display label for the module shown in the UI while referring to a single record (for example, `Contact` or `Deal`). Must contain only alphanumeric characters and underscores, with no consecutive underscores, and cannot be empty.", "maxLength": 50, "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "modules" ], "type": "object" } } }, "description": "Request body for updating modules. Supports batch updates -\nmultiple modules can be updated in a single request. Partial updates\nare supported: only `id` is required; `singular_label`,\n`plural_label`, and `profiles` are optional and can be updated\nindependently. Profile updates use delta semantics: profiles without\n`_delete: null` are added (if not already present), profiles with\n`_delete: null` are removed. Batch updates may result in partial\nsuccess (207 Multi-Status response) if some modules succeed and others\nfail. access_type is not accepted in PUT request payload and cannot be\nchanged.\"", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "BatchSuccess": { "description": "200 response where all modules in the batch updated successfully, each returning a SUCCESS code and its module ID.", "summary": "All modules in the batch updated successfully", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000263276" }, "message": "module updated successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111111000000002654" }, "message": "module updated successfully", "status": "success" } ] } }, "SingleModuleSuccess": { "description": "200 response for a single-module batch update that completed successfully.", "summary": "Single module updated successfully", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000263276" }, "message": "the module name has been updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful batch update response containing one result object per updated module, each confirming the update with a `SUCCESS` code.", "properties": { "modules": { "description": "Array of success results for each updated module in the batch, preserving request order.", "items": { "additionalProperties": false, "description": "Successful module update result", "properties": { "code": { "description": "Returns `SUCCESS` when the module updates without error.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the successfully updated module, containing its unique identifier.", "properties": { "id": { "description": "Unique identifier of the module that was successfully updated.", "format": "int64", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Confirmation text returned when the module update succeeds.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Status indicator for successful operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "UpdateModulesResponseSuccess" } } }, "description": "All modules in the batch updated successfully. Each entry in the `modules` array confirms the update with a `SUCCESS` code and the module ID." }, "207": { "content": { "application/json": { "examples": { "PartialSuccessInvalidProfile": { "description": "207 Multi-Status response where one module updated successfully and another failed because the specified profile ID was invalid. Results preserve request order.", "summary": "Partial batch - one success, one invalid profile error", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000263276" }, "message": "module updated successfully", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.modules[1].profiles[0].id" }, "message": "Invalid profile id passed", "status": "error" } ] } }, "PartialSuccessLabelLength": { "description": "207 Multi-Status response where one module updated successfully and another failed because the plural label exceeded the maximum allowed length.", "summary": "Partial success - label length exceeded error for one module", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000263276" }, "message": "module updated successfully", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "plural_label", "json_path": "$.modules[1].plural_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "PartialSuccessMissingId": { "description": "207 Multi-Status response where one module updated successfully and another failed because the required `id` field was not provided.", "summary": "Partial success - first module succeeds, second fails with missing required ID", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000002654" }, "message": "module updated successfully", "status": "success" }, { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.modules[1]" }, "message": "required field not found", "status": "error" } ] } }, "PartialSuccessTeamModuleProfileUpdate": { "description": "207 Multi-Status response where one module updated successfully and another failed because profile updates are not supported for team-based modules.", "summary": "Partial success - profile update not allowed for team module", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000263276" }, "message": "module updated successfully", "status": "success" }, { "code": "NOT_ALLOWED", "details": { "api_name": "profiles", "json_path": "$.modules[1].profiles" }, "message": "profile update for team module is not allowed", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Multi-status batch update response containing one result object per module in the request. Results preserve request order and include both successful and failed updates.", "properties": { "modules": { "description": "Array of per-module results for each entry in the request, preserving request order. Each element is either a success or an error variant.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful module update result", "properties": { "code": { "description": "Success code indicating that module was updated", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Success details containing the updated module ID", "properties": { "id": { "description": "Unique identifier of the successfully updated module.", "format": "int64", "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Confirmation text returned for the module entry that succeeded.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `success`, indicating this module's update succeeded in the partial batch.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseSuccess" }, { "additionalProperties": false, "description": "Returned when a module update failed due to invalid data - type mismatch, unsupported enum value, or exceeded field length.", "properties": { "code": { "description": "Fixed value `INVALID_DATA`, indicating this module's update failed because the submitted data was invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Identifies a field that received a value of the wrong data type, including the API name, JSONPath, and expected type.", "properties": { "api_name": { "description": "API name of the field that received a value of an incorrect data type.", "maxLength": 50, "minLength": 1, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath locating the field in the request body that contained the incorrect data type.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidFieldValue" }, { "additionalProperties": false, "description": "Identifies a parameter whose submitted value is not among the supported enum values, with the parameter name, index, and accepted values.", "properties": { "index": { "description": "Zero-based index of the invalid parameter.", "format": "int32", "minimum": 0, "type": "integer" }, "param_name": { "description": "Name of the invalid parameter", "maxLength": 50, "minLength": 1, "type": "string" }, "supported_values": { "description": "List of valid values accepted for the parameter.", "items": { "description": "A valid value accepted for this parameter", "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidParameterValue" }, { "additionalProperties": false, "description": "Identifies a field whose submitted value exceeded the maximum allowed character length, with the API name, JSONPath, and the limit.", "properties": { "api_name": { "description": "API name of the field whose value exceeded the maximum allowed length.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath of the field in the request whose value exceeded the maximum allowed length.", "maxLength": 100, "minLength": 1, "type": "string" }, "maximum_length": { "description": "Maximum number of characters permitted for the field.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "ModulesPutResponseFieldLengthExceeded" } ], "description": "Represents the error details for the invalid field." }, "message": { "description": "Explanation of the validation failure for the module entry that contained invalid data.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the module update failed because the submitted data was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidData" }, { "additionalProperties": false, "description": "Returned when a module update failed because a mandatory field was absent from the request.", "properties": { "code": { "description": "Fixed value `MANDATORY_NOT_FOUND`, indicating the module update failed because a required field was absent from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying the required field that was missing, including its API name and JSONPath location.", "properties": { "api_name": { "description": "API name of the required field that was not provided in the request.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location in the request where the required field was expected.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explanation of the missing required field that caused the module entry to fail.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the module update failed because a mandatory field was missing.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseMandatoryNotFound" }, { "additionalProperties": false, "description": "Returned when a module update failed because the request attempted to modify a restricted or immutable field.", "properties": { "code": { "description": "Fixed value `NOT_ALLOWED`, indicating the module update failed because the request attempted to modify a field that cannot be changed.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying the restricted field that was included in the request, by API name and JSONPath.", "properties": { "api_name": { "description": "API name of the field whose update is not permitted.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location of the restricted field in the request.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explanation of the disallowed field modification that caused the module entry to be rejected, identifying which field cannot be changed.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the module update failed because a disallowed field modification was attempted.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseNotAllowed207" }, { "additionalProperties": false, "description": "Returned when a module update failed because the referenced module does not exist, the ID is invalid, or the operation is unsupported for this module type.", "properties": { "code": { "description": "Fixed value `INVALID_MODULE`, indicating the module reference is invalid, does not exist, or the operation is not supported for this module type.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying the field or reference that caused the invalid-module error, by API name and JSONPath.", "properties": { "api_name": { "description": "API name of the field or reference associated with the invalid module.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath to the invalid module reference in the request.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explanation of why the module identifier was not recognized or could not be updated.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the module update failed because the module reference is invalid or the operation is unsupported for this module type.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidModuleTeam" } ], "description": "Represents a single per-module result entry, which is either a success result or an error result." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "UpdateModulesResponseMultiStatus" } } }, "description": "Multi-Status - partial success. Returned when batch update contains both successful and failed module updates. Response includes individual status for each module in the request." }, "400": { "content": { "application/json": { "examples": { "AccessTypeUpdateNotAllowed": { "description": "400 error when attempting to update access_type in PUT request. access_type is immutable after module creation and cannot be changed.", "summary": "Attempt to update access_type rejected", "value": { "modules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "access_type", "json_path": "$.modules[0].access_type" }, "message": "access type update not allowed", "status": "error" } ] } }, "InvalidModuleId": { "description": "400 error response when the request references a module ID that does not exist in the CRM.", "summary": "Module ID does not exist", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.modules[0].id" }, "message": "the module id given seems to be invalid", "status": "error" } ] } }, "InvalidProfileId": { "description": "400 error response when the request includes a profile ID that does not exist or is invalid.", "summary": "Profile ID does not exist", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.modules[0].profiles[0].id" }, "message": "Invalid profile id passed", "status": "error" } ] } }, "LabelLengthExceeded": { "description": "400 error response when a module label value exceeds the maximum allowed character length of 50.", "summary": "Module label exceeds maximum length", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "singular_label", "json_path": "$.modules[0].singular_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "MissingRequiredId": { "description": "400 error response when a module object in the request does not include the required `id` field.", "summary": "Required module ID is missing", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.modules[0].id" }, "message": "required data not found", "status": "error" } ] } }, "ModuleRenameNotAllowed": { "description": "400 error response when the request attempts to rename a module that does not support label changes.", "summary": "Module rename not allowed", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.modules[0].id" }, "message": "Module rename not allowed", "status": "error" } ] } }, "TeamModuleProfileUpdateNotAllowed": { "description": "400 error response when the request attempts to update profiles on a team-based module, which does not support profile assignments.", "summary": "Profile update not allowed for team-based module", "value": { "modules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profiles", "json_path": "$.modules[0].profiles" }, "message": "profile update for team module is not allowed", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Validation error response for batch update failures. Returned when all modules in the request fail validation. No modules are updated when this error occurs.", "properties": { "modules": { "description": "Error result objects for each module in the request, preserving request order. Present when all modules fail validation.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Returned when a module update failed because the module ID is invalid, the module does not exist (INVALID_MODULE), or a field value is invalid (INVALID_DATA).", "properties": { "code": { "description": "`INVALID_MODULE` indicates the module ID does not exist or is invalid; `INVALID_DATA` indicates a field value in the module payload is invalid.", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Identifies the invalid field or module reference by its API name and JSONPath location within the request.", "properties": { "api_name": { "description": "API name of the field or module reference that failed validation.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath to the invalid field or module reference in the request.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidFieldModule" }, { "additionalProperties": false, "description": "Identifies the invalid module by its zero-based position in the request array.", "properties": { "resource_path_index": { "description": "Zero-based index of the invalid module in the request array.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "ModulesPutResponseResourcePathIndex" } ], "description": "Represents the error details about the invalid module reference." }, "message": { "description": "Explanation of the validation error that caused the entire batch request to fail.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating this module update failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidModule" }, { "additionalProperties": false, "description": "Returned when a module update failed because the submitted data was invalid - type mismatch, unsupported enum value, or value exceeding the length limit.", "properties": { "code": { "description": "Fixed value `INVALID_DATA`, indicating the module update failed because the submitted data was invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Identifies a parameter whose submitted value is not among the supported enum values, with the parameter name, index, and accepted values.", "properties": { "index": { "description": "Zero-based position of the invalid value within the parameter array.", "format": "int32", "minimum": 0, "type": "integer" }, "param_name": { "description": "Name of the parameter whose submitted value is not among the supported values.", "maxLength": 50, "minLength": 1, "type": "string" }, "supported_values": { "description": "List of valid values accepted for the parameter", "items": { "description": "A valid value accepted for this parameter", "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidFieldValue400" }, { "additionalProperties": false, "description": "Identifies a field whose submitted value exceeded the maximum allowed character length, with the API name, JSONPath, and the limit.", "properties": { "api_name": { "description": "API name of the field whose submitted value exceeded the maximum allowed character length.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath to the field whose value exceeded the maximum allowed length.", "maxLength": 100, "minLength": 1, "type": "string" }, "maximum_length": { "description": "Maximum number of characters permitted for the field.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ModulesPutResponseFieldLengthExceeded400" }, { "additionalProperties": false, "description": "Identifies a field containing an invalid value by its API name and JSONPath location.", "properties": { "api_name": { "description": "API name of the field that contains an invalid value.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath to the field that contains an invalid value.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidFieldValueGeneric" } ], "description": "Represents the error details for the invalid field." }, "message": { "description": "Explanation of the error for the specific module entry that triggered the batch failure.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating this module update failed because the submitted data was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidData400" }, { "additionalProperties": false, "description": "Returned when a module update failed because the operation is not supported for this module type or is restricted for system modules.", "properties": { "code": { "description": "Fixed value `NOT_SUPPORTED`, indicating this module update failed because the operation is not supported for this module type or is restricted for system modules.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context for the NOT_SUPPORTED error. Typically an empty object when no supplemental detail is available.", "type": "object" }, "message": { "description": "Explanation of why the operation is not supported for this module type or is restricted for system modules.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating this module update failed because the operation is not supported.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseNotSupported" }, { "additionalProperties": false, "description": "Returned when a module update failed because required fields expected in the request were absent.", "properties": { "code": { "description": "Fixed value `EXPECTED_FIELD_MISSING`, indicating required fields were expected in the request but not found.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details listing the fields that were expected but absent, each identified by API name and JSONPath.", "properties": { "expected_fields": { "description": "Fields that were expected in the request but missing, each identified by its API name and JSONPath location.", "items": { "additionalProperties": false, "description": "One expected but missing field, identified by its API name and JSONPath location.", "properties": { "api_name": { "description": "API name of the field that was expected in the request but absent.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location in the request where the expected field was absent.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Explanation of the expected fields that were absent from the request, causing the module entry to be rejected.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the update failed because expected fields were missing from the request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseExpectedFieldMissing" }, { "additionalProperties": false, "description": "Returned when a module update failed because the request attempted to modify a restricted or immutable field.", "properties": { "code": { "description": "Fixed value `NOT_ALLOWED`, indicating the update failed because the request attempted to modify a field that cannot be changed.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying the restricted field that was included in the request, by API name and JSONPath.", "properties": { "api_name": { "description": "API name of the field whose update is not permitted.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location of the restricted field in the request.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explanation of the immutable field violation that caused the module entry to fail.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the update failed because a disallowed field modification was attempted.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseNotAllowed" }, { "additionalProperties": false, "description": "Returned when a module update failed because a mandatory field was absent from the request.", "properties": { "code": { "description": "Fixed value `MANDATORY_NOT_FOUND`, indicating the update failed because a required field was not provided in the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying the required field that was absent from the request, by API name and JSONPath.", "properties": { "api_name": { "description": "API name of the required field that was not provided.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location in the request body where the missing mandatory field was expected.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explanation of the mandatory field that was missing from the request, causing the module update to fail.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the update failed because a mandatory field was not provided.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseMandatoryNotFound400" }, { "additionalProperties": false, "description": "Returned when a module update failed because a field required by the presence of another field was absent from the request.", "properties": { "code": { "description": "Fixed value `DEPENDENT_FIELD_MISSING`, indicating a field required by the presence of another field was absent from the request.", "enum": [ "DEPENDENT_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details identifying both the missing dependent field relationship.", "properties": { "api_name": { "description": "API name of the dependent field that was absent from the request.", "maxLength": 50, "minLength": 1, "type": "string" }, "dependee": { "additionalProperties": false, "description": "The field that requires the dependent field to be present", "properties": { "api_name": { "description": "API name of the field that requires the dependent field.", "maxLength": 50, "minLength": 1, "type": "string" }, "json_path": { "description": "JSONPath location of the field that requires the dependent field.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSONPath location in the request where the dependent field was expected.", "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "api_name", "json_path", "dependee" ], "type": "object" }, "message": { "description": "Explanation of the dependent field relationship that was violated, identifying which field was missing and which field required its presence.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the module update failed due to a missing dependent field.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseDependentFieldMissing" }, { "additionalProperties": false, "description": "Returned when a module update failed because the request used an API version below the minimum required version.", "properties": { "code": { "description": "Fixed value `API_NOT_SUPPORTED`, indicating the request used an API version below the minimum required for this operation.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object indicating the minimum supported API version for this operation.", "properties": { "supported_version": { "description": "Minimum API version number required to perform this operation.", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "supported_version" ], "type": "object" }, "message": { "description": "Explanation of the API version requirement that the request failed to meet, including the minimum supported version.", "maxLength": 1000, "minLength": 1, "type": "string" }, "status": { "description": "Fixed value `error`, indicating the module update failed because the API version is not supported.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseApiNotSupported" } ], "description": "Represents a single per-module error result." }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "UpdateModulesResponseInvalid" } } }, "description": "Bad request - validation failure. Returned when input data fails validation (invalid module ID, unsupported field values, field length exceeded, missing required fields, attempting unsupported operations on system modules, attempting to update immutable fields such as access_type, or attempting to update profiles for a team-based module). No modules are updated when this error occurs." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.UPDATE" ] } ], "summary": "Update CRM modules", "tags": [ "modules" ], "x-zoho-document": "modules" } }, "/crm/v8/settings/modules/{moduleIdentifier}": { "get": { "description": "Retrieves complete metadata for a specific CRM module identified by its API name, including fields, layouts, profiles, related lists, and feature capabilities. Returns 204 when the module is not available through this endpoint, or 400 when the identifier is invalid or the module is unsupported", "operationId": "getModuleByApiName", "parameters": [ { "$ref": "#/components/parameters/ModuleIdentifier" }, { "$ref": "#/components/parameters/ModulesParamQueryFields" }, { "$ref": "#/components/parameters/ModulesIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "CustomModuleTeamBased": { "description": "User-created module with team-based access control, a private profile, and restricted visibility configured", "summary": "Custom module with team-based access", "value": { "modules": [ { "$on_demand_properties": [ "$blocked_reason" ], "$properties": [ "$approval_state", "$wizard_connection_path", "$cpq_executions", "$currency_symbol", "$review", "$review_process", "$approval", "$in_merge", "$process_flow", "$orchestration", "$pathfinder", "$zia_visions", "$editable", "$field_states", "$sharing_permission" ], "access_type": "team_based", "actual_plural_label": "sdfvg", "actual_singular_label": "sdfvgdfvsg", "api_name": "sdfvg", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "business_card_fields": [ { "api_name": "Name", "id": "111111000000268938" }, { "api_name": "Owner", "id": "111111000000268940" }, { "api_name": "Email", "id": "111111000000268942" }, { "api_name": "Modified_By", "id": "111111000000268948" } ], "chart_view_supported": true, "convertable": false, "creatable": true, "custom_view": { "access_type": "public", "category": "public_views", "created_by": null, "created_time": null, "criteria": null, "default": true, "display_value": "All sdfvg", "favorite": null, "fields": [ { "_pin": false, "api_name": "Name", "id": "111111000000268938" }, { "_pin": false, "api_name": "Email", "id": "111111000000268942" }, { "_pin": false, "api_name": "Owner", "id": "111111000000268940" }, { "_pin": false, "api_name": "Modified_Time", "id": "111111000000268952" } ], "id": "111111000000268908", "last_accessed_time": null, "locked": false, "modified_by": null, "modified_time": null, "module": { "api_name": "sdfvg", "id": "111111000000268896" }, "name": "CustomModule Default CustomView", "shared_to": null, "sort_by": null, "sort_order": null, "system_defined": true, "system_name": "ALLVIEWS", "wrap_text": true }, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "custom", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000268896", "isBlueprintSupported": true, "kanban_view_supported": true, "layouts": [ { "display_label": "Standard", "generated_type": "system", "id": "111111000000268895", "name": "Standard", "profiles": [ { "_default_assignment_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000501", "name": "Admins" }, { "_default_assignment_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000503", "name": "Managers" }, { "_default_assignment_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000505", "name": "Members" }, { "_default_assignment_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000507", "name": "Participants" }, { "_default_assignment_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "_default_view": { "id": "111111000000268895", "name": "Standard", "type": "layout" }, "default": true, "id": "111111000000000509", "name": "Requesters" } ], "source": "crm", "status": "active" } ], "lookup_field_properties": { "fields": [ { "api_name": "Name", "id": "111111000000268938", "sequence_number": 1 }, { "api_name": "Email", "id": "111111000000268942", "sequence_number": 2 }, { "api_name": "Owner", "id": "111111000000268940", "sequence_number": 3 }, { "api_name": "Modified_Time", "id": "111111000000268952", "sequence_number": 4 } ] }, "lookupable": true, "modified_by": { "id": "111111000000057804", "name": "12345FIRST1234567890123456789012345678901234567890 123456LAST0987654321123456789009876543211234567890" }, "modified_time": "2025-11-21T12:12:26+05:30", "module_name": "CustomModule3", "parent_module": {}, "per_page": 10, "plural_label": "sdfvg", "presence_sub_menu": true, "private_profile": { "id": "111111000000000501", "name": "Admins" }, "profile_count": 5, "profiles": [ { "id": "111111000000000501", "name": "Admins" }, { "id": "111111000000000503", "name": "Managers" }, { "id": "111111000000000505", "name": "Members" }, { "id": "111111000000000507", "name": "Participants" }, { "id": "111111000000000509", "name": "Requesters" } ], "public_fields_configured": false, "quick_create": true, "recycle_bin_on_delete": true, "related_lists": [ { "action": null, "api_name": "Notes", "customize_display_label": false, "customize_fields": true, "customize_sort": true, "display_label": "Notes", "href": "sdfvg/{ENTITYID}/Notes", "id": "111111000000270034", "module": { "api_name": "Notes", "id": "111111000000002676" }, "name": "Notes", "personality_name": "NOTESPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": false, "delete": false, "disassociate": false, "edit": false }, "sequence_number": "1", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Attachments", "customize_display_label": false, "customize_fields": false, "customize_sort": true, "display_label": "Attachments", "href": "sdfvg/{ENTITYID}/Attachments", "id": "111111000000270036", "module": { "api_name": "Attachments", "id": "111111000000000011" }, "name": "Attachments", "personality_name": "ATTACHMENTSPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": false, "delete": false, "disassociate": false, "edit": false }, "sequence_number": "2", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Emails", "customize_display_label": false, "customize_fields": false, "customize_sort": true, "display_label": "Emails", "href": null, "id": "111111000000270038", "module": { "api_name": "Emails", "id": "111111000000002772" }, "name": "Emails", "personality_name": "EMAILSPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": false, "delete": false, "disassociate": false, "edit": false }, "sequence_number": "3", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Tasks", "customize_display_label": false, "customize_fields": true, "customize_sort": true, "display_label": "Open Tasks", "href": "sdfvg/{ENTITYID}/Tasks", "id": "111111000000270044", "module": { "api_name": "Tasks", "id": "111111000000002670" }, "name": "Tasks", "personality_name": "TASKSPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "6", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Events", "customize_display_label": false, "customize_fields": true, "customize_sort": true, "display_label": "Open Meetings", "href": "sdfvg/{ENTITYID}/Events", "id": "111111000000270048", "module": { "api_name": "Events", "id": "111111000000002672" }, "name": "Events", "personality_name": "EVENTSPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "7", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Calls", "customize_display_label": false, "customize_fields": true, "customize_sort": true, "display_label": "Open Calls", "href": "sdfvg/{ENTITYID}/Calls", "id": "111111000000270046", "module": { "api_name": "Calls", "id": "111111000000002674" }, "name": "Calls", "personality_name": "CALLSPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "8", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Tasks_History", "customize_display_label": false, "customize_fields": true, "customize_sort": true, "display_label": "Closed Tasks", "href": "sdfvg/{ENTITYID}/Tasks_History", "id": "111111000000270052", "module": { "api_name": "Tasks", "id": "111111000000002670" }, "name": "Tasks History", "personality_name": "TASKSHISTORYPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "9", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Events_History", "customize_display_label": false, "customize_fields": true, "customize_sort": true, "display_label": "Closed Meetings", "href": "sdfvg/{ENTITYID}/Events_History", "id": "111111000000270056", "module": { "api_name": "Events", "id": "111111000000002672" }, "name": "Events History", "personality_name": "EVENTSHISTORYPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "10", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Calls_History", "customize_display_label": false, "customize_fields": true, "customize_sort": true, "display_label": "Closed Calls", "href": "sdfvg/{ENTITYID}/Calls_History", "id": "111111000000270054", "module": { "api_name": "Calls", "id": "111111000000002674" }, "name": "Calls History", "personality_name": "CALLSHISTORYPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "11", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "CheckLists", "customize_display_label": false, "customize_fields": false, "customize_sort": false, "display_label": "Checklists", "href": "sdfvg/{ENTITYID}/CheckLists", "id": "111111000000270060", "module": { "api_name": "CheckLists", "id": "111111000000002692" }, "name": "CheckLists", "personality_name": "CHECKLISTSPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": false, "delete": false, "disassociate": false, "edit": false }, "sequence_number": "12", "status": "visible", "type": "default", "visibility": 10 }, { "action": null, "api_name": "Activities_Chronological_View", "customize_display_label": true, "customize_fields": true, "customize_sort": true, "display_label": "ChronologicalView", "href": null, "id": "111111000000270050", "module": null, "name": "ChronologicalView", "parent_related_lists": null, "personality_name": "CHRONOLOGICALVIEWPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "13", "status": "visible", "type": "grouped", "visibility": 10 }, { "action": null, "api_name": "Activities_Chronological_View_History", "customize_display_label": true, "customize_fields": true, "customize_sort": true, "display_label": "ChronologicalView History", "href": null, "id": "111111000000270058", "module": null, "name": "ChronologicalView History", "parent_related_lists": null, "personality_name": "CHRONOLOGICALVIEWHISTORYPERSONALITY", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": false, "disassociate": false, "edit": true }, "sequence_number": "14", "status": "visible", "type": "grouped", "visibility": 10 } ], "sequence_number": 125, "singular_label": "sdfvgdfvsg", "source": "crm", "status": "visible", "sub_menu_available": true, "viewable": true, "visibility": 1, "web_link": null } ] } }, "FieldTrackerModule": { "description": "Picklist history tracking module with a parent module reference and user-hidden visibility status", "summary": "Field tracker module", "value": { "modules": [ { "access_type": "org_based", "actual_plural_label": "Pick List 1 History", "actual_singular_label": "Pick List 1 History", "api_name": "Pick_List_1_History", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": false, "deletable": false, "description": null, "editable": false, "feeds_required": false, "generated_type": "field_tracker", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000271197", "isBlueprintSupported": false, "lookupable": false, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-21T16:47:22+05:30", "module_name": "LinkingModule3", "parent_module": { "api_name": "CM", "id": "111111000000257585" }, "plural_label": "Pick List 1 History", "presence_sub_menu": false, "private_profile": null, "profile_count": 1, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": true, "sequence_number": 126, "show_as_tab": false, "singular_label": "Pick List 1 History", "status": "user_hidden", "sub_menu_available": false, "track_current_data": true, "viewable": true, "visibility": 2 } ] } }, "LeadsModule": { "description": "Leads module response with full CRUD operations, org-based access control, and lead-to-contact conversion capability enabled", "summary": "Standard CRM module - Leads", "value": { "modules": [ { "$field_states": [ "convert_scheduler" ], "$on_demand_properties": [ "$blocked_reason" ], "$properties": [ "$approval_state", "$wizard_connection_path", "$converted_detail", "$cpq_executions", "$currency_symbol", "$zia_owner_assignment", "$review", "$review_process", "$approval", "$in_merge", "$process_flow", "$orchestration", "$pathfinder", "$stop_processing", "$data_source_details", "$zia_visions", "$layout_id", "$editable", "$field_states", "$locked_for_me", "$sharing_permission" ], "access_type": "org_based", "activity_badge": "Enabled", "actual_plural_label": "Leads", "actual_singular_label": "Lead", "api_name": "Leads", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "chart_view": false, "chart_view_supported": true, "convertable": true, "creatable": true, "custom_view": { "access_type": "public", "category": "public_views", "created_by": null, "created_time": null, "criteria": { "comparator": "equal", "field": { "api_name": "Converted__s", "id": "111111000000004906" }, "type": "value", "value": false }, "default": true, "display_value": "All Leads", "favorite": null, "fields": [ { "_pin": false, "api_name": "Full_Name", "id": "111111000000004814" }, { "_pin": false, "api_name": "Company", "id": "111111000000004808" }, { "_pin": false, "api_name": "Email", "id": "111111000000004818" }, { "_pin": false, "api_name": "Phone", "id": "111111000000004820" }, { "_pin": false, "api_name": "Lead_Source", "id": "111111000000004828" }, { "_pin": false, "api_name": "Owner", "id": "111111000000004806" } ], "id": "111111000000051262", "last_accessed_time": "2025-11-24T16:47:11+05:30", "locked": false, "modified_by": null, "modified_time": null, "name": "All Open Leads", "shared_to": null, "sort_by": null, "sort_order": null, "system_defined": true, "system_name": "ALLVIEWS" }, "deletable": true, "description": null, "display_field": "Full_Name", "editable": true, "feeds_required": false, "filter_status": true, "generated_type": "default", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000002648", "isBlueprintSupported": true, "kanban_view": false, "kanban_view_supported": true, "lookup_field_properties": { "fields": [ { "api_name": "Full_Name", "id": "111111000000004814", "sequence_number": 1 }, { "api_name": "Company", "id": "111111000000004808", "sequence_number": 2 }, { "api_name": "Email", "id": "111111000000004818", "sequence_number": 3 }, { "api_name": "Phone", "id": "111111000000004820", "sequence_number": 4 }, { "api_name": "Lead_Source", "id": "111111000000004828", "sequence_number": 5 }, { "api_name": "Owner", "id": "111111000000004806", "sequence_number": 6 } ] }, "lookupable": true, "masked_fields_count": 0, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-12-18T16:00:57+05:30", "module_name": "Leads", "parent_module": {}, "per_page": 50, "plural_label": "Leads", "presence_sub_menu": true, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" }, { "id": "111111000000000499", "name": "Standard" }, { "id": "111111000000236122", "name": "test" }, { "id": "111111000000263146", "name": "Team User" } ], "public_fields_configured": true, "quick_create": true, "recycle_bin_on_delete": true, "related_list_properties": { "fields": [ "Full_Name", "Company", "Email", "Lead_Source", "Lead_Status", "Phone" ], "sort_by": null, "sort_order": null }, "search_layout_fields": [ "Owner", "Company", "Email", "Phone", "Lead_Source", "Full_Name" ], "sequence_number": 2, "show_as_tab": true, "show_emailparser": true, "show_googlesync": true, "show_social": true, "show_visitor": true, "show_webform": true, "showfacebooksync": true, "showleadchainsync": true, "showlinkedinsync": true, "showtiktoksync": true, "singular_label": "Lead", "status": "visible", "sub_menu_available": true, "viewable": true, "visibility": 1, "web_link": null } ] } }, "ModuleWithTerritory": { "description": "Contacts module response with territory assignment enabled, showing territory-related flags alongside standard module metadata", "summary": "Module with territory assignment", "value": { "modules": [ { "access_type": "org_based", "actual_plural_label": "Contacts", "actual_singular_label": "Contact", "api_name": "Contacts", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": true, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "default", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000002650", "isBlueprintSupported": true, "lookupable": true, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-05T12:27:24+05:30", "module_name": "Contacts", "parent_module": {}, "plural_label": "Contacts", "presence_sub_menu": true, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" }, { "id": "111111000000000499", "name": "Standard" } ], "public_fields_configured": false, "quick_create": true, "recycle_bin_on_delete": true, "sequence_number": 3, "show_as_tab": true, "singular_label": "Contact", "status": "visible", "sub_menu_available": true, "territory": { "id": "0", "name": "All Territories", "subordinates": false }, "viewable": true, "visibility": 1 } ] } }, "StaticSubformModule": { "description": "Subform module response with a parent module reference, static field configuration, and web UI visibility disabled", "summary": "Static subform module", "value": { "modules": [ { "access_type": "org_based", "actual_plural_label": "Subform 2", "actual_singular_label": "Subform 2", "api_name": "Subform_2", "api_supported": true, "arguments": [], "business_card_field_limit": 5, "convertable": false, "creatable": true, "deletable": true, "description": null, "editable": true, "feeds_required": false, "generated_type": "static_subform", "global_search_supported": true, "has_more_profiles": false, "id": "111111000000270418", "isBlueprintSupported": false, "lookupable": false, "modified_by": { "id": "111111000000057804", "name": "Rajaa" }, "modified_time": "2025-11-21T15:10:43+05:30", "module_name": "LinkingModule2", "parent_module": { "api_name": "CM", "id": "111111000000257585" }, "plural_label": "Subform 2", "presence_sub_menu": false, "private_profile": null, "profile_count": 4, "profiles": [ { "id": "111111000000000497", "name": "Administrator" } ], "public_fields_configured": false, "quick_create": false, "recycle_bin_on_delete": true, "sequence_number": 25, "show_as_tab": false, "singular_label": "Subform 2", "static_subform_properties": { "fields": [ { "api_name": "Pick_List_1", "id": "111111000000271161" } ] }, "status": "visible", "sub_menu_available": false, "viewable": true, "visibility": 2 } ] } } }, "schema": { "additionalProperties": false, "description": "Complete configuration metadata for a single CRM module, including its fields, layouts, profiles, related lists, and supported capabilities", "properties": { "modules": { "description": "Array of module metadata objects returned for the specified API name. Contains at most one element, as each API name maps to a single module.", "items": { "additionalProperties": false, "description": "Complete metadata for a CRM module including configuration, capabilities, fields, layouts, profiles, and related lists.", "properties": { "$field_states": { "description": "Nullable array of field-state identifiers (up to 1 entry, max 20 characters each) that govern dynamic field visibility and validation rules within this module.", "items": { "description": "Field state identifier", "maxLength": 20, "type": "string" }, "maxItems": 1, "type": [ "array", "null" ] }, "$on_demand_properties": { "description": "Nullable array of string identifiers (up to 100, max 50 chars each) for module properties that are loaded on-demand rather than included in the default response.", "items": { "description": "Name of an on-demand property that can be requested explicitly.", "maxLength": 50, "type": "string" }, "maxItems": 100, "type": [ "array", "null" ] }, "$others_awaiting": { "description": "True when other users are awaiting action on records in this module. Exposed only for the Approvals module.", "type": "boolean" }, "$properties": { "description": "Nullable array of extended property objects (up to 50) representing additional module capabilities; each item is either a string property name or an object with arbitrary key-value pairs.", "items": { "anyOf": [ { "description": "Property name identifier", "maxLength": 50, "type": "string", "x-zs-$id": "ModulesPropertyNameIdentifier" }, { "additionalProperties": true, "description": "Extended property object containing additional module metadata", "type": "object", "x-zs-$id": "ModulesPutResponseExtendedPropertyObject" } ], "description": "Represents a module capability or property flag name." }, "maxItems": 50, "type": [ "array", "null" ] }, "access_type": { "description": "Access control scope for the module. Possible values: org_based - organization-wide access; team_based - team-specific access. Immutable after module creation; cannot be changed via PUT.", "enum": [ "org_based", "team_based" ], "type": "string" }, "activity_badge": { "description": "Activity badge status for the module. Possible values: Enabled - badge is active; Not_Supported - module does not support activity badges; Disabled - badge is inactive.", "enum": [ "Enabled", "Not_Supported", "Disabled" ], "type": "string" }, "actual_plural_label": { "description": "System-level plural label for the module as stored in the database, representing the untranslated base value. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "actual_singular_label": { "description": "System-level singular label for the module as stored in the database, representing the untranslated base value. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "api_name": { "description": "Case-sensitive API name used to reference this module in API requests (e.g., 'Leads', 'Contacts', 'CustomModule1').", "maxLength": 50, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "api_supported": { "description": "True when the module is accessible via the Zoho CRM API; false for modules that are not externally queryable through API endpoints.", "type": "boolean" }, "arguments": { "description": "Array of argument objects (up to 10) used to substitute dynamic parameters in web tab URLs (e.g., https://...&id=${Users.User Id}&name=${Users.First Name}). Duplicates are allowed and order is preserved for multi-occurrence parameters; empty for non-web-tab modules.", "items": { "additionalProperties": false, "description": "Argument object containing name-value pair for URL parameter substitution", "properties": { "name": { "description": "Key name of the URL argument used as a placeholder in the web tab URL template. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "value": { "description": "Field substitution reference expression resolving to a CRM field value at runtime (e.g., users.recordId). Maximum 100 characters.", "maxLength": 100, "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "maxItems": 10, "type": "array", "uniqueItems": false }, "business_card_field_limit": { "description": "Maximum number of fields allowed in the business card view for this module. Non-negative integer; 0 means no fields are configured.", "format": "int32", "minimum": 0, "type": "integer" }, "business_card_fields": { "description": "Fields displayed in the business card view (up to 15). Present only when 'business_card_fields' is included in the include parameter. Can be empty array, array of objects with api_name and id, or array of string API names.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Field reference with API name and unique identifier", "properties": { "api_name": { "description": "API name of the field", "maxLength": 50, "type": "string" }, "id": { "description": "Unique identifier of the field", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "BusinessCardFieldObjectResponse" }, { "description": "Field API name", "maxLength": 50, "type": "string", "x-zs-$id": "BusinessCardFieldStringResponse" } ], "description": "Represents a field reference in the business card view." }, "maxItems": 15, "type": "array" }, "cc_enabled": { "description": "True when CommandCenter (workflow orchestration) is enabled for this module; false when not configured or unsupported.", "type": "boolean" }, "chart_view": { "description": "True when chart view is currently enabled for this module. Distinct from chart_view_supported, which reflects capability.", "type": "boolean" }, "chart_view_supported": { "description": "True when the module's data structure supports chart visualization. A false value means chart view cannot be enabled regardless of settings.", "type": "boolean" }, "convertable": { "description": "True when records in this module can be converted to records in another module (e.g., Leads to Contacts/Accounts).", "type": "boolean" }, "creatable": { "description": "True when new records can be created in this module; false for read-only modules such as analytics or configuration entities.", "type": "boolean" }, "custom_view": { "additionalProperties": false, "description": "Default custom view configuration for the module, including filter criteria, display fields, sort settings, and sharing options. Exposed only when 'custom_view' is included in the include parameter.", "properties": { "$modified_criteria": { "description": "True when the filter criteria of this custom view have been modified from their original configuration.", "type": "boolean" }, "access_type": { "description": "Access scope for the custom view, determining visibility to other users (e.g., private, shared with all, shared with roles).", "enum": [ "shared", "public", "only_to_me" ], "type": "string" }, "category": { "description": "Integer code representing the sharing category of the custom view (e.g., private, shared_with_everyone, shared_with_roles).", "enum": [ "created_by_me", "shared_with_me", "public_views" ], "type": "string" }, "created_by": { "additionalProperties": false, "description": "User object identifying who created this custom view, containing id and name. Null for system-generated views.", "properties": { "id": { "description": "Unique numeric identifier (as string) of the CRM user who created this custom view.", "format": "int64", "type": "string" }, "name": { "description": "Display name of the CRM user who created this custom view. Maximum 101 characters.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "created_time": { "description": "ISO 8601 datetime when the custom view was created, including timezone offset (e.g., 2025-11-20T14:30:00+05:30). Null for system views.", "format": "date-time", "type": [ "string", "null" ] }, "criteria": { "anyOf": [ { "additionalProperties": false, "description": "Single filter criterion defining a field comparison condition.", "properties": { "comparator": { "description": "Comparison operator used for filtering (e.g., equal, contains, greater_than, less_than).", "maxLength": 15, "type": "string" }, "field": { "additionalProperties": false, "description": "Field reference specifying which field to filter on.", "properties": { "api_name": { "description": "API name of the field to filter.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique identifier of the field.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "type of the field being filtered.", "maxLength": 50, "type": "string" }, "value": { "description": "Filter value to compare against. Can be boolean, string, number, object, array, or null depending on field type and comparator." } }, "required": [ "comparator", "field", "type", "value" ], "type": "object", "x-zs-$id": "ModulesPutResponseCriteriaObject" }, { "description": "No filter criteria applied.", "type": "null", "x-zs-$id": "ModulesPutResponseCriteriaNull" } ], "description": "Represents the filter criteria applied to this Custom View." }, "cross_filters": { "description": "Array of cross-module filter objects enabling advanced filtering based on related module conditions (e.g., filter Contacts by associated Deals criteria).", "items": { "additionalProperties": true, "description": "Cross-filter criterion object defining filtering logic for related modules.", "type": "object" }, "maxItems": 3, "minItems": 1, "type": "array" }, "default": { "description": "True when this custom view is the default view loaded for the module; only one view per module can be the default.", "type": "boolean" }, "display_value": { "description": "Human-readable label for the custom view as displayed in the CRM UI. Maximum 100 characters.", "maxLength": 100, "type": "string" }, "favorite": { "description": "Numeric ranking position of this view in the user's favorites list. Null when the view has not been marked as a favorite.", "format": "int32", "type": [ "integer", "null" ] }, "fields": { "description": "Ordered list of field objects to display as columns in this custom view, each identified by api_name and id.", "items": { "additionalProperties": false, "description": "Field configuration specifying which field to show and display settings.", "properties": { "_pin": { "description": "True when this field column is pinned in the custom view, keeping it visible during horizontal scrolling.", "type": "boolean" }, "api_name": { "description": "API name of the field displayed as this view column. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the field displayed as this view column.", "format": "int64", "type": "string" } }, "required": [ "id", "api_name", "_pin" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "id": { "description": "Unique numeric identifier (as string) for this custom view.", "format": "int64", "type": "string" }, "last_accessed_time": { "description": "ISO 8601 datetime when this view was last accessed, including timezone offset. Null if never accessed after creation.", "format": "date-time", "type": [ "string", "null" ] }, "locked": { "default": false, "description": "True when the view is locked by an administrator; locked views cannot be modified or deleted by regular users.", "type": [ "boolean", "null" ] }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "User who last modified this custom view. Null for system views that have never been modified.", "properties": { "id": { "description": "Unique identifier of the user who modified the custom view.", "format": "int64", "type": "string" }, "name": { "description": "Name of the user who modified the custom view.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "CustomViewModifiedByObjectResponse" }, { "description": "Indicates that has never been modified.", "type": "null", "x-zs-$id": "CustomViewModifiedByNullResponse" } ], "description": "Represents the user who last modified this Custom View." }, "modified_time": { "anyOf": [ { "description": "Timestamp when layout was last modified in ISO 8601 format with timezone offset. Null if never modified.", "format": "date-time", "type": "string", "x-zs-$id": "CustomViewModifiedTimeStringResponse" }, { "description": "Indicates that has never been modified.", "type": "null", "x-zs-$id": "CustomViewModifiedTimeNullResponse" } ], "description": "Represents the timestamp when this Custom View was last modified, in ISO 8601 format." }, "module": { "additionalProperties": false, "description": "Reference object identifying the module to which this custom view belongs, containing the module's unique identifier and API name. This is exposed only for client calls.", "properties": { "api_name": { "description": "API name of the module this custom view belongs to. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the module this custom view belongs to.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "System name identifier for the custom view, distinct from display_value. Maximum 50 characters.", "maxLength": 100, "type": "string" }, "offline": { "description": "True when this view is available for offline access in Zoho CRM mobile applications. Only exposed for crmmobile and routeiq services.", "type": "boolean" }, "shared_to": { "description": "Array of sharing target objects (users, roles, groups, or territories) with whom this custom view is shared. Null for public or non-shared views.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Share target with subordinates included.", "properties": { "id": { "description": "Unique identifier of the entity.", "format": "int64", "type": "string" }, "name": { "description": "Name of the entity (user, role, group, or territory).", "maxLength": 50, "type": "string" }, "subordinates": { "description": "Indicates if subordinates of the specified entity are included in sharing.", "enum": [ true ], "type": [ "boolean", "null" ] }, "type": { "description": "Type of entity the view is shared with (territories, roles, groups, users).", "enum": [ "territories", "roles", "groups", "users" ], "type": "string" } }, "required": [ "subordinates", "type", "name", "id" ], "type": "object", "x-zs-$id": "ModulesPutResponseSharedToObject" }, { "additionalProperties": false, "description": "Share target without subordinates.", "properties": { "id": { "description": "Unique identifier of the entity.", "format": "int64", "type": "string" }, "name": { "description": "Name of the entity (user, role, group, or territory).", "maxLength": 50, "type": "string" }, "subordinates": { "description": "Indicates if subordinates are excluded from sharing.", "enum": [ false ], "type": [ "boolean", "null" ] }, "type": { "description": "Type of entity the view is shared with (territories, roles, groups, users).", "enum": [ "territories", "roles", "groups", "users" ], "type": "string" } }, "required": [ "subordinates", "type", "name", "id" ], "type": "object", "x-zs-$id": "ModulesPutResponseSharedToObjectNoSubordinates" } ], "description": "Represents a sharing entry defining an entity that this Custom View is shared with." }, "maxItems": 100, "type": [ "array", "null" ] }, "sort_by": { "additionalProperties": false, "description": "Field object specifying the column used to sort records in this view, containing api_name and id. Null when no sort field is configured.", "properties": { "api_name": { "description": "API name of the field used as the sort column in this view. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the field used as the sort column in this view.", "format": "int64", "type": "string" } }, "required": [ "id", "api_name" ], "type": [ "object", "null" ] }, "sort_order": { "description": "Sort direction applied to this view. Possible values: asc - ascending order; desc - descending order; null - no sort order is configured.", "enum": [ "asc", "desc", null ], "type": [ "string", "null" ] }, "system_defined": { "description": "True when this custom view was created automatically by the system; false when created by a user.", "type": "boolean" }, "system_name": { "description": "Internal system name for this custom view, stored separately from the user-visible display_value. Nullable; maximum 255 characters.", "maxLength": 255, "type": [ "string", "null" ] }, "wrap_text": { "description": "True when text wrapping is enabled for field values displayed in this custom view; false when values are truncated to a single line.", "type": "boolean" } }, "required": [ "display_value", "system_name", "category", "created_time", "modified_time", "last_accessed_time", "name", "created_by", "modified_by", "criteria", "default", "system_defined", "locked", "favorite", "access_type", "shared_to", "fields", "sort_by", "sort_order", "id" ], "type": [ "object", "null" ] }, "default_mapping_fields": { "description": "Array of default field mapping objects (up to 25) for data import and integration operations. Exposed only for SALESORDERS, INVOICES, QUOTES, QUOTEDITEMS, ORDEREDITEMS, and INVOICEDITEMS modules; each entry identifies a field by api_name and id.", "items": { "additionalProperties": false, "description": "Field mapping configuration for import operations.", "properties": { "api_name": { "description": "API name of the field in the default mapping configuration. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the field in the default mapping configuration.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 25, "type": "array" }, "deletable": { "description": "True when records in this module can be permanently deleted; false for protected modules such as configuration entities or system-managed records.", "type": "boolean" }, "description": { "description": "User-defined description of the module. Null when no description has been set. Maximum 255 characters; empty string should not be used.", "maxLength": 255, "type": [ "string", "null" ] }, "display_field": { "anyOf": [ { "description": "API name of the display field", "maxLength": 50, "type": "string", "x-zs-$id": "ModulesPutResponseDisplayFieldString" }, { "additionalProperties": false, "description": "Display field object with detailed properties", "properties": { "api_name": { "description": "API name of the display field", "maxLength": 50, "type": "string" }, "id": { "description": "Unique identifier of the display field", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object", "x-zs-$id": "ModulesPutResponseDisplayFieldObject" }, { "description": "No display field configured", "type": "null", "x-zs-$id": "ModulesPutResponseDisplayFieldNull" } ], "description": "Field designation used as the record display name or title in this module. Either a string containing the field's API name, or an object with api_name and id." }, "editable": { "description": "True when existing records in this module can be edited by users with appropriate permissions; false for read-only modules.", "type": "boolean" }, "emailTemplate_support": { "description": "True when email templates can be used to send emails from records in this module; false when email template functionality is not supported.", "type": "boolean" }, "email_parser_supported": { "description": "True when email parsing is supported for this module, enabling automatic record creation or updates from inbound emails.", "type": "boolean" }, "feeds_required": { "description": "True when activity feeds are enabled for this module, displaying a timeline of record activities and updates.", "type": "boolean" }, "fields": { "description": "Array of complete field metadata objects (up to 1000) for all fields in this module. Populated only when 'fields' is included in the include query parameter and when the service is creator.", "items": { "additionalProperties": true, "description": "Field metadata object containing properties, data type, and configuration.", "type": "object" }, "maxItems": 1000, "type": "array" }, "filter_status": { "description": "True when custom view filters are currently active for this module; false when no active filter state is set.", "type": "boolean" }, "filter_supported": { "description": "True when this module supports custom view filtering; false for modules that do not allow filter configuration.", "type": "boolean" }, "generated_type": { "description": "Classification of how this module was generated. Possible values: default - standard system module; custom - user-created module; web - web tab module; linking - many-to-many linking module; subform - dynamic subform module; static_subform - static subform; field_tracker - field change tracker; picklisttracker - picklist change tracker.", "enum": [ "field_tracker", "default", "web", "linking", "custom", "picklisttracker", "subform", "static_subform" ], "type": "string" }, "global_search_supported": { "description": "True when records in this module appear in global search results; false when the module is excluded from global search.", "type": "boolean" }, "has_more_profiles": { "description": "True when the profiles array is truncated and additional profiles exist beyond those returned (pagination indicator); false when the full profile list is included.", "type": "boolean" }, "id": { "description": "Unique numeric identifier (as string) for this module. Required field; used as the stable reference across all API operations.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } }, "inventory_template_supported": { "description": "True when inventory templates (e.g., for quotes, invoices) can be configured for this module; false when not supported.", "type": "boolean" }, "isBlueprintSupported": { "description": "True when Blueprint process automation can be configured for this module; false when Blueprint is not available for this module type.", "type": "boolean" }, "kanban_view": { "description": "True when kanban view is currently enabled for this module. Distinct from kanban_view_supported, which reflects capability regardless of current setting.", "type": "boolean" }, "kanban_view_supported": { "description": "True when the module's data structure supports kanban view. A false value means kanban view cannot be enabled regardless of settings.", "type": "boolean" }, "layouts": { "description": "Array of layout configuration objects (up to 7) available for this module, ordered by relevance of profiles and record creation for the current user. Populated only when 'layouts' is included in the include query parameter.", "items": { "additionalProperties": false, "description": "Layout configuration object containing layout metadata, profile associations, and field arrangements.", "properties": { "actions_allowed": { "additionalProperties": false, "description": "Object enumerating the operations that the current user can perform on this layout, including flags for clone, deactivate, delete, downgrade, edit, rename, and configure permissions.", "properties": { "clone": { "description": "True when the current user has permission to clone this layout.", "type": "boolean" }, "deactivate": { "description": "True when the current user has permission to deactivate this layout.", "type": "boolean" }, "delete": { "description": "True when the current user has permission to delete this layout.", "type": "boolean" }, "downgrade": { "description": "True when the current user has permission to downgrade this layout to a simpler layout type.", "type": "boolean" }, "edit": { "description": "True when the current user has permission to edit the fields and settings of this layout.", "type": "boolean" }, "rename": { "description": "True when the current user has permission to rename this layout.", "type": "boolean" }, "set_layout_permissions": { "description": "True when the current user has permission to configure profile-based access permissions for this layout.", "type": "boolean" } }, "required": [ "edit", "rename", "clone", "downgrade", "delete", "deactivate", "set_layout_permissions" ], "type": "object" }, "api_name": { "description": "API name used to reference this layout in API requests. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "convert_mapping": { "additionalProperties": false, "description": "Conversion mapping configuration defining target modules (Accounts, Contacts, Deals) and field-level mappings when records in this module are converted. Populated only when 'convert_mapping' is included in the include parameter.", "properties": { "Accounts": { "additionalProperties": false, "description": "Configuration object for converting this module's records to Accounts, including the Account module's display label, id, and internal name.", "properties": { "display_label": { "description": "Human-readable display label for the Accounts module shown in the conversion UI. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) for the Accounts module used as the conversion target.", "format": "int64", "type": "string" }, "name": { "description": "Internal system name of the Accounts module. Maximum 40 characters.", "maxLength": 40, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" }, "Contacts": { "additionalProperties": false, "description": "Configuration object for converting this module's records to Contacts, including the Contacts module's display label, id, and internal name.", "properties": { "display_label": { "description": "Human-readable display label for the Contacts module shown in the conversion UI. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) for the Contacts module used as the conversion target.", "format": "int64", "type": "string" }, "name": { "description": "Internal system name of the Contacts module. Maximum 40 characters.", "maxLength": 40, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" }, "Deals": { "additionalProperties": false, "description": "Configuration object for converting this module's records to Deals, including the Deals module's display label, id, internal name, and an array of field-level mapping configurations.", "properties": { "display_label": { "description": "Human-readable display label for the Deals module shown in the conversion UI. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "fields": { "description": "Array of field mapping objects (up to 1000) specifying how source module fields map to Deals fields during conversion; each entry contains the Deals field api_name, display label, id, and whether the field is required.", "items": { "additionalProperties": false, "description": "Field mapping configuration specifying a single field for conversion.", "properties": { "api_name": { "description": "API name of the target Deals field in this mapping. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "field_label": { "description": "Human-readable display label for the Deals field in the conversion UI. Maximum 100 characters.", "maxLength": 100, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the Deals field in this mapping.", "format": "int64", "type": "string" }, "required": { "description": "True when this Deals field must be populated during the record conversion process; false when it is optional.", "type": "boolean" } }, "required": [ "api_name", "field_label", "id", "required" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "id": { "description": "Unique numeric identifier (as string) for the Deals module used as the conversion target.", "format": "int64", "type": "string" }, "name": { "description": "API name used internally to identify the Deals module within the conversion mapping. Maximum 40 characters.", "maxLength": 40, "type": "string" } }, "required": [ "fields", "display_label", "name", "id" ], "type": "object" }, "Invoices": { "additionalProperties": false, "description": "Conversion target configuration object for the Invoices module, containing display label and identifier details.", "properties": { "display_label": { "description": "Human-readable label displayed for the Invoices module in the conversion mapping. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) for the Invoices module in the conversion mapping.", "format": "int64", "type": "string" }, "name": { "description": "API name used internally to identify the Invoices module within the conversion mapping. Maximum 40 characters.", "maxLength": 40, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" }, "SalesOrders": { "additionalProperties": false, "description": "Conversion target configuration object for the SalesOrders module, containing display label and identifier details.", "properties": { "display_label": { "description": "Human-readable label displayed for the SalesOrders module in the conversion mapping. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) for the SalesOrders module in the conversion mapping.", "format": "int64", "type": "string" }, "name": { "description": "API name used internally to identify the SalesOrders module within the conversion mapping. Maximum 40 characters.", "maxLength": 40, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" } }, "type": "object" }, "created_by": { "additionalProperties": false, "description": "User who created this layout, containing id and name. Null when created by the system.", "properties": { "id": { "description": "Unique numeric identifier (as string) of the user who created the layout.", "format": "int64", "type": "string" }, "name": { "description": "Full name of the user who created the layout. Maximum 101 characters.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "created_for": { "description": "Identifier of the entity (user, profile, or role) for which this layout was created. Maximum 100 characters. Null if created for general use.", "maxLength": 100, "type": [ "string", "null" ] }, "created_time": { "description": "ISO 8601 timestamp with timezone offset recording when the layout was created; nullable.", "format": "date-time", "type": [ "string", "null" ] }, "display_label": { "description": "Human-readable label displayed in the UI for this layout. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "generated_type": { "description": "Classification of how the layout was generated. Possible values: default - standard system layout; custom - user-created; web - web tab; linking - many-to-many; subform - dynamic subform; static_subform - static subform; orchestration - CommandCenter; field_tracker - field change tracker; webtab_slyteui - Slyte UI web tab; system - core system layout.", "enum": [ "default", "web", "custom", "linking", "subform", "orchestration", "field_tracker", "webtab_slyteui", "static_subform", "system" ], "type": "string" }, "has_more_profiles": { "description": "True when additional profiles beyond the current page are associated with this layout, signaling that further pagination is required.", "type": "boolean" }, "id": { "description": "Unique numeric identifier (as string) for the layout.", "format": "int64", "type": "string" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "User who last modified this custom view. Null for system views that have never been modified.", "properties": { "id": { "description": "Unique identifier of the user who modified the custom view.", "format": "int64", "type": "string" }, "name": { "description": "Name of the user who modified the custom view.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "LayoutsModifiedByObjectResponse" }, { "description": "Indicates that has never been modified.", "type": "null", "x-zs-$id": "LayModifiedTimeNullResponse" } ], "description": "Represents the user who last modified this layout." }, "modified_time": { "anyOf": [ { "description": "Timestamp when layout was last modified in ISO 8601 format with timezone offset. Null if never modified.", "format": "date-time", "type": "string", "x-zs-$id": "LayoutsModifiedTimeStringResponse" }, { "description": "Indicates that has never been modified.", "type": "null", "x-zs-$id": "LayoutsModifiedTimeNullResponse" } ], "description": "Represents the timestamp when this layout was last modified, in ISO 8601 format." }, "name": { "description": "Internal API name of the layout. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "profiles": { "description": "Array of user profile objects (up to 202) that have access to this layout, each containing profile id, name, and default view configuration.", "items": { "additionalProperties": false, "description": "Profile configuration with default view settings.", "properties": { "_default_assignment_view": { "additionalProperties": false, "description": "Default assignment view configuration applied when records are assigned under this profile, controlling how record assignment operations are presented.", "properties": { "id": { "description": "Unique numeric identifier (as string) of the default assignment view associated with this profile.", "format": "int64", "type": "string" }, "name": { "description": "Display name of the default assignment view. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "type": { "description": "Category of the default assignment view. Possible values: inventory_templates, layout, canvas, wizard.", "enum": [ "inventory_templates", "layout", "canvas", "wizard" ], "type": "string" } }, "required": [ "name", "id", "type" ], "type": "object" }, "_default_view": { "additionalProperties": false, "description": "Default custom view configuration applied to this profile, determining the initial view presented to users accessing records.", "properties": { "id": { "description": "Unique numeric identifier (as string) of the default view associated with this profile.", "format": "int64", "type": "string" }, "name": { "description": "Display name of the default custom view. Maximum 40 characters.", "maxLength": 40, "type": "string" }, "type": { "description": "Category of the default custom view. Possible values: inventory_templates, layout, canvas, wizard.", "enum": [ "inventory_templates", "layout", "canvas", "wizard" ], "type": "string" } }, "required": [ "name", "id", "type" ], "type": "object" }, "default": { "description": "True when this profile serves as the default profile for the layout.", "type": "boolean" }, "id": { "description": "Unique numeric identifier (as string) for this profile.", "format": "int64", "type": "string" }, "name": { "description": "Name identifying the profile associated with this layout. Maximum 50 characters.", "maxLength": 50, "type": "string" } }, "required": [ "default", "name", "id", "_default_view", "_default_assignment_view" ], "type": "object" }, "maxItems": 202, "type": "array" }, "sections": { "description": "Ordered list of sections grouping fields within the layout. Maximum 7 sections.", "items": { "additionalProperties": true, "description": "Section configuration with fields and display settings.", "type": "object" }, "maxItems": 7, "type": "array" }, "show_business_card": { "description": "True when the business card view is enabled for this layout.", "type": "boolean" }, "source": { "description": "Source system that originated the layout configuration. Possible values: crm, platform_plugin, marketplace_plugin, campaign_integration.", "enum": [ "crm", "platform_plugin", "marketplace_plugin", "campaign_integration" ], "type": "string" }, "status": { "description": "Current lifecycle state of the layout. Possible values: active - in use; inactive - disabled; downgraded - reduced to simpler type; hidden - not visible in UI.", "enum": [ "active", "inactive", "downgraded", "hidden" ], "type": "string" }, "visible": { "description": "True when the layout is visible and accessible to users.", "type": "boolean" } }, "required": [ "id", "name", "display_label", "status", "source", "generated_type" ], "type": "object" }, "maxItems": 7, "type": "array" }, "lookup_field_properties": { "additionalProperties": true, "description": "Configuration properties governing lookup field behavior for this module. Null when the module has no lookup field configuration.", "type": [ "object", "null" ] }, "lookupable": { "description": "True when this module can be targeted as a lookup field by other modules.", "type": "boolean" }, "masked_fields_count": { "description": "Count of masked fields in this module. Exposed only when the 'fields' include parameter is specified.", "format": "int32", "type": "integer" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "User who last modified this custom view. Null for system views that have never been modified.", "properties": { "id": { "description": "Unique identifier of the user who modified the custom view.", "format": "int64", "type": "string" }, "name": { "description": "Name of the user who modified the custom view.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ModulesModifiedByObjectResponse1" }, { "description": "Indicates that has never been modified.", "type": "null", "x-zs-$id": "ModulesModifiedByNullResponse1" } ], "description": "Represents the user who last modified this module configuration." }, "modified_time": { "description": "ISO 8601 timestamp with timezone offset recording when the module configuration was last modified. Null when the module has never been modified after creation.", "format": "date-time", "type": [ "string", "null" ] }, "module_name": { "description": "System-level API name identifying the module, used in API requests and responses. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "module_type": { "description": "Categorizes the module as ENTITIES for standard data modules or CONFIGURATION_ENTITIES for configuration and settings modules.", "enum": [ "CONFIGURATION_ENTITIES", "ENTITIES" ], "type": "string" }, "parent_module": { "additionalProperties": false, "description": "Reference to the parent module for child modules such as subforms and field trackers. Returns an empty object {} for standalone modules. This is populated with api_name and id for modules with parent relationships.", "properties": { "api_name": { "description": "API name of the parent module, used to identify it in API calls. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the parent module.", "format": "int64", "type": "string" } }, "type": "object" }, "per_page": { "description": "Default number of records displayed per page when listing data for this module.", "format": "int32", "type": "integer" }, "plural_label": { "description": "Localized plural display label for the module as shown in the UI, reflecting the active language setting. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "presence_sub_menu": { "description": "True when the presence submenu is available for this module.", "type": "boolean" }, "private_profile": { "additionalProperties": false, "description": "Private profile configuration for team-based access control. Populated only when access_type is 'team_based' with profile name and ID; null for org_based modules.", "properties": { "id": { "description": "Unique numeric identifier (as string) of the private profile.", "format": "int64", "type": "string" }, "name": { "description": "Display name of the private profile; maximum 101 characters.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "profile_count": { "description": "Count of profiles assigned to this module; 0 indicates no profile assignments are configured. Maximum 203 profiles per module.", "format": "int32", "type": "integer" }, "profiles": { "description": "Profiles with access to this module; contains up to 203 entries.", "items": { "additionalProperties": false, "description": "Profile reference with ID and name", "properties": { "id": { "description": "Unique numeric identifier of the profile (as string).", "format": "int64", "type": "string" }, "name": { "description": "Display name of the profile; maximum 50 characters.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 203, "type": "array" }, "public_fields_configured": { "description": "True when public fields have been configured for this module.", "type": "boolean" }, "quick_create": { "description": "True when quick create functionality is enabled for this module.", "type": "boolean" }, "recycle_bin_on_delete": { "description": "True when deleted records are moved to the recycle bin instead of being permanently deleted.", "type": "boolean" }, "related_list_properties": { "additionalProperties": true, "description": "Configuration and settings for related lists in this module; null when no related-list properties are defined.", "type": [ "object", "null" ] }, "related_lists": { "description": "Related lists (subforms and related modules) displayed in this module's detail view; populated only when 'related_lists' is included in the include query parameter.", "items": { "additionalProperties": false, "description": "Related list configuration defining how related module records are displayed and managed within the parent module's detail view.", "properties": { "_layout_specific_properties": { "description": "Per-layout configuration entries governing how this related list appears within each associated layout; contains up to 2,147,483,647 items.", "items": { "additionalProperties": true, "description": "Layout-specific configuration object containing sequence number and layout reference for a related list in a particular layout", "properties": { "layout": { "additionalProperties": false, "description": "Layout reference object identifying the specific layout to which this related list configuration applies.", "properties": { "id": { "description": "Unique numeric identifier (as string) for the layout.", "format": "int64", "type": "string" }, "name": { "description": "Display name of the layout, up to 40 characters.", "maxLength": 40, "type": "string" } }, "type": "object" }, "sequence_number": { "description": "Numeric position defining the display order of this related list within its associated layout.", "format": "int32", "type": "integer" } }, "required": [ "sequence_number", "layout" ], "type": "object" }, "maxItems": 2147483647, "type": "array" }, "action": { "description": "Action URL or operation identifier associated with this related list, up to 64 characters; null when no action is defined.", "maxLength": 64, "type": [ "string", "null" ] }, "api_name": { "description": "API name used to reference this related list programmatically, up to 50 characters.", "maxLength": 50, "type": "string" }, "connectedlookupApiName": { "description": "API name of the connected lookup field linking this related list to another module, up to 50 characters.", "maxLength": 50, "type": "string" }, "connectedmodule": { "description": "API name of the connected module for this related list; null when no module connection exists. Between 1 and 250 alphanumeric or underscore characters when present.", "maxLength": 250, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "customize_display_label": { "description": "True when the display label for this related list can be customized.", "type": "boolean" }, "customize_fields": { "description": "True when fields in this related list can be customized.", "type": "boolean" }, "customize_sort": { "description": "True when sorting for this related list can be customized.", "type": "boolean" }, "display_label": { "description": "UI display label for this related list. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "field_enabled": { "description": "True when this related list field is enabled and active.", "type": "boolean" }, "fields": { "description": "List of fields displayed in this related list. Maximum 1000 items.", "items": { "additionalProperties": false, "description": "Field reference containing the API name and unique identifier of a field displayed in the related list.", "properties": { "api_name": { "description": "API name of the field used in programmatic access. Maximum 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier of the field, returned as a string.", "format": "int64", "type": "string" } }, "required": [ "id", "api_name" ], "type": "object" }, "maxItems": 1000, "type": "array" }, "href": { "description": "Reference URL for the related list, or null if not applicable. Between 1 and 2048 characters when present.", "maxLength": 2048, "minLength": 1, "type": [ "string", "null" ] }, "id": { "description": "Unique numeric identifier of the related list, returned as a string.", "format": "int64", "type": "string" }, "linkingmodule": { "description": "API name of the linking module associated with this related list; null when no linking module is configured. Between 1 and 250 alphanumeric or underscore characters when present.", "maxLength": 250, "minLength": 1, "pattern": "^[A-Za-z0-9_]+$", "type": [ "string", "null" ] }, "module": { "additionalProperties": true, "description": "Module details associated with this related list entry, including its name and metadata; null if no module is linked.", "type": [ "object", "null" ] }, "name": { "description": "System-level name identifying the related list module; maximum 50 characters.", "maxLength": 50, "type": "string" }, "parent_related_lists": { "description": "Array of parent related list references when this entry is nested within another related list; null for top-level related lists. Maximum 100 items.", "items": { "additionalProperties": false, "description": "Parent related list reference object containing API name and unique identifier", "properties": { "api_name": { "description": "API name of the parent related list containing this entry; maximum 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the parent related list.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "personality_name": { "description": "Personality name assigned to this related list configuration, distinguishing its behavioral variant; maximum 50 characters.", "maxLength": 50, "type": "string" }, "record_operations": { "additionalProperties": false, "description": "Set of allowed record-level operations within this related list, such as create, edit, and assign.", "properties": { "assign": { "description": "True when the assign operation is permitted for records in this related list.", "type": "boolean" }, "bulk_edit": { "description": "True when bulk edit of records in this related list is permitted for the current user.", "type": "boolean" }, "create": { "description": "True when creation of records within this related list is permitted for the current user.", "type": "boolean" }, "delete": { "description": "True when deletion of associated records from this related list is permitted for the current user.", "type": "boolean" }, "disassociate": { "description": "True when disassociation of records from this related list is permitted for the current user.", "type": "boolean" }, "edit": { "description": "True when editing of records within this related list is permitted for the current user.", "type": "boolean" } }, "required": [ "edit", "create", "bulk_edit", "delete", "disassociate", "assign" ], "type": "object" }, "sequence_number": { "description": "Display position of this related list; lower values appear first.", "format": "int32", "type": "string" }, "sort_by": { "additionalProperties": false, "description": "Field by which records in this related list are sorted by default; contains the field's API name and unique identifier.", "properties": { "api_name": { "description": "API name of the field used for sorting, up to 50 characters.", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier (as string) of the field used for sorting records in this related list.", "format": "int64", "type": "string" } }, "required": [ "id", "api_name" ], "type": "object" }, "sort_order": { "description": "Sort direction applied to records in this related list. Possible values: asc - ascending; desc - descending; null - no sort order configured.", "enum": [ "asc", "desc", null ], "type": [ "string", "null" ] }, "status": { "description": "Visibility status of this related list; currently only 'visible' is supported.", "enum": [ "visible" ], "type": "string" }, "type": { "description": "Classification of this related list. Possible values: default - standard related list; multiselectlookup - multi-select lookup; combined_view - combined view; custom_lookup - custom lookup; custom_related_list - custom related list; slyteui - Slyte UI; queries - query-based; custom_function - function-based; grouped - grouped list.", "enum": [ "multiselectlookup", "combined_view", "custom_lookup", "custom_related_list", "slyteui", "queries", "custom_function", "grouped", "default" ], "type": "string" }, "visibility": { "description": "Numeric code controlling where this related list appears or is hidden in the UI", "format": "int32", "type": "integer" } }, "required": [ "id", "sequence_number", "display_label", "api_name", "name", "action", "href", "type", "customize_sort", "customize_fields", "customize_display_label", "status" ], "type": "object" }, "maxItems": 2147483647, "type": "array" }, "scoring_supported": { "description": "True when lead or contact scoring is supported for this module", "type": "boolean" }, "search_layout_fields": { "description": "Up to 10 fields displayed in the search result layout for this module", "items": { "description": "Field reference with API name and unique identifier", "maxLength": 25, "type": "string" }, "maxItems": 10, "type": "array" }, "sequence_number": { "description": "Numeric position of this module in the navigation list; lower values appear first, ranging from 1 to 200", "format": "int32", "type": "integer" }, "show_as_tab": { "description": "True when this module is rendered as a tab in the navigation UI", "type": "boolean" }, "show_emailparser": { "description": "True when the Email Parser feature is enabled for this module", "type": "boolean" }, "show_googlesync": { "description": "True when Google Contact Sync is enabled for this module", "type": "boolean" }, "show_social": { "description": "True when social tab features are enabled for this module", "type": "boolean" }, "show_visitor": { "description": "True when the ZLiveDesk visitor tracking feature is enabled for this module", "type": "boolean" }, "show_webform": { "description": "True when the web forms feature is enabled for this module", "type": "boolean" }, "showfacebooksync": { "description": "Indicates if the Facebook LeadChain Sync feature is enabled for this module", "type": "boolean" }, "showleadchainsync": { "description": "True when lead chain synchronization is enabled for this module; only exposed for the Leads module", "type": "boolean" }, "showlinkedinsync": { "description": "True when the LinkedIn LeadChain Sync feature is enabled for this module", "type": "boolean" }, "showtiktoksync": { "description": "True when the TikTok LeadChain Sync feature is enabled for this module", "type": "boolean" }, "singular_label": { "description": "Localized singular display label for the module, up to 50 characters", "maxLength": 50, "type": "string" }, "source": { "description": "Origin of the module configuration. Possible values: crm - native CRM module; platform_plugin - module from a platform plugin; marketplace_plugin - module from a marketplace plugin; campaign_integration - module created via campaign integration", "enum": [ "crm", "platform_plugin", "marketplace_plugin", "campaign_integration" ], "type": "string" }, "static_subform_properties": { "additionalProperties": false, "description": "Static subform configuration properties defined for fields within this module", "properties": { "fields": { "description": "Field references included in the static subform, up to 1000 items", "items": { "additionalProperties": false, "description": "Field reference with API name and ID", "properties": { "api_name": { "description": "API name of the static subform field, up to 50 characters", "maxLength": 50, "type": "string" }, "id": { "description": "Unique numeric identifier of the static subform field, returned as a string", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 1000, "type": "array" } }, "required": [ "fields" ], "type": "object" }, "status": { "description": "Represents the visibility status of the module. Possible values: visible - module is active and visible; scheduled_for_deletion - module is queued for removal; user_hidden - hidden by user preference; system_hidden - hidden by system configuration", "enum": [ "visible", "scheduled_for_deletion", "user_hidden", "system_hidden" ], "type": "string" }, "sub_menu_available": { "description": "True when a submenu is available for this module in the UI navigation", "type": "boolean" }, "territory": { "additionalProperties": false, "description": "Territory restriction applied to the module; null when territory management is not enabled for the organization", "properties": { "id": { "description": "Unique identifier of the territory as a string-encoded numeric ID; '0' indicates no territory restriction is applied", "examples": [ "0", "111111000000045001" ], "format": "int64", "type": "string" }, "name": { "description": "Display name of the assigned territory (e.g., 'All Territories', 'North America')", "maxLength": 50, "type": "string" }, "subordinates": { "description": "True when subordinate (child) territories are included within the scope of this territory restriction", "type": "boolean" } }, "type": [ "object", "null" ] }, "track_current_data": { "description": "True when current data tracking is enabled for records in this module", "type": "boolean" }, "triggers_supported": { "description": "True when workflow triggers are supported for this module", "type": "boolean" }, "viewable": { "description": "True when records in this module can be viewed by the current user", "type": "boolean" }, "visibility": { "description": "Bitwise integer flags controlling module and feature visibility, ranging from 1 to 16383. Base value 1 means fully visible. Add flag values to suppress specific UI surfaces: 2=web UI hidden, 4=tab menu, 8=lookup, 16=related list, 32=multi-select lookup, 64=module settings, 128=automation, 256=templates, 512=import, 1024=export, 4096=reports, 8192=API. ", "examples": [ 1, 2, 4612, 14316 ], "format": "int32", "maximum": 16383, "minimum": 1, "type": "integer" }, "web_link": { "description": "URL associated with this module; null when no web link is configured", "type": [ "string", "null" ] }, "webform_supported": { "description": "True when web forms can be created for this module", "type": "boolean" }, "zia_view": { "description": "True when Zia AI view is enabled for this module; applicable only to the Deals module", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "GetModuleByApiNameSuccessResponse" } } }, "description": "200 OK - Module metadata retrieved successfully; returns the full configuration object for the requested CRM module" }, "204": { "description": "204 No Content - Requested module exists in the system but is not exposed through this endpoint (for example, web tab modules or certain system modules); no response body is returned; use GET /crm/v8/settings/modules to retrieve such modules" }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Error response when the requested module API name targets an endpoint not supported by the API", "summary": "API not supported error", "value": { "code": "API_NOT_SUPPORTED", "details": {}, "message": "api not supported", "status": "error" } }, "ApiVersionNotSupported": { "description": "Error response when the requested API version does not support the getModuleByApiName endpoint", "summary": "API version not supported error", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_version": 2 }, "message": "The api version 1 is not supported. Please use the version 2 or above.", "status": "error" } }, "InvalidModule": { "description": "Error response when the provided module identifier does not match any existing or accessible module in the organization", "summary": "Invalid module identifier", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 2 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequest": { "description": "Error response when the request parameters are malformed, empty, or otherwise syntactically invalid", "summary": "Invalid request parameters", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "api name cannot be empty", "status": "error" } }, "ModuleNotSupportedInApi": { "description": "Error response when the specified module exists but is not accessible or supported through this API endpoint", "summary": "Module not supported in API", "value": { "code": "NOT_SUPPORTED", "details": {}, "message": "the given module is not supported in api", "status": "error" } }, "UnsupportedModule": { "description": "Error response when the specified module API name does not correspond to a supported or recognized module", "summary": "Unsupported module API name", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 2 }, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "NOT_SUPPORTED error when the module is not supported in the API.", "properties": { "code": { "description": "Error code indicating the module is not supported.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the unsupported resource.", "properties": { "resource_path_index": { "description": "Index of the invalid resource in the URL path (0-based). Typically 2 for the {api_name} parameter.", "format": "int32", "minimum": 0, "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message explaining that the module is not supported.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseNotSupported400" }, { "additionalProperties": false, "description": "API_NOT_SUPPORTED error when the requested API version is not supported.", "properties": { "code": { "description": "Error code indicating the requested API version is not supported.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the supported API version.", "properties": { "supported_version": { "description": "The minimum or recommended API version that supports this endpoint.", "format": "int32", "minimum": 1, "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message explaining API version incompatibility.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseApiNotSupported400" }, { "additionalProperties": false, "description": "INVALID_REQUEST error when request parameters are malformed or have empty values.", "properties": { "code": { "description": "Error code indicating an invalid request.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the invalid request (typically empty).", "type": "object" }, "message": { "description": "Human-readable error message explaining the invalid request.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidRequest400" }, { "additionalProperties": false, "description": "INVALID_MODULE error when the module identifier is invalid or does not exist.", "properties": { "code": { "description": "Error code indicating the module is invalid.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the invalid module reference.", "properties": { "resource_path_index": { "description": "Index of the invalid resource in the URL path (0-based). Typically 2 for the {moduleIdentifier} parameter.", "example": 2, "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message explaining the invalid module.", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesGetByApiNameResponseInvalidModule400" } ], "description": "Contains the 400 error response for a failed single-module retrieval request.", "x-zs-$id": "ModulesPutResponseNotAllowed400" } } }, "description": "400 Bad Request - Request failed due to a syntactic error (malformed or empty api_name) or a semantic error (unsupported module, API version mismatch, or invalid module identifier); error codes include NOT_SUPPORTED, API_NOT_SUPPORTED, INVALID_REQUEST, and INVALID_MODULE" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.READ" ] } ], "summary": "Get module metadata by API name", "tags": [ "modules" ], "x-zoho-document": "modules" }, "put": { "description": "Updates the singular label, plural label, and profile assignments for the module identified by {moduleIdentifier}. Immutable fields such as access_type and api_name cannot be changed; attempting to include them returns a NOT_ALLOWED error", "operationId": "updateModuleByApiName", "parameters": [ { "$ref": "#/components/parameters/ModuleIdentifier" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateModuleLabelsAndProfiles": { "description": "Demonstrates a PUT request that updates the singular and plural labels of a module and replaces its profile list in a single call", "summary": "Update Module Labels And Profile Access", "value": { "modules": [ { "id": "111111000000242167", "plural_label": "Custom Modules", "profiles": [ { "id": "111111000000000497" }, { "id": "111111000000000499" } ], "singular_label": "Custom Module" } ] } } }, "schema": { "additionalProperties": false, "description": "Request body schema for updating a module. Contains a single-element modules array with the module ID, updated labels, and profile assignments", "properties": { "modules": { "description": "Single-element array containing the module object with the labels and profile assignments to update. Exactly one item is required.", "items": { "additionalProperties": false, "description": "Module object specifying the updated singular label, plural label, identifier, and profile assignments.", "properties": { "id": { "description": "Unique numeric identifier of the module to update. Must match an existing module. Represented as a numeric string encoding a 64-bit positive integer (Java long/DB bigint).", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } }, "plural_label": { "description": "Plural display label for the module. Accepts 1–50 alphanumeric characters and spaces; special characters are not permitted.", "example": "Custom Modules", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9 ]+$", "type": "string" }, "profiles": { "description": "Non-empty list of unique profiles that should have access to this module. Accepts 1–203 unique profile objects; order is not significant. This cannot be empty.", "items": { "additionalProperties": false, "description": "Profile object specifying a single profile to grant access to the module. Contains the profile numeric identifier.", "properties": { "id": { "description": "Unique numeric identifier of the profile. Represented as a numeric string encoding a 64-bit positive integer.", "example": "111111000000000497", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 203, "minItems": 1, "type": "array", "uniqueItems": true }, "singular_label": { "description": "Singular display label for the module. Accepts 1–50 alphanumeric characters and spaces; special characters are not permitted.", "example": "Custom Module", "maxLength": 50, "minLength": 1, "pattern": "^[A-Za-z0-9 ]+$", "type": "string" } }, "required": [ "singular_label", "plural_label", "id", "profiles" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object" } } }, "description": "Payload for updating a module. Provide the module ID, updated singular and plural labels, and the list of profiles that should have access. access_type is not accepted in this request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpdate": { "description": "Successful update response containing code=SUCCESS, the updated module ID in details.ID, a confirmation message, and an OK status.", "summary": "Module Update Succeeded", "value": { "modules": [ { "code": "SUCCESS", "details": { "id": "111111000000242167" }, "message": "module updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response body schema for a successful module update. Contains a single-element module array with the outcome code, updated module ID, confirmation message, and status", "properties": { "modules": { "description": "Single-element array containing the success result for the updated module.", "items": { "additionalProperties": false, "description": "Success result object containing the operation outcome code, the updated module identifier, a confirmation message, and a status indicator.", "properties": { "code": { "description": "Always \"SUCCESS\". Indicates the module update completed without errors.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the identifier of the successfully updated module.", "properties": { "id": { "description": "Unique numeric identifier of the successfully updated module. Represented as a numeric string encoding a 64-bit positive integer(Java long/DB bigint).", "example": "111111000000242167", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Displays the success message and confirms that the update was applied.", "enum": [ "module updated successfully" ], "type": "string" }, "status": { "description": "Indicates that the operation completed successfully.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPutResponse200" } } }, "description": "Module updated successfully. The response contains the updated module ID and a success confirmation" }, "400": { "content": { "application/json": { "examples": { "AccessTypeUpdateNotAllowed": { "description": "NOT_ALLOWED error returned when the request body includes access_type, which is immutable and cannot be changed after module creation", "summary": "Access Type Update is Blocked", "value": { "modules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "access_type", "json_path": "$.modules[0].access_type" }, "message": "access type update not allowed", "status": "error" } ] } }, "ApiNameUpdateNotAllowed": { "description": "NOT_ALLOWED error returned when the request body includes api_name, which is an immutable field and cannot be modified after creation", "summary": "Api Name Update is Blocked", "value": { "modules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.modules[0].api_name" }, "message": "Api name update not allowed", "status": "error" } ] } }, "ApiVersionNotSupported": { "description": "API_NOT_SUPPORTED error is returned when the caller uses an API version lower than the minimum version required for this endpoint", "summary": "API Version is not Supported", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_version": 2 }, "message": "api version is not supported", "status": "error" } }, "DuplicatePluralLabel": { "description": "DUPLICATE_DATA error is returned when the submitted plural_label value is already in use by another module", "summary": "Duplicate Plural Label Conflict", "value": { "modules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "plural_label", "json_path": "$.modules[0].plural_label" }, "message": "Module plural name duplicate", "status": "error" } ] } }, "DuplicateSingularLabel": { "description": "DUPLICATE_DATA error returned when the submitted singular_label value is already in use by another module, preventing the update", "summary": "Duplicate Singular Label Conflict", "value": { "modules": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "singular_label", "json_path": "$.modules[0].singular_label" }, "message": "Module singular name duplicate", "status": "error" } ] } }, "InvalidDataType": { "description": "INVALID_DATA error returned when a field value has an incorrect data type.", "summary": "Incorrect Field Data Type", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "_delete", "expected_data_type": "jsonobject", "json_path": "$.modules.profiles[0]._delete" }, "message": "_delete is not an valid datatype", "status": "error" } ] } }, "InvalidModuleApiName": { "description": "INVALID_MODULE error returned when the {moduleIdentifier} path parameter does not match any existing module API name", "summary": "Invalid Module Identifier", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 2 }, "message": "the module name given seems to be invalid", "status": "error" } }, "LabelSpecialCharacters": { "description": "INVALID_DATA error returned when a module label includes special characters; only alphanumeric characters and spaces are permitted", "summary": "Label contains special characters", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "singular_label", "json_path": "$.modules[0].singular_label" }, "message": "Special characters in module singular name", "status": "error" } ] } }, "LabelTooLong": { "description": "INVALID_DATA error returned when a module label exceeds 50 characters, with maximum_length included in the error details", "summary": "Label exceeds maximum length", "value": { "modules": [ { "code": "INVALID_DATA", "details": { "api_name": "singular_label", "json_path": "$.modules[0].singular_label", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "MinimumProfilesNotFound": { "description": "MINIMUM_DATA_NOT_FOUND error returned when the profiles array is provided but contains no valid entries, violating the requirement that at least one profile must be assigned", "summary": "Profiles minimum requirement is not met", "value": { "modules": [ { "code": "MINIMUM_DATA_NOT_FOUND", "details": { "api_name": "profiles", "json_path": "$.modules[0].profiles" }, "message": "At least one profile needed", "status": "error" } ] } }, "MissingPluralLabel": { "description": "MANDATORY_NOT_FOUND error returned when the required plural_label field is absent from the request body", "summary": "Plural Label Field Missing", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "plural_label", "json_path": "$.modules[0].plural_label" }, "message": "required field not found", "status": "error" } ] } }, "MissingProfiles": { "description": "MANDATORY_NOT_FOUND error returned when the required profiles field is absent entirely from the request body", "summary": "Profiles field is missing or not provided", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "profiles", "json_path": "$.modules[0].profiles" }, "message": "required field not found", "status": "error" } ] } }, "MissingSingularLabel": { "description": "MANDATORY_NOT_FOUND error returned when the required singular_label field is absent from the request body", "summary": "Singular Label Field Missing", "value": { "modules": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "singular_label", "json_path": "$.modules[0].singular_label" }, "message": "required field not found", "status": "error" } ] } }, "TeamModuleProfileUpdateNotAllowed": { "description": "NOT_ALLOWED error returned when the request attempts to update profile assignments for a team-based module, which does not support profile-based access control", "summary": "Team Module Profile Update Blocked", "value": { "modules": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profiles", "json_path": "$.modules[0].profiles" }, "message": "profile update for team module is not allowed", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "INVALID_MODULE error returned when the {moduleIdentifier} path parameter does not match any existing module", "properties": { "code": { "description": "Always \"INVALID_MODULE\". Returned when the specified module does not exist or the path parameter does not match any module.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the index of the invalid resource in the URL path.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource in the URL path (0-based). Typically 2 for the {api_name} parameter.", "example": 2, "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Explains why the module reference supplied in the request is invalid.", "example": "the module name given seems to be invalid", "maxLength": 1000, "type": "string" }, "status": { "description": "Always \"error\". Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidModules" }, { "additionalProperties": false, "description": "INVALID_DATA error returned when the request body contains a field value that fails format, length, type, or character validation", "properties": { "modules": { "description": "One-element array containing the error detail object for the INVALID_DATA failure. Always contains exactly one entry.", "items": { "additionalProperties": false, "description": "Error object returned when the request contains a field with an invalid value. Includes the error code, a details block identifying the offending field, a message, and a status indicator.", "properties": { "code": { "description": "Always \"INVALID_DATA\". Returned when a field value fails format, length, or type validation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details identifying the invalid field and its location in the request body. May also include the maximum allowed length or expected data type depending on the violation.", "properties": { "api_name": { "description": "API name of the field that failed validation. Maximum 50 characters.", "example": "singular_label", "maxLength": 50, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field. Present only when the validation failure is caused by a type mismatch. Maximum 50 characters.", "example": "jsonobject", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression identifying the location of the invalid field in the request body. Maximum 100 characters.", "example": "$.modules[0].singular_label", "maxLength": 100, "type": "string" }, "maximum_length": { "description": "Maximum permitted character length for the field. Present only when the validation failure is caused by a length constraint violation.", "example": 25, "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explains the validation failure for this field.", "example": "invalid data", "maxLength": 1000, "type": "string" }, "status": { "description": "Always \"error\". Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPutResponseInvalidData400Error" }, { "additionalProperties": false, "description": "API_NOT_SUPPORTED error returned when the API version used by the caller does not support this endpoint", "properties": { "code": { "description": "Always \"API_NOT_SUPPORTED\". Returned when the requested endpoint is not supported by the current API version.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Object containing additional information about the API version incompatibility, including the minimum supported version for this endpoint.", "properties": { "supported_version": { "description": "Minimum API version number that supports this endpoint. The caller must use this version or higher.", "example": 2, "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "supported_version" ], "type": "object" }, "message": { "description": "Explains why the current API version does not support this endpoint.", "example": "api version is not supported", "maxLength": 1000, "type": "string" }, "status": { "description": "Always \"error\". Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ModulesPutResponseApiNotSupportedError" }, { "additionalProperties": false, "description": "MANDATORY_NOT_FOUND error returned when a required field is absent or empty in the request body", "properties": { "modules": { "description": "One-element array containing the error detail object for the MANDATORY_NOT_FOUND failure.", "items": { "additionalProperties": false, "description": "Error object returned when a required field is absent from the request. Identifies the missing field by its API name and JSONPath location.", "properties": { "code": { "description": "Always \"MANDATORY_NOT_FOUND\". Returned when a required field is missing or empty in the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Identifies the missing required field by its API name and its JSONPath location in the request body.", "properties": { "api_name": { "description": "API name of the required field that is missing from the request. Maximum 50 characters.", "example": "profiles", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression identifying the location in the request body where the required field is absent. Maximum 100 characters.", "example": "$.modules[0].profiles", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Indicates which required field is absent from the request.", "example": "required field not found", "maxLength": 1000, "type": "string" }, "status": { "description": "Always \"error\". Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPutResponseMandatoryNotFoundError" }, { "additionalProperties": false, "description": "DUPLICATE_DATA error returned when a submitted field value is already used by another module and uniqueness is required", "properties": { "modules": { "description": "One-element array containing the error detail object for the DUPLICATE_DATA failure.", "items": { "additionalProperties": false, "description": "Error object returned when a field value is duplicated where uniqueness is required. Identifies the offending field by its API name and JSONPath location.", "properties": { "code": { "description": "Always \"DUPLICATE_DATA\". Returned when a field value is duplicated where uniqueness is required.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Identifies the field with the duplicate value by its API name and its JSONPath location in the request body.", "properties": { "api_name": { "description": "API name of the field that contains a duplicate value. Maximum 50 characters.", "example": "singular_label", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression identifying the location of the duplicate field in the request body. Maximum 100 characters.", "example": "$.modules[0].singular_label", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explains the duplicate value error for this field.", "example": "Module singular name duplicate", "maxLength": 1000, "type": "string" }, "status": { "description": "Always \"error\". Indicates that the module update failed due to duplicate data being submitted", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPutResponseDuplicateDataError" }, { "additionalProperties": false, "description": "NOT_ALLOWED error returned when the request attempts to update a field that is immutable or write-restricted, such as access_type or api_name", "properties": { "modules": { "description": "Array of error objects, each describing a module field that was rejected because the update is not permitted", "items": { "additionalProperties": false, "description": "Error object identifying a field whose update was rejected because it is restricted. Contains the error code, the restricted field details, a message, and a status indicator.", "properties": { "code": { "description": "Always \"NOT_ALLOWED\". Indicates that the specified field cannot be updated because it is immutable or write-restricted", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Identifies the restricted field by its API name and its JSONPath location in the request body", "properties": { "api_name": { "description": "API name of the restricted field that cannot be updated. Maximum 50 characters", "example": "api_name", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression identifying the location of the restricted field in the request body. Maximum 100 characters", "example": "$.modules[0].api_name", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explains why the field update was rejected.", "example": "Api name update not allowed", "maxLength": 1000, "type": "string" }, "status": { "description": "Always \"error\". Indicates the request failed because a restricted field was included in the update", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPutResponseNotAllowedError" }, { "additionalProperties": false, "description": "MINIMUM_DATA_NOT_FOUND error returned when a field value is present but does not satisfy the minimum data requirement for that field", "properties": { "modules": { "description": "Array of error objects, each describing a module field whose submitted value does not satisfy minimum data requirements", "items": { "additionalProperties": false, "description": "Error object returned when a field is present in the request but its value does not satisfy minimum data requirements. Contains the error code, a details block with the field location, a message, and a status indicator.", "properties": { "code": { "description": "Always \"MINIMUM_DATA_NOT_FOUND\". Indicates that a field is present but its value does not meet the minimum data requirement", "enum": [ "MINIMUM_DATA_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Identifies the field that failed minimum data validation by its API name and its JSONPath location in the request body", "properties": { "api_name": { "description": "API name of the field that failed the minimum data requirement. Maximum 50 characters", "example": "profiles", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSONPath expression identifying the location of the field in the request body. Maximum 100 characters", "example": "$.modules[0].profiles", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Explains the minimum data requirement that was not satisfied for this field.", "example": "At least one profile needed", "maxLength": 1000, "type": "string" }, "status": { "description": "Always \"error\". Indicates the request failed because a field does not meet the minimum data requirement", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "modules" ], "type": "object", "x-zs-$id": "ModulesPutResponseMinimumDataNotFoundError" } ], "description": "Contains the error response for a failed module update request.", "x-zs-$id": "ModulesPutResponseInvalidModule400" } } }, "description": "Bad request. Returned when the module identifier is invalid, a field value fails validation, a required field is missing, a value is duplicated, a restricted field is included, a field does not meet minimum data requirements, or the API version does not support this endpoint" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.UPDATE" ] } ], "summary": "Update Module Labels and Profiles", "tags": [ "modules" ], "x-zoho-document": "modules" } }, "/crm/v8/settings/pipeline": { "get": { "description": "Retrieve all pipelines available for the specified Deals layout. Use the required layout_id query parameter to identify the layout.", "operationId": "getPipelines", "parameters": [ { "$ref": "#/components/parameters/LayoutID" } ], "responses": { "200": { "content": { "application/json": { "examples": { "PipelineGetResponse": { "value": { "pipeline": [ { "actual_value": "Standard (JackFer)", "default": true, "display_value": "Standard (JackFer)", "id": "2766660000055809075", "maps": [ { "actual_value": "Qualification", "display_value": "Qualification", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007104", "sequence_number": 1 }, { "actual_value": "Needs Analysis", "display_value": "Needs Analysis", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007106", "sequence_number": 2 }, { "actual_value": "Id. Decision Makers", "display_value": "Identify Decision Makers", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007110", "sequence_number": 3 }, { "actual_value": "Proposal/Price Quote", "display_value": "Proposal/Price Quote", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007112", "sequence_number": 4 }, { "actual_value": "Negotiation/Review", "display_value": "Negotiation/Review", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007114", "sequence_number": 5 }, { "actual_value": "Closed Won", "display_value": "Closed Won", "forecast_category": { "id": "2766660000000007094", "name": "Closed" }, "forecast_type": "Closed Won", "id": "2766660000000007116", "sequence_number": 6 }, { "actual_value": "Closed Lost", "display_value": "Closed Lost", "forecast_category": { "id": "2766660000000007096", "name": "Omitted" }, "forecast_type": "Closed Lost", "id": "2766660000000007118", "sequence_number": 7 }, { "actual_value": "Closed Lost to Competition", "display_value": "Closed Lost to Competition", "forecast_category": { "id": "2766660000000007096", "name": "Omitted" }, "forecast_type": "Closed Lost", "id": "2766660000000007120", "sequence_number": 8 }, { "actual_value": "dcba", "display_value": "dcba", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000030928184", "sequence_number": 9 }, { "actual_value": "abcd", "display_value": "abcd", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000030928185", "sequence_number": 10 }, { "actual_value": "ABC", "display_value": "ABC", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000030928272", "sequence_number": 11 } ] }, { "actual_value": "New", "default": false, "display_value": "New", "id": "2766660000055809086", "maps": [ { "actual_value": "Qualification", "display_value": "Qualification", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007104", "sequence_number": 1 }, { "actual_value": "Needs Analysis", "display_value": "Needs Analysis", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007106", "sequence_number": 2 }, { "actual_value": "Id. Decision Makers", "display_value": "Identify Decision Makers", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007110", "sequence_number": 3 }, { "actual_value": "Proposal/Price Quote", "display_value": "Proposal/Price Quote", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007112", "sequence_number": 4 }, { "actual_value": "Negotiation/Review", "display_value": "Negotiation/Review", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007114", "sequence_number": 5 }, { "actual_value": "Closed Won", "display_value": "Closed Won", "forecast_category": { "id": "2766660000000007094", "name": "Closed" }, "forecast_type": "Closed Won", "id": "2766660000000007116", "sequence_number": 6 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineGetResponse" } } }, "description": "Successfully retrieved all pipelines configured for the given layout." }, "204": { "description": "No pipeline records were found for the given layout." }, "400": { "content": { "application/json": { "examples": { "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineGetErrorResponse" } } }, "description": "The request is invalid, for example when the layout_id is invalid." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.READ" ] } ], "summary": "Pipelines", "tags": [ "pipeline" ], "x-zoho-document": "pipeline" }, "patch": { "description": "Update or delete a pipeline for the specified layout using a request body that identifies the pipeline and its stage mappings.", "operationId": "updatePipelines", "parameters": [ { "$ref": "#/components/parameters/LayoutID" } ], "requestBody": { "content": { "application/json": { "examples": { "PipelineDeleteRequest": { "value": { "pipeline": [ { "_delete": { "permanent": null }, "id": "12345678901234567890" } ] } }, "PipelineUpdateRequest": { "value": { "pipeline": [ { "default": false, "display_value": "adfadf12adf", "id": "12345678901234567890", "maps": [ { "id": "2766660000000007106", "sequence_number": 2 }, { "id": "2766660000000007104", "sequence_number": 1 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "PipelineUpdateResponse": { "value": { "pipeline": [ { "code": "SUCCESS", "details": { "id": "2766660000055809093" }, "message": "Pipeline updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineSuccessResponse" } } }, "description": "The pipeline was updated or deleted successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduledError": { "value": { "pipeline": [ { "code": "ALREADY_SCHEDULED", "details": { "api_name": "pipeline", "json_path": "$.pipeline[0].pipeline", "value": "2766660000056063000" }, "message": "Scheduler already running for this pipeline", "status": "error" } ] } }, "CannotRemoveTheLastStageErrorResponse": { "value": { "pipeline": [ { "code": "CANNOT_DELETE", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Cannot delete the last stage associated with the pipeline", "status": "error" } ] } }, "DisplayValueIsNotFountError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "DuplicatePipelineNameError": { "value": { "pipeline": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "Duplicate pipeline label found", "status": "error" } ] } }, "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } }, "InvalidMapStageIDError": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Invalid child option id", "status": "error" } ] } }, "MapIDNotFoundError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "required field not found", "status": "error" } ] } }, "NoMappingFoundErrorRespones": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": {}, "message": "No mapping found ", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PipelineUpdateOrDeleteErrorResponse" }, { "$ref": "#/components/schemas/PipelineGetErrorResponse" }, { "$ref": "#/components/schemas/PipelineMaximumLengthErrorResponse" } ], "x-zs-$id": "PipelineUpdateOrDeleteBulkErrorResponse", "x-zs-llm-description": "Response matches PipelineGetErrorResponse when layout_id is invalid, MaximumLengthErrorResponse when the pipeline array exceeds its maxItems limit, or PipelineUpdateOrDeleteErrorResponse for all other body validation failures (invalid pipeline/stage id, duplicate label, cannot delete last stage, already-scheduled transfer)." } } }, "description": "The request is invalid due to an invalid layout_id, invalid stage mapping, duplicate pipeline label, missing mandatory data, or other pipeline update/delete validation errors." }, "403": { "content": { "application/json": { "examples": { "NoPermissionErrorResponse": { "value": { "code": "NO_PERMISSION", "details": { "permissions": "Crm_Implied_Customize_Zoho_CRM" }, "message": "permission denied to customize Zoho CRM", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineNoPermissionErrorResponse" } } }, "description": "The user does not have permission to update or delete pipeline settings in Zoho CRM." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.UPDATE" ] } ], "summary": "Pipeline", "tags": [ "pipeline" ], "x-zoho-document": "pipeline", "x-zs-llm-description": "Identifies the target pipeline by id inside the request body rather than the URL path, so a single request can only carry one pipeline item (maxItems: 1). To delete instead of update, set the item's _delete.permanent field instead of supplying display_value/maps. To delete a specific stage within maps, add _delete.permanent to that stage entry; at least one stage must remain after deletion." }, "post": { "description": "Create a new pipeline for the specified Deals layout by providing a pipeline display label and one or more mapped stages.", "operationId": "createPipeline", "parameters": [ { "$ref": "#/components/parameters/LayoutID" } ], "requestBody": { "content": { "application/json": { "examples": { "PipelineCreateRequest": { "value": { "pipeline": [ { "default": true, "display_value": "adfadf12adf", "maps": [ { "id": "2766660000000007106", "sequence_number": 2 }, { "id": "2766660000000007104", "sequence_number": 1 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "PipelineCreateResponse": { "value": { "pipeline": [ { "code": "SUCCESS", "details": { "id": "2766660000055809093" }, "message": "Pipeline created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineSuccessResponse" } } }, "description": "Success Response" }, "400": { "content": { "application/json": { "examples": { "DisplayValueIsNotFountError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "DuplicatePipelineNameError": { "value": { "pipeline": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "Duplicate pipeline label found", "status": "error" } ] } }, "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } }, "InvalidMapStageIDError": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Invalid child option id", "status": "error" } ] } }, "MapIDNotFoundError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PipelineCreateErrorResponse" }, { "$ref": "#/components/schemas/PipelineGetErrorResponse" } ], "x-zs-$id": "PipelineCreate400ErrorResponse", "x-zs-llm-description": "Response matches PipelineGetErrorResponse when layout_id itself is invalid; otherwise it matches PipelineCreateErrorResponse for request-body validation failures (duplicate label, invalid stage id, missing mandatory fields)." } } }, "description": "The request body or layout_id is invalid, or mandatory fields required to create the pipeline are missing." }, "403": { "content": { "application/json": { "examples": { "NoPermissionErrorResponse": { "value": { "code": "NO_PERMISSION", "details": { "permissions": "Crm_Implied_Customize_Zoho_CRM" }, "message": "permission denied to customize Zoho CRM", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineNoPermissionErrorResponse" } } }, "description": "The user does not have permission to create or customize pipelines in Zoho CRM." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.CREATE" ] } ], "summary": "Pipeline", "tags": [ "pipeline" ], "x-zoho-document": "pipeline", "x-zs-llm-description": "Creates exactly one pipeline per request (the pipeline array accepts only 1 item). Each stage entry in maps must reference an existing stage ID from the layout's picklist; use the Get Pipelines API to discover valid stage IDs before calling this endpoint." }, "put": { "description": "Update, or delete a pipeline for the specified layout using the supplied pipeline configuration in the request body.", "operationId": "replacePipelines", "parameters": [ { "$ref": "#/components/parameters/LayoutID" } ], "requestBody": { "content": { "application/json": { "examples": { "PipelineDeleteRequest": { "value": { "pipeline": [ { "_delete": { "permanent": null }, "id": "12345678901234567890" } ] } }, "PipelineUpdateRequest": { "value": { "pipeline": [ { "default": false, "display_value": "adfadf12adf", "id": "12345678901234567890", "maps": [ { "id": "2766660000000007106", "sequence_number": 2 }, { "id": "2766660000000007104", "sequence_number": 1 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "PipelineUpdateResponse": { "value": { "pipeline": [ { "code": "SUCCESS", "details": { "id": "2766660000055809093" }, "message": "Pipeline updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineSuccessResponse" } } }, "description": "The pipeline was updated successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduledError": { "value": { "pipeline": [ { "code": "ALREADY_SCHEDULED", "details": { "api_name": "pipeline", "json_path": "$.pipeline[0].pipeline", "value": "2766660000056063000" }, "message": "Scheduler already running for this pipeline", "status": "error" } ] } }, "CannotRemoveTheLastStageErrorResponse": { "value": { "pipeline": [ { "code": "CANNOT_DELETE", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Cannot delete the last stage associated with the pipeline", "status": "error" } ] } }, "DisplayValueIsNotFountError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "DuplicatePipelineNameError": { "value": { "pipeline": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "Duplicate pipeline label found", "status": "error" } ] } }, "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } }, "InvalidMapStageIDError": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Invalid child option id", "status": "error" } ] } }, "MapIDNotFoundError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "required field not found", "status": "error" } ] } }, "MaximumLengthExceededError": { "value": { "code": "INVALID_DATA", "details": { "api_name": "pipeline", "json_path": "$.pipeline", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "NoMappingFoundErrorRespones": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": {}, "message": "No mapping found ", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PipelineUpdateOrDeleteErrorResponse" }, { "$ref": "#/components/schemas/PipelineGetErrorResponse" }, { "$ref": "#/components/schemas/PipelineMaximumLengthErrorResponse" } ], "x-zs-$id": "PipelineUpdateOrDelete400ErrorResponse", "x-zs-llm-description": "Response matches PipelineGetErrorResponse when layout_id is invalid, MaximumLengthErrorResponse when the pipeline array exceeds its maxItems limit, or PipelineUpdateOrDeleteErrorResponse for all other body validation failures (invalid pipeline/stage id, duplicate label, cannot delete last stage, already-scheduled transfer)." } } }, "description": "The request is invalid due to an invalid layout_id, invalid pipeline or stage data, missing required fields, or a request size or length constraint violation." }, "403": { "content": { "application/json": { "examples": { "NoPermissionErrorResponse": { "value": { "code": "NO_PERMISSION", "details": { "permissions": "Crm_Implied_Customize_Zoho_CRM" }, "message": "permission denied to customize Zoho CRM", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineNoPermissionErrorResponse" } } }, "description": "The user does not have permission to update or delete pipeline settings in Zoho CRM." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.UPDATE" ] } ], "summary": "Pipeline", "tags": [ "pipeline" ], "x-zoho-document": "pipeline", "x-zs-llm-description": "Behaves the same as the PATCH variant on this path (body-identified pipeline via id, maxItems: 1, delete via _delete.permanent) — this PUT is provided as an alternate HTTP verb for the identical operation, not a full-resource replace. Prefer either verb consistently within an integration to avoid confusion." } }, "/crm/v8/settings/pipeline/actions/transfer": { "post": { "description": "Transfer records and stage mappings from one pipeline to another in the specified layout, and delete the source pipeline after the transfer is scheduled.", "operationId": "transferAndDeletePipelines", "parameters": [ { "$ref": "#/components/parameters/LayoutID" } ], "requestBody": { "content": { "application/json": { "examples": { "PipelineTransferRequest": { "value": { "transfer_pipeline": [ { "pipeline": { "from": "2766660000056473266", "to": "2766660000056473305" }, "stages": [ { "from": "2766660000000007104", "to": "2766660000000007104" }, { "from": "2766660000000007106", "to": "2766660000000007106" }, { "from": "2766660000000007110", "to": "2766660000000007104" }, { "from": "2766660000000007112", "to": "2766660000000007106" }, { "from": "2766660000000007114", "to": "2766660000000007104" }, { "from": "2766660000030928184", "to": "2766660000000007104" }, { "from": "2766660000030928185", "to": "2766660000000007106" }, { "from": "2766660000030928272", "to": "2766660000000007104" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineTransferResponse" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "PipelineTransferResponseSuccess": { "value": { "transfer_pipeline": [ { "code": "SUCCESS", "details": { "job_id": "2766660000056808404" }, "message": "transfer pipeline scheduled successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineTransferSuccessResponse" } } }, "description": "The pipeline transfer and delete operation was scheduled successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadySchedulerError": { "value": { "transfer_pipeline": [ { "code": "ALREADY_SCHEDULED", "details": { "api_name": "cvid", "value": "2766660000054211054" }, "message": "Scheduler already running for this pipeline", "status": "error" } ] } }, "AlreadyUsedStagedError": { "value": { "transfer_pipeline": [ { "code": "ALREADY_USED", "details": { "api_name": "from", "exists_in": { "json_path": "$.transfer_pipeline[0].stages[0].from" }, "json_path": "$.transfer_pipeline[0].stages[1].from" }, "message": "from id is mapped more than once", "status": "error" } ] } }, "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } }, "InvalidPipelineFromID": { "value": { "transfer_pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "from", "json_path": "$.transfer_pipeline[0].pipeline[0].from" }, "message": "Invalid from id", "status": "error" } ] } }, "InvalidPipelineToID": { "value": { "transfer_pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "to", "json_path": "$.transfer_pipeline[0].pipeline[0].to" }, "message": "Invalid to id", "status": "error" } ] } }, "InvalidStageFromID": { "value": { "transfer_pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "from", "json_path": "$.transfer_pipeline[0].stages[0].from" }, "message": "Invalid from id", "status": "error" } ] } }, "InvalidStageToID": { "value": { "transfer_pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "to", "json_path": "$.transfer_pipeline[0].stages[0].to" }, "message": "Invalid to id", "status": "error" } ] } }, "PipelineFromAndToIDAreSame": { "value": { "transfer_pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "to", "json_path": "$.transfer_pipeline[0].pipeline[0].to" }, "message": "Both from_id and to_id cannot be same ", "status": "error" } ] } }, "StageNotFound": { "value": { "transfer_pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "stages", "json_path": "$.transfer_pipeline[0].stages" }, "message": "Required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PipelineTransferErrorResponse" }, { "$ref": "#/components/schemas/PipelineGetErrorResponse" } ], "x-zs-$id": "PipelineTransfer400ErrorResponse", "x-zs-llm-description": "Response matches PipelineGetErrorResponse when layout_id is invalid, otherwise PipelineTransferErrorResponse for transfer-specific validation failures (invalid source/target pipeline or stage id, duplicate stage mapping, already-scheduled transfer)." } } }, "description": "The request is invalid due to invalid source or target pipeline or stage IDs, duplicate stage mappings, invalid layout_id, missing required fields, or a transfer that is already scheduled." }, "403": { "content": { "application/json": { "examples": { "NoPermissionErrorResponse": { "value": { "code": "NO_PERMISSION", "details": { "permissions": "Crm_Implied_Customize_Zoho_CRM" }, "message": "permission denied to customize Zoho CRM", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineNoPermissionErrorResponse" } } }, "description": "The user does not have permission to transfer or delete pipelines in Zoho CRM." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.CREATE" ] } ], "summary": "Transfer Pipeline", "tags": [ "pipeline" ], "x-zoho-document": "pipeline", "x-zs-llm-description": "Irreversible: the source pipeline (pipeline.from) is deleted once the transfer job is scheduled — the response returns only a job_id, not immediate completion. Every stage belonging to the source pipeline must appear in the stages array with a valid target stage from the destination pipeline; an unmapped source stage causes the request to fail. Use the Get Pipelines API beforehand to enumerate the source pipeline's stage IDs and the destination pipeline's stage IDs." } }, "/crm/v8/settings/pipeline/{pipelineIdentifier}": { "get": { "description": "Retrieve a specific pipeline by pipeline ID for the specified Deals layout.", "operationId": "getPipeline", "parameters": [ { "$ref": "#/components/parameters/LayoutID" }, { "$ref": "#/components/parameters/PipelineId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SinglePipelineGetResponse": { "value": { "pipeline": [ { "actual_value": "Standard (JackFer)", "default": true, "display_value": "Standard (JackFer)", "id": "2766660000055809075", "maps": [ { "actual_value": "Qualification", "display_value": "Qualification", "forecast_category": { "id": "2766660000000007092", "name": "Pipeline" }, "forecast_type": "Open", "id": "2766660000000007104", "sequence_number": 1 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/SinglePipelineGetResponse" } } }, "description": "Successfully retrieved the requested pipeline." }, "204": { "description": "No pipeline was found for the given pipeline ID and layout combination." }, "400": { "content": { "application/json": { "examples": { "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineGetErrorResponse" } } }, "description": "The request is invalid, for example when the layout_id is invalid." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.READ" ] } ], "summary": "Specific Pipeline", "tags": [ "pipeline" ], "x-zoho-document": "pipeline" }, "patch": { "description": "Update or delete a specific pipeline identified by the path ID within the specified layout.", "operationId": "updatePipelineById", "parameters": [ { "$ref": "#/components/parameters/PipelineId" }, { "$ref": "#/components/parameters/LayoutID" } ], "requestBody": { "content": { "application/json": { "examples": { "PipelineDeleteRequest": { "value": { "pipeline": [ { "_delete": { "permanent": null } } ] } }, "PipelineUpdateRequest": { "value": { "pipeline": [ { "default": false, "display_value": "adfadf12adf", "maps": [ { "id": "2766660000000007106", "sequence_number": 2 }, { "id": "2766660000000007104", "sequence_number": 1 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineUpdateRequestUrl" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "PipelineUpdateResponse": { "value": { "pipeline": [ { "code": "SUCCESS", "details": { "id": "2766660000055809093" }, "message": "Pipeline updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineSuccessResponse" } } }, "description": "The specified pipeline was updated or deleted successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduledError": { "value": { "pipeline": [ { "code": "ALREADY_SCHEDULED", "details": { "api_name": "pipeline", "json_path": "$.pipeline[0].pipeline", "value": "2766660000056063000" }, "message": "Scheduler already running for this pipeline", "status": "error" } ] } }, "CannotRemoveTheLastStageErrorResponse": { "value": { "pipeline": [ { "code": "CANNOT_DELETE", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Cannot delete the last stage associated with the pipeline", "status": "error" } ] } }, "DisplayValueIsNotFountError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "DuplicatePipelineNameError": { "value": { "pipeline": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "Duplicate pipeline label found", "status": "error" } ] } }, "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } }, "InvalidMapStageIDError": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Invalid child option id", "status": "error" } ] } }, "InvalidPipelineID": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": { "id": "12345678901234567890" }, "message": "required field not found", "status": "error" } ] } }, "InvalidPipelineIdInUrlErrorResponse": { "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "invalid pick_list_values id", "status": "error" } }, "MapIDNotFoundError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "required field not found", "status": "error" } ] } }, "NoMappingFoundErrorRespones": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": {}, "message": "No mapping found ", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PipelineUpdateOrDeleteUrlErrorResponse" }, { "$ref": "#/components/schemas/PipelineUpdateOrDeleteErrorResponse" }, { "$ref": "#/components/schemas/PipelineGetErrorResponse" } ], "x-zs-$id": "PipelineUpdateOrDeleteByIdErrorResponse", "x-zs-llm-description": "Response matches PipelineUpdateOrDeleteUrlErrorResponse when the pipelineIdentifier path parameter itself is invalid, PipelineGetErrorResponse when layout_id is invalid, or PipelineUpdateOrDeleteErrorResponse for all other body validation failures (invalid stage id, duplicate label, cannot delete last stage, already-scheduled transfer)." } } }, "description": "The request is invalid due to an invalid pipeline ID, invalid layout_id, invalid stage mapping, duplicate pipeline label, missing required fields, or other pipeline validation errors." }, "403": { "content": { "application/json": { "examples": { "NoPermissionErrorResponse": { "value": { "code": "NO_PERMISSION", "details": { "permissions": "Crm_Implied_Customize_Zoho_CRM" }, "message": "permission denied to customize Zoho CRM", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineNoPermissionErrorResponse" } } }, "description": "The user does not have permission to update or delete the specified pipeline in Zoho CRM." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.UPDATE" ] } ], "summary": "Pipeline", "tags": [ "pipeline" ], "x-zoho-document": "pipeline", "x-zs-llm-description": "The pipeline is identified by the pipelineIdentifier path parameter, so unlike the body-identified PATCH on /settings/pipeline, request body items must NOT include id. To delete the pipeline instead of updating it, set _delete.permanent on the item instead of display_value/maps." }, "put": { "description": "Update or replace a specific pipeline identified by the path ID for the specified layout.", "operationId": "replacePipelineById", "parameters": [ { "$ref": "#/components/parameters/PipelineId" }, { "$ref": "#/components/parameters/LayoutID" } ], "requestBody": { "content": { "application/json": { "examples": { "PipelineDeleteRequest": { "value": { "pipeline": [ { "_delete": { "permanent": null } } ] } }, "PipelineUpdateRequest": { "value": { "pipeline": [ { "default": false, "display_value": "adfadf12adf", "maps": [ { "id": "2766660000000007106", "sequence_number": 2 }, { "id": "2766660000000007104", "sequence_number": 1 } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineUpdateRequestUrl" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "PipelineUpdateResponse": { "value": { "pipeline": [ { "code": "SUCCESS", "details": { "id": "2766660000055809093" }, "message": "Pipeline updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PipelineSuccessResponse" } } }, "description": "The specified pipeline was updated successfully." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduledError": { "value": { "pipeline": [ { "code": "ALREADY_SCHEDULED", "details": { "api_name": "pipeline", "json_path": "$.pipeline[0].pipeline", "value": "2766660000056063000" }, "message": "Scheduler already running for this pipeline", "status": "error" } ] } }, "CannotRemoveTheLastStageErrorResponse": { "value": { "pipeline": [ { "code": "CANNOT_DELETE", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Cannot delete the last stage associated with the pipeline", "status": "error" } ] } }, "DisplayValueIsNotFountError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "required field not found", "status": "error" } ] } }, "DuplicatePipelineNameError": { "value": { "pipeline": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "display_value", "json_path": "$.pipeline[0].display_value" }, "message": "Duplicate pipeline label found", "status": "error" } ] } }, "InvalidLayoutID": { "value": { "code": "INVALID_DATA", "details": { "param_name": "layout_id" }, "message": "Invalid layoutid", "status": "error" } }, "InvalidMapStageIDError": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "Invalid child option id", "status": "error" } ] } }, "InvalidPipelineID": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": { "id": "12345678901234567890" }, "message": "required field not found", "status": "error" } ] } }, "InvalidPipelineIdInUrlErrorResponse": { "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "invalid pick_list_values id", "status": "error" } }, "MapIDNotFoundError": { "value": { "pipeline": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.pipeline[0].maps[0].id" }, "message": "required field not found", "status": "error" } ] } }, "NoMappingFoundErrorRespones": { "value": { "pipeline": [ { "code": "INVALID_DATA", "details": {}, "message": "No mapping found ", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PipelineUpdateOrDeleteUrlErrorResponse" }, { "$ref": "#/components/schemas/PipelineUpdateOrDeleteErrorResponse" }, { "$ref": "#/components/schemas/PipelineGetErrorResponse" } ], "x-zs-$id": "PipelineUpdateOrDelete400ByIdErrorResponse", "x-zs-llm-description": "Response matches PipelineUpdateOrDeleteUrlErrorResponse when the pipelineIdentifier path parameter itself is invalid, PipelineGetErrorResponse when layout_id is invalid, or PipelineUpdateOrDeleteErrorResponse for all other body validation failures (invalid stage id, duplicate label, cannot delete last stage, already-scheduled transfer)." } } }, "description": "The request is invalid due to an invalid pipeline ID, invalid layout_id, invalid stage data, missing required fields, or other pipeline validation errors." }, "403": { "content": { "application/json": { "examples": { "NoPermissionErrorResponse": { "value": { "code": "NO_PERMISSION", "details": { "permissions": "Crm_Implied_Customize_Zoho_CRM" }, "message": "permission denied to customize Zoho CRM", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/PipelineNoPermissionErrorResponse" } } }, "description": "The user does not have permission to update or delete the specified pipeline in Zoho CRM." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.pipeline.UPDATE" ] } ], "summary": "Pipeline", "tags": [ "pipeline" ], "x-zoho-document": "pipeline", "x-zs-llm-description": "Behaves the same as the PATCH variant on this path (pipeline identified via pipelineIdentifier path parameter, request body items must not include id, delete via _delete.permanent) — this PUT is an alternate HTTP verb for the identical operation, not a full-resource replace." } }, "/crm/v8/settings/portals": { "get": { "description": "To retrieve the list of all portals configured for the Zoho CRM organization. A 204 response indicates no portal has been created yet.", "operationId": "getPortals", "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the list of portals returned for the organization, including creation and modification metadata.", "summary": "Successful portal list retrieval", "value": { "portals": [ { "active": true, "created_by": { "id": "0987654321", "name": "Jane Doe" }, "created_time": "2022-12-20T10:23:57Z", "login_url": "www.example.com", "modified_by": { "id": "1234567890", "name": "John Doe" }, "modified_time": "2022-12-20T10:23:57Z", "name": "portalname", "zaid": "1234567890" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 200 response schema for listing portals, containing the array of portal summary objects.", "properties": { "portals": { "description": "Represents the list of portals configured for the organization.", "items": { "additionalProperties": false, "description": "Represents the summary details of a single portal.", "properties": { "active": { "description": "Indicates whether the portal is active.", "type": "boolean" }, "created_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who created this portal.", "properties": { "id": { "description": "Represents the unique identifier of the user who created this portal.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who created this portal.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the timestamp when the portal was first added.", "format": "date-time", "type": "string" }, "login_url": { "description": "Represents the login URL for the portal.", "maxLength": 2048, "type": "string" }, "modified_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who last modified this portal.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified this portal.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who last modified this portal.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "modified_time": { "description": "Represents the timestamp when the portal configuration was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "Represents the unique name of the portal.", "maxLength": 60, "type": "string", "x-zs-$id": "PortalsName" }, "zaid": { "description": "Represents the Zoho account ID (`zaid`) associated with the portal.", "maxLength": 255, "type": "string" } }, "required": [ "created_time", "modified_time", "modified_by", "created_by", "zaid", "name", "active" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portals" ], "type": "object", "x-zs-$id": "GetPortalsResponse" } } }, "description": "Returns the list of portals configured for the organization with their summary details." }, "204": { "description": "No portal has been created for this organization. The response body is empty." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "Shows the error response when the Get Portals API is called in a sandbox environment, which is not supported.", "summary": "API_NOT_SUPPORTED - sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the API_NOT_SUPPORTED error returned when the Get Portals API is called in a sandbox environment.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **API_NOT_SUPPORTED** - the API is not supported in the current environment. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context.", "properties": { "unsupported_environment": { "description": "Represents the environment type that does not support this API.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "GetPortalsSandboxErrorResponse" } } }, "description": "The API is not supported in the current environment. Resolution: Retry the request in a production environment." }, "403": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows the error response when the authenticated user lacks the required Read Portals permission.", "summary": "NO_PERMISSION - insufficient portal permission", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Permission is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error returned when the authenticated user lacks the required portal read permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required permission. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "GetPortalsForbiddenResponse" } } }, "description": "The authenticated user does not have the required `ZohoCRM.settings.clientportal.READ` permission. Resolution: Ensure the access token includes the correct scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.READ" ] } ], "summary": "Portals", "tags": [ "portals" ], "x-zoho-document": "portals", "x-zs-llm-description": "Retrieves basic portal info; returns 204 if no portal is configured." }, "post": { "description": "To create a Client Portal for the Zoho CRM organization. Only one portal can be created per organization. The portal name must be unique across Zoho, between 6 and 30 characters.", "operationId": "createPortal", "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Shows a sample request body for creating a portal with a name.", "summary": "Sample portal creation request", "value": { "portals": [ { "name": "examplePortal" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body schema for creating a portal, containing the portal name.", "properties": { "portals": { "description": "Specify the list of portals to create. Only one portal is allowed per request.", "items": { "additionalProperties": false, "description": "Represents the configuration for a new portal.", "properties": { "name": { "description": "Specify the display name for the portal. The name must be between 6 and 30 characters.", "maxLength": 30, "minLength": 6, "type": "string" } }, "required": [ "name" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portals" ], "type": "object" }, "x-zs-llm-examples": [ "Default" ] } }, "description": "The request body must contain a **portals** array with exactly one portal object specifying the portal name. The name must be unique, between 6 and 30 characters.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the response after a portal creation completes successfully.", "summary": "Successful portal creation", "value": { "portals": [ { "code": "SUCCESS", "details": { "name": "examplePortal" }, "message": "Portal created successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 200 response schema for a successful portal creation, including the portal name and result code.", "properties": { "portals": { "description": "Represents the list of created portals.", "items": { "additionalProperties": false, "description": "Represents the creation result for a single portal.", "properties": { "code": { "description": "Represents the result code for the portal creation.\nPossible values: **SUCCESS** - the portal creation completed successfully. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the created portal.", "properties": { "name": { "description": "Represents the name of the created portal.", "maxLength": 30, "type": "string" } }, "required": [ "name" ], "type": "object" }, "message": { "description": "Represents the confirmation message for the portal creation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the portal creation.\nPossible values: **success** - the operation completed successfully. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portals" ], "type": "object", "x-zs-$id": "CreatePortalSuccessResponse" } } }, "description": "Returns the result of the portal creation, including the portal name and a SUCCESS status code." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "Shows the error response when the Create Portal API is called in a sandbox environment, which is not supported.", "summary": "API_NOT_SUPPORTED - sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "Example1": { "description": "Shows the error response when a portal name field value is invalid or out of range.", "summary": "INVALID_DATA - portal name validation error", "value": { "portals": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.portals[0].name", "minimum_length": 6 }, "message": "invalid data", "status": "error" } ] } }, "Example2": { "description": "Shows the error response when the specified portal name is already in use by another organization.", "summary": "ALREADY_USED - portal name already in use", "value": { "portals": [ { "code": "ALREADY_USED", "details": { "api_name": "name" }, "message": "The entered portal name is already in use", "status": "error" } ] } }, "Example3": { "description": "Shows the error response when the required portal name field is missing from the request.", "summary": "MANDATORY_NOT_FOUND - required field missing", "value": { "portals": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.portals[0].name" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the 403 error response when the authenticated user lacks the required permission to create a portal.", "properties": { "portals": { "description": "Represents the list of per-portal validation errors returned when the request is invalid.", "items": { "additionalProperties": false, "description": "Represents the validation error object for a single portal in the request.", "properties": { "code": { "description": "Represents the error code identifying the type of validation failure.\nPossible values: **INVALID_DATA** - a field value is invalid or out of range. **ALREADY_USED** - the portal name is already in use. **MANDATORY_NOT_FOUND** - a required field is missing. ", "enum": [ "ALREADY_USED", "PATTERN_NOT_MATCHED", "MANDATORY_NOT_FOUND", "INVALID_DATA", "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that failed validation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON Path location of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed character length for the field.", "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum required character length for the field.", "format": "int32", "type": "integer" }, "regex": { "description": "Represents the regular expression pattern the field value must match.", "maxLength": 255, "type": "string" }, "resource_path_index": { "description": "Represents the index of the array item associated with the validation error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request encountered a validation error. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "CreatePortalBadRequestResponse" }, { "additionalProperties": false, "description": "Represents the API_NOT_SUPPORTED error returned when the Create Portal API is called in a sandbox environment.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **API_NOT_SUPPORTED** - the API is not supported in the current environment. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context.", "properties": { "unsupported_environment": { "description": "Represents the environment type that does not support this API.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "CreatePortalSandboxErrorResponse" } ], "description": "Represents the 400 error response schema for portal creation, covering per-portal validation errors and sandbox restrictions.", "x-zs-$id": "CreatePortalBadRequestResponseWrapper" } } }, "description": "The request is invalid. Possible causes include an invalid portal name format, a portal name that is already in use, a missing required field, or a sandbox restriction. Resolution: Review the error details and correct the request before retrying." }, "403": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows the error response when the authenticated user lacks the required Create Portal permission and a specific permission identifier is included.", "summary": "NO_PERMISSION - required permission missing", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "Permission is invalid.", "status": "error" } }, "Example2": { "description": "Shows the error response when the authenticated user lacks the required Create Portal permission.", "summary": "NO_PERMISSION - insufficient portal permission", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Permission is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error returned when the authenticated user lacks the required portal creation permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required permission. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "CreatePortalForbiddenResponse" } } }, "description": "The authenticated user does not have the required `ZohoCRM.settings.clientportal.CREATE` permission. Resolution: Ensure the access token includes the correct scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.CREATE" ] } ], "summary": "Portal", "tags": [ "portals" ], "x-zoho-document": "portals", "x-zs-llm-description": "Create portal for the org. Throws exception if portal already exist." } }, "/crm/v8/settings/portals/{portal}": { "get": { "description": "To retrieve the complete configuration of a specific portal in the Zoho CRM organization, including its SAML authentication settings, active status, and creation metadata.", "operationId": "getPortal", "parameters": [ { "$ref": "#/components/parameters/Portals" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the complete portal configuration returned for a specific portal, including SAML settings.", "summary": "Successful portal details retrieval", "value": { "portals": [ { "acs_url": "www.example.com", "active": true, "admin_zuid": 1234567890, "created_by": { "id": "0987654321", "name": "Jane Doe" }, "created_time": "2022-12-20T10:23:57Z", "default_relay_state_url": "https://www.example.com", "issuer": "example.com", "login_url": "www.example.com", "modified_by": { "id": "1234567890", "name": "John Doe" }, "modified_time": "2022-12-20T10:23:57Z", "saml_configuration": { "active": true, "created_by": { "id": "0987654321", "name": "Jane Doe" }, "login_url": "https://www.example.com", "logout_url": "https://www.example.com", "modified_by": { "id": "1234567890", "name": "John Doe" }, "public_key": "-----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOYW3TUj0+8EZOdU+Vj0lhgr61+bJHgnYiyA83LHqKcIKXEYVs70Lb3Ors4dU7XU6gBzxLnsf9nCECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAUiTh+to8d/QKYh9yOLqE25PraBEVselNgNx8Dly//JXfXz42lzwG5WOY94bmUur2qYe8sVUqY07O/1XSW7QBrGMhGA9Hhvgz6zrRPzGPUVVQT3caTG/b+1pNLriga7OSam6rp1uL5emutkyyn6ZUZ7px4K1vGEx6/GBFsepGH5E2N0PRuekTp0eiV+5m+6z4VL7tVtYGQbWUfVgBqBUEhkdu450ry0jJT6SPs1W8TPBQEZQ/Pjis4MubIRKrUtkb+SkLDpBSWmXdoKlsIJt8VqhdqN04bmt91sB+XdgSC4X7ideK7WPcEj2DYna4v/YB13MitxQrKKU9uT/HNm1JHg==n-----END CERTIFICATE-----" }, "single_logout_url": "https://www.example.com", "zaid": "1234567890" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 200 response schema for getting a portal by identifier, containing the full portal configuration.", "properties": { "portals": { "description": "Represents the list of portal objects returned by the response.", "items": { "additionalProperties": false, "description": "Represents the detailed configuration of a single portal.", "properties": { "acs_url": { "description": "Represents the Assertion Consumer Service (ACS) URL for the portal.", "maxLength": 2048, "type": "string" }, "active": { "description": "Indicates whether the portal is active.", "type": "boolean" }, "admin_zuid": { "description": "Represents the Zoho account zone ID of the portal administrator.", "format": "int32", "type": "integer" }, "created_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who created this portal.", "properties": { "id": { "description": "Represents the unique identifier of the CRM user who created this portal.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the CRM user who created this portal.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the timestamp when the portal was first added.", "format": "date-time", "type": "string" }, "default_relay_state_url": { "description": "Represents the default relay state URL used after a successful SAML login.", "maxLength": 2048, "type": "string" }, "issuer": { "description": "Represents the SAML issuer identifier (entity ID) for the portal.", "maxLength": 2048, "type": "string" }, "login_url": { "description": "Represents the login URL for the portal. Displayed on the portal login page.", "maxLength": 2048, "type": "string" }, "modified_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who last modified this portal.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified this portal.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who last modified this portal.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "modified_time": { "description": "Represents the timestamp when the portal configuration was last modified.", "format": "date-time", "type": "string" }, "name": { "description": "Represents the unique name of the portal.", "maxLength": 50, "type": "string", "x-zs-$id": "PortalName" }, "saml_configuration": { "additionalProperties": false, "description": "Represents the SAML authentication configuration for the portal.", "properties": { "active": { "description": "Indicates whether the SAML configuration is active for the portal. Possible values: **true** - SAML SSO is enabled.", "enum": [ true ], "type": "boolean" }, "created_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who created this SAML configuration.", "properties": { "id": { "description": "Represents the unique identifier of the CRM user who created this SAML configuration.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the CRM user who created this SAML configuration.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "login_url": { "description": "Represents the SAML SSO login URL where the portal redirects users for authentication.", "maxLength": 2048, "type": "string" }, "logout_url": { "description": "Represents the SAML SSO logout URL where the portal redirects users when they sign out. Must begin with `https://www.`.", "maxLength": 2048, "pattern": "http[s]://www[.][a-z]{7}[.]com", "type": "string" }, "modified_by": { "additionalProperties": false, "description": "Represents the Zoho CRM user who last modified this SAML configuration.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified this SAML configuration.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who last modified this SAML configuration.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "public_key": { "description": "Represents the SAML X.509 public key certificate used to verify assertions from the identity provider.", "enum": [ "-----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOYW3TUj0+8EZOdU+Vj0lhgr61+bJHgnYiyA83LHqKcIKXEYVs70Lb3Ors4dU7XU6gBzxLnsf9nCECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAUiTh+to8d/QKYh9yOLqE25PraBEVselNgNx8Dly//JXfXz42lzwG5WOY94bmUur2qYe8sVUqY07O/1XSW7QBrGMhGA9Hhvgz6zrRPzGPUVVQT3caTG/b+1pNLriga7OSam6rp1uL5emutkyyn6ZUZ7px4K1vGEx6/GBFsepGH5E2N0PRuekTp0eiV+5m+6z4VL7tVtYGQbWUfVgBqBUEhkdu450ry0jJT6SPs1W8TPBQEZQ/Pjis4MubIRKrUtkb+SkLDpBSWmXdoKlsIJt8VqhdqN04bmt91sB+XdgSC4X7ideK7WPcEj2DYna4v/YB13MitxQrKKU9uT/HNm1JHg==n-----END CERTIFICATE-----" ], "maxLength": 5000, "type": "string" } }, "required": [ "login_url", "logout_url", "public_key", "active" ], "type": [ "object", "null" ] }, "single_logout_url": { "description": "Represents the single logout URL (SLO) used to terminate SAML sessions across all service providers.", "maxLength": 2048, "type": "string" }, "zaid": { "description": "Represents the Zoho account ID (`zaid`) associated with the portal.", "maxLength": 255, "type": "string" } }, "required": [ "created_time", "modified_time", "modified_by", "created_by", "zaid", "active", "saml_configuration" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portals" ], "type": "object", "x-zs-$id": "GetPortalDetailsResponse" } } }, "description": "Returns the complete configuration of the specified portal, including SAML settings and metadata." }, "204": { "description": "No portal has been created for this organization. The response body is empty." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "Shows the error response when the Get Portal API is called in a sandbox environment, which is not supported.", "summary": "API_NOT_SUPPORTED - sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the API_NOT_SUPPORTED error returned when the Get Portal API is called in a sandbox environment.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **API_NOT_SUPPORTED** - the API is not supported in the current environment. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context.", "properties": { "unsupported_environment": { "description": "Represents the environment type that does not support this API.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "GetPortalSandboxErrorResponse" } } }, "description": "The API is not supported in the current environment. Resolution: Retry the request in a production environment." }, "403": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows the error response when the authenticated user lacks the required Read Portal permission and a specific permission identifier is included.", "summary": "NO_PERMISSION - required permission missing", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "Permission is invalid.", "status": "error" } }, "Example2": { "description": "Shows the error response when the authenticated user lacks the required Read Portal permission.", "summary": "NO_PERMISSION - insufficient portal permission", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Permission is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error returned when the authenticated user lacks the required portal read permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required permission. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "GetPortalDetailsForbiddenResponse" } } }, "description": "The authenticated user does not have the required `ZohoCRM.settings.clientportal.READ` permission. Resolution: Ensure the access token includes the correct scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.READ" ] } ], "summary": "Specific Portal", "tags": [ "portals" ], "x-zoho-document": "portals", "x-zs-llm-description": "Retrieves portal details, returns 204 if portalname was invalid." }, "put": { "description": "To update the configuration of an existing portal in the Zoho CRM organization, including the portal name and SAML single sign-on settings.", "operationId": "updatePortal", "parameters": [ { "$ref": "#/components/parameters/Portals" } ], "requestBody": { "content": { "application/json": { "examples": { "Default": { "description": "Shows a sample request body for updating a portal name and SAML configuration.", "summary": "Sample portal update request", "value": { "portals": [ { "name": "updateportal", "saml_configuration": { "active": true, "login_url": "https://www.example.com", "logout_url": "https://www.example.com", "public_key": "-----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOYW3TUj0+8EZOdU+Vj0lhgr61+bJHgnYiyA83LHqKcIKXEYVs70Lb3Ors4dU7XU6gBzxLnsf9nCECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAUiTh+to8d/QKYh9yOLqE25PraBEVselNgNx8Dly//JXfXz42lzwG5WOY94bmUur2qYe8sVUqY07O/1XSW7QBrGMhGA9Hhvgz6zrRPzGPUVVQT3caTG/b+1pNLriga7OSam6rp1uL5emutkyyn6ZUZ7px4K1vGEx6/GBFsepGH5E2N0PRuekTp0eiV+5m+6z4VL7tVtYGQbWUfVgBqBUEhkdu450ry0jJT6SPs1W8TPBQEZQ/Pjis4MubIRKrUtkb+SkLDpBSWmXdoKlsIJt8VqhdqN04bmt91sB+XdgSC4X7ideK7WPcEj2DYna4v/YB13MitxQrKKU9uT/HNm1JHg==n-----END CERTIFICATE-----" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body schema for updating a portal, supporting name and SAML configuration updates.", "properties": { "portals": { "description": "Specify the list of portal update objects. Only one portal is allowed per request.", "items": { "additionalProperties": false, "description": "Represents the set of portal properties to update.", "properties": { "name": { "description": "Specify the updated display name for the portal. The name must be between 6 and 30 characters.", "maxLength": 30, "minLength": 6, "type": "string" }, "saml_configuration": { "additionalProperties": false, "description": "Specify the SAML configuration to apply to the portal.", "properties": { "active": { "description": "Specify **true** to activate the SAML configuration for the portal. Possible values: **true**.", "enum": [ true ], "type": "boolean" }, "login_url": { "description": "Specify the SAML SSO login URL for the portal. Must begin with `https://www.`. Required when updating SAML configuration.", "maxLength": 2048, "pattern": "http[s]://www[.][a-z]{7}[.]com", "type": "string" }, "logout_url": { "description": "Specify the SAML SSO logout URL for the portal. Must begin with `https://www.`. Required when updating SAML configuration.", "maxLength": 2048, "pattern": "http[s]://www[.][a-z]{7}[.]com", "type": "string" }, "public_key": { "description": "Specify the SAML X.509 public key certificate. Required when updating SAML configuration.", "maxLength": 5000, "type": "string" } }, "required": [ "login_url", "logout_url", "public_key" ], "type": "object" } }, "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portals" ], "type": "object" }, "x-zs-llm-examples": [ "Default" ] } }, "description": "The request body must contain a **portals** array with exactly one portal update object. You can update the portal name and SAML configuration. All SAML fields - `login_url`, `logout_url`, and `public_key` - are required when updating SAML settings.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "description": "Shows the response returned when a portal update is completed successfully.", "summary": "Successful portal update", "value": { "portals": [ { "code": "SUCCESS", "details": { "name": "examplePortal" }, "message": "Portal updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 200 response schema for a successful portal update, including the portal name and result code.", "properties": { "portals": { "description": "Represents the list of updated portal results.", "items": { "additionalProperties": false, "description": "Represents the update result for a single portal.", "properties": { "code": { "description": "Represents the result code for the portal update.\nPossible values: **SUCCESS** - the portal update completed successfully. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the updated portal.", "properties": { "name": { "description": "Represents the name of the updated portal.", "maxLength": 30, "type": "string" } }, "required": [ "name" ], "type": "object" }, "message": { "description": "Represents the confirmation message for the portal update.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the portal update.\nPossible values: **success** - the operation completed successfully. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portals" ], "type": "object", "x-zs-$id": "UpdatePortalSuccessResponse" } } }, "description": "Returns the result of the portal update, including the updated portal name and a SUCCESS status code." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "Shows the error response when the Update Portal API is called in a sandbox environment, which is not supported.", "summary": "API_NOT_SUPPORTED - sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "Example1": { "description": "Shows the error response when a portal field value is invalid or out of the allowed range.", "summary": "INVALID_DATA - portal field validation error", "value": { "portals": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.portals[0].name", "minimum_length": 6 }, "message": "invalid data", "status": "error" } ] } }, "Example2": { "description": "Shows the error response when the specified portal name is already in use by another organization.", "summary": "ALREADY_USED - portal name already in use", "value": { "portals": [ { "code": "ALREADY_USED", "details": { "api_name": "name" }, "message": "The entered portal name is already in use", "status": "error" } ] } }, "Example3": { "description": "Shows the error response when a required field is missing from the portal update request.", "summary": "MANDATORY_NOT_FOUND - required field missing", "value": { "portals": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.portals[0].name" }, "message": "required field not found", "status": "error" } ] } }, "Example4": { "description": "Shows the error response when the SAML login URL field is missing from the SAML configuration update.", "summary": "MANDATORY_NOT_FOUND - SAML login URL missing", "value": { "portals": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "login_url", "json_path": "$.portals[0].saml_configuration.login_url" }, "message": "login url is mandatory to configure saml", "status": "error" } ] } }, "Example5": { "description": "Shows the error response when the SAML public key field is missing from the SAML configuration update.", "summary": "MANDATORY_NOT_FOUND - SAML public key missing", "value": { "portals": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "public_key", "json_path": "$.portals[0].saml_configuration.public_key" }, "message": "public key is mandatory to configure saml", "status": "error" } ] } }, "Example6": { "description": "Shows the error response when an attempt is made to set a required SAML field to null.", "summary": "NOT_ALLOWED - null value not permitted", "value": { "portals": [ { "code": "NOT_ALLOWED", "details": { "api_name": "login_url", "json_path": "$.portals[0].saml_configuration.login_url" }, "message": "not allowed to set value as null", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the combined error response schema for the Update Portal operation.", "properties": { "portals": { "description": "Represents the list of per-portal validation errors returned when the update request is invalid.", "items": { "additionalProperties": false, "description": "Represents the validation error object for a single portal update.", "properties": { "code": { "description": "Represents the error code identifying the type of validation failure.\nPossible values: **INVALID_DATA** - a field value is invalid or out of range. **ALREADY_USED** - the portal name is already in use. **MANDATORY_NOT_FOUND** - a required field is missing. **NOT_ALLOWED** - the operation is not permitted. ", "enum": [ "ALREADY_USED", "PATTERN_NOT_MATCHED", "MANDATORY_NOT_FOUND", "INVALID_DATA", "NO_PERMISSION", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that failed validation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON Path location of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed character length for the field.", "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum required character length for the field.", "format": "int32", "type": "integer" }, "regex": { "description": "Represents the regular expression pattern the field value must match.", "maxLength": 255, "type": "string" }, "resource_path_index": { "description": "Represents the index of the array item associated with the validation error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request encountered a validation error. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portals" ], "type": "object", "x-zs-$id": "UpdatePortalBadRequestResponse" }, { "additionalProperties": false, "description": "Represents the per-portal validation error object returned when a portal update request fails validation.", "properties": { "code": { "description": "Represents the error code for the top-level error.\nPossible values: **INVALID_DATA** - a field value is invalid. **ALREADY_USED** - the portal name is already in use. **MANDATORY_NOT_FOUND** - a required field is missing. **NOT_ALLOWED** - the operation is not permitted. ", "enum": [ "ALREADY_USED", "PATTERN_NOT_MATCHED", "MANDATORY_NOT_FOUND", "INVALID_DATA", "NO_PERMISSION", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that failed validation.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON Path location of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed character length for the field.", "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum required character length for the field.", "format": "int32", "type": "integer" }, "regex": { "description": "Represents the regular expression pattern the field value must match.", "maxLength": 255, "type": "string" }, "resource_path_index": { "description": "Represents the index of the array item associated with the validation error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request encountered a validation error. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "UpdateErrorResponse" }, { "additionalProperties": false, "description": "Represents the API_NOT_SUPPORTED error returned when the Update Portal API is called in a sandbox environment.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **API_NOT_SUPPORTED** - the API is not supported in the current environment. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context.", "properties": { "unsupported_environment": { "description": "Represents the environment type that does not support this API.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "UpdatePortalSandboxErrorResponse" } ], "description": "Represents the 400 error response schema for portal updates, covering per-portal validation errors and sandbox restrictions.", "x-zs-$id": "UpdatePortalBadRequestResponseWrapper" } } }, "description": "The request is invalid. Possible causes include an invalid portal name, a name already in use, a missing required SAML field, a null value for a required field, or a sandbox restriction. Resolution: Review the error details and correct the request before retrying." }, "403": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows the error response when the authenticated user lacks the required Update Portal permission and a specific permission identifier is included.", "summary": "NO_PERMISSION - required permission missing", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "Permission is invalid.", "status": "error" } }, "Example2": { "description": "Shows the error response when the authenticated user lacks the required Update Portal permission.", "summary": "NO_PERMISSION - insufficient portal permission", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Permission is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error returned when the authenticated user lacks the required portal update permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required permission. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "maxLength": 255, "type": "string" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "UpdatePortalForbiddenResponse" } } }, "description": "The authenticated user does not have the required `ZohoCRM.settings.clientportal.UPDATE` permission. Resolution: Ensure the access token includes the correct scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.UPDATE" ] } ], "summary": "Portal", "tags": [ "portals" ], "x-zoho-document": "portals", "x-zs-llm-description": "Update the portal name or saml_configurations for portals." } }, "/crm/v8/settings/portals/{portal}/user_type": { "get": { "description": "Retrieves a list of all portal user types configured for the specified portal, with their summary configuration including name, status, user counts, and last modification time.", "operationId": "getPortalUserTypes", "parameters": [ { "$ref": "#/components/parameters/PortalUserTypeParamQueryInclude" }, { "$ref": "#/components/parameters/PortalUserTypeParamQueryIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Represents the response returned the portal user types list. The response contains an array of user type objects with their basic metadata, including name, active status, user counts, and personality module details.", "summary": "Portal user types retrieved successfully (200)", "value": { "user_type": [ { "active": true, "active_user_count": 1, "created_by": { "id": "111113000000059654", "name": "Pavithra R" }, "created_time": "2026-02-20T11:27:39+05:30", "deactive_user_count": 0, "default": true, "id": "111113000000158041", "invitation_field": { "api_name": "Email", "id": "111113000000004612" }, "modified_by": { "id": "111113000000059654", "name": "Pavithra R" }, "modified_time": "2026-02-24T18:04:01+05:30", "name": "Client Portal", "personality_module": { "api_name": "Contacts", "id": "111113000000002666", "plural_label": "Contacts" } }, { "active": true, "active_user_count": 0, "created_by": { "id": "111113000000059654", "name": "Pavithra R" }, "created_time": "2026-02-23T16:28:47+05:30", "deactive_user_count": 0, "default": false, "id": "111113000000165506", "invitation_field": { "api_name": "Email", "id": "111113000000162061" }, "modified_by": { "id": "111113000000059654", "name": "Pavithra R" }, "modified_time": "2026-02-23T16:32:01+05:30", "name": "Teachers", "personality_module": { "api_name": "Teachers", "id": "111113000000162002", "plural_label": "Teachers" } }, { "active": true, "active_user_count": 0, "created_by": { "id": "111113000000059654", "name": "Pavithra R" }, "created_time": "2026-02-25T11:39:39+05:30", "deactive_user_count": 0, "default": false, "id": "111113000000168122", "invitation_field": { "api_name": "Email", "id": "111113000000004612" }, "modified_by": { "id": "111113000000059654", "name": "Pavithra R" }, "modified_time": "2026-02-25T11:39:39+05:30", "name": "Client Portal V8", "personality_module": { "api_name": "Contacts", "id": "111113000000002666", "plural_label": "Contacts" } }, { "active": true, "active_user_count": 0, "created_by": { "id": "111113000000059654", "name": "Pavithra R" }, "created_time": "2026-02-25T12:25:22+05:30", "deactive_user_count": 0, "default": false, "id": "111113000000168238", "invitation_field": { "api_name": "Email", "id": "111113000000004612" }, "modified_by": { "id": "111113000000059654", "name": "Pavithra R" }, "modified_time": "2026-02-25T12:25:22+05:30", "name": "Client sPortal V8", "personality_module": { "api_name": "Contacts", "id": "111113000000002666", "plural_label": "Contacts" } } ] } } }, "schema": { "$ref": "#/components/schemas/GetusertypeResponse200" } } }, "description": "The list of portal user types for the specified portal was retrieved successfully." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "The API does not support requests made by client portal users. \n\n**Resolution:** Use a CRM user account that is not a client portal user to call this API.", "summary": "Api not supported for client portal user (API_NOT_SUPPORTED)", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_login_user_type": "Client Portal User" }, "message": "api not supported for client portal user", "status": "error" } }, "ApiNotSupportedResponse2": { "description": "The API is not supported in sandbox environments. **Resolution:** Run this operation against a production Zoho CRM organization.", "summary": "Api not supported in sandbox (API_NOT_SUPPORTED)", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "ApiNotSupportedResponse3": { "description": "The API is not available for the current domain. **Resolution:** Use one of the supported domains: `eu`, `com`, `in`, `au`.", "summary": "Api not supported (API_NOT_SUPPORTED)", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_domains": [ "eu", "com", "in", "au", "ca", "cn", "jp" ] }, "message": "api not supported", "status": "error" } }, "InvalidDataResponse1": { "description": "The portal name provided in the request path does not match any existing portal. **Resolution:** Verify that the portal name in the request path matches an existing portal name in the Zoho CRM organization.", "summary": "No portal exists with the given portal name. (INVALID_DATA)", "value": { "code": "INVALID_DATA", "details": {}, "message": "No portal exists with the given portal name.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiNotSupportedForClientPortalUserError" }, { "$ref": "#/components/schemas/ApiNotSupportedInSandboxError" }, { "$ref": "#/components/schemas/ApiNotSupportedForDomainError" }, { "$ref": "#/components/schemas/InvalidPortalNameError" } ], "description": "One or more error conditions occurred. See the `oneOf` variants for specific error schemas.", "x-zs-$id": "GetusertypeError400" } } }, "description": "The list request failed because the `{portal}` path parameter is invalid or the request is otherwise malformed." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "No permission (NO_PERMISSION)", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "No permission", "status": "error" } }, "NoPermissionResponse2": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "NO_PERMISSION", "value": { "code": "NO_PERMISSION", "details": {}, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PortalUserTypeNoPermissionError" }, { "$ref": "#/components/schemas/NoPermissionManagePortalsDisabledError" } ], "description": "The request was rejected due to insufficient permissions. See the `oneOf` variants for specific permission error schemas.", "x-zs-$id": "GetusertypeError403" } } }, "description": "The authenticated user does not have permission to list portal user types." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.ALL" ] }, { "OAuth2": [ "ZohoCRM.settings.clientportal.READ" ] } ], "summary": "Portal User Types", "tags": [ "portal_user_type" ], "x-zoho-document": "portal_user_type", "x-zs-llm-description": "Retrieves all user types for a portal. Use include=modules to fetch module-level details. Returns 400 if portal name is invalid." }, "parameters": [ { "$ref": "#/components/parameters/PortalUserTypePortal" } ], "post": { "description": "Creates a new portal user type for the specified portal. A portal user type defines the personality module, invitation field, and per-module access permissions for portal users. The portal must already exist in the organization's Zoho CRM account.", "operationId": "createPortalUserType", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "A sample request body to create a portal user type with the Contacts module as the personality module, an Email field as the invitation field, and access configured for the Contacts, Products, Custom Module, and Notes modules with their respective permissions, fields, layouts, and views.", "summary": "Sample request body for creating portal user type", "value": { "user_type": [ { "active": true, "deactive_user_count": 0, "invitation_field": { "api_name": "Email", "id": "111113000000004612" }, "modules": [ { "api_name": "Contacts", "fields": [ { "api_name": "Last_Name", "id": "111113000000004604", "read_only": false }, { "api_name": "Full_Name", "id": "111113000000004606", "read_only": false }, { "api_name": "Currency", "id": "111113000000004660", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000004662", "read_only": true }, { "api_name": "Layout", "id": "111113000000004668", "read_only": false }, { "api_name": "Locked__s", "id": "111113000000004696", "read_only": true }, { "api_name": "Contact_X_CM01", "id": "111113000000131043", "read_only": false }, { "api_name": "Last_Enriched_Time__s", "id": "111113000000006734", "read_only": false } ], "filters": null, "id": "111113000000002666", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003678", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003678", "name": "Standard" } ], "permissions": { "create": true, "delete": true, "edit": true, "edit_shared_records": false, "view": true }, "plural_label": "Contacts", "shared_type": "private", "views": { "id": "111113000000070019", "type": "canvas_view" } }, { "api_name": "Products", "fields": [ { "api_name": "Product_Name", "id": "111113000000005278", "read_only": false }, { "api_name": "Currency", "id": "111113000000005308", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005310", "read_only": true }, { "api_name": "Layout", "id": "111113000000005312", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000005332", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000005326", "read_only": true } ], "id": "111113000000002768", "permissions": { "view": true }, "plural_label": "Products", "shared_type": "public", "views": { "id": "111113000000053489", "type": "custom_view" } }, { "api_name": "Custom_Module", "fields": [ { "api_name": "Currency", "id": "111113000000125065", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000125067", "read_only": true }, { "api_name": "Layout", "id": "111113000000125071", "read_only": false }, { "api_name": "Locked__s", "id": "111113000000125093", "read_only": true }, { "api_name": "Change_Log_Time__s", "id": "111113000000125111", "read_only": true }, { "api_name": "Name", "id": "111113000000125047", "read_only": false }, { "api_name": "Lookup_1", "id": "111113000000127669", "read_only": false }, { "api_name": "Multi_Select_Lookup_1", "id": "111113000000131001", "read_only": false } ], "filters": [ { "api_name": "Lookup_1", "display_label": "Lookup 1", "id": "111113000000127669" } ], "id": "111113000000125002", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000125001", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000125001", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Custom Module", "shared_type": "private", "views": { "id": "111113000000125014", "type": "custom_view" } }, { "api_name": "Notes", "filters": null, "id": "111113000000002694", "layouts": null, "permissions": { "create": false, "create_attachment": false, "delete": false, "delete_attachment": false, "edit": false, "view": true }, "plural_label": "Notes", "shared_type": "private", "views": null } ], "name": "Client Portal V8", "personality_module": { "api_name": "Contacts", "id": "111113000000002666" } } ] } } }, "schema": { "$ref": "#/components/schemas/PostusertypeRequest" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body containing the portal user type configuration to create. Must include the personality module, invitation field, active status, and the list of CRM modules with their access permissions." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Zoho CRM created the portal user type. The response includes the generated `id` for the new user type along with the full configuration of the personality module, invitation field, modules, permissions, fields, layouts, and views.", "summary": "Portal user type created successfully (201)", "value": { "user_type": [ { "active": true, "default": false, "id": "111113000000168122", "invitation_field": { "api_name": "Email", "id": "111113000000004612" }, "modules": [ { "api_name": "Contacts", "fields": [ { "api_name": "Last_Name", "id": "111113000000004604", "read_only": false }, { "api_name": "Full_Name", "id": "111113000000004606", "read_only": false }, { "api_name": "Currency", "id": "111113000000004660", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000004662", "read_only": true }, { "api_name": "Layout", "id": "111113000000004668", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000004694", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000004696", "read_only": true }, { "api_name": "Contact_X_CM01", "id": "111113000000131043", "read_only": false }, { "api_name": "Last_Enriched_Time__s", "id": "111113000000006734", "read_only": false } ], "filters": null, "id": "111113000000002666", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003678", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003678", "name": "Standard" } ], "permissions": { "create": true, "delete": true, "edit": true, "edit_shared_records": false, "view": true }, "plural_label": "Contacts", "shared_type": "private", "views": { "id": "111113000000070019", "type": "canvas_view" } }, { "api_name": "Products", "fields": [ { "api_name": "Product_Name", "id": "111113000000005278", "read_only": false }, { "api_name": "Currency", "id": "111113000000005308", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005310", "read_only": true }, { "api_name": "Layout", "id": "111113000000005312", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000005332", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000005326", "read_only": true } ], "filters": null, "id": "111113000000002768", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003684", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003684", "name": "Standard" } ], "permissions": { "view": true }, "plural_label": "Products", "shared_type": "public", "views": { "id": "111113000000053489", "type": "custom_view" } }, { "api_name": "Custom_Module", "fields": [ { "api_name": "Currency", "id": "111113000000125065", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000125067", "read_only": true }, { "api_name": "Layout", "id": "111113000000125071", "read_only": false }, { "api_name": "Locked__s", "id": "111113000000125093", "read_only": true }, { "api_name": "Change_Log_Time__s", "id": "111113000000125111", "read_only": true }, { "api_name": "Name", "id": "111113000000125047", "read_only": false }, { "api_name": "Lookup_1", "id": "111113000000127669", "read_only": false }, { "api_name": "Multi_Select_Lookup_1", "id": "111113000000131001", "read_only": false } ], "filters": [ { "api_name": "Lookup_1", "display_label": "Lookup 1", "id": "111113000000127669" } ], "id": "111113000000125002", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000125001", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000125001", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Custom Module", "shared_type": "private", "views": { "id": "111113000000125014", "type": "custom_view" } }, { "api_name": "Notes", "fields": [ { "api_name": "Owner", "id": "111113000000004322", "read_only": false }, { "api_name": "Note_Title", "id": "111113000000004324", "read_only": false }, { "api_name": "Note_Content", "id": "111113000000004326", "read_only": false }, { "api_name": "Parent_Id", "id": "111113000000004328", "read_only": false }, { "api_name": "Created_By", "id": "111113000000004330", "read_only": false }, { "api_name": "Modified_By", "id": "111113000000004332", "read_only": false }, { "api_name": "Created_Time", "id": "111113000000004334", "read_only": false }, { "api_name": "Modified_Time", "id": "111113000000004336", "read_only": false }, { "api_name": "id", "id": "111113000000004338", "read_only": false }, { "api_name": "Associated_Id__s", "id": "111113000000004340", "read_only": false }, { "api_name": "Record_Status__s", "id": "111113000000004342", "read_only": false } ], "filters": null, "id": "111113000000002694", "layouts": null, "permissions": { "create": false, "create_attachment": false, "delete": false, "delete_attachment": false, "edit": false, "view": true }, "plural_label": "Notes", "shared_type": "private", "views": null } ], "name": "Client Portal V8", "personality_module": { "api_name": "Contacts", "id": "111113000000002666", "plural_label": "Contacts" } } ] } } }, "schema": { "$ref": "#/components/schemas/PostusertypeResponse201" } } }, "description": "Zoho CRM created the portal user type successfully. The response contains the identifier and name of the newly created user type." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "The API does not support requests made by client portal users. **Resolution:** Use a CRM user account that is not a client portal user to call this API.", "summary": "API not supported for client portal user", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_login_user_type": "Client Portal User" }, "message": "api not supported for client portal user", "status": "error" } }, "ApiNotSupportedResponse2": { "description": "The API is not supported in sandbox environments. **Resolution:** Run this operation against a production Zoho CRM organization.", "summary": "API not supported in sandbox", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "ApiNotSupportedResponse3": { "description": "The API is not available for the current domain. **Resolution:** Use one of the supported domains: `eu`, `com`, `in`, `au`.", "summary": "API not supported", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_domains": [ "eu", "com", "in", "au", "ca", "cn", "jp" ] }, "message": "api not supported", "status": "error" } }, "DependentFieldMissingResponse1": { "description": "The `layouts` field requires the `id` field to be present in the same object, but it is missing. **Resolution:** Include `layouts` only when `id` is also provided in the same entry.", "summary": "Layouts are missing", "value": { "user_type": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "layouts", "dependee": { "api_name": "id", "json_path": "$.user_type[0].modules[6].id" }, "json_path": "$.user_type[0].modules[6].layouts" }, "message": "layouts are missing.", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "The request body structure is invalid or contains an unrecognized field. **Resolution:** Verify the request body matches the expected schema and all field names are spelled correctly.", "summary": "Invalid data error", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "jsonobject" }, "message": "body", "status": "error" } }, "InvalidDataResponse10": { "description": "The `name` value is not the expected string type. **Resolution:** Provide a valid string value for `name`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.user_type[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "The `name` value exceeds the maximum allowed length of 50 characters. **Resolution:** Shorten the `name` value to 50 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.user_type[*].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "The `name` value is invalid. **Resolution:** Provide a valid value for `name` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.user_type[*].name", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "The `name` value does not match the required character pattern. **Resolution:** Provide a `name` value that contains only letters, digits, and spaces - no special characters.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.user_type[*].name", "regex": "^[A-Za-z0-9]{50}$" }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "The `active` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `active`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "expected_data_type": "boolean", "json_path": "$.user_type[*].active" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "The `active` value is not among the supported options. **Resolution:** Set `active` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "json_path": "$.user_type[*].active", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "The `invitation_field` value is not the expected object type. **Resolution:** Provide a valid object value for `invitation_field`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "invitation_field", "expected_data_type": "jsonobject", "json_path": "$.user_type[*].invitation_field" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "The `invitation_field` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `invitation_field` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "invitation_field", "json_path": "$.user_type[*].invitation_field", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "The `api_name` value is not the expected string type. **Resolution:** Provide a valid string value for `api_name`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.user_type[*].invitation_field.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].invitation_field.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "The field identified by `$.user_type[0].modules[2].fields[0].id` is not permitted in portal configurations. **Resolution:** Remove the restricted field from the `fields` array and use only portal-supported fields.", "summary": "Field is not allowed in portals", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "json_path": "$.user_type[0].modules[2].fields[0].id" }, "message": "Field is not allowed in portals.", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].invitation_field.id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "The `deactive_user_count` value is not the expected integer type. **Resolution:** Provide a valid integer value for `deactive_user_count`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "deactive_user_count", "expected_data_type": "integer", "json_path": "$.user_type[*].deactive_user_count" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "The `modules` value is not the expected array type. **Resolution:** Provide a valid array value for `modules`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "modules", "expected_data_type": "jsonarray", "json_path": "$.user_type[*].modules" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "The `plural_label` value is not the expected string type. **Resolution:** Provide a valid string value for `plural_label`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "plural_label", "expected_data_type": "text", "json_path": "$.user_type[*].modules[*].plural_label" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "The `plural_label` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `plural_label` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "plural_label", "json_path": "$.user_type[*].modules[*].plural_label", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "The `shared_type` value is not the expected string type. **Resolution:** Provide a valid string value for `shared_type`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "expected_data_type": "text", "json_path": "$.user_type[*].modules[*].shared_type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse28": { "description": "The `shared_type` value exceeds the maximum allowed length of 7 characters. **Resolution:** Shorten the `shared_type` value to 7 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "json_path": "$.user_type[*].modules[*].shared_type", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse29": { "description": "The `shared_type` value is invalid. **Resolution:** Provide a valid value for `shared_type` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "json_path": "$.user_type[*].modules[*].shared_type", "minimum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "The `name` value does not match the required character pattern. **Resolution:** Provide a `name` value that contains only letters, digits, and spaces - no special characters.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.user_type[0].name", "regex": "[^`~!&+%()@#^*'/\";:?<>=\\[\\]{}|-]+" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse30": { "description": "The `shared_type` value is not among the supported options. **Resolution:** Set `shared_type` to one of the accepted values. Possible values: `private`, `public`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "json_path": "$.user_type[*].modules[*].shared_type", "supported_values": [ "private", "public" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse31": { "description": "The `api_name` value is not the expected string type. **Resolution:** Provide a valid string value for `api_name`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.user_type[*].modules[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse32": { "description": "The `api_name` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `api_name` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.user_type[*].modules[*].api_name", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse33": { "description": "The `permissions` value is not the expected object type. **Resolution:** Provide a valid object value for `permissions`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "permissions", "expected_data_type": "jsonobject", "json_path": "$.user_type[*].modules[*].permissions" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse34": { "description": "The `permissions` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `permissions` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "permissions", "json_path": "$.user_type[*].modules[*].permissions", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse35": { "description": "The `view` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `view`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.view" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse36": { "description": "The `view` value exceeds the maximum allowed length of 4 characters. **Resolution:** Shorten the `view` value to 4 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "json_path": "$.user_type[*].modules[*].permissions.view", "maximum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse37": { "description": "The `view` value is invalid. **Resolution:** Provide a valid value for `view` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "json_path": "$.user_type[*].modules[*].permissions.view", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse38": { "description": "The `view` value is not among the supported options. **Resolution:** Set `view` to one of the accepted values. Possible values: `true`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "json_path": "$.user_type[*].modules[*].permissions.view", "supported_values": [ "true" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse39": { "description": "The `edit` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `edit`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.edit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "The `personality_module` value is not the expected object type. **Resolution:** Provide a valid object value for `personality_module`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "personality_module", "expected_data_type": "jsonobject", "json_path": "$.user_type[*].personality_module" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse40": { "description": "The `edit` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `edit` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit", "json_path": "$.user_type[*].modules[*].permissions.edit", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse41": { "description": "The `edit` value is invalid. **Resolution:** Provide a valid value for `edit` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit", "json_path": "$.user_type[*].modules[*].permissions.edit", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse42": { "description": "The `edit` value is not among the supported options. **Resolution:** Set `edit` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit", "json_path": "$.user_type[*].modules[*].permissions.edit", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse43": { "description": "The `edit_shared_records` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `edit_shared_records`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit_shared_records", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.edit_shared_records" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse44": { "description": "The `edit_shared_records` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `edit_shared_records` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit_shared_records", "json_path": "$.user_type[*].modules[*].permissions.edit_shared_records", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse45": { "description": "The `edit_shared_records` value is invalid. **Resolution:** Provide a valid value for `edit_shared_records` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit_shared_records", "json_path": "$.user_type[*].modules[*].permissions.edit_shared_records", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse46": { "description": "The `create` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `create`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.create" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse47": { "description": "The `create` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `create` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create", "json_path": "$.user_type[*].modules[*].permissions.create", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse48": { "description": "The `create` value is invalid. **Resolution:** Provide a valid value for `create` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create", "json_path": "$.user_type[*].modules[*].permissions.create", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse49": { "description": "The `create` value is not among the supported options. **Resolution:** Set `create` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create", "json_path": "$.user_type[*].modules[*].permissions.create", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "The `personality_module` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `personality_module` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "personality_module", "json_path": "$.user_type[*].personality_module", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse50": { "description": "The `delete` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `delete`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.delete" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse51": { "description": "The `delete` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `delete` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete", "json_path": "$.user_type[*].modules[*].permissions.delete", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse52": { "description": "The `delete` value is invalid. **Resolution:** Provide a valid value for `delete` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete", "json_path": "$.user_type[*].modules[*].permissions.delete", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse53": { "description": "The `delete` value is not among the supported options. **Resolution:** Set `delete` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete", "json_path": "$.user_type[*].modules[*].permissions.delete", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse54": { "description": "The `delete_attachment` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `delete_attachment`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete_attachment", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.delete_attachment" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse55": { "description": "The `delete_attachment` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `delete_attachment` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete_attachment", "json_path": "$.user_type[*].modules[*].permissions.delete_attachment", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse56": { "description": "The `delete_attachment` value is invalid. **Resolution:** Provide a valid value for `delete_attachment` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete_attachment", "json_path": "$.user_type[*].modules[*].permissions.delete_attachment", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse57": { "description": "The `delete_attachment` value is not among the supported options. **Resolution:** Set `delete_attachment` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete_attachment", "json_path": "$.user_type[*].modules[*].permissions.delete_attachment", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse58": { "description": "The `create_attachment` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `create_attachment`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create_attachment", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.create_attachment" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse59": { "description": "The `create_attachment` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `create_attachment` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create_attachment", "json_path": "$.user_type[*].modules[*].permissions.create_attachment", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "The `api_name` value is not the expected string type. **Resolution:** Provide a valid string value for `api_name`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.user_type[*].personality_module.api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse60": { "description": "The `create_attachment` value is invalid. **Resolution:** Provide a valid value for `create_attachment` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create_attachment", "json_path": "$.user_type[*].modules[*].permissions.create_attachment", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse61": { "description": "The `create_attachment` value is not among the supported options. **Resolution:** Set `create_attachment` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create_attachment", "json_path": "$.user_type[*].modules[*].permissions.create_attachment", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse62": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].modules[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse63": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse64": { "description": "The `filters` value is not the expected array type. **Resolution:** Provide a valid array value for `filters`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "filters", "expected_data_type": "jsonarray", "json_path": "$.user_type[*].modules[*].filters" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse65": { "description": "The `fields` value is not the expected array type. **Resolution:** Provide a valid array value for `fields`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "fields", "expected_data_type": "jsonarray", "json_path": "$.user_type[*].modules[*].fields" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse66": { "description": "The `fields` value exceeds the maximum allowed length of 503 characters. **Resolution:** Shorten the `fields` value to 503 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "fields", "json_path": "$.user_type[*].modules[*].fields", "maximum_length": 503 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse67": { "description": "The `read_only` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `read_only`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "read_only", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].fields[*].read_only" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse68": { "description": "The `read_only` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `read_only` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "read_only", "json_path": "$.user_type[*].modules[*].fields[*].read_only", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse69": { "description": "The `read_only` value is invalid. **Resolution:** Provide a valid value for `read_only` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "read_only", "json_path": "$.user_type[*].modules[*].fields[*].read_only", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "The `api_name` value exceeds the maximum allowed length of 50 characters. **Resolution:** Shorten the `api_name` value to 50 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.user_type[*].personality_module.api_name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse70": { "description": "The `read_only` value is not among the supported options. **Resolution:** Set `read_only` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "read_only", "json_path": "$.user_type[*].modules[*].fields[*].read_only", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse71": { "description": "The `api_name` value is not the expected string type. **Resolution:** Provide a valid string value for `api_name`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.user_type[*].modules[*].fields[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse72": { "description": "The `api_name` value exceeds the maximum allowed length of 50 characters. **Resolution:** Shorten the `api_name` value to 50 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.user_type[*].modules[*].fields[*].api_name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse73": { "description": "The `api_name` value is invalid. **Resolution:** Provide a valid value for `api_name` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.user_type[*].modules[*].fields[*].api_name", "minimum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse74": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].modules[*].fields[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse75": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].fields[*].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse76": { "description": "The `layouts` value is not the expected array type. **Resolution:** Provide a valid array value for `layouts`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "layouts", "expected_data_type": "jsonarray", "json_path": "$.user_type[*].modules[*].layouts" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse77": { "description": "The `views` value is not the expected object type. **Resolution:** Provide a valid object value for `views`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "views", "expected_data_type": "jsonobject", "json_path": "$.user_type[*].modules[*].views" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse78": { "description": "The `views` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `views` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "views", "json_path": "$.user_type[*].modules[*].views", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].personality_module.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].personality_module.id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidPortalNameResponse1": { "description": "The portal name provided in the request path does not match any existing portal. **Resolution:** Verify that the portal name in the request path matches an existing portal name in the Zoho CRM organization.", "summary": "No portal exists with the given portal name. (INVALID_DATA)", "value": { "code": "INVALID_DATA", "details": {}, "message": "No portal exists with the given portal name.", "status": "error" } }, "LicenseLimitExceededResponse1": { "description": "The maximum number of portal user types allowed by your Zoho CRM license has been reached. **Resolution:** Delete an existing user type before creating a new one, or upgrade your license plan.", "summary": "License limit exceeded", "value": { "user_type": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "License limit exceeded.", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "The required field `permissions` is missing from the request body. **Resolution:** Include `permissions` in the request body with a valid value.", "summary": "Required field not found", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "permissions", "json_path": "$.user_type[0].modules[0].permissions" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse10": { "description": "The required field `shared_type` is missing from the request body. **Resolution:** Include `shared_type` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "shared_type", "json_path": "$.user_type[*].modules[*].shared_type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse11": { "description": "The required field `permissions` is missing from the request body. **Resolution:** Include `permissions` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "permissions", "json_path": "$.user_type[*].modules[*].permissions" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse12": { "description": "The required field `view` is missing from the request body. **Resolution:** Include `view` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "view", "json_path": "$.user_type[*].modules[*].permissions.view" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse13": { "description": "The required field `id` is missing from the request body. **Resolution:** Include `id` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "The required field `shared_type` is missing from the request body. **Resolution:** Include `shared_type` in the request body with a valid value.", "summary": "Required field not found", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "shared_type", "json_path": "$.user_type[0].modules[0].shared_type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "The required field `type` is missing from the request body. **Resolution:** Include `type` in the request body with a valid value.", "summary": "Required field not found", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.user_type[0].modules[0].views.type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "The required field `id` is missing from the request body. **Resolution:** Include `id` in the request body with a valid value.", "summary": "Required field not found", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.user_type[0].modules[0].views.id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "The request is missing the required personality module and Notes module configuration. **Resolution:** Include both the personality module and a Notes module in the `modules` array.", "summary": "Personality module and Notes module are mandatory modules", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": {}, "message": "Personality module and Notes module are mandatory modules.", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "The required field `personality_module` is missing from the request body. **Resolution:** Include `personality_module` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "personality_module", "json_path": "$.user_type[*].personality_module" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "The required field `name` is missing from the request body. **Resolution:** Include `name` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.user_type[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "The required field `invitation_field` is missing from the request body. **Resolution:** Include `invitation_field` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "invitation_field", "json_path": "$.user_type[*].invitation_field" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "The required field `modules` is missing from the request body. **Resolution:** Include `modules` in the request body with a valid value.", "summary": "Required field is missing", "value": { "user_type": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "modules", "json_path": "$.user_type[*].modules" }, "message": "Required field is missing", "status": "error" } ] } }, "NotAllowedResponse1": { "description": "The specified layout does not contain the selected filter field. **Resolution:** Remove the filter from the `filters` array or choose a layout that includes the filter field.", "summary": "Layout does not have selected filter in it.", "value": { "user_type": [ { "code": "NOT_ALLOWED", "details": { "json_path": "$.user_type[0].modules[0].layouts[0].id" }, "message": "Layout does not have selected filter in it.", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "description": "The required parameter `read_only` is missing from the request. **Resolution:** Include `read_only` in the request body or parameters with a valid value.", "summary": "One of the expected parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "api_name": "read_only" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiNotSupportedForClientPortalUserError" }, { "$ref": "#/components/schemas/ApiNotSupportedInSandboxError" }, { "$ref": "#/components/schemas/ApiNotSupportedForDomainError" }, { "$ref": "#/components/schemas/InvalidPortalNameError" }, { "$ref": "#/components/schemas/InvalidDataUserTypeBodyError" }, { "additionalProperties": false, "description": "An error response wrapped inside a `user_type` object. Returned when the validation error is associated with the user type body structure rather than a specific field.", "properties": { "user_type": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/LayoutMissingSelectedFilterError" }, { "$ref": "#/components/schemas/LayoutFieldMissingError" }, { "$ref": "#/components/schemas/PrivateModulePermissionsRequiredError" }, { "$ref": "#/components/schemas/PortalUserTypeLicenseLimitExceededError" }, { "$ref": "#/components/schemas/FieldNotAllowedInPortalsError" }, { "$ref": "#/components/schemas/MandatoryPersonalityAndNotesModulesError" }, { "$ref": "#/components/schemas/InvalidUserTypeNameSpecialCharsError" }, { "$ref": "#/components/schemas/PortalUserTypeMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/PortalUserTypeInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidDataMaximumLengthError" }, { "$ref": "#/components/schemas/InvalidDataMinimumLengthError" }, { "$ref": "#/components/schemas/InvalidDataRegexError" }, { "$ref": "#/components/schemas/PortalUserTypeInvalidDataSupportedValuesError" } ], "description": "An error object describing a specific validation failure, layout constraint violation, or field permission issue." }, "maxItems": 25, "type": "array" } }, "required": [ "user_type" ], "type": "object", "x-zs-$id": "PostusertypeError400Wrapper" }, { "$ref": "#/components/schemas/PortalUserTypeRequiredParamMissingError" } ], "description": "One or more error conditions occurred. See the `oneOf` variants for specific error schemas.", "x-zs-$id": "PostusertypeError400" } } }, "description": "The create request failed because the request body contains invalid data, missing required fields, or a field value that does not satisfy the configured constraints." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "No permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "No permission", "status": "error" } }, "NoPermissionResponse2": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "NO_PERMISSION", "value": { "code": "NO_PERMISSION", "details": {}, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PortalUserTypeNoPermissionError" }, { "$ref": "#/components/schemas/NoPermissionManagePortalsDisabledError" } ], "description": "The request was rejected due to insufficient permissions. See the `oneOf` variants for specific permission error schemas.", "x-zs-$id": "PostusertypeError403" } } }, "description": "The authenticated user does not have permission to create portal user types, or the portal configuration prevents this operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.ALL" ] }, { "OAuth2": [ "ZohoCRM.settings.clientportal.CREATE" ] } ], "summary": "Portal User Type", "tags": [ "portal_user_type" ], "x-zoho-document": "portal_user_type", "x-zs-llm-description": "Creates a user type under a portal. Requires modules, layouts, and filters data which can be derived from portals meta." } }, "/crm/v8/settings/portals/{portal}/user_type/{userTypeId}": { "delete": { "description": "Deletes the specified portal user type from the portal. If portal users are assigned to this user type, provide `transfer_To` with the ID of another user type to transfer them before deletion.", "operationId": "deletePortalUserType", "parameters": [ { "$ref": "#/components/parameters/ParamPathUserTypeid" }, { "description": "The ID of the portal user type to transfer existing users to before deleting. Required when the user type being deleted has active users assigned to it.", "in": "query", "name": "transfer_To", "required": false, "schema": { "description": "Represents the unique numeric identifier of the portal user type.", "format": "int64", "maxLength": 255, "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalUserTypes", "propertyId": "PortalUserTypesId" } ], "resource": "portal_user_type" } } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Zoho CRM deleted the portal user type. The response confirms the deletion with a `SUCCESS` status.", "summary": "Portal user type deleted successfully (200)", "value": { "user_type": [ { "code": "SUCCESS", "details": { "id": "5020928000002330000" }, "message": "Portal user type deleted successfully.", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteusertypeResponse200" } } }, "description": "Zoho CRM deleted the portal user type successfully. The response contains the name of the deleted user type." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "The API does not support requests made by client portal users. **Resolution:** Use a CRM user account that is not a client portal user to call this API.", "summary": "Api not supported for client portal user (API_NOT_SUPPORTED)", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_login_user_type": "Client Portal User" }, "message": "api not supported for client portal user", "status": "error" } }, "ApiNotSupportedResponse2": { "description": "The API is not supported in sandbox environments. **Resolution:** Run this operation against a production Zoho CRM organization.", "summary": "Api not supported in sandbox (API_NOT_SUPPORTED)", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "ApiNotSupportedResponse3": { "description": "The API is not available for the current domain. **Resolution:** Use one of the supported domains: `eu`, `com`, `in`, `au`.", "summary": "Api not supported (API_NOT_SUPPORTED)", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_domains": [ "eu", "com", "in", "au", "ca", "cn", "jp" ] }, "message": "api not supported", "status": "error" } }, "InvalidDataResponse1": { "description": "The portal user type cannot be deleted because it still has active users assigned to it. **Resolution:** Remove all users from this user type before deleting it.", "summary": "Deletion of portal user type is not allowed, as user type contains users, which need to be transferred to other user type (INVALID_DATA)", "value": { "code": "INVALID_DATA", "details": { "param_name": "transfer_To" }, "message": "Deletion of portal user type is not allowed, as user type contains users, which need to be transferred to other user type", "status": "error" } }, "InvalidPortalNameResponse1": { "description": "The portal name provided in the request path does not match any existing portal. **Resolution:** Verify that the portal name in the request path matches an existing portal name in the Zoho CRM organization.", "summary": "No portal exists with the given portal name. (INVALID_DATA)", "value": { "code": "INVALID_DATA", "details": {}, "message": "No portal exists with the given portal name.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiNotSupportedForClientPortalUserError" }, { "$ref": "#/components/schemas/ApiNotSupportedInSandboxError" }, { "$ref": "#/components/schemas/ApiNotSupportedForDomainError" }, { "$ref": "#/components/schemas/InvalidPortalNameError" }, { "$ref": "#/components/schemas/DeleteUserTypeUsersPresentError" } ], "description": "One or more error conditions occurred. See the `oneOf` variants for specific error schemas.", "x-zs-$id": "DeleteusertypeError400" } } }, "description": "The request failed. This may occur if the user type still has active portal users assigned to it, or if the request body contains invalid data." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "No permission (NO_PERMISSION)", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "No permission", "status": "error" } }, "NoPermissionResponse2": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "NO_PERMISSION (NO_PERMISSION)", "value": { "code": "NO_PERMISSION", "details": {}, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PortalUserTypeNoPermissionError" }, { "$ref": "#/components/schemas/NoPermissionManagePortalsDisabledError" } ], "description": "The request was rejected due to insufficient permissions. See the `oneOf` variants for specific permission error schemas.", "x-zs-$id": "DeleteusertypeError403" } } }, "description": "The authenticated user does not have permission to delete portal user types." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.ALL" ] }, { "OAuth2": [ "ZohoCRM.settings.clientportal.DELETE" ] } ], "summary": "Delete user type", "tags": [ "portal_user_type" ], "x-zoho-document": "portal_user_type", "x-zs-llm-description": "Deletes a user type by ID. Use `transfer_To` to specify the target user type ID when the user type has active users that need to be transferred first. Fails with INVALID_DATA if users are present and no transfer target is given." }, "get": { "description": "Retrieves the full configuration of a single portal user type, including identity fields, active status, user counts, audit metadata, personality module, invitation field, and per-module access permissions.", "operationId": "getPortalUserType", "parameters": [ { "$ref": "#/components/parameters/PortalUserTypeParamQueryIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Zoho CRM returned the portal user type details. The response contains the full user type configuration including personality module, invitation field, module access list, permissions, fields, layouts, and views.", "summary": "Portal user type retrieved successfully", "value": { "user_type": [ { "active": true, "active_user_count": 1, "deactive_user_count": 0, "default": true, "id": "111113000000158041", "invitation_field": { "api_name": "Email", "id": "111113000000004612" }, "modules": [ { "api_name": "Contacts", "fields": [ { "api_name": "Last_Name", "id": "111113000000004604", "read_only": false }, { "api_name": "Full_Name", "id": "111113000000004606", "read_only": false }, { "api_name": "Currency", "id": "111113000000004660", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000004662", "read_only": true }, { "api_name": "Layout", "id": "111113000000004668", "read_only": false }, { "api_name": "Locked__s", "id": "111113000000004696", "read_only": true }, { "api_name": "Contact_X_CM01", "id": "111113000000131043", "read_only": false }, { "api_name": "Lookup_1", "id": "111113000000150048", "read_only": false }, { "api_name": "Last_Enriched_Time__s", "id": "111113000000006734", "read_only": false } ], "filters": null, "id": "111113000000002666", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003678", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003678", "name": "Standard" } ], "permissions": { "create": true, "delete": true, "edit": true, "edit_shared_records": false, "view": true }, "plural_label": "Contacts", "shared_type": "private", "views": { "display_label": "Contacts - Custom List View", "id": "111113000000070019", "name": "Contacts - Custom List View", "type": "canvas_view" } }, { "api_name": "Deals", "fields": [ { "api_name": "Deal_Name", "id": "111113000000004750", "read_only": false }, { "api_name": "Closing_Date", "id": "111113000000004752", "read_only": false }, { "api_name": "Contact_Name", "id": "111113000000004774", "read_only": false }, { "api_name": "Currency", "id": "111113000000004786", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000004788", "read_only": true }, { "api_name": "Layout", "id": "111113000000004800", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000004826", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000004830", "read_only": true }, { "api_name": "Stage", "id": "111113000000004760", "read_only": false } ], "filters": [ { "api_name": "Contact_Name", "display_label": "Contact Name", "id": "111113000000004774" } ], "id": "111113000000002670", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003680", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003680", "name": "Standard" } ], "permissions": { "create": true, "delete": false, "edit": true, "edit_shared_records": true, "view": true }, "plural_label": "Deals", "shared_type": "private", "views": { "display_label": "Deals - Custom List View", "id": "111113000000070199", "name": "Deals - Custom List View", "type": "canvas_view" } }, { "api_name": "Products", "fields": [ { "api_name": "Product_Name", "id": "111113000000005278", "read_only": false }, { "api_name": "Currency", "id": "111113000000005308", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005310", "read_only": true }, { "api_name": "Layout", "id": "111113000000005312", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000005332", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000005326", "read_only": true } ], "filters": null, "id": "111113000000002768", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003684", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003684", "name": "Standard" } ], "permissions": { "view": true }, "plural_label": "Products", "shared_type": "public", "views": { "display_label": "Default List View", "id": "111113000000053489", "name": "All_Products", "type": "custom_view" } }, { "api_name": "Quotes", "fields": [ { "api_name": "Subject", "id": "111113000000005488", "read_only": false }, { "api_name": "Deal_Name", "id": "111113000000005490", "read_only": false }, { "api_name": "Contact_Name", "id": "111113000000005496", "read_only": false }, { "api_name": "Currency", "id": "111113000000005514", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005516", "read_only": true }, { "api_name": "Layout", "id": "111113000000005518", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000005536", "read_only": true }, { "api_name": "Quoted_Items", "id": "111113000000005566", "permissions": [ { "iscustomizable": false, "view": true }, { "edit": true, "iscustomizable": true }, { "create": true, "iscustomizable": false }, { "delete": true, "iscustomizable": true } ], "read_only": false }, { "api_name": "Grand_Total", "id": "111113000000005576", "read_only": false }, { "api_name": "Quote_Number", "id": "111113000000005486", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000005532", "read_only": true }, { "api_name": "Product_Details", "id": "111113000000005560", "read_only": false }, { "api_name": "Sub_Total", "id": "111113000000005568", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000005578", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000005580", "read_only": false }, { "api_name": "Discount", "id": "111113000000005570", "read_only": false }, { "api_name": "Tax", "id": "111113000000005572", "read_only": false }, { "api_name": "Adjustment", "id": "111113000000005574", "read_only": false }, { "api_name": "Sequence_Number", "id": "111113000000005582", "read_only": false }, { "api_name": "Name", "id": "111113000000005584", "read_only": false }, { "api_name": "Owner", "id": "111113000000005586", "read_only": false }, { "api_name": "Created_By", "id": "111113000000005588", "read_only": false }, { "api_name": "Modified_By", "id": "111113000000005590", "read_only": false }, { "api_name": "Created_Time", "id": "111113000000005592", "read_only": false }, { "api_name": "Modified_Time", "id": "111113000000005594", "read_only": false }, { "api_name": "Last_Activity_Time", "id": "111113000000005596", "read_only": false }, { "api_name": "Layout", "id": "111113000000005600", "read_only": false }, { "api_name": "Parent_Id", "id": "111113000000005602", "read_only": false }, { "api_name": "Currency", "id": "111113000000005604", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005606", "read_only": false }, { "api_name": "Product_Name", "id": "111113000000005608", "read_only": false }, { "api_name": "Description", "id": "111113000000005610", "read_only": false }, { "api_name": "Quantity", "id": "111113000000005612", "read_only": false }, { "api_name": "Total_After_Discount", "id": "111113000000005622", "read_only": false }, { "api_name": "Line_Tax", "id": "111113000000005628", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000005632", "read_only": false }, { "api_name": "Total", "id": "111113000000005618", "read_only": false }, { "api_name": "List_Price", "id": "111113000000005616", "read_only": false }, { "api_name": "Discount", "id": "111113000000005620", "read_only": false }, { "api_name": "Net_Total", "id": "111113000000005626", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000005634", "read_only": false }, { "api_name": "Tax", "id": "111113000000005624", "read_only": false } ], "filters": [ { "api_name": "Contact_Name", "display_label": "Contact Name", "id": "111113000000005496" } ], "id": "111113000000002774", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003700", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003700", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Quotes", "shared_type": "private", "views": { "display_label": "Default List View", "id": "111113000000053897", "name": "All_Quotes", "type": "custom_view" } }, { "api_name": "Sales_Orders", "fields": [ { "api_name": "Subject", "id": "111113000000005640", "read_only": false }, { "api_name": "Deal_Name", "id": "111113000000005642", "read_only": false }, { "api_name": "Contact_Name", "id": "111113000000005652", "read_only": false }, { "api_name": "Currency", "id": "111113000000005676", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005678", "read_only": true }, { "api_name": "Layout", "id": "111113000000005680", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000005698", "read_only": true }, { "api_name": "Ordered_Items", "id": "111113000000005728", "permissions": [ { "iscustomizable": false, "view": true }, { "edit": true, "iscustomizable": true }, { "create": true, "iscustomizable": false }, { "delete": true, "iscustomizable": true } ], "read_only": false }, { "api_name": "Product_Details", "id": "111113000000005722", "read_only": false }, { "api_name": "Quote_Name", "id": "111113000000005646", "read_only": false }, { "api_name": "Grand_Total", "id": "111113000000005738", "read_only": false }, { "api_name": "SO_Number", "id": "111113000000005638", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000005694", "read_only": true }, { "api_name": "Sub_Total", "id": "111113000000005730", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000005740", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000005742", "read_only": false }, { "api_name": "Discount", "id": "111113000000005732", "read_only": false }, { "api_name": "Tax", "id": "111113000000005734", "read_only": false }, { "api_name": "Adjustment", "id": "111113000000005736", "read_only": false }, { "api_name": "Sequence_Number", "id": "111113000000005744", "read_only": false }, { "api_name": "Name", "id": "111113000000005746", "read_only": false }, { "api_name": "Owner", "id": "111113000000005748", "read_only": false }, { "api_name": "Created_By", "id": "111113000000005750", "read_only": false }, { "api_name": "Modified_By", "id": "111113000000005752", "read_only": false }, { "api_name": "Created_Time", "id": "111113000000005754", "read_only": false }, { "api_name": "Modified_Time", "id": "111113000000005756", "read_only": false }, { "api_name": "Last_Activity_Time", "id": "111113000000005758", "read_only": false }, { "api_name": "Layout", "id": "111113000000005762", "read_only": false }, { "api_name": "Parent_Id", "id": "111113000000005764", "read_only": false }, { "api_name": "Currency", "id": "111113000000005766", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005768", "read_only": false }, { "api_name": "Product_Name", "id": "111113000000005770", "read_only": false }, { "api_name": "Description", "id": "111113000000005772", "read_only": false }, { "api_name": "Quantity", "id": "111113000000005774", "read_only": false }, { "api_name": "Total_After_Discount", "id": "111113000000005784", "read_only": false }, { "api_name": "Line_Tax", "id": "111113000000005790", "read_only": false }, { "api_name": "Total", "id": "111113000000005780", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000005794", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000005796", "read_only": false }, { "api_name": "List_Price", "id": "111113000000005778", "read_only": false }, { "api_name": "Discount", "id": "111113000000005782", "read_only": false }, { "api_name": "Tax", "id": "111113000000005786", "read_only": false }, { "api_name": "Net_Total", "id": "111113000000005788", "read_only": false } ], "filters": [ { "api_name": "Contact_Name", "display_label": "Contact Name", "id": "111113000000005652" } ], "id": "111113000000002778", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003686", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003686", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Sales Orders", "shared_type": "private", "views": { "display_label": "Default List View", "id": "111113000000053903", "name": "All_SalesOrders", "type": "custom_view" } }, { "api_name": "Purchase_Orders", "fields": [ { "api_name": "Subject", "id": "111113000000005802", "read_only": false }, { "api_name": "Contact_Name", "id": "111113000000005806", "read_only": false }, { "api_name": "Currency", "id": "111113000000005832", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005834", "read_only": true }, { "api_name": "Layout", "id": "111113000000005836", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000005854", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000005850", "read_only": true }, { "api_name": "Purchase_Items", "id": "111113000000005886", "permissions": [ { "iscustomizable": false, "view": true }, { "edit": true, "iscustomizable": true }, { "create": true, "iscustomizable": false }, { "delete": true, "iscustomizable": true } ], "read_only": false }, { "api_name": "Sub_Total", "id": "111113000000005888", "read_only": false }, { "api_name": "Product_Details", "id": "111113000000005880", "read_only": false }, { "api_name": "Grand_Total", "id": "111113000000005896", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000005898", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000005900", "read_only": false }, { "api_name": "Discount", "id": "111113000000005890", "read_only": false }, { "api_name": "Tax", "id": "111113000000005892", "read_only": false }, { "api_name": "Adjustment", "id": "111113000000005894", "read_only": false }, { "api_name": "Sequence_Number", "id": "111113000000005902", "read_only": false }, { "api_name": "Name", "id": "111113000000005904", "read_only": false }, { "api_name": "Owner", "id": "111113000000005906", "read_only": false }, { "api_name": "Created_By", "id": "111113000000005908", "read_only": false }, { "api_name": "Modified_By", "id": "111113000000005910", "read_only": false }, { "api_name": "Created_Time", "id": "111113000000005912", "read_only": false }, { "api_name": "Modified_Time", "id": "111113000000005914", "read_only": false }, { "api_name": "Last_Activity_Time", "id": "111113000000005916", "read_only": false }, { "api_name": "Layout", "id": "111113000000005920", "read_only": false }, { "api_name": "Parent_Id", "id": "111113000000005922", "read_only": false }, { "api_name": "Currency", "id": "111113000000005924", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005926", "read_only": false }, { "api_name": "Product_Name", "id": "111113000000005928", "read_only": false }, { "api_name": "Description", "id": "111113000000005930", "read_only": false }, { "api_name": "Quantity", "id": "111113000000005932", "read_only": false }, { "api_name": "List_Price", "id": "111113000000005936", "read_only": false }, { "api_name": "Discount", "id": "111113000000005940", "read_only": false }, { "api_name": "Total_After_Discount", "id": "111113000000005942", "read_only": false }, { "api_name": "Line_Tax", "id": "111113000000005948", "read_only": false }, { "api_name": "Net_Total", "id": "111113000000005946", "read_only": false }, { "api_name": "Tax", "id": "111113000000005944", "read_only": false }, { "api_name": "Total", "id": "111113000000005938", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000005952", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000005954", "read_only": false } ], "filters": [ { "api_name": "Contact_Name", "display_label": "Contact Name", "id": "111113000000005806" } ], "id": "111113000000002782", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003696", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003696", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Purchase Orders", "shared_type": "private", "views": { "display_label": "Default List View", "id": "111113000000053909", "name": "All_PurchaseOrders", "type": "custom_view" } }, { "api_name": "Invoices", "fields": [ { "api_name": "Subject", "id": "111113000000005960", "read_only": false }, { "api_name": "Contact_Name", "id": "111113000000005978", "read_only": false }, { "api_name": "Deal_Name__s", "id": "111113000000005984", "read_only": false }, { "api_name": "Currency", "id": "111113000000005992", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005994", "read_only": true }, { "api_name": "Layout", "id": "111113000000005996", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000006014", "read_only": true }, { "api_name": "Invoiced_Items", "id": "111113000000006044", "permissions": [ { "iscustomizable": false, "view": true }, { "edit": true, "iscustomizable": true }, { "create": true, "iscustomizable": false }, { "delete": true, "iscustomizable": true } ], "read_only": false }, { "api_name": "Sales_Order", "id": "111113000000005962", "read_only": false }, { "api_name": "Invoice_Number", "id": "111113000000005958", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000006010", "read_only": true }, { "api_name": "Product_Details", "id": "111113000000006038", "read_only": false }, { "api_name": "Sub_Total", "id": "111113000000006046", "read_only": false }, { "api_name": "Grand_Total", "id": "111113000000006054", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000006056", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000006058", "read_only": false }, { "api_name": "Discount", "id": "111113000000006048", "read_only": false }, { "api_name": "Tax", "id": "111113000000006050", "read_only": false }, { "api_name": "Adjustment", "id": "111113000000006052", "read_only": false }, { "api_name": "Sequence_Number", "id": "111113000000006060", "read_only": false }, { "api_name": "Name", "id": "111113000000006062", "read_only": false }, { "api_name": "Owner", "id": "111113000000006064", "read_only": false }, { "api_name": "Created_By", "id": "111113000000006066", "read_only": false }, { "api_name": "Modified_By", "id": "111113000000006068", "read_only": false }, { "api_name": "Created_Time", "id": "111113000000006070", "read_only": false }, { "api_name": "Modified_Time", "id": "111113000000006072", "read_only": false }, { "api_name": "Last_Activity_Time", "id": "111113000000006074", "read_only": false }, { "api_name": "Layout", "id": "111113000000006078", "read_only": false }, { "api_name": "Parent_Id", "id": "111113000000006080", "read_only": false }, { "api_name": "Currency", "id": "111113000000006082", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000006084", "read_only": false }, { "api_name": "Product_Name", "id": "111113000000006086", "read_only": false }, { "api_name": "Description", "id": "111113000000006088", "read_only": false }, { "api_name": "Quantity", "id": "111113000000006090", "read_only": false }, { "api_name": "Total_After_Discount", "id": "111113000000006100", "read_only": false }, { "api_name": "Line_Tax", "id": "111113000000006106", "read_only": false }, { "api_name": "Discount_Type__s", "id": "111113000000006110", "read_only": false }, { "api_name": "List_Price", "id": "111113000000006094", "read_only": false }, { "api_name": "Discount", "id": "111113000000006098", "read_only": false }, { "api_name": "Tax", "id": "111113000000006102", "read_only": false }, { "api_name": "Total", "id": "111113000000006096", "read_only": false }, { "api_name": "Net_Total", "id": "111113000000006104", "read_only": false }, { "api_name": "Discount_Percentage__s", "id": "111113000000006112", "read_only": false } ], "filters": [ { "api_name": "Contact_Name", "display_label": "Contact Name", "id": "111113000000005978" } ], "id": "111113000000002786", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003692", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003692", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Invoices", "shared_type": "private", "views": { "display_label": "Default List View", "id": "111113000000053924", "name": "All_Invoices", "type": "custom_view" } }, { "api_name": "Cases", "fields": [ { "api_name": "Status", "id": "111113000000005080", "read_only": false }, { "api_name": "Case_Origin", "id": "111113000000005088", "read_only": false }, { "api_name": "Subject", "id": "111113000000005090", "read_only": false }, { "api_name": "Related_To", "id": "111113000000005092", "read_only": false }, { "api_name": "Deal_Name", "id": "111113000000005096", "read_only": false }, { "api_name": "Currency", "id": "111113000000005118", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000005120", "read_only": true }, { "api_name": "Layout", "id": "111113000000005122", "read_only": false }, { "api_name": "Change_Log_Time__s", "id": "111113000000005144", "read_only": true }, { "api_name": "Locked__s", "id": "111113000000005140", "read_only": true }, { "api_name": "Product_Name", "id": "111113000000005082", "read_only": false }, { "api_name": "Case_Number", "id": "111113000000005076", "read_only": true } ], "filters": [ { "api_name": "Related_To", "display_label": "Related To", "id": "111113000000005092" } ], "id": "111113000000002760", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000003688", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000003688", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Cases", "shared_type": "private", "views": { "display_label": "Default List View", "id": "111113000000053504", "name": "All_Cases", "type": "custom_view" } }, { "api_name": "Custom_Module", "fields": [ { "api_name": "Currency", "id": "111113000000125065", "read_only": false }, { "api_name": "Exchange_Rate", "id": "111113000000125067", "read_only": true }, { "api_name": "Layout", "id": "111113000000125071", "read_only": false }, { "api_name": "Locked__s", "id": "111113000000125093", "read_only": true }, { "api_name": "Change_Log_Time__s", "id": "111113000000125111", "read_only": true }, { "api_name": "Name", "id": "111113000000125047", "read_only": false }, { "api_name": "Lookup_1", "id": "111113000000127669", "read_only": false }, { "api_name": "Multi_Select_Lookup_1", "id": "111113000000131001", "read_only": false } ], "filters": [ { "api_name": "Lookup_1", "display_label": "Lookup 1", "id": "111113000000127669" } ], "id": "111113000000125002", "layouts": [ { "_default_view": { "display_label": "Standard", "id": "111113000000125001", "name": "Standard", "type": "layout" }, "display_label": "Standard", "id": "111113000000125001", "name": "Standard" } ], "permissions": { "create": false, "delete": false, "edit": false, "edit_shared_records": false, "view": true }, "plural_label": "Custom Module", "shared_type": "private", "views": { "display_label": "Default List View", "id": "111113000000125014", "name": "CustomModule_Default_CustomView", "type": "custom_view" } }, { "api_name": "Notes", "fields": [ { "api_name": "Owner", "id": "111113000000004322", "read_only": false }, { "api_name": "Note_Title", "id": "111113000000004324", "read_only": false }, { "api_name": "Parent_Id", "id": "111113000000004328", "read_only": false }, { "api_name": "Created_By", "id": "111113000000004330", "read_only": false }, { "api_name": "Modified_By", "id": "111113000000004332", "read_only": false }, { "api_name": "Created_Time", "id": "111113000000004334", "read_only": false }, { "api_name": "Modified_Time", "id": "111113000000004336", "read_only": false }, { "api_name": "id", "id": "111113000000004338", "read_only": false }, { "api_name": "Associated_Id__s", "id": "111113000000004340", "read_only": false }, { "api_name": "Record_Status__s", "id": "111113000000004342", "read_only": false }, { "api_name": "Note_Content", "id": "111113000000004326", "read_only": false } ], "filters": null, "id": "111113000000002694", "layouts": null, "permissions": { "create": false, "create_attachment": false, "delete": false, "delete_attachment": false, "edit": false, "view": true }, "plural_label": "Notes", "shared_type": "private", "views": null } ], "name": "Client Portal", "personality_module": { "api_name": "Contacts", "id": "111113000000002666", "plural_label": "Contacts" } } ] } } }, "schema": { "$ref": "#/components/schemas/GetusertypeByIdResponse200" } } }, "description": "Zoho CRM returned the full configuration of the requested portal user type successfully." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "The API does not support requests made by client portal users. **Resolution:** Use a CRM user account that is not a client portal user to call this API.", "summary": "API not supported for client portal user (API_NOT_SUPPORTED)", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_login_user_type": "Client Portal User" }, "message": "api not supported for client portal user", "status": "error" } }, "ApiNotSupportedResponse2": { "description": "The API is not supported in sandbox environments. **Resolution:** Run this operation against a production Zoho CRM organization.", "summary": "API not supported in sandbox", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "ApiNotSupportedResponse3": { "description": "The API is not available for the current domain. **Resolution:** Use one of the supported domains: `eu`, `com`, `in`, `au`.", "summary": "API not supported", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_domains": [ "eu", "com", "in", "au", "ca", "cn", "jp" ] }, "message": "api not supported", "status": "error" } }, "InvalidPortalNameResponse1": { "description": "The portal name provided in the request path does not match any existing portal. **Resolution:** Verify that the portal name in the request path matches an existing portal name in the Zoho CRM organization.", "summary": "No portal exists with the given portal name", "value": { "code": "INVALID_DATA", "details": {}, "message": "No portal exists with the given portal name.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiNotSupportedForClientPortalUserError" }, { "$ref": "#/components/schemas/ApiNotSupportedInSandboxError" }, { "$ref": "#/components/schemas/ApiNotSupportedForDomainError" }, { "$ref": "#/components/schemas/InvalidPortalNameError" } ], "description": "One or more error conditions occurred. See the `oneOf` variants for specific error schemas.", "x-zs-$id": "GetusertypeErrorAPI400" } } }, "description": "The request failed because the `{userTypeId}` path parameter references a user type that does not exist, or the request is otherwise invalid." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "No permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "No permission", "status": "error" } }, "NoPermissionResponse2": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "NO_PERMISSION", "value": { "code": "NO_PERMISSION", "details": {}, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PortalUserTypeNoPermissionError" }, { "$ref": "#/components/schemas/NoPermissionManagePortalsDisabledError" } ], "description": "The request was rejected due to insufficient permissions. See the `oneOf` variants for specific permission error schemas.", "x-zs-$id": "GetusertypeByIdError403" } } }, "description": "The authenticated user does not have permission to view portal user type configuration." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.ALL" ] }, { "OAuth2": [ "ZohoCRM.settings.clientportal.READ" ] } ], "summary": "Portal User Type", "tags": [ "portal_user_type" ], "x-zoho-document": "portal_user_type", "x-zs-llm-description": "Retrieves a single user type by ID. Returns 204 if user type ID does not exist. Use include=modules to fetch module-level details." }, "parameters": [ { "$ref": "#/components/parameters/PortalUserTypePortal" }, { "$ref": "#/components/parameters/ParamPathUserTypeid" } ], "put": { "description": "Updates the configuration of an existing portal user type. You can modify module-level access settings, including shared type, allowed layouts, filter fields, and field-level permissions.", "operationId": "updatePortalUserType", "parameters": [ { "$ref": "#/components/parameters/ParamPathUserTypeid" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "A sample request body to update an existing portal user type, modifying the active flag and reconfiguring the module access list with updated permissions and field configurations.", "summary": "Update portal user type", "value": { "user_type": [ { "active": true, "modules": [ { "filters": [ { "id": "111113000000005092" } ], "id": "111113000000002666", "layouts": [ { "_default_view": { "id": "111113000000003678", "type": "layout" }, "id": "111113000000003678" } ], "permissions": { "create": true, "delete": true, "edit": true, "edit_shared_records": false, "view": true }, "shared_type": "private", "views": { "id": "111113000000070019", "type": "canvas_view" } } ], "name": "Client Portal Updated" } ] } } }, "schema": { "$ref": "#/components/schemas/PutusertypeRequest" }, "x-zs-llm-examples": [ "SamplePutRequest" ] } }, "description": "The request body containing the portal user type fields to update. Include only the fields you want to change." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Zoho CRM updated the portal user type. The response confirms the update with a `SUCCESS` status and the updated user type details.", "summary": "Portal user type updated successfully", "value": { "user_type": [ { "code": "SUCCESS", "details": { "id": "111113000000168122" }, "message": "Portal user type updated successfully.", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PutusertypeResponse200" } } }, "description": "Zoho CRM updated the portal user type successfully. The response contains the identifier and name of the updated user type." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "The API does not support requests made by client portal users. **Resolution:** Use a CRM user account that is not a client portal user to call this API.", "summary": "API not supported for client portal user.", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_login_user_type": "Client Portal User" }, "message": "api not supported for client portal user", "status": "error" } }, "ApiNotSupportedResponse2": { "description": "The API is not supported in sandbox environments. **Resolution:** Run this operation against a production Zoho CRM organization.", "summary": "API not supported in sandbox.", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "ApiNotSupportedResponse3": { "description": "The API is not available for the current domain. **Resolution:** Use one of the supported domains: `eu`, `com`, `in`, `au`.", "summary": "API not supported.", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_domains": [ "eu", "com", "in", "au", "ca", "cn", "jp" ] }, "message": "api not supported", "status": "error" } }, "InvalidDataResponse1": { "description": "The request body structure is invalid or contains an unrecognized field. **Resolution:** Verify the request body matches the expected schema and all field names are spelled correctly.", "summary": "Deletion of portal user type is not allowed, as user type contains users, which need to be transferred to other user type.", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "jsonobject" }, "message": "body", "status": "error" } }, "InvalidDataResponse10": { "description": "The `shared_type` value is not the expected string type. **Resolution:** Provide a valid string value for `shared_type`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "expected_data_type": "text", "json_path": "$.user_type[*].modules[*].shared_type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "The `shared_type` value exceeds the maximum allowed length of 7 characters. **Resolution:** Shorten the `shared_type` value to 7 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "json_path": "$.user_type[*].modules[*].shared_type", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "The `shared_type` value is invalid. **Resolution:** Provide a valid value for `shared_type` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "json_path": "$.user_type[*].modules[*].shared_type", "minimum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "The `shared_type` value is not among the supported options. **Resolution:** Set `shared_type` to one of the accepted values. Possible values: `public`, `private`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_type", "json_path": "$.user_type[*].modules[*].shared_type", "supported_values": [ "public", "private" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "The `permissions` value is not the expected object type. **Resolution:** Provide a valid object value for `permissions`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "permissions", "expected_data_type": "jsonobject", "json_path": "$.user_type[*].modules[*].permissions" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "The `permissions` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `permissions` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "permissions", "json_path": "$.user_type[*].modules[*].permissions", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "The `view` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `view`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.view" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "The `view` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `view` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "json_path": "$.user_type[*].modules[*].permissions.view", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "The `view` value is invalid. **Resolution:** Provide a valid value for `view` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "json_path": "$.user_type[*].modules[*].permissions.view", "minimum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "The `view` value is not among the supported options. **Resolution:** Set `view` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "view", "json_path": "$.user_type[*].modules[*].permissions.view", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "The `name` value is not the expected string type. **Resolution:** Provide a valid string value for `name`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.user_type[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "The `edit` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `edit`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.edit" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "The `edit_shared_records` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `edit_shared_records`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit_shared_records", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.edit_shared_records" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "The `edit_shared_records` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `edit_shared_records` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit_shared_records", "json_path": "$.user_type[*].modules[*].permissions.edit_shared_records", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "The `edit_shared_records` value is invalid. **Resolution:** Provide a valid value for `edit_shared_records` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit_shared_records", "json_path": "$.user_type[*].modules[*].permissions.edit_shared_records", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "The `edit_shared_records` value is not among the supported options. **Resolution:** Set `edit_shared_records` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "edit_shared_records", "json_path": "$.user_type[*].modules[*].permissions.edit_shared_records", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "The `create` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `create`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.create" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse26": { "description": "The `create` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `create` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create", "json_path": "$.user_type[*].modules[*].permissions.create", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse27": { "description": "The `create` value is invalid. **Resolution:** Provide a valid value for `create` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "create", "json_path": "$.user_type[*].modules[*].permissions.create", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse28": { "description": "The `delete` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `delete`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "delete", "expected_data_type": "boolean", "json_path": "$.user_type[*].modules[*].permissions.delete" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse29": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].modules[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "The `name` value exceeds the maximum allowed length of 50 characters. **Resolution:** Shorten the `name` value to 50 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.user_type[*].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse30": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse31": { "description": "The `filters` value is not the expected array type. **Resolution:** Provide a valid array value for `filters`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "filters", "expected_data_type": "jsonarray", "json_path": "$.user_type[*].modules[*].filters" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse32": { "description": "The `filters` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `filters` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "filters", "json_path": "$.user_type[*].modules[*].filters", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse33": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].modules[*].filters[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse34": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].filters[*].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse35": { "description": "The `layouts` value is not the expected array type. **Resolution:** Provide a valid array value for `layouts`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "layouts", "expected_data_type": "jsonarray", "json_path": "$.user_type[*].modules[*].layouts" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse36": { "description": "The `layouts` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `layouts` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "layouts", "json_path": "$.user_type[*].modules[*].layouts", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse37": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].modules[*].layouts[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse38": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].layouts[*].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse39": { "description": "The `_default_view` value is not the expected object type. **Resolution:** Provide a valid object value for `_default_view`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "_default_view", "expected_data_type": "jsonobject", "json_path": "$.user_type[*].modules[*].layouts[*]._default_view" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "The `active` value is not the expected Boolean type. **Resolution:** Provide a valid Boolean value for `active`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "expected_data_type": "boolean", "json_path": "$.user_type[*].active" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse40": { "description": "The `_default_view` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `_default_view` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "_default_view", "json_path": "$.user_type[*].modules[*].layouts[*]._default_view", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse41": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].modules[*].layouts[*]._default_view.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse42": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].layouts[*]._default_view.id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse43": { "description": "The `type` value is not the expected string type. **Resolution:** Provide a valid string value for `type`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.user_type[*].modules[*].layouts[*]._default_view.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse44": { "description": "The `type` value exceeds the maximum allowed length of 6 characters. **Resolution:** Shorten the `type` value to 6 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.user_type[*].modules[*].layouts[*]._default_view.type", "maximum_length": 6 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse45": { "description": "The `type` value is not among the supported options. **Resolution:** Set `type` to one of the accepted values. Possible values: `wizard`, `layout`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.user_type[*].modules[*].layouts[*]._default_view.type", "supported_values": [ "wizard", "layout" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse46": { "description": "The `views` value is not the expected object type. **Resolution:** Provide a valid object value for `views`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "views", "expected_data_type": "jsonobject", "json_path": "$.user_type[*].modules[*].views" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse47": { "description": "The `views` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `views` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "views", "json_path": "$.user_type[*].modules[*].views", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse48": { "description": "The `id` value is not the expected integer type. **Resolution:** Provide a valid integer value for `id`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.user_type[*].modules[*].views.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse49": { "description": "The `id` value exceeds the maximum allowed length of 18 characters. **Resolution:** Shorten the `id` value to 18 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_type[*].modules[*].views.id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "The `active` value exceeds the maximum allowed length of 5 characters. **Resolution:** Shorten the `active` value to 5 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "json_path": "$.user_type[*].active", "maximum_length": 5 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse50": { "description": "The `type` value is not the expected string type. **Resolution:** Provide a valid string value for `type`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.user_type[*].modules[*].views.type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse51": { "description": "The `type` value exceeds the maximum allowed length of 11 characters. **Resolution:** Shorten the `type` value to 11 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.user_type[*].modules[*].views.type", "maximum_length": 11 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse52": { "description": "The `type` value is not among the supported options. **Resolution:** Set `type` to one of the accepted values. Possible values: `canvas_view`, `custom_view`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.user_type[*].modules[*].views.type", "supported_values": [ "canvas_view", "custom_view" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "The `active` value is invalid. **Resolution:** Provide a valid value for `active` that meets the schema requirements.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "json_path": "$.user_type[*].active", "minimum_length": 4 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "The `active` value is not among the supported options. **Resolution:** Set `active` to one of the accepted values. Possible values: `true`, `false`.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "active", "json_path": "$.user_type[*].active", "supported_values": [ "true", "false" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "The `modules` value is not the expected array type. **Resolution:** Provide a valid array value for `modules`.", "summary": "Invalid data type", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "modules", "expected_data_type": "jsonarray", "json_path": "$.user_type[*].modules" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "The `modules` value exceeds the maximum allowed length of 1 characters. **Resolution:** Shorten the `modules` value to 1 characters or fewer.", "summary": "Invalid data", "value": { "user_type": [ { "code": "INVALID_DATA", "details": { "api_name": "modules", "json_path": "$.user_type[*].modules", "maximum_length": 1 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidPortalNameResponse1": { "description": "The portal name provided in the request path does not match any existing portal. **Resolution:** Verify that the portal name in the request path matches an existing portal name in the Zoho CRM organization.", "summary": "No portal exists with the given portal name", "value": { "code": "INVALID_DATA", "details": {}, "message": "No portal exists with the given portal name.", "status": "error" } }, "NotAllowedResponse1": { "description": "SAML is configured for the portal, so phone number fields cannot be used as the invitation field. **Resolution:** Choose a non-phone field (such as `Email`) as the invitation field for SAML-configured portals.", "summary": "SAML configured for portal so phone field was not allowed for user types", "value": { "user_type": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.user_type[0].invitation_field.id" }, "message": "SAML configured for portal so phone field was not allowed for user types", "status": "error" } ] } }, "NotAllowedResponse2": { "description": "The personality module of the default portal user type cannot be changed. **Resolution:** Remove `personality_module` from the update request, or perform this change on a non-default user type.", "summary": "Change of personality module of default user type is not allowed", "value": { "user_type": [ { "code": "NOT_ALLOWED", "details": { "api_name": "personality_module", "json_path": "$.user_type[0].personality_module" }, "message": "Change of personality module of default user type is not allowed.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiNotSupportedForClientPortalUserError" }, { "$ref": "#/components/schemas/ApiNotSupportedInSandboxError" }, { "$ref": "#/components/schemas/ApiNotSupportedForDomainError" }, { "$ref": "#/components/schemas/InvalidPortalNameError" }, { "$ref": "#/components/schemas/InvalidDataUserTypeBodyError" }, { "additionalProperties": false, "description": "An error response wrapped inside a `user_type` object. Returned when the update request fails due to a structural validation error in the user type body.", "properties": { "user_type": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/SamlInvitationFieldNotAllowedError" }, { "$ref": "#/components/schemas/PersonalityModuleChangeNotAllowedError" }, { "$ref": "#/components/schemas/PortalUserTypeInvalidDataTypeError" }, { "$ref": "#/components/schemas/InvalidDataMaximumLengthError" }, { "$ref": "#/components/schemas/InvalidDataMinimumLengthError" }, { "$ref": "#/components/schemas/PortalUserTypeInvalidDataSupportedValuesError" }, { "$ref": "#/components/schemas/ErrorInvalidPersonalityModule" } ], "description": "An error object describing a specific validation failure, layout constraint violation, or field permission issue." }, "maxItems": 25, "type": "array" } }, "required": [ "user_type" ], "type": "object", "x-zs-$id": "PutusertypeError400Wrapper" } ], "description": "One or more error conditions occurred. See the `oneOf` variants for specific error schemas.", "x-zs-$id": "PutusertypeError400" } } }, "description": "The update request failed because the request body contains invalid data, missing required fields, or a field value that does not satisfy the configured constraints." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "No permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal" ] }, "message": "No permission", "status": "error" } }, "NoPermissionResponse2": { "description": "The authenticated user does not have the required permission to perform this operation. **Resolution:** Grant the `ZohoCRM.settings.clientportal` scope permission to the OAuth client and re-authenticate.", "summary": "NO_PERMISSION", "value": { "code": "NO_PERMISSION", "details": {}, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/PortalUserTypeNoPermissionError" }, { "$ref": "#/components/schemas/NoPermissionManagePortalsDisabledError" } ], "description": "The request was rejected due to insufficient permissions. See the `oneOf` variants for specific permission error schemas.", "x-zs-$id": "PutusertypeError403" } } }, "description": "The authenticated user does not have permission to update portal user types." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.ALL" ] }, { "OAuth2": [ "ZohoCRM.settings.clientportal.UPDATE" ] } ], "summary": "Portal User Type", "tags": [ "portal_user_type" ], "x-zoho-document": "portal_user_type", "x-zs-llm-description": "Updates user type properties such as name, active status, modules, layouts, fields, and permissions." } }, "/crm/v8/settings/portals/{portal}/user_type/{userType}/users": { "delete": { "description": "To delete one or more portal users from your Zoho CRM organization for the specified portal and user type.", "operationId": "deletePortalUsers", "parameters": [ { "$ref": "#/components/parameters/PortalUsersPortal" }, { "$ref": "#/components/parameters/UserType" }, { "description": "List for record IDs of portal users to be deleted.", "in": "query", "name": "personality_ids", "required": false, "schema": { "description": "Represents the unique identifier of the RecordGETDataItem record.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response for the deletion of two portal users, including the personality ID of each deleted user.", "summary": "Successful deletion of portal users", "value": { "users": [ { "code": "SUCCESS", "details": { "personality_id": "12345" }, "message": "User deleted successfully", "status": "success" }, { "code": "SUCCESS", "details": { "personality_id": "67890" }, "message": "User deleted successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing the deletion result for each requested portal user.", "properties": { "users": { "description": "Represents the list of deleted portal user results. Contains one result object per requested deletion.", "items": { "additionalProperties": false, "description": "Represents the deletion result for a single portal user.", "properties": { "code": { "description": "Represents the error code. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the operation result.", "properties": { "personality_id": { "description": "Represents the unique identifier of the portal user record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the success or informational message for this operation result.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**, **success**. ", "enum": [ "error", "success" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeletePortalUsersResponse" } } }, "description": "Returns the deletion result for the requested portal users." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when the delete operation is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "InvalidData": { "description": "Shows the INVALID_DATA error returned when a personality ID does not belong to a valid portal user in the specified user type.", "summary": "Error when the personality ID is invalid", "value": { "users": [ { "code": "INVALID_DATA", "details": { "personality_id": "5020928000001843001" }, "message": "Delete of user failed as personality id does not belongs to any portal user or belongs to portal user, who does not belongs to provided user type.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response returned when one or more field values in the request do not match the expected format or constraints.", "properties": { "users": { "description": "Represents the list of deletion error results. Each object contains error details for a failed deletion.", "items": { "additionalProperties": false, "description": "Represents the deletion result for a single portal user.", "properties": { "code": { "description": "Represents the error code. Possible values: **INVALID_DATA**. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "personality_id": { "description": "Represents the identifier of the portal user record associated with the error. Returned when available.", "format": "int64", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "type": "object", "x-zs-$id": "DeletePortalUsersInvalidDataResponse" }, { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeletePortalUsersApiNotSupportedResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "DeletePortalUsersBadRequestResponse" } } }, "description": "Invalid request - the deletion failed due to a validation error. Resolution: Check the error code and correct the request before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissions": { "description": "Shows the NO_PERMISSION error returned when the authenticated user does not have permission to delete portal users.", "summary": "Error when the user lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal_Users" ] }, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the authenticated user does not have the required permission to perform the operation.", "properties": { "code": { "description": "Represents the error code. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "DeletePortalUsersForbiddenResponse" } } }, "description": "Permission denied. Resolution: The CRM administrator must grant the **ZohoCRM.settings.clientportal** scope permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.DELETE" ] } ], "summary": "delete portal users", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "Based on the personality ids passed in params portal users will be deleted" }, "get": { "description": "To retrieve the list of portal users in your Zoho CRM organization for the specified portal and user type, with optional filtering by source.", "operationId": "getPortalUsers", "parameters": [ { "$ref": "#/components/parameters/PortalUsersPortal" }, { "$ref": "#/components/parameters/UserType" }, { "description": "Represents the number of records to return per page.", "in": "query", "name": "page", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "description": "Represents number of records to return per page.", "in": "query", "name": "per_page", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "description": "Represents the source of the user record.", "in": "query", "name": "Source__s", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Represents the filters of the user record.", "in": "query", "name": "filters", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Represents the list of portal user record IDs to filter the results.", "in": "query", "name": "personality_ids", "required": false, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Represents the filter type for the portal users.", "in": "query", "name": "type", "required": false, "schema": { "maxLength": 255, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows a successful response containing a single portal user with all required fields and the total count in the info object.", "summary": "List of portal users with response metadata", "value": { "info": { "total_count": 1 }, "users": [ { "Source__s": "Portal", "active": true, "confirm": true, "created_time": "2023-01-15T10:30:00Z", "email": "john.doe@example.com", "module": "Contacts", "name": "John Doe", "personality_id": "12345", "status_reason__s": "Active" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing the list of portal users and pagination metadata.", "properties": { "info": { "additionalProperties": false, "description": "Represents pagination metadata for the response.", "properties": { "total_count": { "description": "Represents the total number of portal users available for the specified portal and user type.", "format": "int32", "type": "integer" } }, "required": [ "total_count" ], "type": "object" }, "users": { "description": "Represents the list of portal user objects.", "items": { "additionalProperties": false, "description": "Represents a single portal user and their associated attributes.", "properties": { "Source__s": { "description": "Represents the source of the portal user record.", "maxLength": 255, "type": "string" }, "active": { "description": "Indicates whether the portal user is currently active. Possible values: **true**, **false**. ", "type": "boolean" }, "confirm": { "description": "Indicates whether the portal user has confirmed their account. Possible values: **true**, **false**. ", "type": "boolean" }, "created_time": { "description": "Represents the date and time of portal user creation.", "format": "date-time", "type": "string" }, "email": { "description": "Represents the email address of the portal user.", "format": "email", "type": "string" }, "module": { "description": "Represents the API name of the CRM module associated with the portal user.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the full name of the portal user.", "maxLength": 255, "type": "string" }, "personality_id": { "description": "Represents the unique identifier of the portal user record.", "maxLength": 255, "type": "string" }, "status_reason__s": { "description": "Represents the reason for the current status of the portal user.", "maxLength": 500, "type": "string" } }, "required": [ "personality_id", "confirm", "status_reason__s", "created_time", "module", "name", "active", "email", "Source__s" ], "type": "object" }, "maxItems": 10000, "type": "array" } }, "required": [ "users", "info" ], "type": "object", "x-zs-$id": "GetPortalUsersResponse" } } }, "description": "Returns the list of portal users for the specified portal and user type." }, "204": { "description": "No portal users found for the specified portal and user type. The portal has no users yet." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when the list portal users operation is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "InvalidType": { "description": "Shows the PATTERN_NOT_MATCHED error returned when the **type** parameter value does not match the required format.", "summary": "Error when a parameter value does not match the expected pattern", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "api_name": "type" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response returned when the authenticated user does not have the required permission to perform the operation.", "properties": { "code": { "description": "Represents the error code. Possible values: **PATTERN_NOT_MATCHED**. ", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "api_name": { "description": "Represents the API name of the parameter that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the parameter that caused the error. Returned when available.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "GetPortalUsersPatternNotMatchedResponse" }, { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetPortalUsersApiNotSupportedResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "GetPortalUsersBadRequestResponse" } } }, "description": "Invalid request - a query parameter value does not match the expected format. Resolution: Check the error details for the parameter name and correct the value." }, "403": { "content": { "application/json": { "examples": { "NoPermissions": { "description": "Shows the NO_PERMISSION error returned when the authenticated user does not have the required client portal read permission.", "summary": "Error when the user lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal_Users" ] }, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response returned when the authenticated user does not have the required permission to perform the operation.", "properties": { "code": { "description": "Represents the error code. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "NoPermissionErrorResponse" }, { "additionalProperties": false, "description": "Error response containing a list of portal invitation errors, one per failed invitation.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": false, "description": "Represents a single portal user and their associated attributes.", "properties": { "code": { "description": "Represents the status code of the operation.", "maxLength": 255, "type": "string" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "PortalInviteErrorResponse" }, { "additionalProperties": false, "description": "Alternative error response format for portal invitation failures.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": true, "description": "Represents a single portal user and their associated attributes.", "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "AlternativePortalInviteErrorResponse" }, { "additionalProperties": false, "description": "Error response containing an array of portal invitation error objects.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": true, "description": "Represents a single portal user and their associated attributes.", "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "AdditionalPortalInviteErrorResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "GetPortalUsersForbiddenResponse" } } }, "description": "Permission denied. Resolution: The CRM administrator must grant the **ZohoCRM.settings.clientportal** scope permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.READ" ] } ], "summary": "List portal users", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "Retrieve users of a specific portal filtered by user type." } }, "/crm/v8/settings/portals/{portal}/user_type/{userType}/users/action/transfer": { "post": { "description": "To transfer one or more portal users from one user type group to another within the same portal in your Zoho CRM organization.", "operationId": "transferPortalUsers", "parameters": [ { "$ref": "#/components/parameters/PortalUsersPortal" }, { "$ref": "#/components/parameters/UserType" }, { "description": "The ID of the user type to which you want to transfer the users.", "in": "query", "name": "transfer_To", "required": true, "schema": { "format": "int64", "type": "string" } }, { "description": "The ID of the user type to which you want to transfer the users.", "in": "query", "name": "personality_ids", "required": true, "schema": { "format": "int64", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response when two portal users are transferred to a new user type group.", "summary": "Successful transfer of portal users", "value": { "users": [ { "code": "SUCCESS", "details": { "personality_id": "5020928000000606073" }, "message": "User has been transferred successfully", "status": "success" }, { "code": "SUCCESS", "details": { "personality_id": "5020928000002110005" }, "message": "User has been transferred successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing the transfer result for each requested portal user.", "properties": { "users": { "description": "Represents the list of transferred portal user results. Contains one result object per transferred user.", "items": { "additionalProperties": false, "description": "Represents the transfer result for a single portal user.", "properties": { "code": { "description": "Represents the error code. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the operation result.", "properties": { "personality_id": { "description": "Represents the unique identifier of the portal user record.", "maxLength": 255, "type": "string" } }, "required": [ "personality_id" ], "type": "object" }, "message": { "description": "Represents the success or informational message for this operation result.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "TransferPortalUsersResponse" } } }, "description": "Returns the transfer result for the requested portal users." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when the transfer operation is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "InvalidData": { "description": "Shows the INVALID_DATA error returned when one or more personality IDs do not belong to valid portal users in the specified user type.", "summary": "Error when the transfer data is invalid", "value": { "users": [ { "code": "INVALID_DATA", "details": { "personality_id": "1234567890" }, "message": "Transfer of user failed as personality id does not belongs to any portal user or belongs to portal user, who does not belongs to provided user type.", "status": "error" } ] } }, "RequiredParamMissing": { "description": "Shows the REQUIRED_PARAM_MISSING error returned when the **transfer_To** parameter is not included in the request.", "summary": "Error when a required parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "transfer_To" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response containing a list of portal user transfer errors, one per failed transfer.", "properties": { "code": { "description": "Represents the error code. Possible values: **REQUIRED_PARAM_MISSING**, **INVALID_DATA**. ", "enum": [ "REQUIRED_PARAM_MISSING", "INVALID_DATA" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "param": { "description": "Represents the name of the missing or invalid parameter. Possible values: **personality_ids**, **transfer_To**. Returned when available.", "enum": [ "personality_ids", "transfer_To" ], "type": "string" }, "transfer_To": { "description": "Represents the identifier of the destination user type provided in the request. Returned when available.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "TransferPortalUsersErrorResponse" }, { "additionalProperties": false, "description": "Error response containing a users array with transfer error details.", "properties": { "users": { "description": "Represents the list of transfer error results. Each object contains error details for a failed transfer.", "items": { "additionalProperties": false, "description": "Represents the transfer result for a single portal user.", "properties": { "code": { "description": "Represents the error code. Possible values: **INVALID_DATA**. ", "enum": [ "INVALID_DATA" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "personality_id": { "description": "Represents the identifier of the portal user record associated with the error. Returned when available.", "maxLength": 255, "type": "string" } }, "required": [ "personality_id" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "TransferPortalUsersUsersErrorResponse" }, { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "TransferPortalUsersApiNotSupportedResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "TransferPortalUsersBadRequestResponse" } } }, "description": "Invalid request - the transfer failed due to missing or invalid parameters. Resolution: Check the error code and ensure all required parameters are provided." }, "403": { "content": { "application/json": { "examples": { "NoPermissions": { "description": "Shows the NO_PERMISSION error returned when the authenticated user does not have the required client portal update permission.", "summary": "Error when the user lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal_Users" ] }, "message": "User has been transferred successfully", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the authenticated user does not have the required permission to perform the operation.", "properties": { "code": { "description": "Represents the error code. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "TransferPortalUsersForbiddenResponse" } } }, "description": "Permission denied. Resolution: The CRM administrator must grant the **ZohoCRM.settings.clientportal** scope permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.CREATE" ] } ], "summary": "Transfer portal users from one user group to another", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "USed to change portal users from one user group(user type) to another user type which should match same module and invitation field" } }, "/crm/v8/settings/portals/{portal}/user_type/{userType}/users/actions/change_status": { "put": { "description": "To activate or deactivate multiple portal users in bulk in your Zoho CRM organization for the specified portal and user type.", "operationId": "changePortalUsersStatusBulk", "parameters": [ { "$ref": "#/components/parameters/PortalUsersPortal" }, { "$ref": "#/components/parameters/UserType" } ], "requestBody": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows a request body for changing the active status of multiple portal users in bulk.", "summary": "Request body for bulk status change", "value": { "change_status": [ { "users": [ { "active": false, "personality_id": "12346789899" }, { "active": false, "personality_id": "12346789898" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for changing status of portal users", "properties": { "change_status": { "description": "Represents the list of portal user status change results. Contains one result object per requested status change.", "items": { "additionalProperties": false, "description": "Represents the status change result for a single portal user.", "properties": { "users": { "description": "Represents the list of portal user objects.", "items": { "additionalProperties": false, "description": "Represents the status change result for a single portal user.", "properties": { "active": { "description": "Indicates whether the portal user is currently active. Possible values: **true**, **false**.", "type": "boolean" }, "personality_id": { "description": "Specify the unique identifier of the portal user record.", "maxLength": 255, "type": "string" } }, "required": [ "personality_id", "active" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "change_status" ], "type": "object" }, "x-zs-llm-examples": [ "Example1" ] } }, "description": "The request body must contain a **change_status** array. You can include the personality identifiers and new active status for the portal users." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response when multiple portal users have their status changed in bulk.", "summary": "Successful bulk status change", "value": { "change_status": [ { "code": "SCHEDULED", "details": { "job_id": "5020928000000606073" }, "message": "Portal bulk user status change scheduled successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing the status change result for the portal user.", "properties": { "change_status": { "description": "Represents the list of portal user status change results. Contains one result object per requested status change.", "items": { "additionalProperties": false, "description": "Represents the status change result for a single portal user.", "properties": { "code": { "description": "Represents the error code. Possible values: **SCHEDULED**. ", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the operation result.", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled invitation job.", "maxLength": 255, "type": "string", "x-zs-$id": "PortalUserStatusChangeJobId" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the success or informational message for this operation result.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "change_status" ], "type": "object", "x-zs-$id": "ChangePortalUsersStatusBulkResponse" } } }, "description": "Returns the status change result for the portal user." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when the bulk status change is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ChangePortalUsersStatusBulkApiNotSupportedResponse" } } }, "description": "This API is not supported in sandbox environments. Resolution: The request must be made from a production Zoho CRM organization, not a sandbox." }, "403": { "content": { "application/json": { "examples": { "NoPermissions": { "description": "Shows the NO_PERMISSION error returned when the authenticated user does not have the required client portal permission.", "summary": "Error when the user lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal_Users" ] }, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the authenticated user does not have the required permission to perform the operation.", "properties": { "code": { "description": "Represents the error code. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ChangePortalUsersStatusBulkForbiddenResponse" } } }, "description": "Permission denied. Resolution: The CRM administrator must grant the **ZohoCRM.settings.clientportal** scope permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.UPDATE" ] } ], "summary": "Portal User Status", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "Updating the status of specific portal user which was associated with given record" } }, "/crm/v8/settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status": { "put": { "description": "Changing portal users status.", "operationId": "changePortalUsersStatus", "parameters": [ { "$ref": "#/components/parameters/PortalUsersPortal" }, { "$ref": "#/components/parameters/UserType" }, { "$ref": "#/components/parameters/PortalUsersRecordId" }, { "description": "**true** activates the user in the portal, and **false** deactivates the user in the portal.", "in": "query", "name": "active", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response when the portal user status is changed, including the personality ID of the updated user.", "summary": "Successful status change for a portal user", "value": { "change_status": [ { "code": "SUCCESS", "details": { "personality_id": "5020928000000606073" }, "message": "Status of the user changed successfully.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing the status change result for the portal user.", "properties": { "change_status": { "description": "Represents the list of portal user status change results. Contains one result object per requested status change.", "items": { "additionalProperties": false, "description": "Represents the status change result for a single portal user.", "properties": { "code": { "description": "Represents the error code. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the operation result.", "properties": { "personality_id": { "description": "Represents the unique identifier of the portal user record.", "maxLength": 255, "type": "string" } }, "required": [ "personality_id" ], "type": "object" }, "message": { "description": "Represents the success or informational message for this operation result.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "change_status" ], "type": "object", "x-zs-$id": "ChangePortalUsersStatusResponse" } } }, "description": "Returns the status change result for the portal user." }, "400": { "content": { "application/json": { "examples": { "AlreadyActivated": { "description": "Shows the ALREADY_ACTIVATED error returned when attempting to activate a portal user who is already in an active state.", "summary": "Error when user is already activated", "value": { "code": "ALREADY_ACTIVATED", "details": { "resource_path_index": "6" }, "message": "Already in active state only.", "status": "error" } }, "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when the change status operation is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "InvalidData": { "description": "Shows the INVALID_DATA error returned when the personality ID does not match a valid portal user.", "summary": "Error when the personality ID is invalid", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": "6" }, "message": "Activation/Deactivation of portal user whose personality record in recyclebin is not allowed.", "status": "error" } }, "LimitExceeded": { "description": "Shows the LIMIT_EXCEEDED error returned when activating a portal user would exceed the configured portal user limit.", "summary": "Error when the portal user limit is exceeded", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 0 }, "message": "License Limit has been exceeded.", "status": "error" } }, "NotAllowed": { "description": "Shows the NOT_ALLOWED error returned when the requested status change is not permitted for the portal user.", "summary": "Error when the status change is not allowed", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": "6" }, "message": "Deactivating unconfirmed user is not allowed", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Portal user status changes error response with array of errors", "properties": { "code": { "description": "Represents the error code. Possible values: **ALREADY_ACTIVATED**, **INVALID_DATA**, **LIMIT_EXCEEDED**, **NOT_ALLOWED**. ", "enum": [ "ALREADY_ACTIVATED", "INVALID_DATA", "LIMIT_EXCEEDED", "NOT_ALLOWED" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "limit": { "description": "Represents the configured portal user limit for this portal. Returned when available.", "format": "int32", "type": "integer" }, "resource_path_index": { "description": "Represents the record identifier associated with the error. Returned when available.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ChangePortalUsersStatusErrorResponse" }, { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ChangePortalUsersStatusApiNotSupportedResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "ChangePortalUsersStatusBadRequestResponse" } } }, "description": "Invalid request - the status change failed due to a validation error. Resolution: Check the error code and correct the request parameters before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissions": { "description": "Shows the NO_PERMISSION error returned when the authenticated user does not have the required client portal permission.", "summary": "Error when the user lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal_Users" ] }, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the authenticated user does not have the required permission to perform the operation.", "properties": { "code": { "description": "Represents the error code. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ChangePortalUsersStatusForbiddenResponse" } } }, "description": "Permission denied. Resolution: The CRM administrator must grant the **ZohoCRM.settings.clientportal** scope permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.UPDATE" ] } ], "summary": "Change status of portal users", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "Updating the portal user status in bullk" } }, "/crm/v8/settings/profiles": { "get": { "description": "Retrieves the paginated list of all profiles in the organization, including each profile's name, type, permission details, and section groupings. Use the `type` query parameter to filter by profile type, and `include_types` to include Lite or Support profiles alongside the default set. See [Get Profiles](https://www.zoho.com/crm/developer/docs/api/v8/get-profiles.html).\n\n**Scopes:**\n* ZohoCRM.settings.profiles.ALL\n* ZohoCRM.settings.profiles.READ", "operationId": "getProfiles", "parameters": [ { "$ref": "#/components/parameters/ProfilesType" }, { "$ref": "#/components/parameters/IncludeTypes" }, { "$ref": "#/components/parameters/ProfilesFilters" }, { "$ref": "#/components/parameters/ProfilesPage" }, { "$ref": "#/components/parameters/ProfilesPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "description": "A sample response containing a paginated list of CRM profiles with their permission details.", "summary": "Profiles list", "value": { "info": { "count": 4, "license_limit": 200, "more_records": false, "page": 1, "per_page": 200 }, "profiles": [ { "api_name": "Administrator", "created_by": null, "created_time": null, "custom": false, "description": "This profile will have all the permissions. Users with Administrator profile will be able to view and manage all the data within the organization account by default.", "display_label": "Administrator", "id": "1697753000000015972", "modified_by": { "id": "1697753000000424001", "name": "Mohan Sai Mohan Sai" }, "modified_time": "2025-09-26T18:53:34+05:30", "name": "Administrator", "type": "normal_profile" }, { "api_name": "Standard", "created_by": null, "created_time": null, "custom": false, "description": "This profile will have all the permissions except administrative privileges.", "display_label": "Standard", "id": "1697753000000015975", "modified_by": { "id": "1697753000000424001", "name": "Mohan Sai Mohan Sai" }, "modified_time": "2025-05-28T15:10:51+05:30", "name": "Standard", "type": "normal_profile" }, { "api_name": "Team_User", "created_by": null, "created_time": null, "custom": false, "description": "This profile will be auto-assigned only for Team users who can access Team modules and have limited permissions for Organisation modules.", "display_label": "Team User", "id": "1697753000010415055", "modified_by": { "id": "1697753000000424001", "name": "Mohan Sai Mohan Sai" }, "modified_time": "2025-07-24T18:42:58+05:30", "name": "Team User", "type": "lite_profile" }, { "api_name": "r8ynjk", "created_by": { "id": "1697753000000424001", "name": "Mohan Sai Mohan Sai" }, "created_time": "2025-01-28T14:03:56+05:30", "custom": true, "description": null, "display_label": "34r8ynjke", "id": "1697753000021778019", "modified_by": { "id": "1697753000000424001", "name": "Mohan Sai Mohan Sai" }, "modified_time": "2025-11-20T19:03:43+05:30", "name": "34r8ynjke", "type": "normal_profile" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful response containing the list of CRM profiles and pagination info.", "properties": { "info": { "anyOf": [ { "additionalProperties": false, "description": "Pagination metadata including count, page, per_page, and whether more records exist.", "properties": { "count": { "description": "Number of profiles returned in this response page.", "format": "int32", "type": "integer" }, "license_limit": { "description": "Maximum number of profiles allowed by the organization's license.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional profiles exist beyond the current page.", "type": "boolean" }, "page": { "description": "Current page number in the paginated result set.", "format": "int32", "type": "integer" }, "per_page": { "description": "Number of profiles returned per page.", "format": "int32", "type": "integer" } }, "required": [ "per_page", "page", "count", "more_records" ], "type": "object", "x-zs-$id": "ProfilesPaginationInfo" }, { "additionalProperties": false, "description": "License usage summary when full pagination data is not available.", "properties": { "license_limit": { "description": "Maximum number of profiles allowed by the organization's license.", "format": "int32", "type": "integer" } }, "required": [ "license_limit" ], "type": "object", "x-zs-$id": "ProfilesLicenseLimitSummary" } ], "description": "Pagination and license usage information for the profiles list response." }, "profiles": { "description": "List of profiles returned for this page (up to 200 entries).", "items": { "additionalProperties": false, "description": "Details of a single profile, including its permissions and section groupings.", "properties": { "$has_more": { "description": "Indicates whether the profile has more permission records beyond the included set.", "type": "boolean" }, "api_name": { "$ref": "#/components/schemas/ProfilesApiName", "x-zs-$id": "ProfileApiName" }, "created_by": { "$ref": "#/components/schemas/ProfilesCreatedBy" }, "created_time": { "$ref": "#/components/schemas/ProfilesCreatedTime" }, "custom": { "description": "Indicates whether the profile is a custom profile (`true`) or a system profile (`false`).", "type": "boolean" }, "description": { "description": "Optional description of the profile.", "maxLength": 255, "type": [ "string", "null" ] }, "display_label": { "description": "Display label shown for the profile in the CRM UI.", "maxLength": 255, "type": "string" }, "id": { "$ref": "#/components/schemas/ProfilesId", "description": "Unique profile identifier.", "x-zs-$id": "ProfileId" }, "modified_by": { "$ref": "#/components/schemas/ProfilesModifiedBy" }, "modified_time": { "$ref": "#/components/schemas/ModifiedTime" }, "name": { "$ref": "#/components/schemas/ProfileName" }, "permissions_details": { "description": "Flat list of all individual permissions configured for this profile (up to 2000 entries).", "items": { "additionalProperties": false, "description": "A single permission entry describing a specific access right in the profile.", "properties": { "active": { "description": "Whether the permission is active.", "type": "boolean" }, "api_name": { "description": "API name of the permission.", "maxLength": 255, "type": "string" }, "custom_permission": { "description": "Whether this is a custom permission.", "type": "boolean" }, "customizable": { "description": "Indicates whether this permission can be toggled on or off by an administrator.", "type": "boolean" }, "description": { "description": "Description of the permission.", "maxLength": 500, "type": [ "string", "null" ] }, "display_label": { "description": "Human-readable label displayed for this permission in the CRM UI.", "maxLength": 255, "type": "string" }, "enabled": { "description": "Indicates whether this permission is currently enabled for the profile.", "type": "boolean" }, "id": { "$ref": "#/components/schemas/ProfilesId", "description": "The unique identifier of the permission.", "x-zs-$id": "ProfilePermissionDetailsId" }, "module": { "description": "Module associated with this permission. Null when the permission is not tied to a specific module.", "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Internal API name of the permission.", "maxLength": 255, "type": "string" }, "parent_permissions": { "anyOf": [ { "description": "Array of parent permission identifiers this permission depends on.", "items": { "$ref": "#/components/schemas/ProfilesId" }, "maxItems": 200, "type": "array", "x-zs-$id": "ListProfilePermissionParentPermissionsArray" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesTypeNull" } ], "description": "Null when this permission has no parent dependencies.", "x-zs-$id": "ListProfilePermissionParentPermissionsNull" } ], "description": "List of parent permission names that must be enabled before this permission can be enabled, or null when there are no parent dependencies." }, "tooltip_msg": { "description": "Tooltip text displayed when hovering over this permission in the CRM UI.", "maxLength": 500, "type": "string" } }, "type": "object" }, "maxItems": 2000, "type": "array" }, "sections": { "description": "Grouped sections that organize permissions into categories for display in the CRM UI (up to 100 sections).", "items": { "additionalProperties": false, "description": "A section grouping related permission categories.", "properties": { "categories": { "description": "List of permission categories within this section (up to 100 categories).", "items": { "additionalProperties": false, "description": "A single permission category containing related permissions.", "properties": { "display_label": { "description": "Display label shown for this category in the CRM UI.", "maxLength": 255, "type": "string" }, "module": { "description": "Module associated with this category or null when the category is not module-specific.", "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Internal name of the permission category.", "maxLength": 255, "type": "string" }, "permissions_details": { "description": "Permission identifiers grouped under this category.", "items": { "description": "A single permission identifier string associated with this category.", "maxLength": 255, "type": "string" }, "maxItems": 500, "minItems": 0, "type": "array" } }, "required": [ "display_label", "permissions_details", "name" ], "type": "object" }, "maxItems": 100, "type": "array" }, "name": { "description": "Internal name of the permission section.", "maxLength": 255, "type": "string" } }, "required": [ "name", "categories" ], "type": "object" }, "maxItems": 100, "type": "array" }, "type": { "description": "Profile type classification. Possible values: `private_profile`, `normal_profile`, `lite_profile`, `system_profile`, `portal_profile`. `private_profile` is used exclusively for team modules; non-private profiles are not allowed for team modules.", "enum": [ "private_profile", "normal_profile", "lite_profile", "system_profile", "portal_profile" ], "type": "string" } }, "required": [ "api_name", "id", "created_time", "modified_time", "name", "display_label", "custom", "type" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "ProfilesCollectionResponse" } } }, "description": "Profiles retrieved successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidRequestMethod": { "description": "Returned when the request uses an HTTP method other than GET for this endpoint.", "summary": "Invalid HTTP method used", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "InvalidTypeParam": { "description": "Returned when the `type` query parameter contains a value not in the allowed list.", "summary": "Invalid value for `type` query parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "type" }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/ProfilesInvalidRequestMethodError" } ], "description": "HTTP request method is not supported for this endpoint.", "x-zs-$id": "GetProfilesInvalidRequestMethod" }, { "allOf": [ { "$ref": "#/components/schemas/InvalidQueryParamError" } ], "description": "A query parameter value is invalid.", "x-zs-$id": "GetProfilesInvalidQueryParam" } ], "description": "Error response body for invalid GET /settings/profiles requests.", "x-zs-$id": "GetProfilesBadRequest" } } }, "description": "Invalid request." }, "401": { "$ref": "#/components/responses/ProfilesUnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ProfilesForbiddenResponse" }, "500": { "$ref": "#/components/responses/ProfilesInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.profiles.READ" ] } ], "summary": "Profiles", "tags": [ "profiles" ], "x-zoho-document": "profiles", "x-zs-llm-description": "Lists all CRM profiles with their id and api_name. Call this first to discover profile ids before assigning permissions or transferring/deleting a profile." } }, "/crm/v8/settings/profiles/actions/get_assigned": {}, "/crm/v8/settings/profiles/actions/get_unassigned": {}, "/crm/v8/settings/profiles/actions/transfer_and_delete": {}, "/crm/v8/settings/profiles/{id}": { "delete": { "description": "Transfers all users of the profile identified by `{id}` to the profile specified by the `transfer_to` query parameter, then permanently deletes the source profile. System profiles (Administrator, Standard) cannot be deleted. See [Transfer Users and Delete a Profile](https://www.zoho.com/crm/developer/docs/api/v8/transfer-delete-profile.html).", "operationId": "deleteProfile", "parameters": [ { "$ref": "#/components/parameters/ProfilesId" }, { "description": "Specify the unique identifier of the profile to which users of the deleted profile will be transferred.", "in": "query", "name": "transfer_to", "required": true, "schema": { "$ref": "#/components/schemas/ProfilesId" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Deleted": { "description": "A sample response confirming that the profile was deleted and its users were transferred.", "summary": "Delete result", "value": { "code": "SUCCESS", "details": { "id": "1697753000032967150" }, "message": "Profile deleted", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Successful response for the profile delete operation.", "properties": { "code": { "description": "The status code of the result. \n**Possible values:** \n**SUCCESS**", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details returned with the delete operation result.", "properties": { "id": { "$ref": "#/components/schemas/ProfilesId", "description": "Deleted profile ID." } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable message confirming the delete result.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation result. Possible values: `success`.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteProfileResponse" } } }, "description": "Profile deleted and users transferred successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidAction": { "description": "Returned when the action given in the request is not a valid delete operation.", "summary": "Invalid action", "value": { "code": "INVALID_DATA", "details": {}, "message": "The action given is invalid", "status": "error" } }, "InvalidDeleteRequest": { "description": "Returned when the delete request violates a business rule that prevents profile deletion.", "summary": "Profile deletion failed", "value": { "code": "CANNOT_DELETE", "details": {}, "message": "Profile cannot be deleted", "status": "error" } }, "InvalidId": { "description": "Returned when the profile ID in the request path does not match any existing active profile.", "summary": "Invalid profile ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid or already deleted", "status": "error" } }, "InvalidRequestMethod": { "description": "Returned when the request uses an HTTP method other than DELETE for this endpoint.", "summary": "Invalid HTTP method used", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "InvalidTransferToId": { "description": "Returned when the `transfer_to` query parameter value does not correspond to a valid active profile.", "summary": "Invalid transfer_to profile ID", "value": { "code": "INVALID_DATA", "details": { "id": "169775300002369603" }, "message": "the id given seems to be invalid or already deleted", "status": "error" } }, "SystemProfileNotAllowed": { "description": "Returned when the target profile is a built-in system profile that is protected from deletion.", "summary": "System profile cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "System profile cannot be deleted", "status": "error" } }, "TransferToIdNotFound": { "description": "Returned when the required `transfer_to` query parameter is absent from the delete request.", "summary": "Missing transfer_to parameter", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "param": "transfer_to" }, "message": "Users in the profile need to be transferred. transfer_to param is mandatory.", "status": "error" } } }, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/TransferToIdNotFoundError" } ], "description": "The `transfer_to` query parameter is required but was not provided.", "x-zs-$id": "DeleteProfileBadRequestTransferToNotFound" }, { "allOf": [ { "$ref": "#/components/schemas/InvalidTransferToIdError" } ], "description": "The `transfer_to` value is invalid or refers to a deleted profile.", "x-zs-$id": "DeleteProfileBadRequestInvalidTransferTo" }, { "allOf": [ { "$ref": "#/components/schemas/InvalidDeleteRequestError" } ], "description": "Deletion of this profile is not permitted due to business rules.", "x-zs-$id": "DeleteProfileBadRequestInvalidDeleteRequest" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesInvalidRequestMethodError" } ], "description": "The HTTP method used is not supported for this endpoint.", "x-zs-$id": "DeleteProfileBadRequestInvalidRequestMethod" }, { "allOf": [ { "$ref": "#/components/schemas/DeleteProfileInvalidIdErrorResponse" } ], "description": "The profile ID in the request path is invalid or refers to a deleted profile.", "x-zs-$id": "DeleteProfileBadRequestInvalidId" }, { "allOf": [ { "$ref": "#/components/schemas/DeleteProfileInvalidActionErrorResponse" } ], "description": "The action given is invalid.", "x-zs-$id": "DeleteProfileBadRequestInvalidAction" }, { "allOf": [ { "$ref": "#/components/schemas/DeleteProfileSystemProfileNotAllowedErrorResponse" } ], "description": "The target profile is a system profile and cannot be deleted.", "x-zs-$id": "DeleteProfileBadRequestSystemProfileNotAllowed" } ], "description": "Error response body for invalid DELETE /settings/profiles/{id} requests.", "x-zs-$id": "DeleteProfileBadRequest" } } }, "description": "Invalid delete request." }, "401": { "$ref": "#/components/responses/ProfilesUnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ProfilesForbiddenResponse" }, "500": { "$ref": "#/components/responses/ProfilesInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.profiles.DELETE" ] } ], "summary": "Profile", "tags": [ "profiles" ], "x-zoho-document": "profiles", "x-zs-llm-description": "Deletes a profile by id. If users are still assigned, use transferAndDeleteProfiles instead to move them first." }, "get": { "description": "Retrieves the full details of the CRM profile identified by `{id}`, including its complete permission tree organized by sections and categories. See [Get Profiles](https://www.zoho.com/crm/developer/docs/api/v8/get-profiles.html).", "operationId": "getProfile", "parameters": [ { "$ref": "#/components/parameters/ProfilesId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "description": "A sample response containing the full details of a single CRM profile.", "summary": "Single profile", "value": { "profiles": [ { "api_name": "Administrator", "created_by": null, "created_time": null, "custom": false, "description": "This profile will have all the permissions. Users with Administrator profile will be able to view and manage all the data within the organization account by default.", "display_label": "Administrator", "id": "1697753000000015972", "modified_by": { "id": "1697753000000424001", "name": "Mohan Sai Mohan Sai" }, "modified_time": "2025-09-26T18:53:34+05:30", "name": "Administrator", "permissions_details": [ { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016077", "module": "Leads", "name": "Crm_Implied_View_Leads", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016071", "module": "Leads", "name": "Crm_Implied_Create_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016074", "module": "Leads", "name": "Crm_Implied_Edit_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016080", "module": "Leads", "name": "Crm_Implied_Delete_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051061", "module": "Leads", "name": "Crm_Implied_Customize_Leads", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016119", "module": "Contacts", "name": "Crm_Implied_View_Contacts", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016113", "module": "Contacts", "name": "Crm_Implied_Create_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016116", "module": "Contacts", "name": "Crm_Implied_Edit_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016122", "module": "Contacts", "name": "Crm_Implied_Delete_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051083", "module": "Contacts", "name": "Crm_Implied_Customize_Contacts", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016098", "module": "Accounts", "name": "Crm_Implied_View_Accounts", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016092", "module": "Accounts", "name": "Crm_Implied_Create_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016095", "module": "Accounts", "name": "Crm_Implied_Edit_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016101", "module": "Accounts", "name": "Crm_Implied_Delete_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051105", "module": "Accounts", "name": "Crm_Implied_Customize_Accounts", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016140", "module": "Deals", "name": "Crm_Implied_View_Deals", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016134", "module": "Deals", "name": "Crm_Implied_Create_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016137", "module": "Deals", "name": "Crm_Implied_Edit_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016143", "module": "Deals", "name": "Crm_Implied_Delete_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051127", "module": "Deals", "name": "Crm_Implied_Customize_Deals", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016368", "module": "Events", "name": "Crm_Implied_View_Events", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016362", "module": "Events", "name": "Crm_Implied_Create_Events", "parent_permissions": [ "1697753000000016368" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016365", "module": "Events", "name": "Crm_Implied_Edit_Events", "parent_permissions": [ "1697753000000016368" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016371", "module": "Events", "name": "Crm_Implied_Delete_Events", "parent_permissions": [ "1697753000000016368" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051177", "module": "Events", "name": "Crm_Implied_Customize_Events", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000017061", "module": "Calls", "name": "Crm_Implied_View_Calls", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000017057", "module": "Calls", "name": "Crm_Implied_Create_Calls", "parent_permissions": [ "1697753000000017061" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000017059", "module": "Calls", "name": "Crm_Implied_Edit_Calls", "parent_permissions": [ "1697753000000017061" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000017063", "module": "Calls", "name": "Crm_Implied_Delete_Calls", "parent_permissions": [ "1697753000000017061" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051199", "module": "Calls", "name": "Crm_Implied_Customize_Calls", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000130001", "module": "Reports", "name": "Crm_Implied_View_Reports", "parent_permissions": null }, { "customizable": true, "display_label": "Manage", "enabled": true, "id": "1697753000000112119", "module": "Reports", "name": "Crm_Implied_Manage_Reports", "parent_permissions": [ "1697753000000130001" ] }, { "customizable": true, "display_label": "Schedule", "enabled": true, "id": "1697753000000016029", "module": "Reports", "name": "Crm_Implied_Schedule_Reports", "parent_permissions": [ "1697753000000130001" ] }, { "customizable": true, "display_label": "Export", "enabled": true, "id": "1697753000008567043", "module": "Reports", "name": "Crm_Implied_Export_Reports", "parent_permissions": [ "1697753000000130001" ] }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000130002", "module": "Analytics", "name": "Crm_Implied_View_Dashboards", "parent_permissions": null }, { "customizable": true, "display_label": "Manage", "enabled": true, "id": "1697753000000112121", "module": "Analytics", "name": "Crm_Implied_Manage_Dashboards", "parent_permissions": [ "1697753000000130002" ] }, { "customizable": true, "display_label": "Export", "enabled": true, "id": "1697753000020712084", "module": "Analytics", "name": "Crm_Implied_Export_Dashboards", "parent_permissions": [ "1697753000000130002" ] }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016224", "module": "Products", "name": "Crm_Implied_View_Products", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016218", "module": "Products", "name": "Crm_Implied_Create_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016221", "module": "Products", "name": "Crm_Implied_Edit_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016227", "module": "Products", "name": "Crm_Implied_Delete_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051219", "module": "Products", "name": "Crm_Implied_Customize_Products", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016281", "module": "Quotes", "name": "Crm_Implied_View_Quotes", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016275", "module": "Quotes", "name": "Crm_Implied_Create_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016278", "module": "Quotes", "name": "Crm_Implied_Edit_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016284", "module": "Quotes", "name": "Crm_Implied_Delete_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051241", "module": "Quotes", "name": "Crm_Implied_Customize_Quotes", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016296", "module": "Sales_Orders", "name": "Crm_Implied_View_SalesOrders", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016290", "module": "Sales_Orders", "name": "Crm_Implied_Create_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016293", "module": "Sales_Orders", "name": "Crm_Implied_Edit_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016299", "module": "Sales_Orders", "name": "Crm_Implied_Delete_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051263", "module": "Sales_Orders", "name": "Crm_Implied_Customize_SalesOrders", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016311", "module": "Purchase_Orders", "name": "Crm_Implied_View_PurchaseOrders", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016305", "module": "Purchase_Orders", "name": "Crm_Implied_Create_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016308", "module": "Purchase_Orders", "name": "Crm_Implied_Edit_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016314", "module": "Purchase_Orders", "name": "Crm_Implied_Delete_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051285", "module": "Purchase_Orders", "name": "Crm_Implied_Customize_PurchaseOrders", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016326", "module": "Invoices", "name": "Crm_Implied_View_Invoices", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016320", "module": "Invoices", "name": "Crm_Implied_Create_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016323", "module": "Invoices", "name": "Crm_Implied_Edit_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016329", "module": "Invoices", "name": "Crm_Implied_Delete_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051307", "module": "Invoices", "name": "Crm_Implied_Customize_Invoices", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016161", "module": "Campaigns", "name": "Crm_Implied_View_Campaigns", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016155", "module": "Campaigns", "name": "Crm_Implied_Create_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016158", "module": "Campaigns", "name": "Crm_Implied_Edit_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016164", "module": "Campaigns", "name": "Crm_Implied_Delete_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051333", "module": "Campaigns", "name": "Crm_Implied_Customize_Campaigns", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016245", "module": "Price_Books", "name": "Crm_Implied_View_PriceBooks", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016239", "module": "Price_Books", "name": "Crm_Implied_Create_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016242", "module": "Price_Books", "name": "Crm_Implied_Edit_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016248", "module": "Price_Books", "name": "Crm_Implied_Delete_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051355", "module": "Price_Books", "name": "Crm_Implied_Customize_PriceBooks", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016182", "module": "Cases", "name": "Crm_Implied_View_Cases", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016176", "module": "Cases", "name": "Crm_Implied_Create_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016179", "module": "Cases", "name": "Crm_Implied_Edit_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016185", "module": "Cases", "name": "Crm_Implied_Delete_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051377", "module": "Cases", "name": "Crm_Implied_Customize_Cases", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016203", "module": "Solutions", "name": "Crm_Implied_View_Solutions", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016197", "module": "Solutions", "name": "Crm_Implied_Create_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016200", "module": "Solutions", "name": "Crm_Implied_Edit_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016206", "module": "Solutions", "name": "Crm_Implied_Delete_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051399", "module": "Solutions", "name": "Crm_Implied_Customize_Solutions", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000036003", "module": "Documents", "name": "Crm_Implied_View_Docs", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000036005", "module": "Documents", "name": "Crm_Implied_Create_Docs", "parent_permissions": [ "1697753000000036003" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000036011", "module": "Documents", "name": "Crm_Implied_Edit_Docs", "parent_permissions": [ "1697753000000036003" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000036007", "module": "Documents", "name": "Crm_Implied_Delete_Docs", "parent_permissions": [ "1697753000000036003" ] }, { "customizable": true, "display_label": "Manage Folder", "enabled": true, "id": "1697753000000112123", "module": "Documents", "name": "Crm_Implied_Manage_Docs_Folder", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016341", "module": "Forecasts", "name": "Crm_Implied_View_Forecasts", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000064003", "module": "Visits", "name": "Crm_Implied_View_Visits", "parent_permissions": null }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000064005", "module": "Visits", "name": "Crm_Implied_Delete_Visits", "parent_permissions": [ "1697753000000064003" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051441", "module": "Visits", "name": "Crm_Implied_Customize_Visits", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000029668801", "module": "kishorespidertest__Hello_World", "name": "Crm_Implied_View_CustomModule15", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000029668803", "module": "kishorespidertest__Hello_World", "name": "Crm_Implied_Create_CustomModule15", "parent_permissions": [ "1697753000029668801" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000029668805", "module": "kishorespidertest__Hello_World", "name": "Crm_Implied_Edit_CustomModule15", "parent_permissions": [ "1697753000029668801" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000029668807", "module": "kishorespidertest__Hello_World", "name": "Crm_Implied_Delete_CustomModule15", "parent_permissions": [ "1697753000029668801" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000029668849", "module": "kishorespidertest__Hello_World", "name": "Crm_Implied_Customize_CustomModule15", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000029670058", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_View_CustomModule16", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000029670060", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Create_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000029670062", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Edit_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000029670064", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Delete_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000029670106", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Customize_CustomModule16", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000030075017", "module": "leadchainlocal__SocialLeadChain", "name": "Crm_Implied_View_WebTab2", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000932769", "module": "Services__s", "name": "Crm_Implied_View_Services", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000932765", "module": "Services__s", "name": "Crm_Implied_Create_Services", "parent_permissions": [ "1697753000000932769" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000932767", "module": "Services__s", "name": "Crm_Implied_Edit_Services", "parent_permissions": [ "1697753000000932769" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000932771", "module": "Services__s", "name": "Crm_Implied_Delete_Services", "parent_permissions": [ "1697753000000932769" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051499", "module": "Services__s", "name": "Crm_Implied_Customize_Services", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000932803", "module": "Appointments__s", "name": "Crm_Implied_View_Appointments", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000932799", "module": "Appointments__s", "name": "Crm_Implied_Create_Appointments", "parent_permissions": [ "1697753000000932803" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000932801", "module": "Appointments__s", "name": "Crm_Implied_Edit_Appointments", "parent_permissions": [ "1697753000000932803" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000932805", "module": "Appointments__s", "name": "Crm_Implied_Delete_Appointments", "parent_permissions": [ "1697753000000932803" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051519", "module": "Appointments__s", "name": "Crm_Implied_Customize_Appointments", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016266", "module": "Vendors", "name": "Crm_Implied_View_Vendors", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016260", "module": "Vendors", "name": "Crm_Implied_Create_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016263", "module": "Vendors", "name": "Crm_Implied_Edit_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016269", "module": "Vendors", "name": "Crm_Implied_Delete_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051541", "module": "Vendors", "name": "Crm_Implied_Customize_Vendors", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000512847", "module": "CM1", "name": "Crm_Implied_View_CustomModule1", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000512849", "module": "CM1", "name": "Crm_Implied_Create_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000512851", "module": "CM1", "name": "Crm_Implied_Edit_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000512853", "module": "CM1", "name": "Crm_Implied_Delete_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051563", "module": "CM1", "name": "Crm_Implied_Customize_CustomModule1", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000002846878", "module": "Pending_Tasks", "name": "Crm_Implied_View_CustomModule2", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000002846880", "module": "Pending_Tasks", "name": "Crm_Implied_Create_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000002846882", "module": "Pending_Tasks", "name": "Crm_Implied_Edit_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000002846884", "module": "Pending_Tasks", "name": "Crm_Implied_Delete_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051607", "module": "Pending_Tasks", "name": "Crm_Implied_Customize_CustomModule2", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000004350867", "module": "Testers", "name": "Crm_Implied_View_CustomModule3", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000004350869", "module": "Testers", "name": "Crm_Implied_Create_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000004350871", "module": "Testers", "name": "Crm_Implied_Edit_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000004350873", "module": "Testers", "name": "Crm_Implied_Delete_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051629", "module": "Testers", "name": "Crm_Implied_Customize_CustomModule3", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000004360868", "module": "workers", "name": "Crm_Implied_View_CustomModule4", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000004360870", "module": "workers", "name": "Crm_Implied_Create_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000004360872", "module": "workers", "name": "Crm_Implied_Edit_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000004360874", "module": "workers", "name": "Crm_Implied_Delete_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051651", "module": "workers", "name": "Crm_Implied_Customize_CustomModule4", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000004910876", "module": "orgs", "name": "Crm_Implied_View_CustomModule6", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000004910878", "module": "orgs", "name": "Crm_Implied_Create_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000004910880", "module": "orgs", "name": "Crm_Implied_Edit_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000004910882", "module": "orgs", "name": "Crm_Implied_Delete_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051695", "module": "orgs", "name": "Crm_Implied_Customize_CustomModule6", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000019173425", "module": "Dependancy_Products", "name": "Crm_Implied_View_LinkingModule9", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000019173427", "module": "Dependancy_Products", "name": "Crm_Implied_Create_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000019173429", "module": "Dependancy_Products", "name": "Crm_Implied_Edit_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000019173431", "module": "Dependancy_Products", "name": "Crm_Implied_Delete_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000019173465", "module": "Dependancy_Products", "name": "Crm_Implied_Customize_LinkingModule9", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000019204285", "module": "Dependent_Leads", "name": "Crm_Implied_View_LinkingModule10", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000019204287", "module": "Dependent_Leads", "name": "Crm_Implied_Create_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000019204289", "module": "Dependent_Leads", "name": "Crm_Implied_Edit_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000019204291", "module": "Dependent_Leads", "name": "Crm_Implied_Delete_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000019204325", "module": "Dependent_Leads", "name": "Crm_Implied_Customize_LinkingModule10", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000020431873", "module": "skbc", "name": "Crm_Implied_View_CustomModule9", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000020431875", "module": "skbc", "name": "Crm_Implied_Create_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000020431877", "module": "skbc", "name": "Crm_Implied_Edit_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000020431879", "module": "skbc", "name": "Crm_Implied_Delete_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000020431921", "module": "skbc", "name": "Crm_Implied_Customize_CustomModule9", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000022742119", "module": "Untitled", "name": "Crm_Implied_View_CustomModule13", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000022742121", "module": "Untitled", "name": "Crm_Implied_Create_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000022742123", "module": "Untitled", "name": "Crm_Implied_Edit_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000022742125", "module": "Untitled", "name": "Crm_Implied_Delete_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000022742167", "module": "Untitled", "name": "Crm_Implied_Customize_CustomModule13", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000023593893", "module": "only_in_production", "name": "Crm_Implied_View_CustomModule10", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000023593895", "module": "only_in_production", "name": "Crm_Implied_Create_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000023593897", "module": "only_in_production", "name": "Crm_Implied_Edit_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000023593899", "module": "only_in_production", "name": "Crm_Implied_Delete_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000023593941", "module": "only_in_production", "name": "Crm_Implied_Customize_CustomModule10", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000026388915", "module": "cm34", "name": "Crm_Implied_View_CustomModule11", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000026388917", "module": "cm34", "name": "Crm_Implied_Create_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000026388919", "module": "cm34", "name": "Crm_Implied_Edit_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000026388921", "module": "cm34", "name": "Crm_Implied_Delete_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000026388965", "module": "cm34", "name": "Crm_Implied_Customize_CustomModule11", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000026414205", "module": "cm69", "name": "Crm_Implied_View_CustomModule12", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000026414207", "module": "cm69", "name": "Crm_Implied_Create_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000026414209", "module": "cm69", "name": "Crm_Implied_Edit_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000026414211", "module": "cm69", "name": "Crm_Implied_Delete_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000026414255", "module": "cm69", "name": "Crm_Implied_Customize_CustomModule12", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000016383", "module": "Tasks", "name": "Crm_Implied_View_Tasks", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000016377", "module": "Tasks", "name": "Crm_Implied_Create_Tasks", "parent_permissions": [ "1697753000000016383" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000016380", "module": "Tasks", "name": "Crm_Implied_Edit_Tasks", "parent_permissions": [ "1697753000000016383" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000016386", "module": "Tasks", "name": "Crm_Implied_Delete_Tasks", "parent_permissions": [ "1697753000000016383" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000010051149", "module": "Tasks", "name": "Crm_Implied_Customize_Tasks", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000028626001", "module": "Functions__s", "name": "Crm_Implied_View_Functions", "parent_permissions": [ "1697753000000338035" ] }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000028626003", "module": "Functions__s", "name": "Crm_Implied_Create_Functions", "parent_permissions": [ "1697753000000338035" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000028626005", "module": "Functions__s", "name": "Crm_Implied_Edit_Functions", "parent_permissions": [ "1697753000000338035" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000028626007", "module": "Functions__s", "name": "Crm_Implied_Delete_Functions", "parent_permissions": [ "1697753000000338035" ] }, { "customizable": false, "display_label": "Customize", "enabled": true, "id": "1697753000028626009", "module": "Functions__s", "name": "Crm_Implied_Customize_Functions", "parent_permissions": [ "1697753000000338035" ] }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000342074", "module": "Notes", "name": "Crm_Implied_View_Notes", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000019005", "module": "Notes", "name": "Crm_Implied_Create_Notes", "parent_permissions": [ "1697753000000342074" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000000019007", "module": "Notes", "name": "Crm_Implied_Edit_Notes", "parent_permissions": [ "1697753000000342074" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000019009", "module": "Notes", "name": "Crm_Implied_Delete_Notes", "parent_permissions": [ "1697753000000342074" ] }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000342072", "module": "Attachments", "name": "Crm_Implied_View_Attachments", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000000019001", "module": "Attachments", "name": "Crm_Implied_Create_Attachments", "parent_permissions": [ "1697753000000342072" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000000019003", "module": "Attachments", "name": "Crm_Implied_Delete_Attachments", "parent_permissions": [ "1697753000000342072" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000143001", "module": "Leads", "name": "Crm_Implied_Import_Leads", "parent_permissions": [ "1697753000000016071" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000143003", "module": "Contacts", "name": "Crm_Implied_Import_Contacts", "parent_permissions": [ "1697753000000016113" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000143005", "module": "Accounts", "name": "Crm_Implied_Import_Accounts", "parent_permissions": [ "1697753000000016092" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000143007", "module": "Deals", "name": "Crm_Implied_Import_Deals", "parent_permissions": [ "1697753000000016134" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000143011", "module": "Events", "name": "Crm_Implied_Import_Events", "parent_permissions": [ "1697753000000016362" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000013133007", "module": "Calls", "name": "Crm_Implied_Import_Calls", "parent_permissions": [ "1697753000000017057" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000143013", "module": "Products", "name": "Crm_Implied_Import_Products", "parent_permissions": [ "1697753000000016218" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000143009", "module": "Campaigns", "name": "Crm_Implied_Import_Campaigns", "parent_permissions": [ "1697753000000016155" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000143017", "module": "Price_Books", "name": "Crm_Implied_Import_PriceBooks", "parent_permissions": [ "1697753000000016239" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000143021", "module": "Cases", "name": "Crm_Implied_Import_Cases", "parent_permissions": [ "1697753000000016176" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000143019", "module": "Solutions", "name": "Crm_Implied_Import_Solutions", "parent_permissions": [ "1697753000000016197" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670070", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Import_CustomModule16", "parent_permissions": [ "1697753000029670060" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000143015", "module": "Vendors", "name": "Crm_Implied_Import_Vendors", "parent_permissions": [ "1697753000000016260" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512859", "module": "CM1", "name": "Crm_Implied_Import_CustomModule1", "parent_permissions": [ "1697753000000512849" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846890", "module": "Pending_Tasks", "name": "Crm_Implied_Import_CustomModule2", "parent_permissions": [ "1697753000002846880" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350879", "module": "Testers", "name": "Crm_Implied_Import_CustomModule3", "parent_permissions": [ "1697753000004350869" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360880", "module": "workers", "name": "Crm_Implied_Import_CustomModule4", "parent_permissions": [ "1697753000004360870" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910888", "module": "orgs", "name": "Crm_Implied_Import_CustomModule6", "parent_permissions": [ "1697753000004910878" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173437", "module": "Dependancy_Products", "name": "Crm_Implied_Import_LinkingModule9", "parent_permissions": [ "1697753000019173427" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204297", "module": "Dependent_Leads", "name": "Crm_Implied_Import_LinkingModule10", "parent_permissions": [ "1697753000019204287" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431885", "module": "skbc", "name": "Crm_Implied_Import_CustomModule9", "parent_permissions": [ "1697753000020431875" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742131", "module": "Untitled", "name": "Crm_Implied_Import_CustomModule13", "parent_permissions": [ "1697753000022742121" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593905", "module": "only_in_production", "name": "Crm_Implied_Import_CustomModule10", "parent_permissions": [ "1697753000023593895" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388927", "module": "cm34", "name": "Crm_Implied_Import_CustomModule11", "parent_permissions": [ "1697753000026388917" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414217", "module": "cm69", "name": "Crm_Implied_Import_CustomModule12", "parent_permissions": [ "1697753000026414207" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000333001", "module": "Tasks", "name": "Crm_Implied_Import_Tasks", "parent_permissions": [ "1697753000000016377" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016062", "module": "Leads", "name": "Crm_Implied_Export_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016104", "module": "Contacts", "name": "Crm_Implied_Export_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000016083", "module": "Accounts", "name": "Crm_Implied_Export_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000016125", "module": "Deals", "name": "Crm_Implied_Export_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000016359", "module": "Events", "name": "Crm_Implied_Export_Events", "parent_permissions": [ "1697753000000016368" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000000017055", "module": "Calls", "name": "Crm_Implied_Export_Calls", "parent_permissions": [ "1697753000000017061" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000016209", "module": "Products", "name": "Crm_Implied_Export_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000016272", "module": "Quotes", "name": "Crm_Implied_Export_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000016287", "module": "Sales_Orders", "name": "Crm_Implied_Export_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000016302", "module": "Purchase_Orders", "name": "Crm_Implied_Export_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000016317", "module": "Invoices", "name": "Crm_Implied_Export_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000016146", "module": "Campaigns", "name": "Crm_Implied_Export_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000016230", "module": "Price_Books", "name": "Crm_Implied_Export_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000016167", "module": "Cases", "name": "Crm_Implied_Export_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000016188", "module": "Solutions", "name": "Crm_Implied_Export_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": false, "display_label": "Forecasts", "enabled": true, "id": "1697753000000016332", "module": "Forecasts", "name": "Crm_Implied_Export_Forecasts", "parent_permissions": [ "1697753000000016341" ] }, { "customizable": false, "display_label": "Visits", "enabled": true, "id": "1697753000000111001", "module": "Visits", "name": "Crm_Implied_Export_Visits", "parent_permissions": [ "1697753000000064003" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670072", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Export_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Users", "enabled": true, "id": "1697753000000016008", "module": "users", "name": "Crm_Implied_Export_Users", "parent_permissions": null }, { "customizable": false, "display_label": "Notes", "enabled": true, "id": "1697753000000016011", "module": "Notes", "name": "Crm_Implied_Export_Notes", "parent_permissions": [ "1697753000000342074" ] }, { "customizable": false, "display_label": "Services", "enabled": true, "id": "1697753000000932757", "module": "Services__s", "name": "Crm_Implied_Export_Services", "parent_permissions": [ "1697753000000932769" ] }, { "customizable": false, "display_label": "Competitors", "enabled": true, "id": "1697753000000016014", "module": "Competitors", "name": "Crm_Implied_Export_Competitors", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Appointments", "enabled": true, "id": "1697753000000932791", "module": "Appointments__s", "name": "Crm_Implied_Export_Appointments", "parent_permissions": [ "1697753000000932803" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000016251", "module": "Vendors", "name": "Crm_Implied_Export_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512861", "module": "CM1", "name": "Crm_Implied_Export_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846892", "module": "Pending_Tasks", "name": "Crm_Implied_Export_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350881", "module": "Testers", "name": "Crm_Implied_Export_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360882", "module": "workers", "name": "Crm_Implied_Export_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910890", "module": "orgs", "name": "Crm_Implied_Export_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173439", "module": "Dependancy_Products", "name": "Crm_Implied_Export_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204299", "module": "Dependent_Leads", "name": "Crm_Implied_Export_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431887", "module": "skbc", "name": "Crm_Implied_Export_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742133", "module": "Untitled", "name": "Crm_Implied_Export_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593907", "module": "only_in_production", "name": "Crm_Implied_Export_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388929", "module": "cm34", "name": "Crm_Implied_Export_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414219", "module": "cm69", "name": "Crm_Implied_Export_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000016374", "module": "Tasks", "name": "Crm_Implied_Export_Tasks", "parent_permissions": [ "1697753000000016383" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000112001", "module": "Leads", "name": "Crm_Implied_Send_Mail_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000112003", "module": "Contacts", "name": "Crm_Implied_Send_Mail_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000008571088", "module": "Accounts", "name": "Crm_Implied_Send_Mail_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000112013", "module": "Deals", "name": "Crm_Implied_Send_Mail_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000112005", "module": "Quotes", "name": "Crm_Implied_Send_Mail_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000112007", "module": "Sales_Orders", "name": "Crm_Implied_Send_Mail_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000112011", "module": "Purchase_Orders", "name": "Crm_Implied_Send_Mail_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000112009", "module": "Invoices", "name": "Crm_Implied_Send_Mail_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000018979040", "module": "Cases", "name": "Crm_Implied_Send_Mail_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670094", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Send_Mail_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000008571089", "module": "Vendors", "name": "Crm_Implied_Send_Mail_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512883", "module": "CM1", "name": "Crm_Implied_Send_Mail_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846914", "module": "Pending_Tasks", "name": "Crm_Implied_Send_Mail_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350903", "module": "Testers", "name": "Crm_Implied_Send_Mail_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360904", "module": "workers", "name": "Crm_Implied_Send_Mail_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910912", "module": "orgs", "name": "Crm_Implied_Send_Mail_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173453", "module": "Dependancy_Products", "name": "Crm_Implied_Send_Mail_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204313", "module": "Dependent_Leads", "name": "Crm_Implied_Send_Mail_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431909", "module": "skbc", "name": "Crm_Implied_Send_Mail_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742155", "module": "Untitled", "name": "Crm_Implied_Send_Mail_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593929", "module": "only_in_production", "name": "Crm_Implied_Send_Mail_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388953", "module": "cm34", "name": "Crm_Implied_Send_Mail_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414243", "module": "cm69", "name": "Crm_Implied_Send_Mail_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016494", "module": "Leads", "name": "Crm_Implied_Mass_Email_Leads", "parent_permissions": [ "1697753000000112001" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016497", "module": "Contacts", "name": "Crm_Implied_Mass_Email_Contacts", "parent_permissions": [ "1697753000000112003" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000112015", "module": "Deals", "name": "Crm_Implied_Mass_Email_Deals", "parent_permissions": [ "1697753000000112013" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000018979042", "module": "Cases", "name": "Crm_Implied_Mass_Email_Cases", "parent_permissions": [ "1697753000018979040" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670082", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Mass_Email_CustomModule16", "parent_permissions": [ "1697753000029670094" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000008571092", "module": "Vendors", "name": "Crm_Implied_Mass_Email_Vendors", "parent_permissions": [ "1697753000008571089" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512871", "module": "CM1", "name": "Crm_Implied_Mass_Email_CustomModule1", "parent_permissions": [ "1697753000000512883" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846902", "module": "Pending_Tasks", "name": "Crm_Implied_Mass_Email_CustomModule2", "parent_permissions": [ "1697753000002846914" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350891", "module": "Testers", "name": "Crm_Implied_Mass_Email_CustomModule3", "parent_permissions": [ "1697753000004350903" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360892", "module": "workers", "name": "Crm_Implied_Mass_Email_CustomModule4", "parent_permissions": [ "1697753000004360904" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910900", "module": "orgs", "name": "Crm_Implied_Mass_Email_CustomModule6", "parent_permissions": [ "1697753000004910912" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173423", "module": "Dependancy_Products", "name": "Crm_Implied_Mass_Email_LinkingModule9", "parent_permissions": [ "1697753000019173453" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204283", "module": "Dependent_Leads", "name": "Crm_Implied_Mass_Email_LinkingModule10", "parent_permissions": [ "1697753000019204313" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431897", "module": "skbc", "name": "Crm_Implied_Mass_Email_CustomModule9", "parent_permissions": [ "1697753000020431909" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742143", "module": "Untitled", "name": "Crm_Implied_Mass_Email_CustomModule13", "parent_permissions": [ "1697753000022742155" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593917", "module": "only_in_production", "name": "Crm_Implied_Mass_Email_CustomModule10", "parent_permissions": [ "1697753000023593929" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388941", "module": "cm34", "name": "Crm_Implied_Mass_Email_CustomModule11", "parent_permissions": [ "1697753000026388953" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414231", "module": "cm69", "name": "Crm_Implied_Mass_Email_CustomModule12", "parent_permissions": [ "1697753000026414243" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000154001", "module": "Leads", "name": "Crm_Implied_MailMerge_Mail_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000154005", "module": "Contacts", "name": "Crm_Implied_MailMerge_Mail_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000154003", "module": "Accounts", "name": "Crm_Implied_MailMerge_Mail_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000154007", "module": "Deals", "name": "Crm_Implied_MailMerge_Mail_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000004259039", "module": "Quotes", "name": "Crm_Implied_MailMerge_Mail_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000004259041", "module": "Sales_Orders", "name": "Crm_Implied_MailMerge_Mail_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000004259043", "module": "Purchase_Orders", "name": "Crm_Implied_MailMerge_Mail_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000004259045", "module": "Invoices", "name": "Crm_Implied_MailMerge_Mail_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670102", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_MailMerge_Mail_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512891", "module": "CM1", "name": "Crm_Implied_MailMerge_Mail_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846922", "module": "Pending_Tasks", "name": "Crm_Implied_MailMerge_Mail_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350911", "module": "Testers", "name": "Crm_Implied_MailMerge_Mail_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360912", "module": "workers", "name": "Crm_Implied_MailMerge_Mail_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910920", "module": "orgs", "name": "Crm_Implied_MailMerge_Mail_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173457", "module": "Dependancy_Products", "name": "Crm_Implied_MailMerge_Mail_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204317", "module": "Dependent_Leads", "name": "Crm_Implied_MailMerge_Mail_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431917", "module": "skbc", "name": "Crm_Implied_MailMerge_Mail_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742163", "module": "Untitled", "name": "Crm_Implied_MailMerge_Mail_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593937", "module": "only_in_production", "name": "Crm_Implied_MailMerge_Mail_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388961", "module": "cm34", "name": "Crm_Implied_MailMerge_Mail_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414251", "module": "cm69", "name": "Crm_Implied_MailMerge_Mail_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000112017", "module": "Leads", "name": "Crm_Implied_Delete_Mail_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000112019", "module": "Contacts", "name": "Crm_Implied_Delete_Mail_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000008571093", "module": "Accounts", "name": "Crm_Implied_Delete_Mail_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000112029", "module": "Deals", "name": "Crm_Implied_Delete_Mail_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000112021", "module": "Quotes", "name": "Crm_Implied_Delete_Mail_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000112023", "module": "Sales_Orders", "name": "Crm_Implied_Delete_Mail_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000112027", "module": "Purchase_Orders", "name": "Crm_Implied_Delete_Mail_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000112025", "module": "Invoices", "name": "Crm_Implied_Delete_Mail_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000018979043", "module": "Cases", "name": "Crm_Implied_Delete_Mail_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670096", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Delete_Mail_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000008571094", "module": "Vendors", "name": "Crm_Implied_Delete_Mail_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512885", "module": "CM1", "name": "Crm_Implied_Delete_Mail_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846916", "module": "Pending_Tasks", "name": "Crm_Implied_Delete_Mail_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350905", "module": "Testers", "name": "Crm_Implied_Delete_Mail_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360906", "module": "workers", "name": "Crm_Implied_Delete_Mail_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910914", "module": "orgs", "name": "Crm_Implied_Delete_Mail_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173455", "module": "Dependancy_Products", "name": "Crm_Implied_Delete_Mail_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204315", "module": "Dependent_Leads", "name": "Crm_Implied_Delete_Mail_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431911", "module": "skbc", "name": "Crm_Implied_Delete_Mail_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742157", "module": "Untitled", "name": "Crm_Implied_Delete_Mail_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593931", "module": "only_in_production", "name": "Crm_Implied_Delete_Mail_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388955", "module": "cm34", "name": "Crm_Implied_Delete_Mail_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414245", "module": "cm69", "name": "Crm_Implied_Delete_Mail_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016449", "module": "Leads", "name": "Crm_Implied_Mass_Update_Leads", "parent_permissions": [ "1697753000000016074" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016455", "module": "Contacts", "name": "Crm_Implied_Mass_Update_Contacts", "parent_permissions": [ "1697753000000016116" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000016452", "module": "Accounts", "name": "Crm_Implied_Mass_Update_Accounts", "parent_permissions": [ "1697753000000016095" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000016458", "module": "Deals", "name": "Crm_Implied_Mass_Update_Deals", "parent_permissions": [ "1697753000000016137" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000371642", "module": "Events", "name": "Crm_Implied_Mass_Update_Events", "parent_permissions": [ "1697753000000016365" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000000371644", "module": "Calls", "name": "Crm_Implied_Mass_Update_Calls", "parent_permissions": [ "1697753000000017059" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000016470", "module": "Products", "name": "Crm_Implied_Mass_Update_Products", "parent_permissions": [ "1697753000000016221" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000016479", "module": "Quotes", "name": "Crm_Implied_Mass_Update_Quotes", "parent_permissions": [ "1697753000000016278" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000016482", "module": "Sales_Orders", "name": "Crm_Implied_Mass_Update_SalesOrders", "parent_permissions": [ "1697753000000016293" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000016485", "module": "Purchase_Orders", "name": "Crm_Implied_Mass_Update_PurchaseOrders", "parent_permissions": [ "1697753000000016308" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000016488", "module": "Invoices", "name": "Crm_Implied_Mass_Update_Invoices", "parent_permissions": [ "1697753000000016323" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000016461", "module": "Campaigns", "name": "Crm_Implied_Mass_Update_Campaigns", "parent_permissions": [ "1697753000000016158" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000016473", "module": "Price_Books", "name": "Crm_Implied_Mass_Update_PriceBooks", "parent_permissions": [ "1697753000000016242" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000016464", "module": "Cases", "name": "Crm_Implied_Mass_Update_Cases", "parent_permissions": [ "1697753000000016179" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000016467", "module": "Solutions", "name": "Crm_Implied_Mass_Update_Solutions", "parent_permissions": [ "1697753000000016200" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670076", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Mass_Update_CustomModule16", "parent_permissions": [ "1697753000029670062" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000016476", "module": "Vendors", "name": "Crm_Implied_Mass_Update_Vendors", "parent_permissions": [ "1697753000000016263" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512865", "module": "CM1", "name": "Crm_Implied_Mass_Update_CustomModule1", "parent_permissions": [ "1697753000000512851" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846896", "module": "Pending_Tasks", "name": "Crm_Implied_Mass_Update_CustomModule2", "parent_permissions": [ "1697753000002846882" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350885", "module": "Testers", "name": "Crm_Implied_Mass_Update_CustomModule3", "parent_permissions": [ "1697753000004350871" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360886", "module": "workers", "name": "Crm_Implied_Mass_Update_CustomModule4", "parent_permissions": [ "1697753000004360872" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910894", "module": "orgs", "name": "Crm_Implied_Mass_Update_CustomModule6", "parent_permissions": [ "1697753000004910880" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173443", "module": "Dependancy_Products", "name": "Crm_Implied_Mass_Update_LinkingModule9", "parent_permissions": [ "1697753000019173429" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204303", "module": "Dependent_Leads", "name": "Crm_Implied_Mass_Update_LinkingModule10", "parent_permissions": [ "1697753000019204289" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431891", "module": "skbc", "name": "Crm_Implied_Mass_Update_CustomModule9", "parent_permissions": [ "1697753000020431877" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742137", "module": "Untitled", "name": "Crm_Implied_Mass_Update_CustomModule13", "parent_permissions": [ "1697753000022742123" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593911", "module": "only_in_production", "name": "Crm_Implied_Mass_Update_CustomModule10", "parent_permissions": [ "1697753000023593897" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388933", "module": "cm34", "name": "Crm_Implied_Mass_Update_CustomModule11", "parent_permissions": [ "1697753000026388919" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414223", "module": "cm69", "name": "Crm_Implied_Mass_Update_CustomModule12", "parent_permissions": [ "1697753000026414209" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000371640", "module": "Tasks", "name": "Crm_Implied_Mass_Update_Tasks", "parent_permissions": [ "1697753000000016380" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016419", "module": "Leads", "name": "Crm_Implied_Mass_Delete_Leads", "parent_permissions": [ "1697753000000016080" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016425", "module": "Contacts", "name": "Crm_Implied_Mass_Delete_Contacts", "parent_permissions": [ "1697753000000016122" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000016422", "module": "Accounts", "name": "Crm_Implied_Mass_Delete_Accounts", "parent_permissions": [ "1697753000000016101" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000016428", "module": "Deals", "name": "Crm_Implied_Mass_Delete_Deals", "parent_permissions": [ "1697753000000016143" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000371660", "module": "Events", "name": "Crm_Implied_Mass_Delete_Events", "parent_permissions": [ "1697753000000016371" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000000371662", "module": "Calls", "name": "Crm_Implied_Mass_Delete_Calls", "parent_permissions": [ "1697753000000017063" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000016440", "module": "Products", "name": "Crm_Implied_Mass_Delete_Products", "parent_permissions": [ "1697753000000016227" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000350009", "module": "Quotes", "name": "Crm_Implied_Mass_Delete_Quotes", "parent_permissions": [ "1697753000000016284" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000350011", "module": "Sales_Orders", "name": "Crm_Implied_Mass_Delete_SalesOrders", "parent_permissions": [ "1697753000000016299" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000350013", "module": "Purchase_Orders", "name": "Crm_Implied_Mass_Delete_PurchaseOrders", "parent_permissions": [ "1697753000000016314" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000350015", "module": "Invoices", "name": "Crm_Implied_Mass_Delete_Invoices", "parent_permissions": [ "1697753000000016329" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000016431", "module": "Campaigns", "name": "Crm_Implied_Mass_Delete_Campaigns", "parent_permissions": [ "1697753000000016164" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000016443", "module": "Price_Books", "name": "Crm_Implied_Mass_Delete_PriceBooks", "parent_permissions": [ "1697753000000016248" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000016434", "module": "Cases", "name": "Crm_Implied_Mass_Delete_Cases", "parent_permissions": [ "1697753000000016185" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000016437", "module": "Solutions", "name": "Crm_Implied_Mass_Delete_Solutions", "parent_permissions": [ "1697753000000016206" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670078", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Mass_Delete_CustomModule16", "parent_permissions": [ "1697753000029670064" ] }, { "customizable": false, "display_label": "Services", "enabled": true, "id": "1697753000000932773", "module": "Services__s", "name": "Crm_Implied_Mass_Delete_Services", "parent_permissions": [ "1697753000000932771" ] }, { "customizable": false, "display_label": "Appointments", "enabled": true, "id": "1697753000000932807", "module": "Appointments__s", "name": "Crm_Implied_Mass_Delete_Appointments", "parent_permissions": [ "1697753000000932805" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000016446", "module": "Vendors", "name": "Crm_Implied_Mass_Delete_Vendors", "parent_permissions": [ "1697753000000016269" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512867", "module": "CM1", "name": "Crm_Implied_Mass_Delete_CustomModule1", "parent_permissions": [ "1697753000000512853" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846898", "module": "Pending_Tasks", "name": "Crm_Implied_Mass_Delete_CustomModule2", "parent_permissions": [ "1697753000002846884" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350887", "module": "Testers", "name": "Crm_Implied_Mass_Delete_CustomModule3", "parent_permissions": [ "1697753000004350873" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360888", "module": "workers", "name": "Crm_Implied_Mass_Delete_CustomModule4", "parent_permissions": [ "1697753000004360874" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910896", "module": "orgs", "name": "Crm_Implied_Mass_Delete_CustomModule6", "parent_permissions": [ "1697753000004910882" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173445", "module": "Dependancy_Products", "name": "Crm_Implied_Mass_Delete_LinkingModule9", "parent_permissions": [ "1697753000019173431" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204305", "module": "Dependent_Leads", "name": "Crm_Implied_Mass_Delete_LinkingModule10", "parent_permissions": [ "1697753000019204291" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431893", "module": "skbc", "name": "Crm_Implied_Mass_Delete_CustomModule9", "parent_permissions": [ "1697753000020431879" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742139", "module": "Untitled", "name": "Crm_Implied_Mass_Delete_CustomModule13", "parent_permissions": [ "1697753000022742125" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593913", "module": "only_in_production", "name": "Crm_Implied_Mass_Delete_CustomModule10", "parent_permissions": [ "1697753000023593899" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388935", "module": "cm34", "name": "Crm_Implied_Mass_Delete_CustomModule11", "parent_permissions": [ "1697753000026388921" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414225", "module": "cm69", "name": "Crm_Implied_Mass_Delete_CustomModule12", "parent_permissions": [ "1697753000026414211" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000371658", "module": "Tasks", "name": "Crm_Implied_Mass_Delete_Tasks", "parent_permissions": [ "1697753000000016386" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000112089", "module": "Leads", "name": "Crm_Implied_Change_Owner_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000112091", "module": "Contacts", "name": "Crm_Implied_Change_Owner_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000112093", "module": "Accounts", "name": "Crm_Implied_Change_Owner_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000112095", "module": "Deals", "name": "Crm_Implied_Change_Owner_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000211003", "module": "Events", "name": "Crm_Implied_Change_Owner_Events", "parent_permissions": [ "1697753000000016368" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000000211005", "module": "Calls", "name": "Crm_Implied_Change_Owner_Calls", "parent_permissions": [ "1697753000000017061" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000112107", "module": "Products", "name": "Crm_Implied_Change_Owner_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000112101", "module": "Quotes", "name": "Crm_Implied_Change_Owner_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000112103", "module": "Sales_Orders", "name": "Crm_Implied_Change_Owner_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000112113", "module": "Purchase_Orders", "name": "Crm_Implied_Change_Owner_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000112105", "module": "Invoices", "name": "Crm_Implied_Change_Owner_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000112097", "module": "Campaigns", "name": "Crm_Implied_Change_Owner_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000112111", "module": "Price_Books", "name": "Crm_Implied_Change_Owner_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000112117", "module": "Cases", "name": "Crm_Implied_Change_Owner_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000112115", "module": "Solutions", "name": "Crm_Implied_Change_Owner_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670092", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Change_Owner_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Services", "enabled": true, "id": "1697753000000932755", "module": "Services__s", "name": "Crm_Implied_Change_Owner_Services", "parent_permissions": [ "1697753000000932769" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000112109", "module": "Vendors", "name": "Crm_Implied_Change_Owner_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512881", "module": "CM1", "name": "Crm_Implied_Change_Owner_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846912", "module": "Pending_Tasks", "name": "Crm_Implied_Change_Owner_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350901", "module": "Testers", "name": "Crm_Implied_Change_Owner_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360902", "module": "workers", "name": "Crm_Implied_Change_Owner_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910910", "module": "orgs", "name": "Crm_Implied_Change_Owner_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173459", "module": "Dependancy_Products", "name": "Crm_Implied_Change_Owner_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204319", "module": "Dependent_Leads", "name": "Crm_Implied_Change_Owner_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431907", "module": "skbc", "name": "Crm_Implied_Change_Owner_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742153", "module": "Untitled", "name": "Crm_Implied_Change_Owner_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593927", "module": "only_in_production", "name": "Crm_Implied_Change_Owner_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388951", "module": "cm34", "name": "Crm_Implied_Change_Owner_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414241", "module": "cm69", "name": "Crm_Implied_Change_Owner_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000211001", "module": "Tasks", "name": "Crm_Implied_Change_Owner_Tasks", "parent_permissions": [ "1697753000000016383" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016389", "module": "Leads", "name": "Crm_Implied_Mass_Transfer_Leads", "parent_permissions": [ "1697753000000112089" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016395", "module": "Contacts", "name": "Crm_Implied_Mass_Transfer_Contacts", "parent_permissions": [ "1697753000000112091" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000016392", "module": "Accounts", "name": "Crm_Implied_Mass_Transfer_Accounts", "parent_permissions": [ "1697753000000112093" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000016398", "module": "Deals", "name": "Crm_Implied_Mass_Transfer_Deals", "parent_permissions": [ "1697753000000112095" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000371654", "module": "Events", "name": "Crm_Implied_Mass_Transfer_Events", "parent_permissions": [ "1697753000000211003" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000000371656", "module": "Calls", "name": "Crm_Implied_Mass_Transfer_Calls", "parent_permissions": [ "1697753000000211005" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000016410", "module": "Products", "name": "Crm_Implied_Mass_Transfer_Products", "parent_permissions": [ "1697753000000112107" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000350001", "module": "Quotes", "name": "Crm_Implied_Mass_Transfer_Quotes", "parent_permissions": [ "1697753000000112101" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000350003", "module": "Sales_Orders", "name": "Crm_Implied_Mass_Transfer_SalesOrders", "parent_permissions": [ "1697753000000112103" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000350005", "module": "Purchase_Orders", "name": "Crm_Implied_Mass_Transfer_PurchaseOrders", "parent_permissions": [ "1697753000000112113" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000350007", "module": "Invoices", "name": "Crm_Implied_Mass_Transfer_Invoices", "parent_permissions": [ "1697753000000112105" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000016401", "module": "Campaigns", "name": "Crm_Implied_Mass_Transfer_Campaigns", "parent_permissions": [ "1697753000000112097" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000016413", "module": "Price_Books", "name": "Crm_Implied_Mass_Transfer_PriceBooks", "parent_permissions": [ "1697753000000112111" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000016404", "module": "Cases", "name": "Crm_Implied_Mass_Transfer_Cases", "parent_permissions": [ "1697753000000112117" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000016407", "module": "Solutions", "name": "Crm_Implied_Mass_Transfer_Solutions", "parent_permissions": [ "1697753000000112115" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670074", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Mass_Transfer_CustomModule16", "parent_permissions": [ "1697753000029670092" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000016416", "module": "Vendors", "name": "Crm_Implied_Mass_Transfer_Vendors", "parent_permissions": [ "1697753000000112109" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512863", "module": "CM1", "name": "Crm_Implied_Mass_Transfer_CustomModule1", "parent_permissions": [ "1697753000000512881" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846894", "module": "Pending_Tasks", "name": "Crm_Implied_Mass_Transfer_CustomModule2", "parent_permissions": [ "1697753000002846912" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350883", "module": "Testers", "name": "Crm_Implied_Mass_Transfer_CustomModule3", "parent_permissions": [ "1697753000004350901" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360884", "module": "workers", "name": "Crm_Implied_Mass_Transfer_CustomModule4", "parent_permissions": [ "1697753000004360902" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910892", "module": "orgs", "name": "Crm_Implied_Mass_Transfer_CustomModule6", "parent_permissions": [ "1697753000004910910" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173441", "module": "Dependancy_Products", "name": "Crm_Implied_Mass_Transfer_LinkingModule9", "parent_permissions": [ "1697753000019173459" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204301", "module": "Dependent_Leads", "name": "Crm_Implied_Mass_Transfer_LinkingModule10", "parent_permissions": [ "1697753000019204319" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431889", "module": "skbc", "name": "Crm_Implied_Mass_Transfer_CustomModule9", "parent_permissions": [ "1697753000020431907" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742135", "module": "Untitled", "name": "Crm_Implied_Mass_Transfer_CustomModule13", "parent_permissions": [ "1697753000022742153" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593909", "module": "only_in_production", "name": "Crm_Implied_Mass_Transfer_CustomModule10", "parent_permissions": [ "1697753000023593927" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388931", "module": "cm34", "name": "Crm_Implied_Mass_Transfer_CustomModule11", "parent_permissions": [ "1697753000026388951" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414221", "module": "cm69", "name": "Crm_Implied_Mass_Transfer_CustomModule12", "parent_permissions": [ "1697753000026414241" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000371652", "module": "Tasks", "name": "Crm_Implied_Mass_Transfer_Tasks", "parent_permissions": [ "1697753000000211001" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016500", "module": "Leads", "name": "Crm_Implied_Convert_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000112081", "module": "Quotes", "name": "Crm_Implied_Convert_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000112083", "module": "Sales_Orders", "name": "Crm_Implied_Convert_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000087001", "module": "Leads", "name": "Crm_Implied_Mass_Convert_Leads", "parent_permissions": [ "1697753000000016500" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000112085", "module": "Quotes", "name": "Crm_Implied_Mass_Convert_Quotes", "parent_permissions": [ "1697753000000112081" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000112087", "module": "Sales_Orders", "name": "Crm_Implied_Mass_Convert_SalesOrders", "parent_permissions": [ "1697753000000112083" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000162001", "module": "Leads", "name": "Crm_Implied_Share_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000113003", "module": "Contacts", "name": "Crm_Implied_Share_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000113001", "module": "Accounts", "name": "Crm_Implied_Share_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000113005", "module": "Deals", "name": "Crm_Implied_Share_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000162011", "module": "Products", "name": "Crm_Implied_Share_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000162017", "module": "Quotes", "name": "Crm_Implied_Share_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000162019", "module": "Sales_Orders", "name": "Crm_Implied_Share_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000162021", "module": "Purchase_Orders", "name": "Crm_Implied_Share_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000162023", "module": "Invoices", "name": "Crm_Implied_Share_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000162003", "module": "Campaigns", "name": "Crm_Implied_Share_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000162015", "module": "Price_Books", "name": "Crm_Implied_Share_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000162007", "module": "Cases", "name": "Crm_Implied_Share_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000162009", "module": "Solutions", "name": "Crm_Implied_Share_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670104", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Share_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000162013", "module": "Vendors", "name": "Crm_Implied_Share_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512893", "module": "CM1", "name": "Crm_Implied_Share_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846924", "module": "Pending_Tasks", "name": "Crm_Implied_Share_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350913", "module": "Testers", "name": "Crm_Implied_Share_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360914", "module": "workers", "name": "Crm_Implied_Share_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910922", "module": "orgs", "name": "Crm_Implied_Share_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431919", "module": "skbc", "name": "Crm_Implied_Share_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742165", "module": "Untitled", "name": "Crm_Implied_Share_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593939", "module": "only_in_production", "name": "Crm_Implied_Share_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388963", "module": "cm34", "name": "Crm_Implied_Share_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414253", "module": "cm69", "name": "Crm_Implied_Share_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000001872059", "module": "Leads", "name": "Crm_Implied_Lock_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000001872051", "module": "Contacts", "name": "Crm_Implied_Lock_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000001872055", "module": "Accounts", "name": "Crm_Implied_Lock_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000001872049", "module": "Deals", "name": "Crm_Implied_Lock_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000007918061", "module": "Products", "name": "Crm_Implied_Lock_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000001872043", "module": "Quotes", "name": "Crm_Implied_Lock_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000001872041", "module": "Sales_Orders", "name": "Crm_Implied_Lock_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000001872039", "module": "Purchase_Orders", "name": "Crm_Implied_Lock_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000001872037", "module": "Invoices", "name": "Crm_Implied_Lock_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000001872045", "module": "Price_Books", "name": "Crm_Implied_Lock_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000001872057", "module": "Cases", "name": "Crm_Implied_Lock_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000001872053", "module": "Solutions", "name": "Crm_Implied_Lock_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670350", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Lock_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000001872047", "module": "Vendors", "name": "Crm_Implied_Lock_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000001872061", "module": "CM1", "name": "Crm_Implied_Lock_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002855062", "module": "Pending_Tasks", "name": "Crm_Implied_Lock_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004351051", "module": "Testers", "name": "Crm_Implied_Lock_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004363052", "module": "workers", "name": "Crm_Implied_Lock_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004911066", "module": "orgs", "name": "Crm_Implied_Lock_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020433097", "module": "skbc", "name": "Crm_Implied_Lock_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742341", "module": "Untitled", "name": "Crm_Implied_Lock_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023623115", "module": "only_in_production", "name": "Crm_Implied_Lock_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026413151", "module": "cm34", "name": "Crm_Implied_Lock_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414441", "module": "cm69", "name": "Crm_Implied_Lock_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000112051", "module": "Leads", "name": "Crm_Implied_Print_View_Leads", "parent_permissions": [ "1697753000000016077" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000112053", "module": "Contacts", "name": "Crm_Implied_Print_View_Contacts", "parent_permissions": [ "1697753000000016119" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000112055", "module": "Accounts", "name": "Crm_Implied_Print_View_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000112057", "module": "Deals", "name": "Crm_Implied_Print_View_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000371648", "module": "Events", "name": "Crm_Implied_Print_View_Events", "parent_permissions": [ "1697753000000016368" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000000371650", "module": "Calls", "name": "Crm_Implied_Print_View_Calls", "parent_permissions": [ "1697753000000017061" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000112069", "module": "Products", "name": "Crm_Implied_Print_View_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000112063", "module": "Quotes", "name": "Crm_Implied_Print_View_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000112065", "module": "Sales_Orders", "name": "Crm_Implied_Print_View_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000112075", "module": "Purchase_Orders", "name": "Crm_Implied_Print_View_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000112067", "module": "Invoices", "name": "Crm_Implied_Print_View_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000112059", "module": "Campaigns", "name": "Crm_Implied_Print_View_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000112073", "module": "Price_Books", "name": "Crm_Implied_Print_View_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000112079", "module": "Cases", "name": "Crm_Implied_Print_View_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000112077", "module": "Solutions", "name": "Crm_Implied_Print_View_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": false, "display_label": "Visits", "enabled": true, "id": "1697753000000114001", "module": "Visits", "name": "Crm_Implied_Print_View_Visits", "parent_permissions": [ "1697753000000064003" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670098", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Print_View_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Services", "enabled": true, "id": "1697753000000932779", "module": "Services__s", "name": "Crm_Implied_Print_View_Services", "parent_permissions": [ "1697753000000932769" ] }, { "customizable": false, "display_label": "Appointments", "enabled": true, "id": "1697753000000932813", "module": "Appointments__s", "name": "Crm_Implied_Print_View_Appointments", "parent_permissions": [ "1697753000000932803" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000112071", "module": "Vendors", "name": "Crm_Implied_Print_View_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512887", "module": "CM1", "name": "Crm_Implied_Print_View_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846918", "module": "Pending_Tasks", "name": "Crm_Implied_Print_View_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350907", "module": "Testers", "name": "Crm_Implied_Print_View_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360908", "module": "workers", "name": "Crm_Implied_Print_View_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910916", "module": "orgs", "name": "Crm_Implied_Print_View_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173461", "module": "Dependancy_Products", "name": "Crm_Implied_Print_View_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204321", "module": "Dependent_Leads", "name": "Crm_Implied_Print_View_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431913", "module": "skbc", "name": "Crm_Implied_Print_View_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742159", "module": "Untitled", "name": "Crm_Implied_Print_View_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593933", "module": "only_in_production", "name": "Crm_Implied_Print_View_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388957", "module": "cm34", "name": "Crm_Implied_Print_View_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414247", "module": "cm69", "name": "Crm_Implied_Print_View_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000371646", "module": "Tasks", "name": "Crm_Implied_Print_View_Tasks", "parent_permissions": [ "1697753000000016383" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000112031", "module": "Leads", "name": "Crm_Implied_ZohoSheet_View_Leads", "parent_permissions": [ "1697753000000016071", "1697753000000016074" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000112033", "module": "Contacts", "name": "Crm_Implied_ZohoSheet_View_Contacts", "parent_permissions": [ "1697753000000016113", "1697753000000016116" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000112035", "module": "Accounts", "name": "Crm_Implied_ZohoSheet_View_Accounts", "parent_permissions": [ "1697753000000016092", "1697753000000016095" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000112037", "module": "Deals", "name": "Crm_Implied_ZohoSheet_View_Deals", "parent_permissions": [ "1697753000000016134", "1697753000000016137" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000112047", "module": "Products", "name": "Crm_Implied_ZohoSheet_View_Products", "parent_permissions": [ "1697753000000016218", "1697753000000016221" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000112039", "module": "Campaigns", "name": "Crm_Implied_ZohoSheet_View_Campaigns", "parent_permissions": [ "1697753000000016155", "1697753000000016158" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000112049", "module": "Price_Books", "name": "Crm_Implied_ZohoSheet_View_PriceBooks", "parent_permissions": [ "1697753000000016239", "1697753000000016242" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000112045", "module": "Cases", "name": "Crm_Implied_ZohoSheet_View_Cases", "parent_permissions": [ "1697753000000016176", "1697753000000016179" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000112043", "module": "Solutions", "name": "Crm_Implied_ZohoSheet_View_Solutions", "parent_permissions": [ "1697753000000016197", "1697753000000016200" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670100", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_ZohoSheet_View_CustomModule16", "parent_permissions": [ "1697753000029670060", "1697753000029670062" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000112041", "module": "Vendors", "name": "Crm_Implied_ZohoSheet_View_Vendors", "parent_permissions": [ "1697753000000016260", "1697753000000016263" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512889", "module": "CM1", "name": "Crm_Implied_ZohoSheet_View_CustomModule1", "parent_permissions": [ "1697753000000512849", "1697753000000512851" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846920", "module": "Pending_Tasks", "name": "Crm_Implied_ZohoSheet_View_CustomModule2", "parent_permissions": [ "1697753000002846880", "1697753000002846882" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350909", "module": "Testers", "name": "Crm_Implied_ZohoSheet_View_CustomModule3", "parent_permissions": [ "1697753000004350869", "1697753000004350871" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360910", "module": "workers", "name": "Crm_Implied_ZohoSheet_View_CustomModule4", "parent_permissions": [ "1697753000004360870", "1697753000004360872" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910918", "module": "orgs", "name": "Crm_Implied_ZohoSheet_View_CustomModule6", "parent_permissions": [ "1697753000004910878", "1697753000004910880" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173463", "module": "Dependancy_Products", "name": "Crm_Implied_ZohoSheet_View_LinkingModule9", "parent_permissions": [ "1697753000019173427", "1697753000019173429" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204323", "module": "Dependent_Leads", "name": "Crm_Implied_ZohoSheet_View_LinkingModule10", "parent_permissions": [ "1697753000019204287", "1697753000019204289" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431915", "module": "skbc", "name": "Crm_Implied_ZohoSheet_View_CustomModule9", "parent_permissions": [ "1697753000020431875", "1697753000020431877" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742161", "module": "Untitled", "name": "Crm_Implied_ZohoSheet_View_CustomModule13", "parent_permissions": [ "1697753000022742121", "1697753000022742123" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593935", "module": "only_in_production", "name": "Crm_Implied_ZohoSheet_View_CustomModule10", "parent_permissions": [ "1697753000023593895", "1697753000023593897" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388959", "module": "cm34", "name": "Crm_Implied_ZohoSheet_View_CustomModule11", "parent_permissions": [ "1697753000026388917", "1697753000026388919" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414249", "module": "cm69", "name": "Crm_Implied_ZohoSheet_View_CustomModule12", "parent_permissions": [ "1697753000026414207", "1697753000026414209" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000135023", "module": "Leads", "name": "Crm_Implied_Tags_Leads", "parent_permissions": [ "1697753000000016074" ] }, { "customizable": false, "display_label": "Contacts", "enabled": false, "id": "1697753000000135015", "module": "Contacts", "name": "Crm_Implied_Tags_Contacts", "parent_permissions": [ "1697753000000016116" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000135025", "module": "Accounts", "name": "Crm_Implied_Tags_Accounts", "parent_permissions": [ "1697753000000016095" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000135019", "module": "Deals", "name": "Crm_Implied_Tags_Deals", "parent_permissions": [ "1697753000000016137" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000000211009", "module": "Events", "name": "Crm_Implied_Tags_Events", "parent_permissions": [ "1697753000000016365" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000000211011", "module": "Calls", "name": "Crm_Implied_Tags_Calls", "parent_permissions": [ "1697753000000017059" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000000135021", "module": "Products", "name": "Crm_Implied_Tags_Products", "parent_permissions": [ "1697753000000016221" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000000135005", "module": "Quotes", "name": "Crm_Implied_Tags_Quotes", "parent_permissions": [ "1697753000000016278" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000000135007", "module": "Sales_Orders", "name": "Crm_Implied_Tags_SalesOrders", "parent_permissions": [ "1697753000000016293" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000000135001", "module": "Purchase_Orders", "name": "Crm_Implied_Tags_PurchaseOrders", "parent_permissions": [ "1697753000000016308" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000000135003", "module": "Invoices", "name": "Crm_Implied_Tags_Invoices", "parent_permissions": [ "1697753000000016323" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000000135009", "module": "Campaigns", "name": "Crm_Implied_Tags_Campaigns", "parent_permissions": [ "1697753000000016158" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000000135013", "module": "Price_Books", "name": "Crm_Implied_Tags_PriceBooks", "parent_permissions": [ "1697753000000016242" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000135027", "module": "Cases", "name": "Crm_Implied_Tags_Cases", "parent_permissions": [ "1697753000000016179" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000000135017", "module": "Solutions", "name": "Crm_Implied_Tags_Solutions", "parent_permissions": [ "1697753000000016200" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670080", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Tags_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Services", "enabled": true, "id": "1697753000000932775", "module": "Services__s", "name": "Crm_Implied_Tags_Services", "parent_permissions": [ "1697753000000932767" ] }, { "customizable": false, "display_label": "Appointments", "enabled": true, "id": "1697753000000932809", "module": "Appointments__s", "name": "Crm_Implied_Tags_Appointments", "parent_permissions": [ "1697753000000932801" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000135011", "module": "Vendors", "name": "Crm_Implied_Tags_Vendors", "parent_permissions": [ "1697753000000016263" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512869", "module": "CM1", "name": "Crm_Implied_Tags_CustomModule1", "parent_permissions": [ "1697753000000512851" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846900", "module": "Pending_Tasks", "name": "Crm_Implied_Tags_CustomModule2", "parent_permissions": [ "1697753000002846882" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350889", "module": "Testers", "name": "Crm_Implied_Tags_CustomModule3", "parent_permissions": [ "1697753000004350871" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360890", "module": "workers", "name": "Crm_Implied_Tags_CustomModule4", "parent_permissions": [ "1697753000004360872" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910898", "module": "orgs", "name": "Crm_Implied_Tags_CustomModule6", "parent_permissions": [ "1697753000004910880" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431895", "module": "skbc", "name": "Crm_Implied_Tags_CustomModule9", "parent_permissions": [ "1697753000020431877" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742141", "module": "Untitled", "name": "Crm_Implied_Tags_CustomModule13", "parent_permissions": [ "1697753000022742123" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593915", "module": "only_in_production", "name": "Crm_Implied_Tags_CustomModule10", "parent_permissions": [ "1697753000023593897" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388937", "module": "cm34", "name": "Crm_Implied_Tags_CustomModule11", "parent_permissions": [ "1697753000026388919" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414227", "module": "cm69", "name": "Crm_Implied_Tags_CustomModule12", "parent_permissions": [ "1697753000026414209" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000211007", "module": "Tasks", "name": "Crm_Implied_Tags_Tasks", "parent_permissions": [ "1697753000000016380" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000030040177", "module": "Leads", "name": "Crm_Implied_AccessTimeline_Leads", "parent_permissions": [ "1697753000000016077" ], "tooltip_msg": "Includes both Timeline and Interactions." }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000030040181", "module": "Contacts", "name": "Crm_Implied_AccessTimeline_Contacts", "parent_permissions": [ "1697753000000016119" ], "tooltip_msg": "Includes both Timeline and Interactions." }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000030040179", "module": "Accounts", "name": "Crm_Implied_AccessTimeline_Accounts", "parent_permissions": [ "1697753000000016098" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000030040183", "module": "Deals", "name": "Crm_Implied_AccessTimeline_Deals", "parent_permissions": [ "1697753000000016140" ] }, { "customizable": false, "display_label": "Meetings", "enabled": true, "id": "1697753000030040189", "module": "Events", "name": "Crm_Implied_AccessTimeline_Events", "parent_permissions": [ "1697753000000016368" ] }, { "customizable": false, "display_label": "Calls", "enabled": true, "id": "1697753000030040209", "module": "Calls", "name": "Crm_Implied_AccessTimeline_Calls", "parent_permissions": [ "1697753000000017061" ] }, { "customizable": false, "display_label": "Products", "enabled": true, "id": "1697753000030040195", "module": "Products", "name": "Crm_Implied_AccessTimeline_Products", "parent_permissions": [ "1697753000000016224" ] }, { "customizable": false, "display_label": "Quotes", "enabled": true, "id": "1697753000030040201", "module": "Quotes", "name": "Crm_Implied_AccessTimeline_Quotes", "parent_permissions": [ "1697753000000016281" ] }, { "customizable": false, "display_label": "Sales Orders", "enabled": true, "id": "1697753000030040203", "module": "Sales_Orders", "name": "Crm_Implied_AccessTimeline_SalesOrders", "parent_permissions": [ "1697753000000016296" ] }, { "customizable": false, "display_label": "Purchase Orders", "enabled": true, "id": "1697753000030040205", "module": "Purchase_Orders", "name": "Crm_Implied_AccessTimeline_PurchaseOrders", "parent_permissions": [ "1697753000000016311" ] }, { "customizable": false, "display_label": "Invoices", "enabled": true, "id": "1697753000030040207", "module": "Invoices", "name": "Crm_Implied_AccessTimeline_Invoices", "parent_permissions": [ "1697753000000016326" ] }, { "customizable": false, "display_label": "Campaigns", "enabled": true, "id": "1697753000030040185", "module": "Campaigns", "name": "Crm_Implied_AccessTimeline_Campaigns", "parent_permissions": [ "1697753000000016161" ] }, { "customizable": false, "display_label": "Price Books", "enabled": true, "id": "1697753000030040199", "module": "Price_Books", "name": "Crm_Implied_AccessTimeline_PriceBooks", "parent_permissions": [ "1697753000000016245" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000030040191", "module": "Cases", "name": "Crm_Implied_AccessTimeline_Cases", "parent_permissions": [ "1697753000000016182" ] }, { "customizable": false, "display_label": "Solutions", "enabled": true, "id": "1697753000030040193", "module": "Solutions", "name": "Crm_Implied_AccessTimeline_Solutions", "parent_permissions": [ "1697753000000016203" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000030040149", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_AccessTimeline_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Services", "enabled": true, "id": "1697753000030040211", "module": "Services__s", "name": "Crm_Implied_AccessTimeline_Services", "parent_permissions": [ "1697753000000932769" ] }, { "customizable": false, "display_label": "Appointments", "enabled": true, "id": "1697753000030040213", "module": "Appointments__s", "name": "Crm_Implied_AccessTimeline_Appointments", "parent_permissions": [ "1697753000000932803" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000030040197", "module": "Vendors", "name": "Crm_Implied_AccessTimeline_Vendors", "parent_permissions": [ "1697753000000016266" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000030040151", "module": "CM1", "name": "Crm_Implied_AccessTimeline_CustomModule1", "parent_permissions": [ "1697753000000512847" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000030040153", "module": "Pending_Tasks", "name": "Crm_Implied_AccessTimeline_CustomModule2", "parent_permissions": [ "1697753000002846878" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000030040155", "module": "Testers", "name": "Crm_Implied_AccessTimeline_CustomModule3", "parent_permissions": [ "1697753000004350867" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000030040157", "module": "workers", "name": "Crm_Implied_AccessTimeline_CustomModule4", "parent_permissions": [ "1697753000004360868" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000030040161", "module": "orgs", "name": "Crm_Implied_AccessTimeline_CustomModule6", "parent_permissions": [ "1697753000004910876" ] }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000030040173", "module": "Dependancy_Products", "name": "Crm_Implied_AccessTimeline_LinkingModule9", "parent_permissions": [ "1697753000019173425" ] }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000030040175", "module": "Dependent_Leads", "name": "Crm_Implied_AccessTimeline_LinkingModule10", "parent_permissions": [ "1697753000019204285" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000030040167", "module": "skbc", "name": "Crm_Implied_AccessTimeline_CustomModule9", "parent_permissions": [ "1697753000020431873" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000030040169", "module": "Untitled", "name": "Crm_Implied_AccessTimeline_CustomModule13", "parent_permissions": [ "1697753000022742119" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000030040171", "module": "only_in_production", "name": "Crm_Implied_AccessTimeline_CustomModule10", "parent_permissions": [ "1697753000023593893" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388989", "module": "cm34", "name": "Crm_Implied_AccessTimeline_CustomModule11", "parent_permissions": [ "1697753000026388915" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414279", "module": "cm69", "name": "Crm_Implied_AccessTimeline_CustomModule12", "parent_permissions": [ "1697753000026414205" ] }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000030040187", "module": "Tasks", "name": "Crm_Implied_AccessTimeline_Tasks", "parent_permissions": [ "1697753000000016383" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016506", "module": "Leads", "name": "Crm_Implied_Merge_Leads", "parent_permissions": [ "1697753000000016074" ] }, { "customizable": false, "display_label": "Contacts", "enabled": false, "id": "1697753000000016512", "module": "Contacts", "name": "Crm_Implied_Merge_Contacts", "parent_permissions": [ "1697753000000016116" ] }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000016509", "module": "Accounts", "name": "Crm_Implied_Merge_Accounts", "parent_permissions": [ "1697753000000016095" ] }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000002346036", "module": "Deals", "name": "Crm_Implied_Merge_Deals", "parent_permissions": [ "1697753000000016137" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670128", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Merge_CustomModule16", "parent_permissions": [ "1697753000029670058" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000000016515", "module": "Vendors", "name": "Crm_Implied_Merge_Vendors", "parent_permissions": [ "1697753000000016263" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000002346012", "module": "CM1", "name": "Crm_Implied_Merge_CustomModule1", "parent_permissions": [ "1697753000000512851" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846926", "module": "Pending_Tasks", "name": "Crm_Implied_Merge_CustomModule2", "parent_permissions": [ "1697753000002846882" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350915", "module": "Testers", "name": "Crm_Implied_Merge_CustomModule3", "parent_permissions": [ "1697753000004350871" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360916", "module": "workers", "name": "Crm_Implied_Merge_CustomModule4", "parent_permissions": [ "1697753000004360872" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910924", "module": "orgs", "name": "Crm_Implied_Merge_CustomModule6", "parent_permissions": [ "1697753000004910880" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431943", "module": "skbc", "name": "Crm_Implied_Merge_CustomModule9", "parent_permissions": [ "1697753000020431877" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742189", "module": "Untitled", "name": "Crm_Implied_Merge_CustomModule13", "parent_permissions": [ "1697753000022742123" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593963", "module": "only_in_production", "name": "Crm_Implied_Merge_CustomModule10", "parent_permissions": [ "1697753000023593897" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388987", "module": "cm34", "name": "Crm_Implied_Merge_CustomModule11", "parent_permissions": [ "1697753000026388919" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414277", "module": "cm69", "name": "Crm_Implied_Merge_CustomModule12", "parent_permissions": [ "1697753000026414209" ] }, { "customizable": false, "display_label": "Custom View", "enabled": true, "id": "1697753000000017053", "module": null, "name": "Crm_Implied_Manage_CustomViews", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Support Access", "enabled": true, "id": "1697753000004259035", "module": null, "name": "Crm_Implied_Manage_Support_Access", "parent_permissions": null }, { "customizable": false, "display_label": "Kanban View", "enabled": true, "id": "1697753000012792017", "module": null, "name": "Crm_Implied_Manage_View_Kanban", "parent_permissions": null }, { "customizable": false, "display_label": "Split View", "enabled": true, "id": "1697753000024629553", "module": null, "name": "Crm_Implied_Manage_SplitView", "parent_permissions": null }, { "customizable": false, "display_label": "Timeline View", "enabled": true, "id": "1697753000021281010", "module": null, "name": "Crm_Implied_Manage_Timeline", "parent_permissions": null }, { "customizable": false, "display_label": "Zia Voice", "enabled": true, "id": "1697753000000174001", "module": null, "name": "Crm_Implied_Zoho_ZIAVoice_Integ", "parent_permissions": null }, { "customizable": false, "display_label": "List Subordinates only", "enabled": false, "id": "1697753000002668030", "module": null, "name": "Crm_Implied_List_Subordinate_Users" }, { "customizable": false, "display_label": "Override Forecast", "enabled": true, "id": "1697753000020302025", "module": null, "name": "Crm_Implied_Override_Forecasts", "parent_permissions": [ "1697753000000016341" ] }, { "customizable": false, "display_label": "Manage Users", "enabled": true, "id": "1697753000000015978", "module": null, "name": "Crm_Implied_Manage_Users", "parent_permissions": null }, { "customizable": false, "display_label": "Subordinates only", "enabled": false, "id": "1697753000000175001", "module": null, "name": "Crm_Implied_Manage_Subordinate_Users", "parent_permissions": [ "1697753000000015978" ] }, { "customizable": false, "display_label": "Manage Roles", "enabled": true, "id": "1697753000000015984", "module": null, "name": "Crm_Implied_Manage_Roles", "parent_permissions": [ "1697753000000015978" ] }, { "customizable": false, "display_label": "Manage Profiles", "enabled": true, "id": "1697753000000015987", "module": null, "name": "Crm_Implied_Manage_Profiles", "parent_permissions": [ "1697753000000015978" ] }, { "customizable": false, "display_label": "Manage Groups", "enabled": true, "id": "1697753000000015990", "module": null, "name": "Crm_Implied_Manage_Groups", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Data Sharing", "enabled": true, "id": "1697753000000015993", "module": null, "name": "Crm_Implied_Manage_Data_Sharing", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Compliance Settings", "enabled": true, "id": "1697753000000186001", "module": null, "name": "Crm_Implied_Manage_Compliance_Settings", "parent_permissions": null }, { "customizable": false, "display_label": "Modules Customization", "enabled": true, "id": "1697753000000015999", "module": null, "name": "Crm_Implied_Customize_Zoho_CRM", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Portals", "enabled": true, "id": "1697753000000158001", "module": null, "name": "Crm_Implied_Manage_ClientPortal", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Portals Users", "enabled": true, "id": "1697753000000158003", "module": null, "name": "Crm_Implied_Manage_ClientPortal_Users", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Calendar Booking", "enabled": true, "id": "1697753000000228001", "module": null, "name": "Crm_Implied_Manage_CalendarBooking", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Currencies", "enabled": true, "id": "1697753000003377017", "module": null, "name": "Crm_Implied_Manage_Currencies", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Domain Mapping", "enabled": true, "id": "1697753000010009930", "module": null, "name": "Crm_Implied_Manage_DomainMapping", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Motivator", "enabled": true, "id": "1697753000015758011", "module": null, "name": "Crm_Implied_Manage_Motivator", "parent_permissions": null }, { "customizable": false, "display_label": "Email Integration ( POP3 / IMAP )", "enabled": true, "id": "1697753000000045001", "module": null, "name": "Crm_Implied_Zoho_Mail_Integ", "parent_permissions": null }, { "customizable": false, "display_label": "BCC Dropbox", "enabled": true, "id": "1697753000000042001", "module": null, "name": "Crm_Implied_BCC_Dropbox", "parent_permissions": null }, { "customizable": false, "display_label": "Show Chat Bar", "enabled": true, "id": "1697753000000051001", "module": null, "name": "Crm_Implied_Chat_Bar", "parent_permissions": null }, { "customizable": false, "display_label": "Email Templates", "enabled": true, "id": "1697753000000016035", "module": null, "name": "Crm_Implied_Manage_Email_Templates", "parent_permissions": null }, { "customizable": false, "display_label": "Inventory Templates", "enabled": true, "id": "1697753000000016038", "module": null, "name": "Crm_Implied_Manage_Inventory_Templates", "parent_permissions": null }, { "customizable": false, "display_label": "Mail Merge using Zoho Writer", "enabled": true, "id": "1697753000000018001", "module": null, "name": "Crm_Implied_ZohoWriter_Addon", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Automation", "enabled": true, "id": "1697753000000016032", "module": null, "name": "Crm_Implied_Manage_Workflow", "parent_permissions": null }, { "customizable": false, "display_label": "Case Escalation Rules", "enabled": true, "id": "1697753000000016548", "module": null, "name": "Crm_Implied_Case_Escalation_Rules", "parent_permissions": null }, { "customizable": false, "display_label": "CommandCenter", "enabled": true, "id": "1697753000014343009", "module": null, "name": "Crm_Implied_View_Commandcenter", "parent_permissions": [ "1697753000000016032" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016053", "module": "Leads", "name": "Crm_Implied_Manage_AR_Leads", "parent_permissions": null }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016056", "module": "Contacts", "name": "Crm_Implied_Manage_AR_Contacts", "parent_permissions": null }, { "customizable": false, "display_label": "Accounts", "enabled": true, "id": "1697753000000360039", "module": "Accounts", "name": "Crm_Implied_Manage_AR_Accounts", "parent_permissions": null }, { "customizable": false, "display_label": "Deals", "enabled": true, "id": "1697753000000139001", "module": "Deals", "name": "Crm_Implied_Manage_AR_Deals", "parent_permissions": null }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000016059", "module": "Cases", "name": "Crm_Implied_Manage_AR_Cases", "parent_permissions": null }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670084", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Manage_AR_CustomModule16", "parent_permissions": null }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512873", "module": "CM1", "name": "Crm_Implied_Manage_AR_CustomModule1", "parent_permissions": null }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846904", "module": "Pending_Tasks", "name": "Crm_Implied_Manage_AR_CustomModule2", "parent_permissions": null }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350893", "module": "Testers", "name": "Crm_Implied_Manage_AR_CustomModule3", "parent_permissions": null }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360894", "module": "workers", "name": "Crm_Implied_Manage_AR_CustomModule4", "parent_permissions": null }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910902", "module": "orgs", "name": "Crm_Implied_Manage_AR_CustomModule6", "parent_permissions": null }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173447", "module": "Dependancy_Products", "name": "Crm_Implied_Manage_AR_LinkingModule9", "parent_permissions": null }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204307", "module": "Dependent_Leads", "name": "Crm_Implied_Manage_AR_LinkingModule10", "parent_permissions": null }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431899", "module": "skbc", "name": "Crm_Implied_Manage_AR_CustomModule9", "parent_permissions": null }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742145", "module": "Untitled", "name": "Crm_Implied_Manage_AR_CustomModule13", "parent_permissions": null }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593919", "module": "only_in_production", "name": "Crm_Implied_Manage_AR_CustomModule10", "parent_permissions": null }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388943", "module": "cm34", "name": "Crm_Implied_Manage_AR_CustomModule11", "parent_permissions": null }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414233", "module": "cm69", "name": "Crm_Implied_Manage_AR_CustomModule12", "parent_permissions": null }, { "customizable": false, "display_label": "Tasks", "enabled": true, "id": "1697753000000360041", "module": "Tasks", "name": "Crm_Implied_Manage_AR_Tasks", "parent_permissions": null }, { "customizable": false, "display_label": "View", "enabled": true, "id": "1697753000030465001", "module": null, "name": "Crm_Implied_View_Cadences", "parent_permissions": null }, { "customizable": false, "display_label": "Manage", "enabled": true, "id": "1697753000030465002", "module": null, "name": "Crm_Implied_Manage_Cadences", "parent_permissions": [ "1697753000030465001" ] }, { "customizable": false, "display_label": "Enroll", "enabled": true, "id": "1697753000012154063", "module": null, "name": "Crm_Implied_Manage_Enroll_Series", "parent_permissions": [ "1697753000030465001" ] }, { "customizable": false, "display_label": "Un-enroll", "enabled": true, "id": "1697753000012154064", "module": null, "name": "Crm_Implied_Manage_UnEnroll_Series", "parent_permissions": [ "1697753000030465001" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016518", "module": "Leads", "name": "Crm_Implied_Web_To_Leads", "parent_permissions": null }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016521", "module": "Contacts", "name": "Crm_Implied_Web_To_Contacts", "parent_permissions": null }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000016524", "module": "Cases", "name": "Crm_Implied_Web_To_Cases", "parent_permissions": null }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670086", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Web_To_CustomModule16", "parent_permissions": null }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000006280014", "module": "Vendors", "name": "Crm_Implied_Web_To_Vendors", "parent_permissions": null }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512875", "module": "CM1", "name": "Crm_Implied_Web_To_CustomModule1", "parent_permissions": null }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846906", "module": "Pending_Tasks", "name": "Crm_Implied_Web_To_CustomModule2", "parent_permissions": null }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350895", "module": "Testers", "name": "Crm_Implied_Web_To_CustomModule3", "parent_permissions": null }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360896", "module": "workers", "name": "Crm_Implied_Web_To_CustomModule4", "parent_permissions": null }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910904", "module": "orgs", "name": "Crm_Implied_Web_To_CustomModule6", "parent_permissions": null }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173449", "module": "Dependancy_Products", "name": "Crm_Implied_Web_To_LinkingModule9", "parent_permissions": null }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204309", "module": "Dependent_Leads", "name": "Crm_Implied_Web_To_LinkingModule10", "parent_permissions": null }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431901", "module": "skbc", "name": "Crm_Implied_Web_To_CustomModule9", "parent_permissions": null }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742147", "module": "Untitled", "name": "Crm_Implied_Web_To_CustomModule13", "parent_permissions": null }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593921", "module": "only_in_production", "name": "Crm_Implied_Web_To_CustomModule10", "parent_permissions": null }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388945", "module": "cm34", "name": "Crm_Implied_Web_To_CustomModule11", "parent_permissions": null }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414235", "module": "cm69", "name": "Crm_Implied_Web_To_CustomModule12", "parent_permissions": null }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000277001", "module": "Leads", "name": "Crm_Implied_Webform_Abtesting_Leads", "parent_permissions": [ "1697753000000016518" ] }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000277003", "module": "Contacts", "name": "Crm_Implied_Webform_Abtesting_Contacts", "parent_permissions": [ "1697753000000016521" ] }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000277005", "module": "Cases", "name": "Crm_Implied_Webform_Abtesting_Cases", "parent_permissions": [ "1697753000000016524" ] }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670088", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Webform_Abtesting_CustomModule16", "parent_permissions": [ "1697753000029670086" ] }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000006280018", "module": "Vendors", "name": "Crm_Implied_Webform_Abtesting_Vendors", "parent_permissions": [ "1697753000006280014" ] }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512877", "module": "CM1", "name": "Crm_Implied_Webform_Abtesting_CustomModule1", "parent_permissions": [ "1697753000000512875" ] }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846908", "module": "Pending_Tasks", "name": "Crm_Implied_Webform_Abtesting_CustomModule2", "parent_permissions": [ "1697753000002846906" ] }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350897", "module": "Testers", "name": "Crm_Implied_Webform_Abtesting_CustomModule3", "parent_permissions": [ "1697753000004350895" ] }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360898", "module": "workers", "name": "Crm_Implied_Webform_Abtesting_CustomModule4", "parent_permissions": [ "1697753000004360896" ] }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910906", "module": "orgs", "name": "Crm_Implied_Webform_Abtesting_CustomModule6", "parent_permissions": [ "1697753000004910904" ] }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431903", "module": "skbc", "name": "Crm_Implied_Webform_Abtesting_CustomModule9", "parent_permissions": [ "1697753000020431901" ] }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742149", "module": "Untitled", "name": "Crm_Implied_Webform_Abtesting_CustomModule13", "parent_permissions": [ "1697753000022742147" ] }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593923", "module": "only_in_production", "name": "Crm_Implied_Webform_Abtesting_CustomModule10", "parent_permissions": [ "1697753000023593921" ] }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388947", "module": "cm34", "name": "Crm_Implied_Webform_Abtesting_CustomModule11", "parent_permissions": [ "1697753000026388945" ] }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414237", "module": "cm69", "name": "Crm_Implied_Webform_Abtesting_CustomModule12", "parent_permissions": [ "1697753000026414235" ] }, { "customizable": false, "display_label": "Leadsaushbxuscuvs", "enabled": true, "id": "1697753000000016527", "module": "Leads", "name": "Crm_Implied_Approve_Web_Leads", "parent_permissions": null }, { "customizable": false, "display_label": "Contacts", "enabled": true, "id": "1697753000000016530", "module": "Contacts", "name": "Crm_Implied_Approve_Web_Contacts", "parent_permissions": null }, { "customizable": false, "display_label": "Cases", "enabled": true, "id": "1697753000000016533", "module": "Cases", "name": "Crm_Implied_Approve_Web_Cases", "parent_permissions": null }, { "customizable": false, "display_label": "Spider Test", "enabled": true, "id": "1697753000029670090", "module": "kishorespidertest__Spider_Test", "name": "Crm_Implied_Approve_Web_CustomModule16", "parent_permissions": null }, { "customizable": false, "display_label": "Vendors", "enabled": true, "id": "1697753000006280016", "module": "Vendors", "name": "Crm_Implied_Approve_Web_Vendors", "parent_permissions": null }, { "customizable": false, "display_label": "CM1", "enabled": true, "id": "1697753000000512879", "module": "CM1", "name": "Crm_Implied_Approve_Web_CustomModule1", "parent_permissions": null }, { "customizable": false, "display_label": "Pending Tasks", "enabled": true, "id": "1697753000002846910", "module": "Pending_Tasks", "name": "Crm_Implied_Approve_Web_CustomModule2", "parent_permissions": null }, { "customizable": false, "display_label": "Testers", "enabled": true, "id": "1697753000004350899", "module": "Testers", "name": "Crm_Implied_Approve_Web_CustomModule3", "parent_permissions": null }, { "customizable": false, "display_label": "workers", "enabled": true, "id": "1697753000004360900", "module": "workers", "name": "Crm_Implied_Approve_Web_CustomModule4", "parent_permissions": null }, { "customizable": false, "display_label": "orgs", "enabled": true, "id": "1697753000004910908", "module": "orgs", "name": "Crm_Implied_Approve_Web_CustomModule6", "parent_permissions": null }, { "customizable": false, "display_label": "Dependancy Products", "enabled": true, "id": "1697753000019173451", "module": "Dependancy_Products", "name": "Crm_Implied_Approve_Web_LinkingModule9", "parent_permissions": null }, { "customizable": false, "display_label": "Dependent Leads", "enabled": true, "id": "1697753000019204311", "module": "Dependent_Leads", "name": "Crm_Implied_Approve_Web_LinkingModule10", "parent_permissions": null }, { "customizable": false, "display_label": "skbc", "enabled": true, "id": "1697753000020431905", "module": "skbc", "name": "Crm_Implied_Approve_Web_CustomModule9", "parent_permissions": null }, { "customizable": false, "display_label": "Untitled", "enabled": true, "id": "1697753000022742151", "module": "Untitled", "name": "Crm_Implied_Approve_Web_CustomModule13", "parent_permissions": null }, { "customizable": false, "display_label": "only in production", "enabled": true, "id": "1697753000023593925", "module": "only_in_production", "name": "Crm_Implied_Approve_Web_CustomModule10", "parent_permissions": null }, { "customizable": false, "display_label": "cm34", "enabled": true, "id": "1697753000026388949", "module": "cm34", "name": "Crm_Implied_Approve_Web_CustomModule11", "parent_permissions": null }, { "customizable": false, "display_label": "cm69", "enabled": true, "id": "1697753000026414239", "module": "cm69", "name": "Crm_Implied_Approve_Web_CustomModule12", "parent_permissions": null }, { "customizable": false, "display_label": "Unsubscription Link", "enabled": true, "id": "1697753000000016041", "module": null, "name": "Crm_Implied_Manage_Unsubscribe_Form", "parent_permissions": null }, { "customizable": false, "display_label": "Migrate data from other CRM", "enabled": true, "id": "1697753000000016044", "module": null, "name": "Crm_Implied_Data_Migration", "parent_permissions": null }, { "customizable": false, "display_label": "Import History", "enabled": true, "id": "1697753000000016539", "module": null, "name": "Crm_Implied_Import_History", "parent_permissions": null }, { "customizable": false, "display_label": "View Storage Details", "enabled": true, "id": "1697753000000016047", "module": null, "name": "Crm_Implied_View_Storage_Usage", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Sandbox", "enabled": true, "id": "1697753000000112125", "module": null, "name": "Crm_Implied_Manage_Sandbox", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000022927153", "module": "Projects", "name": "Crm_Implied_View_Projects", "parent_permissions": null }, { "customizable": true, "display_label": "Create", "enabled": true, "id": "1697753000022927159", "module": "Projects", "name": "Crm_Implied_Create_Projects", "parent_permissions": [ "1697753000022927153" ] }, { "customizable": true, "display_label": "Edit", "enabled": true, "id": "1697753000022927155", "module": "Projects", "name": "Crm_Implied_Edit_Projects", "parent_permissions": [ "1697753000022927153" ] }, { "customizable": true, "display_label": "Delete", "enabled": true, "id": "1697753000022927157", "module": "Projects", "name": "Crm_Implied_Delete_Projects", "parent_permissions": [ "1697753000022927153" ] }, { "customizable": false, "display_label": "Phone Bridge", "enabled": true, "id": "1697753000000045007", "module": null, "name": "Crm_Implied_Zoho_PhoneBridge_Integ", "parent_permissions": null }, { "customizable": false, "display_label": "Meeting", "enabled": true, "id": "1697753000000016557", "module": null, "name": "Crm_Implied_Zohomeeting_View", "parent_permissions": null }, { "customizable": true, "display_label": "Zoho Expense", "enabled": true, "id": "1697753000010374754", "module": "Zoho_Expense", "name": "Crm_Implied_View_Expense", "parent_permissions": null }, { "customizable": true, "display_label": "Manage configuration", "enabled": true, "id": "1697753000019700307", "module": null, "name": "Crm_Implied_Manage_Smart_Prompt", "parent_permissions": null }, { "customizable": true, "display_label": "View result", "enabled": true, "id": "1697753000002793053", "module": null, "name": "Crm_Implied_View_Smart_Prompt", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000000290083", "module": null, "name": "Crm_Implied_Manage_Prediction", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000000290075", "module": null, "name": "Crm_Implied_View_Result_Prediction", "parent_permissions": null }, { "customizable": false, "display_label": "View analytics", "enabled": true, "id": "1697753000000369013", "module": null, "name": "Crm_Implied_View_Analytics_Prediction", "parent_permissions": [ "1697753000000290083" ] }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000000572023", "module": null, "name": "Crm_Implied_Manage_Nba", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000000572025", "module": null, "name": "Crm_Implied_View_Nba", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000001272029", "module": null, "name": "Crm_Implied_Manage_Zia_Score", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000001272031", "module": null, "name": "Crm_Implied_View_Result_Zia_Score", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000021375004", "module": null, "name": "Crm_Implied_Manage_Writing_Assistant", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000021375002", "module": null, "name": "Crm_Implied_View_Writing_Assistant", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000017855012", "module": null, "name": "Crm_Implied_View_Zia_Notes_Summary", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000009015044", "module": null, "name": "Crm_Implied_Manage_Email_Intelligence", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000009015042", "module": null, "name": "Crm_Implied_View_Email_Intelligence", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000028432022", "module": null, "name": "Crm_Implied_Manage_CustomAI", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000028432024", "module": null, "name": "Crm_Implied_View_CustomAI", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000000290071", "module": null, "name": "Crm_Implied_Manage_Recommendation", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000000290079", "module": null, "name": "Crm_Implied_View_Result_Recommendation", "parent_permissions": null }, { "customizable": false, "display_label": "View analytics", "enabled": true, "id": "1697753000005688060", "module": null, "name": "Crm_Implied_View_Analytics_Recommendation", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000002143011", "module": null, "name": "Crm_Implied_Manage_Similarity", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000002143009", "module": null, "name": "Crm_Implied_View_Result_Similarity", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000000293038", "module": null, "name": "Crm_Implied_Manage_Data_Enrichment", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000010009894", "module": null, "name": "Crm_Implied_View_Data_Enrichment", "parent_permissions": null }, { "customizable": false, "display_label": "View analytics", "enabled": true, "id": "1697753000010009896", "module": null, "name": "Crm_Implied_View_Data_Enrichment_Analytics", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000009765073", "module": null, "name": "Crm_Implied_Manage_BestTime", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000009765075", "module": null, "name": "Crm_Implied_View_Result_BestTime", "parent_permissions": null }, { "customizable": false, "display_label": "View analytics", "enabled": true, "id": "1697753000011131003", "module": null, "name": "Crm_Implied_View_Analytics_BestTime", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Configuration", "enabled": true, "id": "1697753000000290069", "module": null, "name": "Crm_Implied_Manage_Vision", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Action", "enabled": true, "id": "1697753000000290077", "module": null, "name": "Crm_Implied_Approve_Actions", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000025539240", "module": null, "name": "Crm_Implied_Manage_Icr", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000025539242", "module": null, "name": "Crm_Implied_View_Icr", "parent_permissions": null }, { "customizable": true, "display_label": "Manage configuration", "enabled": true, "id": "1697753000019700307", "module": null, "name": "Crm_Implied_Manage_Smart_Prompt", "parent_permissions": null }, { "customizable": true, "display_label": "View result", "enabled": true, "id": "1697753000002793053", "module": null, "name": "Crm_Implied_View_Smart_Prompt", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000016100007", "module": null, "name": "Crm_Implied_Manage_Zia_Presentation", "parent_permissions": null }, { "customizable": false, "display_label": "View result", "enabled": true, "id": "1697753000005123017", "module": null, "name": "Crm_Implied_View_Zia_Strategy_Influencer", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000005123015", "module": null, "name": "Crm_Implied_Manage_Zia_Strategy_Influencer", "parent_permissions": null }, { "customizable": false, "display_label": "Manage configuration", "enabled": true, "id": "1697753000026542004", "module": null, "name": "Crm_Implied_Manage_Usage_Data", "parent_permissions": null }, { "customizable": false, "display_label": "View analytics", "enabled": true, "id": "1697753000011131003", "module": null, "name": "Crm_Implied_View_Analytics_BestTime", "parent_permissions": null }, { "customizable": true, "display_label": "Grouped View", "enabled": false, "id": "1697753000001355008", "module": null, "name": "Crm_Implied_View_CPQ_Grouped_View", "parent_permissions": null }, { "customizable": false, "display_label": "View", "enabled": true, "id": "1697753000001088053", "module": null, "name": "Crm_Implied_View_CPQ_Product_Configurator", "parent_permissions": null }, { "customizable": false, "display_label": "Create", "enabled": true, "id": "1697753000001088055", "module": null, "name": "Crm_Implied_Create_CPQ_Product_Configurator", "parent_permissions": [ "1697753000001088053" ] }, { "customizable": false, "display_label": "Edit", "enabled": true, "id": "1697753000001088057", "module": null, "name": "Crm_Implied_Edit_CPQ_Product_Configurator", "parent_permissions": [ "1697753000001088053" ] }, { "customizable": false, "display_label": "Delete", "enabled": true, "id": "1697753000001088059", "module": null, "name": "Crm_Implied_Delete_CPQ_Product_Configurator", "parent_permissions": [ "1697753000001088053" ] }, { "customizable": false, "display_label": "View", "enabled": true, "id": "1697753000001088061", "module": null, "name": "Crm_Implied_View_CPQ_Price_Rules", "parent_permissions": null }, { "customizable": false, "display_label": "Create", "enabled": true, "id": "1697753000001088063", "module": null, "name": "Crm_Implied_Create_CPQ_Price_Rules", "parent_permissions": [ "1697753000001088061" ] }, { "customizable": false, "display_label": "Edit", "enabled": true, "id": "1697753000001088065", "module": null, "name": "Crm_Implied_Edit_CPQ_Price_Rules", "parent_permissions": [ "1697753000001088061" ] }, { "customizable": false, "display_label": "Delete", "enabled": true, "id": "1697753000001088067", "module": null, "name": "Crm_Implied_Delete_CPQ_Price_Rules", "parent_permissions": [ "1697753000001088061" ] }, { "customizable": false, "display_label": "View", "enabled": true, "id": "1697753000005690100", "module": null, "name": "Crm_Implied_View_CPQ_Guided_Selling", "parent_permissions": null }, { "customizable": false, "display_label": "Create", "enabled": true, "id": "1697753000005690102", "module": null, "name": "Crm_Implied_Create_CPQ_Guided_Selling", "parent_permissions": [ "1697753000005690100" ] }, { "customizable": false, "display_label": "Edit", "enabled": true, "id": "1697753000005690104", "module": null, "name": "Crm_Implied_Edit_CPQ_Guided_Selling", "parent_permissions": [ "1697753000005690100" ] }, { "customizable": false, "display_label": "Delete", "enabled": true, "id": "1697753000005690106", "module": null, "name": "Crm_Implied_Delete_CPQ_Guided_Selling", "parent_permissions": [ "1697753000005690100" ] }, { "customizable": false, "display_label": "View", "enabled": true, "id": "1697753000001088069", "module": null, "name": "Crm_Implied_View_CPQ_Quotes_dashboard", "parent_permissions": null }, { "customizable": false, "display_label": "Edit", "enabled": true, "id": "1697753000001088071", "module": null, "name": "Crm_Implied_Edit_CPQ_Quotes_dashboard", "parent_permissions": [ "1697753000001088069" ] }, { "customizable": false, "display_label": "Manage Extensibility", "enabled": true, "id": "1697753000000338035", "module": null, "name": "Crm_Implied_Advanced_Dev_Access", "parent_permissions": null }, { "customizable": false, "display_label": "Manage Zoho CRM Variables", "enabled": true, "id": "1697753000000338037", "module": null, "name": "Crm_Implied_Variables_Access", "parent_permissions": null }, { "customizable": true, "display_label": "Zoho Finance", "enabled": true, "id": "1697753000000342036", "module": "Zoho_Books", "name": "Crm_Implied_View_Finance", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000342038", "module": "CustomModule5001", "name": "Crm_Implied_View_Invoice_Invoices", "parent_permissions": [ "1697753000000342036" ] }, { "customizable": true, "display_label": "Create & Edit", "enabled": true, "id": "1697753000000342040", "module": "CustomModule5001", "name": "Crm_Implied_Create_Invoice_Invoices", "parent_permissions": [ "1697753000000342038" ] }, { "customizable": true, "display_label": "Send Email", "enabled": true, "id": "1697753000000342042", "module": "CustomModule5001", "name": "Crm_Implied_Email_Invoice_Invoices", "parent_permissions": [ "1697753000000342038" ] }, { "customizable": false, "display_label": "Record's Timeline", "enabled": true, "id": "1697753000030040223", "module": "CustomModule5001", "name": "Crm_Implied_AccessTimeline_Invoice_Invoices", "parent_permissions": [ "1697753000000342038" ] }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000342044", "module": "CustomModule5002", "name": "Crm_Implied_View_Invoice_Estimates", "parent_permissions": [ "1697753000000342036" ] }, { "customizable": true, "display_label": "Create & Edit", "enabled": true, "id": "1697753000000342046", "module": "CustomModule5002", "name": "Crm_Implied_Create_Invoice_Estimates", "parent_permissions": [ "1697753000000342044" ] }, { "customizable": true, "display_label": "Send Email", "enabled": true, "id": "1697753000000342048", "module": "CustomModule5002", "name": "Crm_Implied_Email_Invoice_Estimates", "parent_permissions": [ "1697753000000342044" ] }, { "customizable": false, "display_label": "Record's Timeline", "enabled": true, "id": "1697753000030040225", "module": "CustomModule5002", "name": "Crm_Implied_AccessTimeline_Invoice_Estimates", "parent_permissions": [ "1697753000000342044" ] }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000342056", "module": "CustomModule5003", "name": "Crm_Implied_View_Invoice_PurchaseOrders", "parent_permissions": [ "1697753000000342036" ] }, { "customizable": true, "display_label": "Create & Edit", "enabled": true, "id": "1697753000000342058", "module": "CustomModule5003", "name": "Crm_Implied_Create_Invoice_PurchaseOrders", "parent_permissions": [ "1697753000000342056" ] }, { "customizable": true, "display_label": "Send Email", "enabled": true, "id": "1697753000000342060", "module": "CustomModule5003", "name": "Crm_Implied_Email_Invoice_PurchaseOrders", "parent_permissions": [ "1697753000000342056" ] }, { "customizable": false, "display_label": "Record's Timeline", "enabled": true, "id": "1697753000030040229", "module": "CustomModule5003", "name": "Crm_Implied_AccessTimeline_Invoice_PurchaseOrders", "parent_permissions": [ "1697753000000342056" ] }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000000342050", "module": "CustomModule5004", "name": "Crm_Implied_View_Invoice_SalesOrders", "parent_permissions": [ "1697753000000342036" ] }, { "customizable": true, "display_label": "Create & Edit", "enabled": true, "id": "1697753000000342052", "module": "CustomModule5004", "name": "Crm_Implied_Create_Invoice_SalesOrders", "parent_permissions": [ "1697753000000342050" ] }, { "customizable": true, "display_label": "Send Email", "enabled": true, "id": "1697753000000342054", "module": "CustomModule5004", "name": "Crm_Implied_Email_Invoice_SalesOrders", "parent_permissions": [ "1697753000000342050" ] }, { "customizable": false, "display_label": "Record's Timeline", "enabled": true, "id": "1697753000030040227", "module": "CustomModule5004", "name": "Crm_Implied_AccessTimeline_Invoice_SalesOrders", "parent_permissions": [ "1697753000000342050" ] }, { "customizable": true, "display_label": "Receivables and Payables Summary", "enabled": false, "id": "1697753000000342062", "module": null, "name": "Crm_Implied_View_Invoice_Receivable", "parent_permissions": [ "1697753000000342036" ] }, { "customizable": false, "display_label": "Sync with Google Contact", "enabled": true, "id": "1697753000000027003", "module": null, "name": "Crm_Implied_Gcontact_Sync", "parent_permissions": null }, { "customizable": false, "display_label": "Sync with Google Calendar", "enabled": true, "id": "1697753000000027001", "module": null, "name": "Crm_Implied_Gcal_Sync", "parent_permissions": null }, { "customizable": true, "display_label": "Google Ads", "enabled": true, "id": "1697753000000219003", "module": "Google_AdWords", "name": "Crm_Implied_View_Google AdWords", "parent_permissions": null }, { "customizable": false, "display_label": "Social Admin", "enabled": true, "id": "1697753000000096001", "module": null, "name": "Crm_Implied_Social_Admin", "parent_permissions": null }, { "customizable": true, "display_label": "Social Tab", "enabled": true, "id": "1697753000000216001", "module": "Social", "name": "Crm_Implied_View_Social", "parent_permissions": null }, { "customizable": false, "display_label": "Personal Social Profiles", "enabled": true, "id": "1697753000000030001", "module": null, "name": "Crm_Implied_Social_Integration", "parent_permissions": null }, { "customizable": true, "display_label": "View", "enabled": true, "id": "1697753000013034422", "module": "Voice_of_the_Customer__s", "name": "Crm_Implied_View_Voice of the Customer", "parent_permissions": null }, { "customizable": true, "display_label": "Manage", "enabled": true, "id": "1697753000013034424", "module": "Voice_of_the_Customer__s", "name": "Crm_Implied_Manage_Voice of the Customer", "parent_permissions": null }, { "customizable": true, "display_label": "Record level insights", "enabled": true, "id": "1697753000013034426", "module": null, "name": "Crm_Implied_View_Voc_Record_Insights", "parent_permissions": null }, { "customizable": false, "display_label": "ABM", "enabled": true, "id": "1697753000012154007", "module": null, "name": "Crm_Implied_Manage_ABM", "parent_permissions": null }, { "customizable": false, "display_label": "Create", "enabled": true, "id": "1697753000012154008", "module": null, "name": "Crm_Implied_Create_ABM_Segments", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Edit", "enabled": true, "id": "1697753000012154009", "module": null, "name": "Crm_Implied_Edit_ABM_Segments", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Delete", "enabled": true, "id": "1697753000012154010", "module": null, "name": "Crm_Implied_Delete_ABM_Segments", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Manage Journeys", "enabled": true, "id": "1697753000012154015", "module": null, "name": "Crm_Implied_Manage_ABM_Journeys", "parent_permissions": [ "1697753000000016032", "1697753000012154007" ] }, { "customizable": false, "display_label": "Push Contacts To Zoho Campaigns", "enabled": true, "id": "1697753000012154014", "module": null, "name": "Crm_Implied_Manage_ABM_Push_Campaigns", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Send Email", "enabled": true, "id": "1697753000012154013", "module": null, "name": "Crm_Implied_Manage_ABM_Email", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Create", "enabled": true, "id": "1697753000012154011", "module": null, "name": "Crm_Implied_Create_ABM_Notes", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Delete", "enabled": true, "id": "1697753000012154012", "module": null, "name": "Crm_Implied_Delete_ABM_Notes", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Setup", "enabled": true, "id": "1697753000012154016", "module": null, "name": "Crm_Implied_Manage_ABM_Configurations", "parent_permissions": [ "1697753000012154007" ] }, { "customizable": false, "display_label": "Plug-in for Microsoft-Word", "enabled": true, "id": "1697753000000045011", "module": null, "name": "Crm_Implied_MS_Office_Integ", "parent_permissions": null }, { "customizable": false, "display_label": "Zoho Mobile Apps Access", "enabled": true, "id": "1697753000000045005", "module": null, "name": "Crm_Implied_Zoho_Mobile_Integ", "parent_permissions": null }, { "customizable": false, "display_label": "Zoho CRM API Access", "enabled": true, "id": "1697753000000017065", "module": null, "name": "Crm_Implied_Api_Access", "parent_permissions": null } ], "sections": [ { "categories": [ { "display_label": "Leadsaushbxuscuvs", "module": "Leads", "name": "Leads", "permissions_details": [ "1697753000000016077", "1697753000000016071", "1697753000000016074", "1697753000000016080", "1697753000010051061" ] }, { "display_label": "Contacts", "module": "Contacts", "name": "Contacts", "permissions_details": [ "1697753000000016119", "1697753000000016113", "1697753000000016116", "1697753000000016122", "1697753000010051083" ] }, { "display_label": "Accounts", "module": "Accounts", "name": "Accounts", "permissions_details": [ "1697753000000016098", "1697753000000016092", "1697753000000016095", "1697753000000016101", "1697753000010051105" ] }, { "display_label": "Deals", "module": "Deals", "name": "Potentials", "permissions_details": [ "1697753000000016140", "1697753000000016134", "1697753000000016137", "1697753000000016143", "1697753000010051127" ] }, { "display_label": "Meetings", "module": "Events", "name": "Events", "permissions_details": [ "1697753000000016368", "1697753000000016362", "1697753000000016365", "1697753000000016371", "1697753000010051177" ] }, { "display_label": "Calls", "module": "Calls", "name": "Calls", "permissions_details": [ "1697753000000017061", "1697753000000017057", "1697753000000017059", "1697753000000017063", "1697753000010051199" ] }, { "display_label": "Reports", "module": "Reports", "name": "Reports", "permissions_details": [ "1697753000000130001", "1697753000000112119", "1697753000000016029", "1697753000008567043" ] }, { "display_label": "Analytics", "module": "Analytics", "name": "Dashboards", "permissions_details": [ "1697753000000130002", "1697753000000112121", "1697753000020712084" ] }, { "display_label": "Products", "module": "Products", "name": "Products", "permissions_details": [ "1697753000000016224", "1697753000000016218", "1697753000000016221", "1697753000000016227", "1697753000010051219" ] }, { "display_label": "Quotes", "module": "Quotes", "name": "Quotes", "permissions_details": [ "1697753000000016281", "1697753000000016275", "1697753000000016278", "1697753000000016284", "1697753000010051241" ] }, { "display_label": "Sales Orders", "module": "Sales_Orders", "name": "SalesOrders", "permissions_details": [ "1697753000000016296", "1697753000000016290", "1697753000000016293", "1697753000000016299", "1697753000010051263" ] }, { "display_label": "Purchase Orders", "module": "Purchase_Orders", "name": "PurchaseOrders", "permissions_details": [ "1697753000000016311", "1697753000000016305", "1697753000000016308", "1697753000000016314", "1697753000010051285" ] }, { "display_label": "Invoices", "module": "Invoices", "name": "Invoices", "permissions_details": [ "1697753000000016326", "1697753000000016320", "1697753000000016323", "1697753000000016329", "1697753000010051307" ] }, { "display_label": "Campaigns", "module": "Campaigns", "name": "Campaigns", "permissions_details": [ "1697753000000016161", "1697753000000016155", "1697753000000016158", "1697753000000016164", "1697753000010051333" ] }, { "display_label": "Price Books", "module": "Price_Books", "name": "PriceBooks", "permissions_details": [ "1697753000000016245", "1697753000000016239", "1697753000000016242", "1697753000000016248", "1697753000010051355" ] }, { "display_label": "Cases", "module": "Cases", "name": "Cases", "permissions_details": [ "1697753000000016182", "1697753000000016176", "1697753000000016179", "1697753000000016185", "1697753000010051377" ] }, { "display_label": "Solutions", "module": "Solutions", "name": "Solutions", "permissions_details": [ "1697753000000016203", "1697753000000016197", "1697753000000016200", "1697753000000016206", "1697753000010051399" ] }, { "display_label": "Documents", "module": "Documents", "name": "Documents", "permissions_details": [ "1697753000000036003", "1697753000000036005", "1697753000000036011", "1697753000000036007", "1697753000000112123" ] }, { "display_label": "Forecasts", "module": "Forecasts", "name": "Forecasts", "permissions_details": [ "1697753000000016341" ] }, { "display_label": "Visits", "module": "Visits", "name": "Visits", "permissions_details": [ "1697753000000064003", "1697753000000064005", "1697753000010051441" ] }, { "display_label": "Hello World", "module": "kishorespidertest__Hello_World", "name": "CustomModule15", "permissions_details": [ "1697753000029668801", "1697753000029668803", "1697753000029668805", "1697753000029668807", "1697753000029668849" ] }, { "display_label": "Spider Test", "module": "kishorespidertest__Spider_Test", "name": "CustomModule16", "permissions_details": [ "1697753000029670058", "1697753000029670060", "1697753000029670062", "1697753000029670064", "1697753000029670106" ] }, { "display_label": "LeadChain", "module": "leadchainlocal__SocialLeadChain", "name": "WebTab2", "permissions_details": [ "1697753000030075017" ] }, { "display_label": "Services", "module": "Services__s", "name": "Services", "permissions_details": [ "1697753000000932769", "1697753000000932765", "1697753000000932767", "1697753000000932771", "1697753000010051499" ] }, { "display_label": "Appointments", "module": "Appointments__s", "name": "Appointments", "permissions_details": [ "1697753000000932803", "1697753000000932799", "1697753000000932801", "1697753000000932805", "1697753000010051519" ] }, { "display_label": "Vendors", "module": "Vendors", "name": "Vendors", "permissions_details": [ "1697753000000016266", "1697753000000016260", "1697753000000016263", "1697753000000016269", "1697753000010051541" ] }, { "display_label": "CM1", "module": "CM1", "name": "CustomModule1", "permissions_details": [ "1697753000000512847", "1697753000000512849", "1697753000000512851", "1697753000000512853", "1697753000010051563" ] }, { "display_label": "Pending Tasks", "module": "Pending_Tasks", "name": "CustomModule2", "permissions_details": [ "1697753000002846878", "1697753000002846880", "1697753000002846882", "1697753000002846884", "1697753000010051607" ] }, { "display_label": "Testers", "module": "Testers", "name": "CustomModule3", "permissions_details": [ "1697753000004350867", "1697753000004350869", "1697753000004350871", "1697753000004350873", "1697753000010051629" ] }, { "display_label": "workers", "module": "workers", "name": "CustomModule4", "permissions_details": [ "1697753000004360868", "1697753000004360870", "1697753000004360872", "1697753000004360874", "1697753000010051651" ] }, { "display_label": "orgs", "module": "orgs", "name": "CustomModule6", "permissions_details": [ "1697753000004910876", "1697753000004910878", "1697753000004910880", "1697753000004910882", "1697753000010051695" ] }, { "display_label": "Dependancy Products", "module": "Dependancy_Products", "name": "LinkingModule9", "permissions_details": [ "1697753000019173425", "1697753000019173427", "1697753000019173429", "1697753000019173431", "1697753000019173465" ] }, { "display_label": "Dependent Leads", "module": "Dependent_Leads", "name": "LinkingModule10", "permissions_details": [ "1697753000019204285", "1697753000019204287", "1697753000019204289", "1697753000019204291", "1697753000019204325" ] }, { "display_label": "skbc", "module": "skbc", "name": "CustomModule9", "permissions_details": [ "1697753000020431873", "1697753000020431875", "1697753000020431877", "1697753000020431879", "1697753000020431921" ] }, { "display_label": "Untitled", "module": "Untitled", "name": "CustomModule13", "permissions_details": [ "1697753000022742119", "1697753000022742121", "1697753000022742123", "1697753000022742125", "1697753000022742167" ] }, { "display_label": "only in production", "module": "only_in_production", "name": "CustomModule10", "permissions_details": [ "1697753000023593893", "1697753000023593895", "1697753000023593897", "1697753000023593899", "1697753000023593941" ] }, { "display_label": "cm34", "module": "cm34", "name": "CustomModule11", "permissions_details": [ "1697753000026388915", "1697753000026388917", "1697753000026388919", "1697753000026388921", "1697753000026388965" ] }, { "display_label": "cm69", "module": "cm69", "name": "CustomModule12", "permissions_details": [ "1697753000026414205", "1697753000026414207", "1697753000026414209", "1697753000026414211", "1697753000026414255" ] }, { "display_label": "Tasks", "module": "Tasks", "name": "Tasks", "permissions_details": [ "1697753000000016383", "1697753000000016377", "1697753000000016380", "1697753000000016386", "1697753000010051149" ] }, { "display_label": "Functions", "module": "Functions__s", "name": "Functions", "permissions_details": [ "1697753000028626001", "1697753000028626003", "1697753000028626005", "1697753000028626007", "1697753000028626009" ] }, { "display_label": "Notes", "module": "Notes", "name": "Notes", "permissions_details": [ "1697753000000342074", "1697753000000019005", "1697753000000019007", "1697753000000019009" ] }, { "display_label": "Attachments", "module": "Attachments", "name": "Attachments", "permissions_details": [ "1697753000000342072", "1697753000000019001", "1697753000000019003" ] } ], "name": "module" }, { "categories": [ { "display_label": "Import Own Records", "name": "import", "permissions_details": [ "1697753000000143001", "1697753000000143003", "1697753000000143005", "1697753000000143007", "1697753000000143011", "1697753000013133007", "1697753000000143013", "1697753000000143009", "1697753000000143017", "1697753000000143021", "1697753000000143019", "1697753000029670070", "1697753000000143015", "1697753000000512859", "1697753000002846890", "1697753000004350879", "1697753000004360880", "1697753000004910888", "1697753000019173437", "1697753000019204297", "1697753000020431885", "1697753000022742131", "1697753000023593905", "1697753000026388927", "1697753000026414217", "1697753000000333001" ] }, { "display_label": "Import Organization Records", "name": "import_org", "permissions_details": [] }, { "display_label": "Export", "name": "export", "permissions_details": [ "1697753000000016062", "1697753000000016104", "1697753000000016083", "1697753000000016125", "1697753000000016359", "1697753000000017055", "1697753000000016209", "1697753000000016272", "1697753000000016287", "1697753000000016302", "1697753000000016317", "1697753000000016146", "1697753000000016230", "1697753000000016167", "1697753000000016188", "1697753000000016332", "1697753000000111001", "1697753000029670072", "1697753000000016008", "1697753000000016011", "1697753000000932757", "1697753000000016014", "1697753000000932791", "1697753000000016251", "1697753000000512861", "1697753000002846892", "1697753000004350881", "1697753000004360882", "1697753000004910890", "1697753000019173439", "1697753000019204299", "1697753000020431887", "1697753000022742133", "1697753000023593907", "1697753000026388929", "1697753000026414219", "1697753000000016374" ] } ], "name": "import_and_export" }, { "categories": [ { "display_label": "Send Email", "name": "send_mail", "permissions_details": [ "1697753000000112001", "1697753000000112003", "1697753000008571088", "1697753000000112013", "1697753000000112005", "1697753000000112007", "1697753000000112011", "1697753000000112009", "1697753000018979040", "1697753000029670094", "1697753000008571089", "1697753000000512883", "1697753000002846914", "1697753000004350903", "1697753000004360904", "1697753000004910912", "1697753000019173453", "1697753000019204313", "1697753000020431909", "1697753000022742155", "1697753000023593929", "1697753000026388953", "1697753000026414243" ] }, { "display_label": "Mass Email", "name": "mass_mail", "permissions_details": [ "1697753000000016494", "1697753000000016497", "1697753000000112015", "1697753000018979042", "1697753000029670082", "1697753000008571092", "1697753000000512871", "1697753000002846902", "1697753000004350891", "1697753000004360892", "1697753000004910900", "1697753000019173423", "1697753000019204283", "1697753000020431897", "1697753000022742143", "1697753000023593917", "1697753000026388941", "1697753000026414231" ] }, { "display_label": "Mail Merge", "name": "mailmerge_mail", "permissions_details": [ "1697753000000154001", "1697753000000154005", "1697753000000154003", "1697753000000154007", "1697753000004259039", "1697753000004259041", "1697753000004259043", "1697753000004259045", "1697753000029670102", "1697753000000512891", "1697753000002846922", "1697753000004350911", "1697753000004360912", "1697753000004910920", "1697753000019173457", "1697753000019204317", "1697753000020431917", "1697753000022742163", "1697753000023593937", "1697753000026388961", "1697753000026414251" ] }, { "display_label": "Delete Email", "name": "delete_mail", "permissions_details": [ "1697753000000112017", "1697753000000112019", "1697753000008571093", "1697753000000112029", "1697753000000112021", "1697753000000112023", "1697753000000112027", "1697753000000112025", "1697753000018979043", "1697753000029670096", "1697753000008571094", "1697753000000512885", "1697753000002846916", "1697753000004350905", "1697753000004360906", "1697753000004910914", "1697753000019173455", "1697753000019204315", "1697753000020431911", "1697753000022742157", "1697753000023593931", "1697753000026388955", "1697753000026414245" ] } ], "name": "mail" }, { "categories": [ { "display_label": "Mass Update", "name": "mass_update", "permissions_details": [ "1697753000000016449", "1697753000000016455", "1697753000000016452", "1697753000000016458", "1697753000000371642", "1697753000000371644", "1697753000000016470", "1697753000000016479", "1697753000000016482", "1697753000000016485", "1697753000000016488", "1697753000000016461", "1697753000000016473", "1697753000000016464", "1697753000000016467", "1697753000029670076", "1697753000000016476", "1697753000000512865", "1697753000002846896", "1697753000004350885", "1697753000004360886", "1697753000004910894", "1697753000019173443", "1697753000019204303", "1697753000020431891", "1697753000022742137", "1697753000023593911", "1697753000026388933", "1697753000026414223", "1697753000000371640" ] }, { "display_label": "Mass Delete", "name": "mass_delete", "permissions_details": [ "1697753000000016419", "1697753000000016425", "1697753000000016422", "1697753000000016428", "1697753000000371660", "1697753000000371662", "1697753000000016440", "1697753000000350009", "1697753000000350011", "1697753000000350013", "1697753000000350015", "1697753000000016431", "1697753000000016443", "1697753000000016434", "1697753000000016437", "1697753000029670078", "1697753000000932773", "1697753000000932807", "1697753000000016446", "1697753000000512867", "1697753000002846898", "1697753000004350887", "1697753000004360888", "1697753000004910896", "1697753000019173445", "1697753000019204305", "1697753000020431893", "1697753000022742139", "1697753000023593913", "1697753000026388935", "1697753000026414225", "1697753000000371658" ] }, { "display_label": "Change Owner", "name": "change_owner", "permissions_details": [ "1697753000000112089", "1697753000000112091", "1697753000000112093", "1697753000000112095", "1697753000000211003", "1697753000000211005", "1697753000000112107", "1697753000000112101", "1697753000000112103", "1697753000000112113", "1697753000000112105", "1697753000000112097", "1697753000000112111", "1697753000000112117", "1697753000000112115", "1697753000029670092", "1697753000000932755", "1697753000000112109", "1697753000000512881", "1697753000002846912", "1697753000004350901", "1697753000004360902", "1697753000004910910", "1697753000019173459", "1697753000019204319", "1697753000020431907", "1697753000022742153", "1697753000023593927", "1697753000026388951", "1697753000026414241", "1697753000000211001" ] }, { "display_label": "Mass Transfer", "name": "mass_transfer", "permissions_details": [ "1697753000000016389", "1697753000000016395", "1697753000000016392", "1697753000000016398", "1697753000000371654", "1697753000000371656", "1697753000000016410", "1697753000000350001", "1697753000000350003", "1697753000000350005", "1697753000000350007", "1697753000000016401", "1697753000000016413", "1697753000000016404", "1697753000000016407", "1697753000029670074", "1697753000000016416", "1697753000000512863", "1697753000002846894", "1697753000004350883", "1697753000004360884", "1697753000004910892", "1697753000019173441", "1697753000019204301", "1697753000020431889", "1697753000022742135", "1697753000023593909", "1697753000026388931", "1697753000026414221", "1697753000000371652" ] }, { "display_label": "Convert", "name": "convert", "permissions_details": [ "1697753000000016500", "1697753000000112081", "1697753000000112083" ] }, { "display_label": "Mass Convert", "name": "mass_convert", "permissions_details": [ "1697753000000087001", "1697753000000112085", "1697753000000112087" ] }, { "display_label": "Share", "name": "share", "permissions_details": [ "1697753000000162001", "1697753000000113003", "1697753000000113001", "1697753000000113005", "1697753000000162011", "1697753000000162017", "1697753000000162019", "1697753000000162021", "1697753000000162023", "1697753000000162003", "1697753000000162015", "1697753000000162007", "1697753000000162009", "1697753000029670104", "1697753000000162013", "1697753000000512893", "1697753000002846924", "1697753000004350913", "1697753000004360914", "1697753000004910922", "1697753000020431919", "1697753000022742165", "1697753000023593939", "1697753000026388963", "1697753000026414253" ] }, { "display_label": "Lock", "name": "lock", "permissions_details": [ "1697753000001872059", "1697753000001872051", "1697753000001872055", "1697753000001872049", "1697753000007918061", "1697753000001872043", "1697753000001872041", "1697753000001872039", "1697753000001872037", "1697753000001872045", "1697753000001872057", "1697753000001872053", "1697753000029670350", "1697753000001872047", "1697753000001872061", "1697753000002855062", "1697753000004351051", "1697753000004363052", "1697753000004911066", "1697753000020433097", "1697753000022742341", "1697753000023623115", "1697753000026413151", "1697753000026414441" ] } ], "name": "tool" }, { "categories": [ { "display_label": "Print View", "name": "print_view", "permissions_details": [ "1697753000000112051", "1697753000000112053", "1697753000000112055", "1697753000000112057", "1697753000000371648", "1697753000000371650", "1697753000000112069", "1697753000000112063", "1697753000000112065", "1697753000000112075", "1697753000000112067", "1697753000000112059", "1697753000000112073", "1697753000000112079", "1697753000000112077", "1697753000000114001", "1697753000029670098", "1697753000000932779", "1697753000000932813", "1697753000000112071", "1697753000000512887", "1697753000002846918", "1697753000004350907", "1697753000004360908", "1697753000004910916", "1697753000019173461", "1697753000019204321", "1697753000020431913", "1697753000022742159", "1697753000023593933", "1697753000026388957", "1697753000026414247", "1697753000000371646" ] }, { "display_label": "Sheet View", "name": "sheet_view", "permissions_details": [ "1697753000000112031", "1697753000000112033", "1697753000000112035", "1697753000000112037", "1697753000000112047", "1697753000000112039", "1697753000000112049", "1697753000000112045", "1697753000000112043", "1697753000029670100", "1697753000000112041", "1697753000000512889", "1697753000002846920", "1697753000004350909", "1697753000004360910", "1697753000004910918", "1697753000019173463", "1697753000019204323", "1697753000020431915", "1697753000022742161", "1697753000023593935", "1697753000026388959", "1697753000026414249" ] }, { "display_label": "Tags", "name": "tags", "permissions_details": [ "1697753000000135023", "1697753000000135015", "1697753000000135025", "1697753000000135019", "1697753000000211009", "1697753000000211011", "1697753000000135021", "1697753000000135005", "1697753000000135007", "1697753000000135001", "1697753000000135003", "1697753000000135009", "1697753000000135013", "1697753000000135027", "1697753000000135017", "1697753000029670080", "1697753000000932775", "1697753000000932809", "1697753000000135011", "1697753000000512869", "1697753000002846900", "1697753000004350889", "1697753000004360890", "1697753000004910898", "1697753000020431895", "1697753000022742141", "1697753000023593915", "1697753000026388937", "1697753000026414227", "1697753000000211007" ] }, { "display_label": "Record's Timeline", "name": "access_timeline", "permissions_details": [ "1697753000030040177", "1697753000030040181", "1697753000030040179", "1697753000030040183", "1697753000030040189", "1697753000030040209", "1697753000030040195", "1697753000030040201", "1697753000030040203", "1697753000030040205", "1697753000030040207", "1697753000030040185", "1697753000030040199", "1697753000030040191", "1697753000030040193", "1697753000030040149", "1697753000030040211", "1697753000030040213", "1697753000030040197", "1697753000030040151", "1697753000030040153", "1697753000030040155", "1697753000030040157", "1697753000030040161", "1697753000030040173", "1697753000030040175", "1697753000030040167", "1697753000030040169", "1697753000030040171", "1697753000026388989", "1697753000026414279", "1697753000030040187" ] }, { "display_label": "Find and Merge", "name": "find_and_merge", "permissions_details": [ "1697753000000016506", "1697753000000016512", "1697753000000016509", "1697753000002346036", "1697753000029670128", "1697753000000016515", "1697753000002346012", "1697753000002846926", "1697753000004350915", "1697753000004360916", "1697753000004910924", "1697753000020431943", "1697753000022742189", "1697753000023593963", "1697753000026388987", "1697753000026414277" ] }, { "display_label": "Custom View", "name": "custom_view", "permissions_details": [ "1697753000000017053" ] }, { "display_label": "Manage Support Access", "name": "manage_support_access", "permissions_details": [ "1697753000004259035" ] }, { "display_label": "Kanban View", "name": "kanban_view", "permissions_details": [ "1697753000012792017" ] }, { "display_label": "Split View", "name": "split_view", "permissions_details": [ "1697753000024629553" ] }, { "display_label": "Timeline View", "name": "timeline_view", "permissions_details": [ "1697753000021281010" ] }, { "display_label": "Zia Voice", "name": "zia_voice", "permissions_details": [ "1697753000000174001" ] }, { "display_label": "List Subordinates only", "name": "list_subordinates_only", "permissions_details": [ "1697753000002668030" ] }, { "display_label": "Override Forecast", "name": "override_forecast", "permissions_details": [ "1697753000020302025" ] } ], "name": "other" }, { "categories": [ { "display_label": "User Management", "name": "user_management", "permissions_details": [ "1697753000000015978", "1697753000000175001", "1697753000000015984", "1697753000000015987", "1697753000000015990", "1697753000000015993" ] }, { "display_label": "Manage Compliance Settings", "name": "manage_compliance_settings", "permissions_details": [ "1697753000000186001" ] }, { "display_label": "Modules Customization", "name": "module_customization", "permissions_details": [ "1697753000000015999" ] }, { "display_label": "Manage Portals", "name": "manage_portals", "permissions_details": [ "1697753000000158001" ] }, { "display_label": "Manage Portals Users", "name": "manage_portals_users", "permissions_details": [ "1697753000000158003" ] }, { "display_label": "Manage Calendar Booking", "name": "manage_calendar_booking", "permissions_details": [ "1697753000000228001" ] }, { "display_label": "Manage Currencies", "name": "manage_currencies", "permissions_details": [ "1697753000003377017" ] }, { "display_label": "Manage Domain Mapping", "name": "manage_domain_mapping", "permissions_details": [ "1697753000010009930" ] }, { "display_label": "Manage Motivator", "name": "manage_motivator", "permissions_details": [ "1697753000015758011" ] } ], "name": "admin" }, { "categories": [ { "display_label": "Email & Chat Settings", "name": "email_chat", "permissions_details": [ "1697753000000045001", "1697753000000042001", "1697753000000051001" ] }, { "display_label": "Manage Templates", "name": "template", "permissions_details": [ "1697753000000016035", "1697753000000016038", "1697753000000018001" ] } ], "name": "template" }, { "categories": [ { "display_label": "Manage Automation", "name": "workflow", "permissions_details": [ "1697753000000016032" ] }, { "display_label": "Case Escalation Rules", "name": "case_escalation", "permissions_details": [ "1697753000000016548" ] }, { "display_label": "CommandCenter", "name": "commandcenter", "permissions_details": [ "1697753000014343009" ] }, { "display_label": "Assignment Rules & Threshold", "name": "assignment", "permissions_details": [ "1697753000000016053", "1697753000000016056", "1697753000000360039", "1697753000000139001", "1697753000000016059", "1697753000029670084", "1697753000000512873", "1697753000002846904", "1697753000004350893", "1697753000004360894", "1697753000004910902", "1697753000019173447", "1697753000019204307", "1697753000020431899", "1697753000022742145", "1697753000023593919", "1697753000026388943", "1697753000026414233", "1697753000000360041" ] }, { "display_label": "Cadences", "name": "cadences", "permissions_details": [ "1697753000030465001", "1697753000030465002", "1697753000012154063", "1697753000012154064" ] } ], "name": "automation" }, { "categories": [ { "display_label": "Manage Webform", "name": "web_form", "permissions_details": [ "1697753000000016518", "1697753000000016521", "1697753000000016524", "1697753000029670086", "1697753000006280014", "1697753000000512875", "1697753000002846906", "1697753000004350895", "1697753000004360896", "1697753000004910904", "1697753000019173449", "1697753000019204309", "1697753000020431901", "1697753000022742147", "1697753000023593921", "1697753000026388945", "1697753000026414235" ] }, { "display_label": "A/B Testing", "name": "A/B Testing", "permissions_details": [ "1697753000000277001", "1697753000000277003", "1697753000000277005", "1697753000029670088", "1697753000006280018", "1697753000000512877", "1697753000002846908", "1697753000004350897", "1697753000004360898", "1697753000004910906", "1697753000020431903", "1697753000022742149", "1697753000023593923", "1697753000026388947", "1697753000026414237" ] }, { "display_label": "Approval", "name": "approval", "permissions_details": [ "1697753000000016527", "1697753000000016530", "1697753000000016533", "1697753000029670090", "1697753000006280016", "1697753000000512879", "1697753000002846910", "1697753000004350899", "1697753000004360900", "1697753000004910908", "1697753000019173451", "1697753000019204311", "1697753000020431905", "1697753000022742151", "1697753000023593925", "1697753000026388949", "1697753000026414239" ] }, { "display_label": "Unsubscription Link", "name": "unsubscription", "permissions_details": [ "1697753000000016041" ] } ], "name": "web_form" }, { "categories": [ { "display_label": "Migrate data from other CRM", "name": "data_migration", "permissions_details": [ "1697753000000016044" ] }, { "display_label": "Import History", "name": "import_history", "permissions_details": [ "1697753000000016539" ] }, { "display_label": "View Storage Details", "name": "view_storage", "permissions_details": [ "1697753000000016047" ] }, { "display_label": "Manage Sandbox", "name": "sandbox", "permissions_details": [ "1697753000000112125" ] } ], "name": "data_admin" }, { "categories": [ { "display_label": "Projects", "name": "zprojects", "permissions_details": [ "1697753000022927153", "1697753000022927159", "1697753000022927155", "1697753000022927157" ] }, { "display_label": "Phone Bridge", "name": "zphone", "permissions_details": [ "1697753000000045007" ] }, { "display_label": "Meeting", "name": "zmeeting", "permissions_details": [ "1697753000000016557" ] }, { "display_label": "Zoho Expense", "name": "zexpense", "permissions_details": [ "1697753000010374754" ] } ], "name": "zoho_app" }, { "categories": [ { "display_label": "Smart Prompt", "name": "smart_prompt", "permissions_details": [ "1697753000019700307", "1697753000002793053" ] }, { "display_label": "Prediction", "name": "prediction", "permissions_details": [ "1697753000000290083", "1697753000000290075", "1697753000000369013" ] }, { "display_label": "Next best suggestions", "name": "next_best_action", "permissions_details": [ "1697753000000572023", "1697753000000572025" ] }, { "display_label": "Zia Score", "name": "zia_score", "permissions_details": [ "1697753000001272029", "1697753000001272031" ] }, { "display_label": "Writing Assistant", "name": "writing_assistant", "permissions_details": [ "1697753000021375004", "1697753000021375002" ] }, { "display_label": "Summarize notes", "name": "zia_summary", "permissions_details": [ "1697753000017855012" ] }, { "display_label": "Usage Data", "name": "CUSTOMER_USAGE_DATA", "permissions_details": [] }, { "display_label": "Email Intelligence", "name": "Email_Intelligence", "permissions_details": [ "1697753000009015044", "1697753000009015042" ] }, { "display_label": "Custom AI Studio", "name": "CustomAI", "permissions_details": [ "1697753000028432022", "1697753000028432024" ] }, { "display_label": "Recommendation", "name": "recommendation", "permissions_details": [ "1697753000000290071", "1697753000000290079", "1697753000005688060" ] }, { "display_label": "Similarity Recommendation", "name": "similarity", "permissions_details": [ "1697753000002143011", "1697753000002143009" ] }, { "display_label": "Enrichment", "name": "enrichment", "permissions_details": [ "1697753000000293038", "1697753000010009894", "1697753000010009896" ] }, { "display_label": "Best Time to Contact", "name": "best_time_to_contact", "permissions_details": [ "1697753000009765073", "1697753000009765075", "1697753000011131003" ] }, { "display_label": "Image Validation", "name": "imageValidation", "permissions_details": [ "1697753000000290069", "1697753000000290077" ] }, { "display_label": "Intelligent Character Recognition", "name": "intelligent_character_recognition", "permissions_details": [ "1697753000025539240", "1697753000025539242" ] }, { "display_label": "Smart Prompt", "name": "smart_prompt", "permissions_details": [ "1697753000019700307", "1697753000002793053" ] }, { "display_label": "Zia Presentation", "name": "zia_presentation", "permissions_details": [ "1697753000016100007" ] }, { "display_label": "Zia Strategy Influencer", "name": "zia_strategy_influencer", "permissions_details": [ "1697753000005123017", "1697753000005123015" ] }, { "display_label": "Usage Data", "name": "usage_data", "permissions_details": [ "1697753000026542004" ] }, { "display_label": "View analytics", "name": "best_time_to_contact", "permissions_details": [ "1697753000011131003" ] } ], "name": "zia" }, { "categories": [ { "display_label": "Grouped View", "name": "grouped_view", "permissions_details": [ "1697753000001355008" ] }, { "display_label": "Product configurator", "name": "product_configurator", "permissions_details": [ "1697753000001088053", "1697753000001088055", "1697753000001088057", "1697753000001088059" ] }, { "display_label": "Price rules", "name": "price_rule", "permissions_details": [ "1697753000001088061", "1697753000001088063", "1697753000001088065", "1697753000001088067" ] }, { "display_label": "Guided Selling", "name": "guided_selling", "permissions_details": [ "1697753000005690100", "1697753000005690102", "1697753000005690104", "1697753000005690106" ] }, { "display_label": "Quick view dashboard component", "name": "quick_view_dashboard", "permissions_details": [ "1697753000001088069", "1697753000001088071" ] } ], "name": "cpq" }, { "categories": [ { "display_label": "Manage Extensibility", "name": "advanced_dev", "permissions_details": [ "1697753000000338035" ] } ], "name": "developer_permission" }, { "categories": [ { "display_label": "Manage Zoho CRM Variables", "name": "crmvariables", "permissions_details": [ "1697753000000338037" ] } ], "name": "crm_variables" }, { "categories": [ { "display_label": "Zoho Finance", "name": "zohofinance", "permissions_details": [ "1697753000000342036" ] }, { "display_label": "Invoices", "name": "invoices", "permissions_details": [ "1697753000000342038", "1697753000000342040", "1697753000000342042", "1697753000030040223" ] }, { "display_label": "Estimates", "name": "estimates", "permissions_details": [ "1697753000000342044", "1697753000000342046", "1697753000000342048", "1697753000030040225" ] }, { "display_label": "Purchase Orders", "name": "purchaseorder", "permissions_details": [ "1697753000000342056", "1697753000000342058", "1697753000000342060", "1697753000030040229", "1697753000000342050", "1697753000000342052", "1697753000000342054", "1697753000030040227" ] }, { "display_label": "Sales Orders", "name": "salesorder", "permissions_details": [ "1697753000000342056", "1697753000000342058", "1697753000000342060", "1697753000030040229", "1697753000000342050", "1697753000000342052", "1697753000000342054", "1697753000030040227" ] }, { "display_label": "Receivables and Payables Summary", "name": "receivables", "permissions_details": [ "1697753000000342062" ] } ], "name": "zoho_finance" }, { "categories": [ { "display_label": "Sync with Google Contact", "name": "gcontact", "permissions_details": [ "1697753000000027003" ] }, { "display_label": "Sync with Google Calendar", "name": "gcalendar", "permissions_details": [ "1697753000000027001" ] }, { "display_label": "Google Ads", "name": "gadwords", "permissions_details": [ "1697753000000219003" ] } ], "name": "google_app" }, { "categories": [ { "display_label": "Social Admin", "name": "social_admin", "permissions_details": [ "1697753000000096001" ] }, { "display_label": "Social Tab", "name": "social_tab", "permissions_details": [ "1697753000000216001" ] }, { "display_label": "Personal Social Profiles", "name": "social_integ", "permissions_details": [ "1697753000000030001" ] } ], "name": "social_app" }, { "categories": [ { "display_label": "Overall Dashboard Insights", "name": "dashboards", "permissions_details": [ "1697753000013034422", "1697753000013034424" ] }, { "display_label": "Record level insights", "name": "record_insights", "permissions_details": [ "1697753000013034426" ] } ], "name": "voc" }, { "categories": [ { "display_label": "ABM", "name": "zohoabm", "permissions_details": [ "1697753000012154007" ] }, { "display_label": "Segments", "name": "segments", "permissions_details": [ "1697753000012154008", "1697753000012154009", "1697753000012154010" ] }, { "display_label": "Manage Journeys", "name": "journeys", "permissions_details": [ "1697753000012154015" ] }, { "display_label": "Push Contacts To Zoho Campaigns", "name": "push_campaigns", "permissions_details": [ "1697753000012154014" ] }, { "display_label": "Send Email", "name": "email", "permissions_details": [ "1697753000012154013" ] }, { "display_label": "Notes", "name": "notes", "permissions_details": [ "1697753000012154011", "1697753000012154012" ] }, { "display_label": "Setup", "name": "setup", "permissions_details": [ "1697753000012154016" ] } ], "name": "zoho_abm" }, { "categories": [ { "display_label": "Plug-in for Microsoft-Word", "name": "offile", "permissions_details": [ "1697753000000045011" ] }, { "display_label": "Zoho Mobile Apps Access", "name": "mobile", "permissions_details": [ "1697753000000045005" ] } ], "name": "other_app" }, { "categories": [ { "display_label": "Zoho CRM API Access", "name": "crmapi", "permissions_details": [ "1697753000000017065" ] } ], "name": "crm_api" } ], "type": "normal_profile" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful response containing the requested profile's details.", "properties": { "profiles": { "description": "Array containing the details of the requested profile (single-item array).", "items": { "additionalProperties": false, "description": "Full details of the requested profile.", "properties": { "$has_more": { "description": "Indicates whether the profile has more permission records beyond the included set.", "type": "boolean" }, "api_name": { "$ref": "#/components/schemas/ProfilesApiName", "x-zs-$id": "SingleProfileApiName" }, "created_by": { "$ref": "#/components/schemas/ProfilesCreatedBy" }, "created_time": { "$ref": "#/components/schemas/ProfilesCreatedTime" }, "custom": { "description": "Indicates whether the profile is a custom profile (`true`) or a system profile (`false`).", "type": "boolean" }, "description": { "description": "Optional description of the profile.", "maxLength": 255, "type": [ "string", "null" ] }, "display_label": { "description": "Display label shown for the profile in the CRM UI.", "maxLength": 255, "type": "string" }, "id": { "$ref": "#/components/schemas/ProfilesId", "description": "Unique profile identifier.", "x-zs-$id": "SingleProfileId" }, "modified_by": { "$ref": "#/components/schemas/ProfilesModifiedBy" }, "modified_time": { "$ref": "#/components/schemas/ModifiedTime" }, "name": { "$ref": "#/components/schemas/ProfileName" }, "permissions_details": { "description": "Flat list of all individual permissions configured for this profile (up to 2000 entries).", "items": { "additionalProperties": false, "description": "A single permission entry describing a specific access right in the profile.", "properties": { "active": { "description": "Whether the permission is active.", "type": "boolean" }, "api_name": { "description": "API name of the permission.", "maxLength": 255, "type": "string", "x-zs-$id": "SingleProfilePermissionsApiName" }, "custom_permission": { "description": "Whether this is a custom permission.", "type": "boolean" }, "customizable": { "description": "Indicates whether this permission can be toggled on or off by an administrator.", "type": "boolean" }, "description": { "description": "Description of the permission.", "maxLength": 500, "type": [ "string", "null" ] }, "display_label": { "description": "Human-readable label displayed for this permission in the CRM UI.", "maxLength": 255, "type": "string" }, "enabled": { "description": "Indicates whether this permission is currently enabled for the profile.", "type": "boolean" }, "id": { "$ref": "#/components/schemas/ProfilesId", "description": "The unique identifier of the permission.", "x-zs-$id": "SingleProfilePermissionsId" }, "module": { "description": "Module associated with this permission. Null when the permission is not tied to a specific module.", "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Internal API name of the permission.", "maxLength": 255, "type": "string" }, "parent_permissions": { "anyOf": [ { "description": "Array of parent permission identifiers this permission depends on.", "items": { "$ref": "#/components/schemas/ProfilesId" }, "maxItems": 200, "type": "array", "x-zs-$id": "ProfilePermissionParentPermissionsArray" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesTypeNull" } ], "description": "Null when this permission has no parent dependencies.", "x-zs-$id": "ProfilePermissionParentPermissionsNull" } ], "description": "List of parent permission names this permission depends on, or null when there are no parent dependencies." }, "tooltip_msg": { "description": "Tooltip text displayed when hovering over this permission in the CRM UI.", "maxLength": 500, "type": "string" } }, "type": "object" }, "maxItems": 2000, "type": "array" }, "sections": { "description": "Grouped sections that organize permissions into categories for display in the CRM UI (up to 100 sections).", "items": { "additionalProperties": false, "description": "A section grouping related permission categories.", "properties": { "categories": { "description": "List of permission categories within this section (up to 100 categories).", "items": { "additionalProperties": false, "description": "A single permission category containing related permissions.", "properties": { "display_label": { "description": "Display label shown for this category in the CRM UI.", "maxLength": 255, "type": "string" }, "module": { "description": "Module associated with this category or null when the category is not module-specific.", "maxLength": 100, "type": [ "string", "null" ] }, "name": { "description": "Internal name of the permission category.", "maxLength": 255, "type": "string" }, "permissions_details": { "description": "Permission identifiers grouped under this category.", "items": { "description": "A single permission identifier string associated with this category.", "maxLength": 255, "type": "string" }, "maxItems": 500, "minItems": 0, "type": "array" } }, "required": [ "display_label", "permissions_details", "name" ], "type": "object" }, "maxItems": 100, "type": "array" }, "name": { "description": "Internal name of the permission section.", "maxLength": 255, "type": "string" } }, "required": [ "name", "categories" ], "type": "object" }, "maxItems": 100, "type": "array" }, "type": { "description": "Profile type classification. Possible values: `private_profile`, `normal_profile`, `lite_profile`, `system_profile`, `portal_profile`. `private_profile` is used exclusively for team modules; non-private profiles are not allowed for team modules.", "enum": [ "private_profile", "normal_profile", "lite_profile", "system_profile", "portal_profile" ], "type": "string" } }, "required": [ "api_name", "id", "created_time", "modified_time", "name", "display_label", "custom", "type", "permissions_details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "SingleProfileResponse" } } }, "description": "Profile retrieved successfully." }, "204": { "description": "No content - the profile exists but has no body to return." }, "400": { "content": { "application/json": { "examples": { "InvalidId": { "description": "Returned when the profile ID in the request path does not correspond to an existing active profile.", "summary": "Invalid profile ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid or already deleted", "status": "error" } }, "InvalidRequestMethod": { "description": "Returned when the request uses an HTTP method other than GET for this endpoint.", "summary": "Invalid HTTP method used", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/ProfilesInvalidRequestMethodError" } ], "description": "HTTP request method is not supported for this endpoint.", "x-zs-$id": "GetProfileInvalidRequestMethod" }, { "allOf": [ { "$ref": "#/components/schemas/ProfilesInvalidIdError" } ], "description": "The profile ID is invalid or refers to a deleted profile.", "x-zs-$id": "GetProfileInvalidId" } ], "description": "Error response body for invalid GET /settings/profiles/{id} requests.", "x-zs-$id": "GetProfileBadRequest" } } }, "description": "Invalid request." }, "401": { "$ref": "#/components/responses/ProfilesUnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ProfilesForbiddenResponse" }, "500": { "$ref": "#/components/responses/ProfilesInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.profiles.READ" ] } ], "summary": "Profile", "tags": [ "profiles" ], "x-zoho-document": "profiles", "x-zs-llm-description": "Fetches a single profile by id, including its permissions_details. Use to read current state before an update." }, "patch": { "description": "Partially updates the name, description, and permission enablement for the profile identified by `{id}`. System profiles (Administrator, Standard) cannot be updated. See [Update Profile Permission](https://www.zoho.com/crm/developer/docs/api/v8/update-profile-permission.html).", "operationId": "patchProfile", "parameters": [ { "$ref": "#/components/parameters/ProfilesId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdatePermissions": { "description": "A sample request body enabling or disabling specific permissions for the target profile.", "summary": "Update permission enablement for a profile", "value": { "profiles": [ { "description": "Updated description for the profile.", "name": "Updated Profile Name", "permissions_details": [ { "enabled": false, "id": "1408246000000063001" }, { "enabled": true, "id": "1408246000000057001" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for the partial profile update operation.", "properties": { "profiles": { "description": "Specify a single-item JSON array containing the profile update payload.", "items": { "additionalProperties": false, "description": "Partial update payload for the profile.", "minProperties": 1, "properties": { "description": { "description": "Specify the new text description for the profile.", "maxLength": 250, "type": [ "string", "null" ] }, "name": { "description": "Specify the new name for the profile (up to 50 characters).", "maxLength": 50, "type": [ "string", "null" ] }, "permissions_details": { "description": "List of permission toggle entries to apply (up to 2000).", "items": { "additionalProperties": false, "description": "A single permission toggle entry specifying the permission ID and its desired enabled state.", "properties": { "enabled": { "description": "Desired enabled state for the permission.\n**Possible values:**\n`true` to enable, `false` to disable.", "type": "boolean" }, "id": { "description": "The unique identifier of the permission.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfilePermissionDetailsId" } ], "resource": "profiles" } } }, "required": [ "id", "enabled" ], "type": "object" }, "maxItems": 2000, "type": "array" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object" }, "x-zs-llm-examples": [ "UpdatePermissions" ] } }, "description": "Payload containing the profile fields and permission enablement entries to update.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Updated": { "description": "A sample response confirming that the profile was partially updated successfully.", "summary": "Update result", "value": { "profiles": [ { "code": "SUCCESS", "details": { "id": "4670092000001127685" }, "message": "profile updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful response for the partial profile update operation.", "properties": { "profiles": { "description": "Update results for the profile (up to 50 entries).", "items": { "additionalProperties": false, "description": "Result for the partial profile update operation.", "properties": { "code": { "description": "Operation result code. Possible values: `SUCCESS`.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object containing the ID of the updated profile.", "properties": { "id": { "description": "Unique identifier of the updated profile.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable message confirming the update result.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation. \n**Possible values:**\n**success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "PatchProfileResponse" } } }, "description": "Profile updated successfully." }, "400": { "content": { "application/json": { "examples": { "ChildPermissionParentDisabled": { "description": "Returned when a permission toggle entry attempts to enable a child permission whose parent permission is currently disabled.", "summary": "Child permission cannot be enabled because parent is disabled", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.profiles[0].permissions_details[0].id" }, "message": "Child permission can not be enabled, since its parent permission is disabled", "status": "error" } ] } }, "DuplicateData": { "description": "Returned when the updated profile name is already used by another profile in the organization.", "summary": "Duplicate profile name", "value": { "profiles": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.profiles[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidAction": { "description": "Returned when the action given in the request is not a valid operation for profile update.", "summary": "Invalid action", "value": { "profiles": [ { "code": "INVALID_DATA", "details": {}, "message": "The action given is invalid", "status": "error" } ] } }, "InvalidPermissionId": { "description": "Returned when a permission ID supplied in `permissions_details` does not correspond to a valid permission.", "summary": "Invalid permission ID", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.profiles[0].permissions_details[0].id" }, "message": "Invalid permission ID", "status": "error" } ] } }, "InvalidPermissionsDetailsDatatype": { "summary": "Invalid data type for `permissions_details`", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "permissions_details", "expected_data_type": "jsonarray", "json_path": "$.profiles[0].permissions_details" }, "message": "invalid data", "status": "error" } ] } }, "InvalidProfileId": { "description": "Returned when the profile ID in the request path does not match any existing active profile.", "summary": "Invalid or deleted profile ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid or already deleted", "status": "error" } }, "InvalidProfileNameSpecialChars": { "description": "Returned when the updated profile name contains one or more disallowed special characters.", "summary": "Invalid profile name (special characters)", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.profiles[0].name" }, "message": "Profile name should not contain the following special character(s) : #, %, &, (, ), *, ^", "status": "error" } ] } }, "PermissionNotAllowed": { "description": "Returned when a permission ID in `permissions_details` is read-only and cannot be toggled.", "summary": "Permission ID cannot be updated", "value": { "profiles": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.profiles[0].permissions_details[0].id" }, "message": "This Permissionid cannot be updated", "status": "error" } ] } }, "PrivateProfileNotAllowed": { "description": "Returned when the target profile is a `private_profile`, which is used exclusively for team modules and cannot be updated through this endpoint.", "summary": "Team Module profile cannot be updated", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Team Module profile cannot be updated", "status": "error" } }, "SystemProfileNotAllowed": { "description": "Returned when the target profile is a built-in system profile that is protected from modifications.", "summary": "System profile cannot be updated", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "System profile cannot be updated", "status": "error" } } }, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileDuplicateDataErrorResponse" } ], "description": "The profile name in the request is already in use by another profile.", "x-zs-$id": "PatchProfileBadRequestDuplicateData" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidProfileNameSpecialCharsErrorResponse" } ], "description": "The profile name contains disallowed special characters.", "x-zs-$id": "PatchProfileBadRequestInvalidProfileNameSpecialChars" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidActionErrorResponse" } ], "description": "The action given in the request is invalid.", "x-zs-$id": "PatchProfileBadRequestInvalidAction" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidPermissionIdErrorResponse" } ], "description": "A permission ID in `permissions_details` is invalid.", "x-zs-$id": "PatchProfileBadRequestInvalidPermissionId" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfilePermissionNotCustomizableErrorResponse" } ], "description": "A permission in `permissions_details` is not customizable.", "x-zs-$id": "PatchProfileBadRequestPermissionNotCustomizable" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse" } ], "description": "`permissions_details` has an unexpected data type (expected JSON object or JSON array).", "x-zs-$id": "PatchProfileBadRequestInvalidPermissionsDetailsDatatype" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileChildPermissionParentDisabledErrorResponse" } ], "description": "A child permission cannot be enabled because its parent permission is disabled.", "x-zs-$id": "PatchProfileBadRequestChildPermissionParentDisabled" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfilePermissionNotAllowedErrorResponse" } ], "description": "A permission ID in `permissions_details` cannot be updated.", "x-zs-$id": "PatchProfileBadRequestPermissionNotAllowed" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileSystemProfileNotAllowedErrorResponse" } ], "description": "The target profile is a system profile and cannot be updated.", "x-zs-$id": "PatchProfileBadRequestSystemProfileNotAllowed" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfilePrivateProfileNotAllowedErrorResponse" } ], "description": "The target profile is a private (team module) profile and cannot be updated.", "x-zs-$id": "PatchProfileBadRequestPrivateProfileNotAllowed" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidIdErrorResponse" } ], "description": "The profile ID is invalid or refers to a deleted profile.", "x-zs-$id": "PatchProfileBadRequestInvalidId" } ], "description": "Error response body for invalid PATCH /settings/profiles/{id} requests.", "x-zs-$id": "PatchProfileBadRequest" } } }, "description": "Invalid update request." }, "401": { "$ref": "#/components/responses/ProfilesUnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ProfilesForbiddenResponse" }, "500": { "$ref": "#/components/responses/ProfilesInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.profiles.UPDATE" ] } ], "summary": "Profile", "tags": [ "profiles" ], "x-zoho-document": "profiles", "x-zs-llm-description": "Partially updates a profile (name, description, and/or permissions_details) by id. Send only the fields to change; permissions_details entries require id." }, "put": { "description": "Replaces the name, description, and permission enablement for the profile identified by `{id}`. System profiles (Administrator, Standard) cannot be updated. See [Update Profile Permission](https://www.zoho.com/crm/developer/docs/api/v8/update-profile-permission.html).", "operationId": "updateProfile", "parameters": [ { "$ref": "#/components/parameters/ProfilesId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdatePermissions": { "description": "A sample request body enabling or disabling specific permissions for the target profile.", "summary": "Update permission enablement for a profile", "value": { "profiles": [ { "description": "Updated description for the profile.", "name": "Updated Profile Name", "permissions_details": [ { "enabled": false, "id": "1408246000000063001" }, { "enabled": true, "id": "1408246000000057001" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for the profile update operation.", "properties": { "profiles": { "description": "Specify a single-item JSON array containing the profile update payload.", "items": { "additionalProperties": false, "description": "Specify the payload for updating the profile.", "minProperties": 1, "properties": { "description": { "description": "Specify the new text description for the profile.", "maxLength": 250, "type": [ "string", "null" ] }, "name": { "description": "Specify the new name for the profile (up to 50 characters).", "maxLength": 50, "type": [ "string", "null" ] }, "permissions_details": { "description": "List of permission toggle entries to apply (up to 2000).", "items": { "additionalProperties": false, "description": "A single permission toggle entry specifying the permission ID and its desired enabled state.", "properties": { "enabled": { "description": "Desired enabled state for the permission.\n**Possible values:**\n`true` to enable, `false` to disable.", "type": "boolean" }, "id": { "description": "The unique identifier of the permission.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfilePermissionDetailsId" } ], "resource": "profiles" } } }, "required": [ "id", "enabled" ], "type": "object" }, "maxItems": 2000, "type": "array" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object" }, "x-zs-llm-examples": [ "UpdatePermissions" ] } }, "description": "Payload containing profile fields and permission enablement entries to update.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Updated": { "description": "A sample response confirming that the profile was updated successfully.", "summary": "Update result", "value": { "profiles": [ { "code": "SUCCESS", "details": { "id": "4670092000001127685" }, "message": "profile updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful response for the profile update operation.", "properties": { "profiles": { "description": "Update results for the profile (up to 50 entries).", "items": { "additionalProperties": false, "description": "Result for the profile update operation.", "properties": { "code": { "description": "Operation result code. Possible values: `SUCCESS`.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details object containing the ID of the updated profile.", "properties": { "id": { "description": "Unique identifier of the updated profile.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable message confirming the update result.", "maxLength": 500, "type": "string" }, "status": { "description": "Operation result status. Possible values: `success`.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "profiles" ], "type": "object", "x-zs-$id": "UpdateProfileResponse" } } }, "description": "Profile updated successfully." }, "400": { "content": { "application/json": { "examples": { "ChildPermissionParentDisabled": { "description": "Returned when a permission toggle entry attempts to enable a child permission whose parent permission is currently disabled.", "summary": "Child permission cannot be enabled because parent is disabled", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.profiles[0].permissions_details[0].id" }, "message": "Child permission can not be enabled, since its parent permission is disabled", "status": "error" } ] } }, "DuplicateData": { "description": "Returned when the updated profile name is already used by another profile in the organization.", "summary": "Duplicate profile name", "value": { "profiles": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.profiles[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidAction": { "description": "Returned when the action given in the request is not a valid operation for profile update.", "summary": "Invalid action", "value": { "profiles": [ { "code": "INVALID_DATA", "details": {}, "message": "The action given is invalid", "status": "error" } ] } }, "InvalidPermissionId": { "description": "Returned when a permission ID supplied in `permissions_details` does not correspond to a valid permission.", "summary": "Invalid permission ID", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.profiles[0].permissions_details[0].id" }, "message": "Invalid permission ID", "status": "error" } ] } }, "InvalidPermissionsDetailsDatatype": { "summary": "Invalid data type for `permissions_details`", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "permissions_details", "expected_data_type": "jsonarray", "json_path": "$.profiles[0].permissions_details" }, "message": "invalid data", "status": "error" } ] } }, "InvalidProfileId": { "description": "Returned when the profile ID in the request path does not match any existing active profile.", "summary": "Invalid or deleted profile ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid or already deleted", "status": "error" } }, "InvalidProfileNameSpecialChars": { "description": "Returned when the updated profile name contains one or more disallowed special characters.", "summary": "Invalid profile name (special characters)", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.profiles[0].name" }, "message": "Profile name should not contain the following special character(s) : #, %, &, (, ), *, ^", "status": "error" } ] } }, "PermissionNotAllowed": { "description": "Returned when a permission ID in `permissions_details` is read-only and cannot be toggled.", "summary": "Permission ID cannot be updated", "value": { "profiles": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.profiles[0].permissions_details[0].id" }, "message": "This Permissionid cannot be updated", "status": "error" } ] } }, "PrivateProfileNotAllowed": { "description": "Returned when the target profile is a `private_profile`, which is used exclusively for team modules and cannot be updated through this endpoint.", "summary": "Team Module profile cannot be updated", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Team Module profile cannot be updated", "status": "error" } }, "SystemProfileNotAllowed": { "description": "Returned when the target profile is a built-in system profile that is protected from modifications.", "summary": "System profile cannot be updated", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "System profile cannot be updated", "status": "error" } } }, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileDuplicateDataErrorResponse" } ], "description": "The profile name in the request is already in use by another profile.", "x-zs-$id": "UpdateProfileBadRequestDuplicateData" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidProfileNameSpecialCharsErrorResponse" } ], "description": "The profile name contains disallowed special characters.", "x-zs-$id": "UpdateProfileBadRequestInvalidProfileNameSpecialChars" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidActionErrorResponse" } ], "description": "The action given in the request is invalid.", "x-zs-$id": "UpdateProfileBadRequestInvalidAction" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidPermissionIdErrorResponse" } ], "description": "A permission ID in `permissions_details` is invalid.", "x-zs-$id": "UpdateProfileBadRequestInvalidPermissionId" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfilePermissionNotCustomizableErrorResponse" } ], "description": "A permission in `permissions_details` is not customizable.", "x-zs-$id": "UpdateProfileBadRequestPermissionNotCustomizable" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse" } ], "description": "`permissions_details` has an unexpected data type (expected JSON object or JSON array).", "x-zs-$id": "UpdateProfileBadRequestInvalidPermissionsDetailsDatatype" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileChildPermissionParentDisabledErrorResponse" } ], "description": "A child permission cannot be enabled because its parent permission is disabled.", "x-zs-$id": "UpdateProfileBadRequestChildPermissionParentDisabled" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfilePermissionNotAllowedErrorResponse" } ], "description": "A permission ID in `permissions_details` cannot be updated.", "x-zs-$id": "UpdateProfileBadRequestPermissionNotAllowed" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileSystemProfileNotAllowedErrorResponse" } ], "description": "The target profile is a system profile and cannot be updated.", "x-zs-$id": "UpdateProfileBadRequestSystemProfileNotAllowed" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfilePrivateProfileNotAllowedErrorResponse" } ], "description": "The target profile is a private (team module) profile and cannot be updated.", "x-zs-$id": "UpdateProfileBadRequestPrivateProfileNotAllowed" }, { "allOf": [ { "$ref": "#/components/schemas/UpdateProfileInvalidIdErrorResponse" } ], "description": "The profile ID is invalid or refers to a deleted profile.", "x-zs-$id": "UpdateProfileBadRequestInvalidId" } ], "description": "Error response body for invalid PUT /settings/profiles/{id} requests.", "x-zs-$id": "UpdateProfileBadRequest" } } }, "description": "Invalid update request." }, "401": { "$ref": "#/components/responses/ProfilesUnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ProfilesForbiddenResponse" }, "500": { "$ref": "#/components/responses/ProfilesInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.profiles.UPDATE" ] } ], "summary": "Specific Profile", "tags": [ "profiles" ], "x-zoho-document": "profiles", "x-zs-llm-description": "Replaces a profile's permission set by id. Before calling: GET /settings/profiles/{id} to read current permissions_details; each entry must carry id." } }, "/crm/v8/settings/profiles/{id}/actions/clone": { "post": { "description": "Creates a new profile by cloning the existing profile identified by `{id}`. The request body must include the new profile's `name`, which must be unique within the organization and must not exceed 50 characters. See [Create a Profile](https://www.zoho.com/crm/developer/docs/api/v8/create-profile.html).", "operationId": "cloneProfile", "parameters": [ { "$ref": "#/components/parameters/ProfilesId" } ], "requestBody": { "content": { "application/json": { "examples": { "Sample": { "description": "A sample request body supplying the name for a new profile to be created by cloning the source profile.", "summary": "Clone profile payload", "value": { "profiles": [ { "description": "Cloned from Standard profile", "name": "Cloned Standard" } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for cloning a profile.", "properties": { "profiles": { "description": "Single-item JSON array containing the new profile definition for the clone operation.", "items": { "additionalProperties": false, "description": "New profile to create from the cloned source.", "properties": { "description": { "description": "A description of the profile. Accepts up to 250 characters.", "maxLength": 250, "type": [ "string", "null" ] }, "name": { "description": "The name of the new profile. Accepts up to 50 characters.", "maxLength": 50, "type": "string" } }, "required": [ "name" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "profiles" ], "type": "object" }, "x-zs-llm-examples": [ "Sample" ] } }, "description": "Profile definition for the new cloned profile.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Created": { "description": "A sample response confirming that the profile was cloned successfully.", "summary": "Clone result", "value": { "profiles": [ { "code": "SUCCESS", "details": { "id": "1697753000033202019" }, "message": "profile created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CloneProfileResponse" } } }, "description": "Profile cloned successfully." }, "400": { "content": { "application/json": { "examples": { "CannotBeCloned": { "description": "Returned when the source profile has a restriction that prevents it from being cloned.", "summary": "Profile cannot be cloned", "value": { "profiles": [ { "code": "INVALID_DATA", "details": {}, "message": "Profile cannot be Cloned", "status": "error" } ] } }, "DuplicateProfileName": { "description": "Returned when the requested name for the cloned profile is already used by another profile.", "summary": "Duplicate profile name", "value": { "profiles": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.profiles[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidCreateRequest": { "description": "Returned when the request body is missing a required field such as `name`.", "summary": "Validation failed", "value": { "profiles": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.profiles[0].name" }, "message": "required field not found", "status": "error" } ] } }, "InvalidProfileNameSpecialChars": { "description": "Returned when the new profile name includes special characters that are not permitted.", "summary": "Invalid profile name", "value": { "profiles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.profiles[0].name" }, "message": "Profile name should not contain the following special character(s) : #, %, &, (, ), *, ^", "status": "error" } ] } }, "LimitExceeded": { "description": "Returned when creating the cloned profile would exceed the organization's maximum allowed profile count.", "summary": "License limit exceeded", "value": { "profiles": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": { "limit": 2 }, "message": "Request exceeds your license limit.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "allOf": [ { "$ref": "#/components/schemas/CloneProfileInvalidIdErrorResponse" } ], "description": "The profile ID in the request path is invalid or refers to a deleted profile.", "x-zs-$id": "CloneProfileBadRequestInvalidId" }, { "allOf": [ { "$ref": "#/components/schemas/CloneProfileInvalidCreateRequestErrorResponse" } ], "description": "The request body is missing a mandatory field (for example, `name`).", "x-zs-$id": "CloneProfileBadRequestInvalidCreateRequest" }, { "allOf": [ { "$ref": "#/components/schemas/CloneProfileDuplicateProfileNameErrorResponse" } ], "description": "The requested profile name already belongs to an existing profile.", "x-zs-$id": "CloneProfileBadRequestDuplicateProfileName" }, { "allOf": [ { "$ref": "#/components/schemas/CloneProfileLicenseLimitExceededErrorResponse" } ], "description": "Cloning would exceed the organization's allowed profile count.", "x-zs-$id": "CloneProfileBadRequestLicenseLimitExceeded" }, { "allOf": [ { "$ref": "#/components/schemas/CloneProfileInvalidProfileNameSpecialCharsErrorResponse" } ], "description": "The new profile name contains disallowed special characters.", "x-zs-$id": "CloneProfileBadRequestInvalidProfileNameSpecialChars" }, { "allOf": [ { "$ref": "#/components/schemas/CloneProfileCannotBeClonedErrorResponse" } ], "description": "The source profile cannot be cloned due to business rules.", "x-zs-$id": "CloneProfileBadRequestCannotBeCloned" } ], "description": "Error response body for invalid POST /settings/profiles/{id}/actions/clone requests.", "x-zs-$id": "CloneProfileBadRequest" } } }, "description": "Invalid clone request." }, "401": { "$ref": "#/components/responses/ProfilesUnauthorizedResponse" }, "403": { "$ref": "#/components/responses/ProfilesForbiddenResponse" }, "500": { "$ref": "#/components/responses/ProfilesInternalServerErrorResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.profiles.CREATE" ] } ], "summary": "Clone a CRM profile", "tags": [ "profiles" ], "x-zoho-document": "profiles", "x-zs-llm-description": "Creates a new profile by cloning the source profile in the path id. Before calling: GET /settings/profiles for the source id. Provide the new profile name in the body." } }, "/crm/v8/settings/record_locking_configurations": { "delete": { "description": "Deletes the record locking configuration(s) for the specified module using the provided configuration IDs.", "operationId": "deleteRecordLockingConfiguration", "parameters": [ { "description": "The API name of the module for which the configuration should be deleted.", "in": "query", "name": "module", "required": true, "schema": { "description": "Module API name. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module names.", "maxLength": 256, "type": "string" } }, { "description": "Comma-separated list of record locking configuration IDs to delete.", "in": "query", "name": "ids", "required": true, "schema": { "description": "Comma-separated IDs of the configurations to delete.", "maxLength": 256, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "summary": "Successful response for deleting a record locking configuration", "value": { "record_locking_configurations": [ { "code": "SUCCESS", "details": { "id": "431525000001114019" }, "message": "record locking configuration deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for a successful deletion.", "properties": { "record_locking_configurations": { "description": "Array containing details of the deleted configuration(s).", "items": { "additionalProperties": false, "description": "Details of a deleted configuration.", "properties": { "code": { "description": "Success code for the operation.", "enum": [ "SUCCESS" ], "maxLength": 256, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the deleted configuration.", "properties": { "id": { "description": "ID of the deleted configuration.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Informational message about the deletion.", "maxLength": 256, "type": "string" }, "status": { "description": "Indicates successful deletion.", "enum": [ "success" ], "maxLength": 256, "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfiguration200Response" } } }, "description": "Successfully deleted the specified record locking configuration(s)." }, "400": { "content": { "application/json": { "examples": { "FeatureNotSupported": { "summary": "Record locking not supported in the user's edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Record Locking Configuration is not supported in your edition", "status": "error" } }, "InvalidData": { "summary": "Invalid configuration ID provided", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidModule": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "NoPermission": { "summary": "User lacks customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "NotAllowed": { "summary": "Attempting to delete a system-created configuration", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Configuration created by system cannot be deleted", "status": "error" } }, "RequiredParamMissing": { "summary": "Missing required `module` parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object.", "properties": { "code": { "description": "Error code identifying the failure reason.", "enum": [ "INVALID_MODULE", "REQUIRED_PARAM_MISSING", "INVALID_DATA", "FEATURE_NOT_SUPPORTED", "NO_PERMISSION", "NOT_ALLOWED" ], "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Empty details for `INVALID_MODULE` or `FEATURE_NOT_SUPPORTED`.", "type": "object", "x-zs-$id": "DeleteRecordLockingConfiguration400ResponseInvalidModuleFeatureNotSupportedDetails" }, { "additionalProperties": false, "description": "Indicates which parameter is missing.", "properties": { "param_name": { "description": "Name of the missing parameter.", "maxLength": 256, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfiguration400ResponseParamNameDetail" }, { "additionalProperties": false, "description": "Indicates which path element is invalid.", "properties": { "resource_path_index": { "description": "Index of the invalid path element.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfiguration400ResponseResourcePathIndexDetail" }, { "additionalProperties": false, "description": "Lists required permissions when permission is denied.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "A required permission name.", "maxLength": 256, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfiguration400ResponsePermissionsDetail" } ], "description": "Additional error details that vary by error code." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfiguration400Response" } } }, "description": "Bad Request - The request could not be processed due to invalid input, missing parameters, unsupported features, or permission issues." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.record_locking_configurations.DELETE" ] } ], "summary": "Delete record locking configuration", "tags": [ "record_locking_configurations" ], "x-zoho-document": "record_locking_configurations" }, "get": { "description": "Retrieves the existing record locking configuration for the specified module.", "operationId": "getRecordLockingConfiguration", "parameters": [ { "$ref": "#/components/parameters/RecordLockingConfigurationsModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "description": "Example response showing the details of a record locking configuration.", "summary": "Successful response for retrieving a record locking configuration", "value": { "record_locking_configurations": [ { "created_by": { "id": "2000000058001", "name": "sivasankar.g" }, "created_time": "2025-11-24T10:43:45+05:30", "excluded_fields": [ { "api_name": "Annual_Revenue", "id": "2000000004846" }, { "api_name": "City", "id": "2000000004924" } ], "feature_type": "record_locking", "id": "2000000066499", "lock_excluded_profiles": [ { "id": "2000000000497", "name": "Administrator" }, { "id": "2000000000499", "name": "Standard" } ], "lock_for_portal_users": true, "lock_type": "both", "locked_for": "all_profiles_except_excluded_profiles", "locking_rules": [ { "criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue", "id": "2000000004846" }, "type": "value", "value": "10" }, "id": "2000000066513", "lock_existing_records": false, "name": "Tesing" } ], "modified_by": { "id": "2000000058001", "name": "sivasankar.g" }, "modified_time": "2025-11-24T10:43:45+05:30", "restricted_actions": [ "update", "delete", "tags", "convert", "change_owner" ], "restricted_communications": [ "send_mail" ], "restricted_custom_buttons": null, "system_defined": false } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the record locking configuration details.", "properties": { "record_locking_configurations": { "description": "Array containing the record locking configuration details.", "items": { "additionalProperties": false, "description": "Details of the record locking configuration.", "properties": { "created_by": { "additionalProperties": false, "description": "User who created the configuration.", "properties": { "id": { "description": "Unique identifier of the user.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the user.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Timestamp when the configuration was created.", "format": "date-time", "type": "string" }, "excluded_fields": { "description": "Fields that are exempt from locking.", "items": { "additionalProperties": false, "description": "Minimal details of an excluded field.", "properties": { "api_name": { "description": "API name of the excluded field.", "maxLength": 256, "type": "string" }, "id": { "description": "Unique identifier of the excluded field.", "maxLength": 32, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "feature_type": { "default": "record_locking", "description": "Feature type identifier (always `record_locking`).", "enum": [ "record_locking" ], "type": "string" }, "id": { "description": "Unique identifier of the configuration.", "maxLength": 32, "type": "string" }, "lock_excluded_profiles": { "description": "Profiles that are excluded from locking.", "items": { "additionalProperties": false, "description": "Minimal details of an excluded profile.", "properties": { "id": { "description": "Unique identifier of the profile.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the profile.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "lock_for_portal_users": { "default": true, "description": "Indicates whether portal users are subject to locking.", "type": "boolean" }, "lock_type": { "description": "The locking mode used for this configuration.", "enum": [ "automatic", "manual", "both" ], "type": "string" }, "locked_for": { "description": "Indicates which profiles the lock applies to.", "enum": [ "all_profiles", "all_profiles_except_excluded_profiles" ], "type": "string" }, "locking_rules": { "description": "List of locking rules defined in the configuration.", "items": { "additionalProperties": false, "description": "Details of a locking rule.", "properties": { "criteria": { "additionalProperties": false, "description": "Criteria that records must match for the rule to apply.", "properties": { "comparator": { "description": "The comparator used in the criteria.", "maxLength": 256, "type": "string" }, "field": { "additionalProperties": false, "description": "Details of the field used in the criteria.", "properties": { "api_name": { "description": "API name of the field.", "maxLength": 256, "type": "string" }, "id": { "description": "Unique identifier of the field.", "maxLength": 32, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Type of the criteria.", "maxLength": 256, "type": "string" }, "value": {} }, "required": [ "comparator", "field", "type" ], "type": "object" }, "id": { "description": "Unique identifier of the locking rule.", "maxLength": 32, "type": "string" }, "lock_existing_records": { "default": false, "description": "Indicates whether existing records are locked when the rule is applied.", "type": "boolean" }, "name": { "description": "Name of the locking rule.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id", "lock_existing_records" ], "type": "object" }, "maxItems": 5, "type": "array" }, "modified_by": { "additionalProperties": false, "description": "User who last modified the configuration.", "properties": { "id": { "description": "Unique identifier of the user.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the user.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "modified_time": { "description": "Timestamp when the configuration was last modified.", "format": "date-time", "type": "string" }, "restricted_actions": { "description": "List of actions that are restricted on locked records.", "items": { "description": "A restricted action.", "enum": [ "change_owner", "update", "delete", "tags", "convert" ], "type": "string" }, "maxItems": 5, "type": "array" }, "restricted_communications": { "description": "List of communication actions restricted on locked records.", "items": { "description": "A restricted communication action.", "enum": [ "send_mail" ], "type": "string" }, "maxItems": 1, "type": "array" }, "restricted_custom_buttons": { "description": "List of custom buttons restricted on locked records (may be null).", "items": { "additionalProperties": false, "description": "Minimal details of a restricted custom button.", "properties": { "id": { "description": "Unique identifier of the custom button.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the custom button.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "type": [ "array", "null" ] }, "system_defined": { "description": "Indicates whether the configuration is system-defined.", "type": "boolean" } }, "required": [ "lock_type", "locked_for", "created_time", "excluded_fields", "feature_type", "locking_rules", "modified_time", "system_defined", "created_by", "modified_by", "id", "lock_for_portal_users", "restricted_communications", "restricted_custom_buttons", "restricted_actions", "lock_excluded_profiles" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "GetRecordLockingConfiguration200Response" } } }, "description": "Successfully retrieved the record locking configuration details for the specified module." }, "204": { "description": "No record locking configuration is configured for the specified module." }, "400": { "content": { "application/json": { "examples": { "FeatureNotSupported": { "summary": "Record locking not supported in the user's edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Record Locking Configuration is not supported in your edition", "status": "error" } }, "InvalidData": { "summary": "Invalid configuration ID provided", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidModule": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "NoPermission": { "summary": "User lacks customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "RequiredParamMissing": { "summary": "Missing required `module` parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object.", "properties": { "code": { "description": "Error code identifying the failure reason.", "enum": [ "INVALID_MODULE", "REQUIRED_PARAM_MISSING", "INVALID_DATA", "FEATURE_NOT_SUPPORTED", "NO_PERMISSION" ], "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Indicates which parameter is missing.", "properties": { "param_name": { "description": "Name of the missing parameter.", "maxLength": 256, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "GetRecordLockingConfiguration400ResponseParamNameDetail" }, { "additionalProperties": false, "description": "Indicates which path element is invalid.", "properties": { "resource_path_index": { "description": "Index of the invalid path element.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "GetRecordLockingConfiguration400ResponseResourcePathIndexDetail" }, { "additionalProperties": false, "description": "Lists required permissions when permission is denied.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "A required permission name.", "enum": [ "Crm_Implied_Customize_Zoho_CRM" ], "maxLength": 256, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "GetRecordLockingConfiguration400ResponsePermissionsDetail" }, { "additionalProperties": false, "description": "Empty details object for errors without additional information.", "type": "object", "x-zs-$id": "GetRecordLockingConfiguration400ResponseMinimalDetailsFallback" } ], "description": "Additional error details that vary by error code." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "GetRecordLockingConfiguration400Response" } } }, "description": "Bad Request - The request could not be processed due to invalid input, missing parameters, unsupported features, or permission issues." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.record_locking_configurations.READ" ] } ], "summary": "Get record locking configuration", "tags": [ "record_locking_configurations" ], "x-zoho-document": "record_locking_configurations" }, "post": { "description": "Creates a new record locking configuration for the specified module. You can define locking rules, restricted actions, excluded fields, and other settings.", "operationId": "createRecordLockingConfiguration", "parameters": [ { "$ref": "#/components/parameters/RecordLockingConfigurationsModule" } ], "requestBody": { "content": { "application/json": { "examples": { "RequestBody": { "summary": "Request body for creating a record locking configuration", "value": { "record_locking_configurations": [ { "excluded_fields": [ { "id": "2000000004846" }, { "id": "2000000004924" } ], "feature_type": "record_locking", "lock_excluded_profiles": [ { "id": "2000000000497" }, { "id": "2000000000495" } ], "lock_for_portal_users": true, "lock_type": "automatic", "locked_for": "all_profiles", "locking_rules": [ { "criteria": { "field": "Amount", "operator": "greater_than", "value": 50000 }, "lock_existing_records": true, "name": "HighValueDealsRule" }, { "criteria": { "field": "Status", "operator": "equals", "value": "Critical" }, "name": "CriticalStatusRule" } ], "restricted_actions": [ "update", "delete" ], "restricted_communications": [ "send_mail" ], "restricted_custom_buttons": [ { "id": "2000000034237" }, { "id": "2000000034564" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for creating a record locking configuration.", "properties": { "record_locking_configurations": { "description": "Array containing the record locking configuration details to be created.", "items": { "additionalProperties": true, "description": "Object representing the record locking configuration to create.", "properties": { "excluded_fields": { "description": "Fields that are exempt from locking. Even if a record is locked, these fields can still be modified.", "items": { "additionalProperties": false, "description": "Field descriptor for a field to be excluded from locking.", "properties": { "id": { "description": "The unique identifier of the field. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve field IDs.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" } ], "resource": "fields" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "feature_type": { "default": "record_locking", "description": "Feature type identifier. Must be `record_locking` for this configuration.", "enum": [ "record_locking" ], "type": "string" }, "lock_excluded_profiles": { "description": "Profiles that are excluded from locking. These profiles can still edit locked records. This property is required when `locked_for` is `all_profiles_except_excluded_profiles`.", "items": { "additionalProperties": false, "description": "Profile descriptor for a profile to be excluded from locking.", "properties": { "id": { "description": "Profile ID. Use the [Get Profiles API](profiles.yaml#$.paths./settings/profiles.get) to retrieve profile IDs.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "lock_for_portal_users": { "default": true, "description": "If `true`, portal users are also subject to the locking restrictions.", "type": "boolean" }, "lock_type": { "description": "Defines the locking mode. `automatic` locks records based on rules, `manual` requires explicit action, `both` supports both.", "enum": [ "automatic", "manual", "both" ], "type": "string" }, "locked_for": { "description": "Indicates which profiles the lock applies to. Use `all_profiles` for everyone, or `all_profiles_except_excluded_profiles` to exclude specific profiles.", "enum": [ "all_profiles", "all_profiles_except_excluded_profiles" ], "type": "string" }, "locking_rules": { "description": "A set of rules that define when records should be automatically locked. Each rule contains criteria that records must match to be locked.", "items": { "additionalProperties": false, "description": "A locking rule object.", "properties": { "criteria": { "additionalProperties": true, "description": "Criteria that records must satisfy for the rule to apply. The structure depends on the field type and operator.", "type": "object" }, "lock_existing_records": { "default": false, "description": "If `true`, existing records that match the criteria will also be locked when the rule is saved.", "type": "boolean" }, "name": { "description": "Unique name for the locking rule.", "maxLength": 256, "type": "string" } }, "required": [ "name", "criteria" ], "type": "object" }, "maxItems": 5, "type": "array" }, "restricted_actions": { "description": "List of actions that are restricted on locked records. These actions cannot be performed on locked records.", "items": { "default": "update", "description": "A restricted action that is prohibited on locked records.", "enum": [ "change_owner", "update", "delete", "tags" ], "type": "string" }, "maxItems": 10, "type": "array" }, "restricted_communications": { "description": "List of communication actions that are restricted for locked records.", "items": { "description": "A restricted communication action that is prohibited on locked records.", "enum": [ "send_mail" ], "type": "string" }, "maxItems": 10, "type": "array" }, "restricted_custom_buttons": { "description": "List of custom buttons that are restricted on locked records. These buttons cannot be used on locked records.", "items": { "additionalProperties": false, "description": "Descriptor of a restricted custom button.", "properties": { "id": { "description": "Unique identifier of the custom button.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getCustomButtons", "propertyId": "CustomButtonId" } ], "resource": "custom_button_api" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 30, "type": "array" } }, "required": [ "lock_type" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessCase": { "summary": "Successful response for creating a record locking configuration", "value": { "record_locking_configurations": [ { "code": "SUCCESS", "details": { "id": "431525000001114019" }, "message": "record locking configuration created successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for a successful configuration creation.", "properties": { "record_locking_configurations": { "description": "Array containing details of the created record locking configuration.", "items": { "additionalProperties": false, "description": "Details of the created record locking configuration.", "properties": { "code": { "description": "Success code for the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the created configuration.", "properties": { "id": { "description": "Unique identifier of the newly created record locking configuration.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Informational message about the creation.", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates that the creation operation was successful.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration201Response" } } }, "description": "Successfully created the record locking configuration for the specified module." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "summary": "Ambiguity when `id` and `api_name` refer to different fields", "value": { "record_locking_configurations": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[0].api_name" }, { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[0].id" } ] }, "message": "Field Id and apiname are ambiguous", "status": "error" } ] } }, "DependentFieldMissingExcludedProfiles": { "summary": "Missing `lock_excluded_profiles` when `locked_for` is `all_profiles_except_excluded_profiles`", "value": { "record_locking_configurations": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "lock_excluded_profiles", "dependee": { "api_name": "locked_for", "json_path": "$.record_locking_configurations[0].locked_for" }, "json_path": "$.record_locking_configurations[0].lock_excluded_profiles" }, "message": "lock_excluded_profiles should have been given when locked_for is given as all_profiles_except_excluded_profiles ", "status": "error" } ] } }, "DependentFieldMissingLocktype": { "summary": "Missing `locking_rules` when `lock_type` is `automatic` or `both`", "value": { "record_locking_configurations": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "locking_rules", "dependee": { "api_name": "lock_type", "json_path": "$.record_locking_configurations[0].lock_type" }, "json_path": "$.record_locking_configurations[0].locking_rules" }, "message": "locking_rules should have been given when lock_type is given as automatic or both", "status": "error" } ] } }, "DuplicateDataCriteria": { "summary": "Duplicate criteria found among locking rules", "value": { "record_locking_configurations": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "criteria", "json_path": "$.record_locking_configurations[0].locking_rules[1].criteria" }, "message": "Duplicate criteria found, Enter unique criteria.", "status": "error" } ] } }, "DuplicateDataRulename": { "summary": "Duplicate rule name found", "value": { "record_locking_configurations": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.record_locking_configurations[0].locking_rules[1].name" }, "message": "Duplicate rule name found, Enter unique rulename.", "status": "error" } ] } }, "ExpectedFieldMissingExcludedFields": { "summary": "Missing both `id` and `api_name` for an excluded field", "value": { "record_locking_configurations": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[0].api_name" }, { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[0].id" } ] }, "message": "Field Id and apiname is missing.", "status": "error" } ] } }, "FeatureNotSupported": { "summary": "Record locking not supported in the user's edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Record Locking Configuration is not supported in your edition", "status": "error" } }, "InvalidDataFieldsId": { "summary": "Invalid or missing field ID", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[4].id" }, "message": "field not found", "status": "error" } ] } }, "InvalidExcludedProfileData": { "summary": "Invalid profile ID in `lock_excluded_profiles`", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].lock_excluded_profiles[0].id" }, "message": "lock_excluded_profiles not found", "status": "error" } ] } }, "InvalidFeaturetypeData": { "summary": "Invalid feature type (must be `record_locking`)", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.record_locking_configurations[0].feature_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidFieldData": { "summary": "The provided field API name is incorrect or does not exist", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].locking_rules[0].criteria.fields.api_name" }, "message": "field not found", "status": "error" } ] } }, "InvalidLockedforData": { "summary": "Invalid `locked_for` value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "locked_for", "json_path": "$.record_locking_configurations[0].locked_for", "supported_values": [ "all_profiles", "all_profiles_except_excluded_profiles" ] }, "message": "locked_for not found", "status": "error" } ] } }, "InvalidLocktypeData": { "summary": "Invalid lock type value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "lock_type", "json_path": "$.record_locking_configurations[0].lock_type", "supported_values": [ "manual", "automatic", "both" ] }, "message": "lock_type not found", "status": "error" } ] } }, "InvalidModuleData": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRestrictedActionData": { "summary": "Invalid restricted action value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "restricted_actions", "json_path": "$.record_locking_configurations[0].restricted_actions[1]", "supported_values": [ "convert", "update", "delete", "change_owner", "tags" ] }, "message": "action not found", "status": "error" } ] } }, "InvalidRestrictedCommunicationData": { "summary": "Invalid restricted communication value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "restricted_communications", "json_path": "$.record_locking_configurations[0].restricted_communications[1]", "supported_values": [ "send_mail", "send_survey", "send_portal_invitation" ] }, "message": "communications not found", "status": "error" } ] } }, "InvalidRestrictedCustomButtonData": { "summary": "Invalid custom button ID", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].restricted_custom_buttons[0].id" }, "message": "custom button not found", "status": "error" } ] } }, "LimitExceededConfiguration": { "summary": "A configuration already exists for the module", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 1, "param_name": "module" }, "message": "Configuration already created for this module", "status": "error" } }, "LimitExceededCustomButtons": { "summary": "Exceeded maximum number of restricted custom buttons", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "restricted_custom_buttons", "available_limit": 2, "json_path": "$.record_locking_configurations[0].restricted_custom_buttons", "limit": 30 }, "message": "Maximum limit for restricted custom buttons exceeded", "status": "error" } ] } }, "LimitExceededExcludedFields": { "summary": "Exceeded maximum number of excluded fields", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "excluded_fields", "available_limit": 2, "json_path": "$.record_locking_configurations[0].excluded_fields", "limit": 15 }, "message": "Maximum limit for excluded fields exceeded", "status": "error" } ] } }, "LimitExceededExcludedProfiles": { "summary": "Exceeded maximum number of excluded profiles", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "lock_excluded_profiles", "available_limit": 2, "json_path": "$.record_locking_configurations[0].lock_excluded_profiles", "limit": 15 }, "message": "Maximum limit for excluded profiles exceeded", "status": "error" } ] } }, "LimitExceededLockrules": { "summary": "Exceeded maximum number of locking rules", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "locking_rules", "available_limit": 2, "json_path": "$.record_locking_configurations[0].locking_rules", "limit": 5 }, "message": "Maximum limit for locking rules exceeded", "status": "error" } ] } }, "MandatoryNotFoundLocktype": { "summary": "Missing required `lock_type` field", "value": { "record_locking_configurations": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "lock_type", "json_path": "$.record_locking_configurations[0].lock_type" }, "message": "required field not found", "status": "error" } ] } }, "NoPermission": { "summary": "User lacks customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "NotSupportedApiname": { "summary": "Unsupported field (e.g., Tag, Owner, read-only) used in excluded fields", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[4].api_name" }, "message": "Field not supported", "status": "error" } ] } }, "NotSupportedCommunication": { "summary": "Restricted communication not supported", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "restricted_communications", "json_path": "$.record_locking_configurations[0].restricted_communications" }, "message": "communications not found", "status": "error" } ] } }, "NotSupportedField": { "summary": "Unsupported field used in criteria", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].locking_rules[0].criteria.group[0].field.api_name" }, "message": "field not supported", "status": "error" } ] } }, "NotSupportedModule": { "summary": "Module does not support record locking", "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "the module name given is not supported for the feature", "status": "error" } }, "RequiredParamMissing": { "summary": "Missing required `module` parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "additionalProperties": true, "anyOf": [ { "additionalProperties": false, "description": "Simple error envelope for parameter, module, or permission errors.", "properties": { "code": { "description": "Error code that identifies the failure reason.", "enum": [ "INVALID_MODULE", "REQUIRED_PARAM_MISSING", "INVALID_DATA", "FEATURE_NOT_SUPPORTED", "NO_PERMISSION", "NOT_SUPPORTED", "LIMIT_EXCEEDED", "MANDATORY_NOT_FOUND", "DEPENDENT_FIELD_MISSING", "DUPLICATE_DATA" ], "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Indicates which parameter is missing.", "properties": { "param_name": { "description": "Name of the missing parameter.", "maxLength": 256, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response1ParamMissingDetails" }, { "additionalProperties": false, "description": "Indicates which path element is invalid.", "properties": { "resource_path_index": { "description": "Index of the invalid path element.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response1ResourcePathIndexDetails" }, { "additionalProperties": false, "description": "Lists required permissions when permission is denied.", "properties": { "permissions": { "description": "List of permissions required to perform the operation.", "items": { "description": "A required permission name.", "maxLength": 256, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response1PermissionDetails" }, { "additionalProperties": false, "description": "Provides limit details when a limit is exceeded.", "properties": { "available_limit": { "description": "Remaining available capacity, if applicable.", "format": "int32", "type": "integer" }, "limit": { "description": "The maximum allowed value.", "format": "int32", "type": "integer" }, "param_name": { "description": "Parameter name that hit the limit (e.g., module).", "maxLength": 256, "type": "string" } }, "required": [ "limit" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response1LimitExceededDetails" }, { "additionalProperties": false, "description": "Empty details object used by some error codes.", "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response1EmptyDetails" } ], "description": "Additional information that varies by error code." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response1" }, { "additionalProperties": false, "description": "Array-wrapped error envelope for record-locking-configuration errors.", "properties": { "record_locking_configurations": { "description": "Array containing a single error object for the configuration item.", "items": { "additionalProperties": false, "description": "Error object for a specific locking configuration.", "properties": { "code": { "description": "Error code for the configuration error.", "enum": [ "INVALID_DATA", "NOT_SUPPORTED", "LIMIT_EXCEEDED", "DEPENDENT_FIELD_MISSING", "MANDATORY_NOT_FOUND", "EXPECTED_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING", "DUPLICATE_DATA" ], "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Indicates a field-related error with API name and JSON path.", "properties": { "api_name": { "description": "API name of the field involved.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path pointing to the location of the error.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2FieldDetail" }, { "additionalProperties": false, "description": "Lists supported values when an invalid value is provided.", "properties": { "api_name": { "description": "API name of the field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path to the error location.", "maxLength": 256, "type": "string" }, "supported_values": { "description": "List of allowed values.", "items": { "description": "A supported value.", "maxLength": 256, "type": "string" }, "maxItems": 15, "type": "array" } }, "required": [ "supported_values", "api_name", "json_path" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2SupportedValuesDetail" }, { "additionalProperties": false, "description": "Provides limit details for nested arrays (locking rules, excluded fields, etc.).", "properties": { "api_name": { "description": "API name of the array that exceeded the limit.", "maxLength": 256, "type": "string" }, "available_limit": { "description": "Remaining available count, if positive.", "format": "int32", "type": "integer" }, "json_path": { "description": "JSON path to the array location.", "maxLength": 256, "type": "string" }, "limit": { "description": "Maximum allowed count.", "format": "int32", "type": "integer" } }, "required": [ "limit", "api_name", "json_path" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2LimitExceededNestedDetail" }, { "additionalProperties": false, "description": "Indicates a missing dependent field.", "properties": { "api_name": { "description": "API name of the missing dependent field.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Information about the field that is causing the dependency.", "properties": { "api_name": { "description": "API name of the dependee field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the dependee field.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path of the missing dependent field.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2DependeeDetail" }, { "additionalProperties": false, "description": "Lists expected fields when both `id` and `api_name` are missing.", "properties": { "expected_fields": { "description": "List of expected field descriptors (each with JSON path and API name).", "items": { "additionalProperties": false, "description": "Descriptor for an expected field.", "properties": { "api_name": { "description": "API name of the expected field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the expected field.", "maxLength": 256, "type": "string" } }, "required": [ "json_path", "api_name" ], "type": "object" }, "maxItems": 15, "type": "array" } }, "required": [ "expected_fields" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2ExpectedFieldsDetail" }, { "additionalProperties": false, "description": "Indicates ambiguity when `id` and `api_name` refer to different fields.", "properties": { "ambiguity_due_to": { "description": "List of ambiguous field descriptors.", "items": { "additionalProperties": false, "description": "Descriptor for an ambiguous field.", "properties": { "api_name": { "description": "API name of the ambiguous field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the ambiguous field.", "maxLength": 256, "type": "string" } }, "required": [ "json_path", "api_name" ], "type": "object" }, "maxItems": 15, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2AmbiguityDueToDetail" }, { "additionalProperties": false, "description": "Minimal details fallback when no specific fields apply.", "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2MinimalDetail" } ], "description": "Detailed metadata for the configuration error. The structure varies by error type." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400Response2" } ], "description": "Union of a simple error object or an array-wrapped error envelope.", "type": "object", "x-zs-$id": "CreateRecordLockingConfiguration400ResponseWrapper" } } }, "description": "Bad Request - The request could not be processed due to invalid syntax, missing parameters, or invalid data." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.record_locking_configurations.CREATE" ] } ], "summary": "Create record locking configuration", "tags": [ "record_locking_configurations" ], "x-zoho-document": "record_locking_configurations" }, "put": { "description": "Updates an existing record locking configuration for the specified module. You can modify any of the configuration settings.", "operationId": "updateRecordLockingConfiguration", "parameters": [ { "$ref": "#/components/parameters/RecordLockingConfigurationsModule" } ], "requestBody": { "content": { "application/json": { "examples": { "RequestBody": { "summary": "Request body for updating a record locking configuration", "value": { "record_locking_configurations": [ { "excluded_fields": [ { "id": "2000000004846" }, { "id": "2000000004924" } ], "feature_type": "record_locking", "id": "2000000066499", "lock_excluded_profiles": [ { "id": "2000000000497" }, { "id": "2000000000499" } ], "lock_for_portal_users": true, "lock_type": "both", "locked_for": "all_profiles", "locking_rules": [ { "criteria": { "amount": { "gte": 50000 } }, "id": "2000000066513", "lock_existing_records": true, "name": "High Value Deal Lock" } ], "restricted_actions": [ "update", "delete", "change_owner" ], "restricted_communications": [ "send_mail" ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for updating a record locking configuration.", "properties": { "record_locking_configurations": { "description": "Array containing the updated record locking configuration.", "items": { "additionalProperties": false, "description": "The record locking configuration object to update.", "properties": { "excluded_fields": { "description": "Fields that are exempt from locking. Even if a record is locked, these fields can still be modified.", "items": { "additionalProperties": false, "description": "Field descriptor for a field to be excluded from locking.", "properties": { "id": { "description": "The unique identifier of the field. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve field IDs.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" } ], "resource": "fields" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "feature_type": { "default": "record_locking", "description": "Feature type identifier. Must be `record_locking`.", "enum": [ "record_locking" ], "type": "string" }, "id": { "description": "Unique identifier of the record locking configuration to update. This field is required.", "maxLength": 32, "type": "string" }, "lock_excluded_profiles": { "description": "Profiles that are excluded from locking. This property is required when `locked_for` is `all_profiles_except_excluded_profiles`.", "items": { "additionalProperties": false, "description": "Profile descriptor for a profile to be excluded from locking.", "properties": { "id": { "description": "Profile ID. Use the [Get Profiles API](profiles.yaml#$.paths./settings/profiles.get) to retrieve profile IDs.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "lock_for_portal_users": { "default": true, "description": "If `true`, portal users are also subject to the locking restrictions.", "type": "boolean" }, "lock_type": { "description": "Defines the locking mode. `automatic` locks records based on rules, `manual` requires explicit action, `both` supports both.", "enum": [ "automatic", "manual", "both" ], "type": "string" }, "locked_for": { "description": "Indicates which profiles the lock applies to. Use `all_profiles` for everyone, or `all_profiles_except_excluded_profiles` to exclude specific profiles.", "enum": [ "all_profiles", "all_profiles_except_excluded_profiles" ], "type": "string" }, "locking_rules": { "description": "A set of rules that define when records should be automatically locked.", "items": { "additionalProperties": false, "description": "A locking rule object.", "properties": { "criteria": { "additionalProperties": true, "description": "Criteria that records must satisfy for the rule to apply.", "type": "object" }, "id": { "description": "Unique identifier of the locking rule. Required when updating an existing rule.", "maxLength": 32, "type": "string" }, "lock_existing_records": { "default": false, "description": "If `true`, existing records that match the criteria will also be locked when the rule is saved.", "type": "boolean" }, "name": { "description": "Unique name for the locking rule.", "maxLength": 256, "type": "string" } }, "required": [ "name", "criteria" ], "type": "object" }, "maxItems": 5, "type": "array" }, "restricted_actions": { "description": "List of actions that are restricted on locked records.", "items": { "default": "update", "description": "A restricted action that is prohibited on locked records.", "enum": [ "change_owner", "update", "delete", "tags" ], "type": "string" }, "maxItems": 10, "type": "array" }, "restricted_communications": { "description": "List of communication actions that are restricted for locked records.", "items": { "description": "A restricted communication action.", "enum": [ "send_mail" ], "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "summary": "Successful response for updating a record locking configuration", "value": { "record_locking_configurations": [ { "code": "SUCCESS", "details": { "id": "431525000001114019" }, "message": "record locking configuration updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for a successful configuration update.", "properties": { "record_locking_configurations": { "description": "Array containing the update response.", "items": { "additionalProperties": false, "description": "Details of the updated record locking configuration.", "properties": { "code": { "description": "Success code for the operation.", "enum": [ "SUCCESS" ], "maxLength": 256, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the updated configuration.", "properties": { "id": { "description": "Unique identifier of the updated configuration.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Informational message about the update.", "maxLength": 256, "type": "string" }, "status": { "description": "Indicates that the update was successful.", "enum": [ "success" ], "maxLength": 256, "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration200Response" } } }, "description": "Successfully updated the record locking configuration for the specified module." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "summary": "Ambiguity when `id` and `api_name` refer to different fields", "value": { "record_locking_configurations": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[0].api_name" }, { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[0].id" } ] }, "message": "Field Id and apiname are ambiguous", "status": "error" } ] } }, "DependentFieldMissingExcludedProfiles": { "summary": "Missing `lock_excluded_profiles` when `locked_for` is `all_profiles_except_excluded_profiles`", "value": { "record_locking_configurations": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "lock_excluded_profiles", "dependee": { "api_name": "locked_for", "json_path": "$.record_locking_configurations[0].locked_for" }, "json_path": "$.record_locking_configurations[0].lock_excluded_profiles" }, "message": "lock_excluded_profiles should have been given when locked_for is given as all_profiles_except_excluded_profiles ", "status": "error" } ] } }, "DependentFieldMissingLockType": { "summary": "Missing `locking_rules` when `lock_type` is `automatic` or `both`", "value": { "record_locking_configurations": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "locking_rules", "dependee": { "api_name": "lock_type", "json_path": "$.record_locking_configurations[0].lock_type" }, "json_path": "$.record_locking_configurations[0].locking_rules" }, "message": "locking_rules should have been given when lock_type is given as automatic or both", "status": "error" } ] } }, "DuplicateDataCriteria": { "summary": "Duplicate criteria found among locking rules", "value": { "record_locking_configurations": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "criteria", "json_path": "$.record_locking_configurations[0].locking_rules[1].criteria" }, "message": "Duplicate criteria found, Enter unique criteria.", "status": "error" } ] } }, "DuplicateDataRuleName": { "summary": "Duplicate rule name found", "value": { "record_locking_configurations": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.record_locking_configurations[0].locking_rules[1].name" }, "message": "Duplicate rule name found, Enter unique rulename.", "status": "error" } ] } }, "ExpectedFieldMissingError": { "summary": "Missing both `id` and `api_name` for an excluded field", "value": { "record_locking_configurations": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[0].api_name" }, { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[0].id" } ] }, "message": "Field Id and apiname is missing.", "status": "error" } ] } }, "FeatureNotSupported": { "summary": "Record locking not supported in the user's edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Record Locking Configuration is not supported in your edition", "status": "error" } }, "InvalidDataCustomButtonData": { "summary": "Invalid custom button ID", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].restricted_custom_buttons[0].id" }, "message": "custom button not found", "status": "error" } ] } }, "InvalidDataExcludedProfiles": { "summary": "Invalid profile ID in `lock_excluded_profiles`", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].lock_excluded_profiles[0].id" }, "message": "lock_excluded_profiles not found", "status": "error" } ] } }, "InvalidDataExcludedsFieldsData": { "summary": "Invalid or missing field ID", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[4].id" }, "message": "field not found", "status": "error" } ] } }, "InvalidDataFieldsData": { "summary": "The provided field API name is incorrect or does not exist", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].locking_rules[0].criteria.fields.api_name" }, "message": "field not found", "status": "error" } ] } }, "InvalidDataLockType": { "summary": "Invalid feature type (must be `record_locking`)", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.record_locking_configurations[0].feature_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataLockedForDetails": { "summary": "Invalid `locked_for` value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "locked_for", "json_path": "$.record_locking_configurations[0].locked_for", "supported_values": [ "all_profiles", "all_profiles_except_excluded_profiles" ] }, "message": "locked_for not found", "status": "error" } ] } }, "InvalidDataLocktypeData": { "summary": "Invalid lock type value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "lock_type", "json_path": "$.record_locking_configurations[0].lock_type", "supported_values": [ "manual", "automatic", "both" ] }, "message": "lock_type not found", "status": "error" } ] } }, "InvalidDataRestrictedCommunication": { "summary": "Invalid restricted communication value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "restricted_communications", "json_path": "$.record_locking_configurations[0].restricted_communications[1]", "supported_values": [ "send_mail", "send_survey", "send_portal_invitation" ] }, "message": "communications not found", "status": "error" } ] } }, "InvalidDataRestrictedData": { "summary": "Invalid restricted action value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "restricted_actions", "json_path": "$.record_locking_configurations[0].restricted_actions[1]", "supported_values": [ "convert", "update", "delete", "change_owner", "tags" ] }, "message": "action not found", "status": "error" } ] } }, "InvalidModuleData": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "LimitExceededForCustomButtons": { "summary": "Exceeded maximum number of restricted custom buttons", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "restricted_custom_buttons", "available_limit": 2, "json_path": "$.record_locking_configurations[0].restricted_custom_buttons", "limit": 30 }, "message": "Maximum limit for restricted custom buttons exceeded", "status": "error" } ] } }, "LimitExceededForExcludedFields": { "summary": "Exceeded maximum number of excluded fields", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "excluded_fields", "available_limit": 2, "json_path": "$.record_locking_configurations[0].excluded_fields", "limit": 15 }, "message": "Maximum limit for excluded fields exceeded", "status": "error" } ] } }, "LimitExceededForExcludedProfiles": { "summary": "Exceeded maximum number of excluded profiles", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "lock_excluded_profiles", "available_limit": 2, "json_path": "$.record_locking_configurations[0].lock_excluded_profiles", "limit": 15 }, "message": "Maximum limit for excluded profiles exceeded", "status": "error" } ] } }, "LimitExceededLockRule": { "summary": "Exceeded maximum number of locking rules", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "locking_rules", "available_limit": 2, "json_path": "$.record_locking_configurations[0].locking_rules", "limit": 5 }, "message": "Maximum limit for locking rules exceeded", "status": "error" } ] } }, "NoPermission": { "summary": "User lacks customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "NotAllowedSystemConfigUpdate": { "summary": "Attempting to update a system-created configuration", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Configuration created by system cannot be updated", "status": "error" } }, "NotSupportedFieldData": { "summary": "Unsupported field (e.g., Tag, Owner, read-only) used in excluded fields", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[4].api_name" }, "message": "Field not supported", "status": "error" } ] } }, "NotSupportedFieldDataError": { "summary": "Unsupported field used in criteria", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].locking_rules[0].criteria.group[0].field.api_name" }, "message": "field not supported", "status": "error" } ] } }, "NotSupportedModuleData": { "summary": "Module does not support record locking", "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "the module name given is not supported for the feature", "status": "error" } }, "NotSupportedRestrictedCommunication": { "summary": "Restricted communication not supported", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "restricted_communications", "json_path": "$.record_locking_configurations[0].restricted_communications" }, "message": "communications not found", "status": "error" } ] } }, "RequiredParamMissingModule": { "summary": "Missing required `module` parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Flat error response object.", "properties": { "code": { "description": "Error code identifying the failure reason.", "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Indicates which parameter is missing.", "properties": { "param_name": { "description": "Name of the missing parameter.", "maxLength": 256, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response1MissingParameterDetail" }, { "additionalProperties": false, "description": "Indicates which path element is invalid.", "properties": { "resource_path_index": { "description": "Index of the invalid path element.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response1ResourcePathIndexDetail" }, { "additionalProperties": false, "description": "Lists required permissions when permission is denied.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "A required permission name.", "maxLength": 256, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response1PermissionDetail" }, { "additionalProperties": false, "description": "Provides limit details when a limit is exceeded.", "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response1LimitDetail" } ], "description": "Additional error details that vary by error code." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response1" }, { "additionalProperties": false, "description": "Array-wrapped error envelope for record-locking-configuration errors.", "properties": { "record_locking_configurations": { "description": "Array of error objects for the configuration item.", "items": { "additionalProperties": false, "description": "Error object for a specific locking configuration.", "properties": { "code": { "description": "Error code for the configuration error.", "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Field-related error with API name and JSON path.", "properties": { "api_name": { "description": "API name of the field involved.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path to the error location.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2ApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Lists supported values when an invalid value is provided.", "properties": { "api_name": { "description": "API name of the field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path to the error location.", "maxLength": 256, "type": "string" }, "supported_values": { "description": "List of allowed values.", "items": { "description": "A supported value.", "maxLength": 256, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "supported_values", "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2SupportedValuesApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Provides limit details for nested arrays.", "properties": { "api_name": { "description": "API name of the array that exceeded the limit.", "maxLength": 256, "type": "string" }, "available_limit": { "description": "Remaining available count, if positive.", "format": "int32", "type": "integer" }, "json_path": { "description": "JSON path to the array location.", "maxLength": 256, "type": "string" }, "limit": { "description": "Maximum allowed count.", "format": "int32", "type": "integer" } }, "required": [ "limit", "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2LimitAvailableLimitApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Indicates a missing dependent field.", "properties": { "api_name": { "description": "API name of the missing dependent field.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Information about the field that is causing the dependency.", "properties": { "api_name": { "description": "API name of the dependee field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the dependee field.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path of the missing dependent field.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2DependeeApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Lists expected fields when both `id` and `api_name` are missing.", "properties": { "expected_fields": { "description": "List of expected field descriptors.", "items": { "additionalProperties": false, "description": "Descriptor for an expected field.", "properties": { "api_name": { "description": "API name of the expected field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the expected field.", "maxLength": 256, "type": "string" } }, "required": [ "json_path", "api_name" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "expected_fields" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2ExpectedFieldsDetail" }, { "additionalProperties": false, "description": "Indicates ambiguity when `id` and `api_name` refer to different fields.", "properties": { "ambiguity_due_to": { "description": "List of ambiguous field descriptors.", "items": { "additionalProperties": false, "description": "Descriptor for an ambiguous field.", "properties": { "api_name": { "description": "API name of the ambiguous field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the ambiguous field.", "maxLength": 256, "type": "string" } }, "required": [ "json_path", "api_name" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2AmbiguityDueToDetail" }, { "additionalProperties": false, "description": "Minimal or empty details fallback.", "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2MinimalDetailsFallback" } ], "description": "Detailed metadata for the configuration error. The structure varies by error type." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfiguration400Response2" } ], "description": "Union of a flat error object or an array-wrapped error envelope.", "x-zs-$id": "UpdateRecordLockingConfiguration400ResponseWrapper" } } }, "description": "Bad Request - The request could not be processed due to invalid input, missing parameters, unsupported features, or permission issues." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.record_locking_configurations.UPDATE" ] } ], "summary": "Update record locking configuration", "tags": [ "record_locking_configurations" ], "x-zoho-document": "record_locking_configurations" } }, "/crm/v8/settings/record_locking_configurations/{id}": { "delete": { "description": "Deletes a specific record locking configuration using the configuration ID provided in the URL path.", "operationId": "deleteRecordLockingConfigurationPassingIdInURL", "parameters": [ { "$ref": "#/components/parameters/RecordLockingConfigurationsId" }, { "description": "API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module names.", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 256, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "summary": "Successful response for deleting a specific configuration", "value": { "record_locking_configurations": [ { "code": "SUCCESS", "details": { "id": "431525000001114019" }, "message": "record locking configuration deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for a successful deletion.", "properties": { "record_locking_configurations": { "description": "Array containing the deletion response.", "items": { "additionalProperties": false, "description": "Details of the deleted configuration.", "properties": { "code": { "description": "Success code for the operation.", "enum": [ "SUCCESS" ], "maxLength": 256, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the deleted configuration.", "properties": { "id": { "description": "ID of the deleted configuration.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Informational message about the deletion.", "maxLength": 256, "type": "string" }, "status": { "description": "Indicates successful deletion.", "enum": [ "success" ], "maxLength": 256, "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfigurationById200Response" } } }, "description": "Successfully deleted the specified record locking configuration." }, "400": { "content": { "application/json": { "examples": { "FeatureNotSupported": { "summary": "Record locking not supported in the user's edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Record Locking Configuration is not supported in your edition", "status": "error" } }, "InvalidData": { "summary": "Invalid configuration ID provided", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidModule": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "NoPermission": { "summary": "User lacks customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "NotAllowed": { "summary": "Attempting to delete a system-created configuration", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Configuration created by system cannot be deleted", "status": "error" } }, "RequiredParamMissing": { "summary": "Missing required `module` parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object.", "properties": { "code": { "description": "Error code identifying the failure reason.", "enum": [ "INVALID_MODULE", "REQUIRED_PARAM_MISSING", "INVALID_DATA", "FEATURE_NOT_SUPPORTED", "NO_PERMISSION", "NOT_ALLOWED" ], "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Empty details for `INVALID_MODULE` or `FEATURE_NOT_SUPPORTED`.", "properties": {}, "type": "object", "x-zs-$id": "DeleteRecordLockingConfigurationById400ResponseEmptyDetail" }, { "additionalProperties": false, "description": "Indicates which parameter is missing.", "properties": { "param_name": { "description": "Name of the missing parameter.", "maxLength": 256, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfigurationById400ResponseRequiredParamMissingDetail" }, { "additionalProperties": false, "description": "Indicates which path element is invalid.", "properties": { "resource_path_index": { "description": "Index of the invalid path element.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfigurationById400ResponseInvalidPathElementDetail" }, { "additionalProperties": false, "description": "Lists required permissions when permission is denied.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "A required permission name.", "maxLength": 256, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfigurationById400ResponseNoPermissionDetail" } ], "description": "Additional error details that vary by error code." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "DeleteRecordLockingConfigurationById400Response" } } }, "description": "Bad Request - The request could not be processed due to invalid input, missing parameters, unsupported features, or permission issues." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.record_locking_configurations.DELETE" ] } ], "summary": "Delete specific record locking configuration", "tags": [ "record_locking_configurations" ], "x-zoho-document": "record_locking_configurations" }, "get": { "description": "Retrieves a specific record locking configuration using the configuration ID provided in the URL path.", "operationId": "getRecordLockingConfigurationPassingIdInURL", "parameters": [ { "description": "API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module names.", "in": "query", "name": "module", "required": true, "schema": { "maxLength": 256, "type": "string" } }, { "$ref": "#/components/parameters/RecordLockingConfigurationsId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "description": "Example response showing the details of a record locking configuration.", "summary": "Successful response for retrieving a specific record locking configuration", "value": { "record_locking_configurations": [ { "created_by": { "id": "2000000058001", "name": "sivasankar.g" }, "created_time": "2025-11-24T10:43:45+05:30", "excluded_fields": [ { "api_name": "Annual_Revenue", "id": "2000000004846" }, { "api_name": "City", "id": "2000000004924" } ], "feature_type": "record_locking", "id": "2000000066499", "lock_excluded_profiles": [ { "id": "2000000000497", "name": "Administrator" }, { "id": "2000000000499", "name": "Standard" } ], "lock_for_portal_users": true, "lock_type": "both", "locked_for": "all_profiles_except_excluded_profiles", "locking_rules": [ { "criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue", "id": "2000000004846" }, "type": "value", "value": "10" }, "id": "2000000066513", "lock_existing_records": false, "name": "Tesing" } ], "modified_by": { "id": "2000000058001", "name": "sivasankar.g" }, "modified_time": "2025-11-24T10:43:45+05:30", "restricted_actions": [ "update", "delete", "tags", "convert", "change_owner" ], "restricted_communications": [ "send_mail" ], "restricted_custom_buttons": null, "system_defined": false } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the record locking configuration details.", "properties": { "record_locking_configurations": { "description": "Array containing the record locking configuration details.", "items": { "additionalProperties": false, "description": "Details of the record locking configuration.", "properties": { "created_by": { "additionalProperties": false, "description": "User who created the configuration.", "properties": { "id": { "description": "Unique identifier of the user.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the user.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Timestamp when the configuration was created.", "format": "date-time", "type": "string" }, "excluded_fields": { "description": "Fields that are exempt from locking.", "items": { "additionalProperties": false, "description": "Minimal details of an excluded field.", "properties": { "api_name": { "description": "API name of the excluded field.", "maxLength": 256, "type": "string" }, "id": { "description": "Unique identifier of the excluded field.", "maxLength": 32, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "feature_type": { "default": "record_locking", "description": "Feature type identifier (always `record_locking`).", "enum": [ "record_locking" ], "type": "string" }, "id": { "description": "Unique identifier of the configuration.", "maxLength": 32, "type": "string" }, "lock_excluded_profiles": { "description": "Profiles that are excluded from locking.", "items": { "additionalProperties": false, "description": "Minimal details of an excluded profile.", "properties": { "id": { "description": "Unique identifier of the profile.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the profile.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "lock_for_portal_users": { "default": true, "description": "Indicates whether portal users are subject to locking.", "type": "boolean" }, "lock_type": { "description": "The locking mode used for this configuration.", "enum": [ "automatic", "manual", "both" ], "type": "string" }, "locked_for": { "description": "Indicates which profiles the lock applies to.", "enum": [ "all_profiles", "all_profiles_except_excluded_profiles" ], "type": "string" }, "locking_rules": { "description": "List of locking rules defined in the configuration.", "items": { "additionalProperties": false, "description": "Details of a locking rule.", "properties": { "criteria": { "additionalProperties": false, "description": "Criteria that records must match for the rule to apply.", "properties": { "comparator": { "description": "The comparator used in the criteria.", "maxLength": 256, "type": "string" }, "field": { "additionalProperties": false, "description": "Details of the field used in the criteria.", "properties": { "api_name": { "description": "API name of the field.", "maxLength": 256, "type": "string" }, "id": { "description": "Unique identifier of the field.", "maxLength": 32, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Type of the criteria.", "maxLength": 256, "type": "string" }, "value": {} }, "required": [ "comparator", "field", "type" ], "type": "object" }, "id": { "description": "Unique identifier of the locking rule.", "maxLength": 32, "type": "string" }, "lock_existing_records": { "default": false, "description": "Indicates whether existing records are locked when the rule is applied.", "type": "boolean" }, "name": { "description": "Name of the locking rule.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id", "lock_existing_records" ], "type": "object" }, "maxItems": 5, "type": "array" }, "modified_by": { "additionalProperties": false, "description": "User who last modified the configuration.", "properties": { "id": { "description": "Unique identifier of the user.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the user.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "modified_time": { "description": "Timestamp when the configuration was last modified.", "format": "date-time", "type": "string" }, "restricted_actions": { "description": "List of actions that are restricted on locked records.", "items": { "description": "A restricted action.", "enum": [ "change_owner", "update", "delete", "tags", "convert" ], "type": "string" }, "maxItems": 5, "type": "array" }, "restricted_communications": { "description": "List of communication actions restricted on locked records.", "items": { "description": "A restricted communication action.", "enum": [ "send_mail" ], "type": "string" }, "maxItems": 1, "type": "array" }, "restricted_custom_buttons": { "description": "List of custom buttons restricted on locked records (may be null).", "items": { "additionalProperties": false, "description": "Minimal details of a restricted custom button.", "properties": { "id": { "description": "Unique identifier of the custom button.", "maxLength": 32, "type": "string" }, "name": { "description": "Name of the custom button.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "type": [ "array", "null" ] }, "system_defined": { "description": "Indicates whether the configuration is system-defined.", "type": "boolean" } }, "required": [ "lock_type", "locked_for", "created_time", "excluded_fields", "feature_type", "locking_rules", "modified_time", "system_defined", "created_by", "modified_by", "id", "lock_for_portal_users", "restricted_communications", "restricted_custom_buttons", "restricted_actions", "lock_excluded_profiles" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "GetRecordLockingConfigurationById200Response" } } }, "description": "Successfully retrieved the specified record locking configuration details." }, "204": { "description": "No record locking configuration exists for the provided ID in the specified module." }, "400": { "content": { "application/json": { "examples": { "FeatureNotSupported": { "summary": "Record locking not supported in the user's edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Record Locking Configuration is not supported in your edition", "status": "error" } }, "InvalidData": { "summary": "Invalid configuration ID provided", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidModule": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "NoPermission": { "summary": "User lacks customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "RequiredParamMissing": { "summary": "Missing required `module` parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response object.", "properties": { "code": { "description": "Error code identifying the failure reason.", "enum": [ "INVALID_MODULE", "REQUIRED_PARAM_MISSING", "INVALID_DATA", "FEATURE_NOT_SUPPORTED", "NO_PERMISSION" ], "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Indicates which parameter is missing.", "properties": { "param_name": { "description": "Name of the missing parameter.", "maxLength": 256, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "GetRecordLockingConfigurationById400ResponseRequiredParamMissingDetail" }, { "additionalProperties": false, "description": "Indicates which path element is invalid.", "properties": { "resource_path_index": { "description": "Index of the invalid path element.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "GetRecordLockingConfigurationById400ResponseInvalidPathElementDetail" }, { "additionalProperties": false, "description": "Lists required permissions when permission is denied.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "A required permission name.", "enum": [ "Crm_Implied_Customize_Zoho_CRM" ], "maxLength": 256, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "GetRecordLockingConfigurationById400ResponseNoPermissionDetail" }, { "additionalProperties": false, "description": "Empty details object for errors without additional information.", "type": "object", "x-zs-$id": "GetRecordLockingConfigurationById400ResponseEmptyDetail" } ], "description": "Additional error details that vary by error code." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "GetRecordLockingConfigurationById400Response" } } }, "description": "Bad Request - The request could not be processed due to invalid input, missing parameters, unsupported features, or permission issues." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.record_locking_configurations.READ" ] } ], "summary": "Get specific record locking configuration", "tags": [ "record_locking_configurations" ], "x-zoho-document": "record_locking_configurations" }, "put": { "description": "Updates an existing record locking configuration for the specified module using the configuration ID provided in the URL path.", "operationId": "updateRecordLockingConfigurationPassingIdInURL", "parameters": [ { "$ref": "#/components/parameters/RecordLockingConfigurationsId" }, { "description": "API name of the module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module names.", "in": "query", "name": "module", "required": true, "schema": { "examples": [ "Leads", "Contacts" ], "maxLength": 256, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "RequestBody": { "summary": "Request body for updating a specific record locking configuration", "value": { "record_locking_configurations": [ { "excluded_fields": [ { "id": "2000000004846" }, { "id": "2000000004924" } ], "feature_type": "record_locking", "id": "2000000066499", "lock_excluded_profiles": [ { "id": "2000000000497" }, { "id": "2000000000499" } ], "lock_for_portal_users": true, "lock_type": "both", "locked_for": "all_profiles", "locking_rules": [ { "criteria": { "amount": { "gte": 50000 } }, "id": "2000000066513", "lock_existing_records": true, "name": "High Value Deal Lock" } ], "restricted_actions": [ "update", "delete", "change_owner" ], "restricted_communications": [ "send_mail" ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for updating a record locking configuration.", "properties": { "record_locking_configurations": { "description": "Array containing the updated configuration.", "items": { "additionalProperties": false, "description": "The configuration object to update.", "properties": { "excluded_fields": { "description": "Fields that are exempt from locking.", "items": { "additionalProperties": false, "description": "Field descriptor for a field to be excluded from locking.", "properties": { "id": { "description": "Field ID. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve field IDs.", "example": "1385208000000973001", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFields", "propertyId": "FieldsId" } ], "resource": "fields" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "feature_type": { "default": "record_locking", "description": "Feature type identifier (must be `record_locking`).", "enum": [ "record_locking" ], "type": "string" }, "id": { "description": "Unique identifier of the configuration to update. This field is required.", "maxLength": 32, "type": "string" }, "lock_excluded_profiles": { "description": "Profiles that are excluded from locking. Required when `locked_for` is `all_profiles_except_excluded_profiles`.", "items": { "additionalProperties": false, "description": "Profile descriptor for a profile to be excluded from locking.", "properties": { "id": { "description": "Profile ID. Use the [Get Profiles API](profiles.yaml#$.paths./settings/profiles.get) to retrieve profile IDs.", "example": "4832675000000850800", "format": "int64", "maxLength": 19, "minLength": 1, "pattern": "^[0-9]{1,19}$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getProfiles", "propertyId": "ProfileId" } ], "resource": "profiles" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 15, "type": "array" }, "lock_for_portal_users": { "default": true, "description": "If `true`, portal users are also subject to the locking restrictions.", "type": "boolean" }, "lock_type": { "description": "Defines the locking mode. `automatic` locks records based on rules, `manual` requires explicit action, `both` supports both.", "enum": [ "automatic", "manual", "both" ], "type": "string" }, "locked_for": { "description": "Indicates which profiles the lock applies to.", "enum": [ "all_profiles", "all_profiles_except_excluded_profiles" ], "type": "string" }, "locking_rules": { "description": "A set of rules that define when records should be automatically locked.", "items": { "additionalProperties": false, "description": "A locking rule object.", "properties": { "criteria": { "additionalProperties": true, "description": "Criteria that records must satisfy for the rule to apply.", "type": "object" }, "id": { "description": "Unique identifier of the locking rule. Required when updating an existing rule.", "maxLength": 32, "type": "string" }, "lock_existing_records": { "default": false, "description": "If `true`, existing records that match the criteria will also be locked when the rule is saved.", "type": "boolean" }, "name": { "description": "Unique name for the locking rule.", "maxLength": 256, "type": "string" } }, "required": [ "name", "criteria" ], "type": "object" }, "maxItems": 5, "type": "array" }, "restricted_actions": { "description": "List of actions that are restricted on locked records.", "items": { "default": "update", "description": "A restricted action.", "enum": [ "change_owner", "update", "delete", "tags" ], "type": "string" }, "maxItems": 10, "type": "array" }, "restricted_communications": { "description": "List of communication actions that are restricted for locked records.", "items": { "description": "A restricted communication action.", "enum": [ "send_mail" ], "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "summary": "Successful response for updating a specific configuration", "value": { "record_locking_configurations": [ { "code": "SUCCESS", "details": { "id": "431525000001114019" }, "message": "record locking configuration updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object for a successful update.", "properties": { "record_locking_configurations": { "description": "Array containing the update response.", "items": { "additionalProperties": false, "description": "Details of the updated configuration.", "properties": { "code": { "description": "Success code for the operation.", "enum": [ "SUCCESS" ], "maxLength": 256, "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the updated configuration.", "properties": { "id": { "description": "ID of the updated configuration.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Informational message about the update.", "maxLength": 256, "type": "string" }, "status": { "description": "Indicates successful update.", "enum": [ "success" ], "maxLength": 256, "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById200Response" } } }, "description": "Successfully updated the record locking configuration." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "summary": "Ambiguity when `id` and `api_name` refer to different fields", "value": { "record_locking_configurations": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[0].api_name" }, { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[0].id" } ] }, "message": "Field Id and apiname are ambiguous", "status": "error" } ] } }, "DependentFieldMissingExcludedProfiles": { "summary": "Missing `lock_excluded_profiles` when `locked_for` is `all_profiles_except_excluded_profiles`", "value": { "record_locking_configurations": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "lock_excluded_profiles", "dependee": { "api_name": "locked_for", "json_path": "$.record_locking_configurations[0].locked_for" }, "json_path": "$.record_locking_configurations[0].lock_excluded_profiles" }, "message": "lock_excluded_profiles should have been given when locked_for is given as all_profiles_except_excluded_profiles ", "status": "error" } ] } }, "DependentFieldMissingLockType": { "summary": "Missing `locking_rules` when `lock_type` is `automatic` or `both`", "value": { "record_locking_configurations": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "locking_rules", "dependee": { "api_name": "lock_type", "json_path": "$.record_locking_configurations[0].lock_type" }, "json_path": "$.record_locking_configurations[0].locking_rules" }, "message": "locking_rules should have been given when lock_type is given as automatic or both", "status": "error" } ] } }, "DuplicateDataCriteria": { "summary": "Duplicate criteria found among locking rules", "value": { "record_locking_configurations": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "criteria", "json_path": "$.record_locking_configurations[0].locking_rules[1].criteria" }, "message": "Duplicate criteria found, Enter unique criteria.", "status": "error" } ] } }, "DuplicateDataRuleName": { "summary": "Duplicate rule name found", "value": { "record_locking_configurations": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.record_locking_configurations[0].locking_rules[1].name" }, "message": "Duplicate rule name found, Enter unique rulename.", "status": "error" } ] } }, "ExpectedFieldMissingError": { "summary": "Missing both `id` and `api_name` for an excluded field", "value": { "record_locking_configurations": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[0].api_name" }, { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[0].id" } ] }, "message": "Field Id and apiname is missing.", "status": "error" } ] } }, "FeatureNotSupported": { "summary": "Record locking not supported in the user's edition", "value": { "code": "FEATURE_NOT_SUPPORTED", "details": {}, "message": "Record Locking Configuration is not supported in your edition", "status": "error" } }, "InvalidDataCustomButtonData": { "summary": "Invalid custom button ID", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].restricted_custom_buttons[0].id" }, "message": "custom button not found", "status": "error" } ] } }, "InvalidDataExcludedProfiles": { "summary": "Invalid profile ID in `lock_excluded_profiles`", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].lock_excluded_profiles[0].id" }, "message": "lock_excluded_profiles not found", "status": "error" } ] } }, "InvalidDataExcludedsFieldsData": { "summary": "Invalid or missing field ID", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.record_locking_configurations[0].excluded_fields[4].id" }, "message": "field not found", "status": "error" } ] } }, "InvalidDataFieldsData": { "summary": "The provided field API name is incorrect or does not exist", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].locking_rules[0].criteria.fields.api_name" }, "message": "field not found", "status": "error" } ] } }, "InvalidDataLockType": { "summary": "Invalid feature type (must be `record_locking`)", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "feature_type", "json_path": "$.record_locking_configurations[0].feature_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataLockedForDetails": { "summary": "Invalid `locked_for` value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "locked_for", "json_path": "$.record_locking_configurations[0].locked_for", "supported_values": [ "all_profiles", "all_profiles_except_excluded_profiles" ] }, "message": "locked_for not found", "status": "error" } ] } }, "InvalidDataLocktypeData": { "summary": "Invalid lock type value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "lock_type", "json_path": "$.record_locking_configurations[0].lock_type", "supported_values": [ "manual", "automatic", "both" ] }, "message": "lock_type not found", "status": "error" } ] } }, "InvalidDataRestrictedCommunication": { "summary": "Invalid restricted communication value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "restricted_communications", "json_path": "$.record_locking_configurations[0].restricted_communications[1]", "supported_values": [ "send_mail", "send_survey", "send_portal_invitation" ] }, "message": "communications not found", "status": "error" } ] } }, "InvalidDataRestrictedData": { "summary": "Invalid restricted action value", "value": { "record_locking_configurations": [ { "code": "INVALID_DATA", "details": { "api_name": "restricted_actions", "json_path": "$.record_locking_configurations[0].restricted_actions[1]", "supported_values": [ "convert", "update", "delete", "change_owner", "tags" ] }, "message": "action not found", "status": "error" } ] } }, "InvalidModuleData": { "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "LimitExceededForCustomButtons": { "summary": "Exceeded maximum number of restricted custom buttons", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "restricted_custom_buttons", "available_limit": 2, "json_path": "$.record_locking_configurations[0].restricted_custom_buttons", "limit": 30 }, "message": "Maximum limit for restricted custom buttons exceeded", "status": "error" } ] } }, "LimitExceededForExcludedFields": { "summary": "Exceeded maximum number of excluded fields", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "excluded_fields", "available_limit": 2, "json_path": "$.record_locking_configurations[0].excluded_fields", "limit": 15 }, "message": "Maximum limit for excluded fields exceeded", "status": "error" } ] } }, "LimitExceededForExcludedProfiles": { "summary": "Exceeded maximum number of excluded profiles", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "lock_excluded_profiles", "available_limit": 2, "json_path": "$.record_locking_configurations[0].lock_excluded_profiles", "limit": 15 }, "message": "Maximum limit for excluded profiles exceeded", "status": "error" } ] } }, "LimitExceededLockRule": { "summary": "Exceeded maximum number of locking rules", "value": { "record_locking_configurations": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "locking_rules", "available_limit": 2, "json_path": "$.record_locking_configurations[0].locking_rules", "limit": 5 }, "message": "Maximum limit for locking rules exceeded", "status": "error" } ] } }, "NoPermission": { "summary": "User lacks customization permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Customize_Zoho_CRM" ] }, "message": "permission denied", "status": "error" } }, "NotAllowedSystemConfigUpdate": { "summary": "Attempting to update a system-created configuration", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Configuration created by system cannot be updated", "status": "error" } }, "NotSupportedFieldData": { "summary": "Unsupported field (e.g., Tag, Owner, read-only) used in excluded fields", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].excluded_fields[4].api_name" }, "message": "Field not supported", "status": "error" } ] } }, "NotSupportedFieldDataError": { "summary": "Unsupported field used in criteria", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "api_name", "json_path": "$.record_locking_configurations[0].locking_rules[0].criteria.group[0].field.api_name" }, "message": "field not supported", "status": "error" } ] } }, "NotSupportedModuleData": { "summary": "Module does not support record locking", "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "the module name given is not supported for the feature", "status": "error" } }, "NotSupportedRestrictedCommunication": { "summary": "Restricted communication not supported", "value": { "record_locking_configurations": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "restricted_communications", "json_path": "$.record_locking_configurations[0].restricted_communications" }, "message": "communications not found", "status": "error" } ] } }, "RequiredParamMissingModule": { "summary": "Missing required `module` parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Flat error response object.", "properties": { "code": { "description": "Error code identifying the failure reason.", "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Indicates which parameter is missing.", "properties": { "param_name": { "description": "Name of the missing parameter.", "maxLength": 256, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response1ParamNameDetail" }, { "additionalProperties": false, "description": "Indicates which path element is invalid.", "properties": { "resource_path_index": { "description": "Index of the invalid path element.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response1ResourcePathIndexDetail" }, { "additionalProperties": false, "description": "Lists required permissions when permission is denied.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "A required permission name.", "maxLength": 256, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response1PermissionsDetail" }, { "additionalProperties": false, "description": "Provides limit details when a limit is exceeded.", "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response1LimitDetail" } ], "description": "Additional error details that vary by error code." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response1" }, { "additionalProperties": false, "description": "Array-wrapped error envelope for configuration errors.", "properties": { "record_locking_configurations": { "description": "Array of error objects for the configuration item.", "items": { "additionalProperties": false, "description": "Error object for a specific locking configuration.", "properties": { "code": { "description": "Error code for the configuration error.", "maxLength": 256, "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Field-related error with API name and JSON path.", "properties": { "api_name": { "description": "API name of the field involved.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path to the error location.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2ApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Lists supported values when an invalid value is provided.", "properties": { "api_name": { "description": "API name of the field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path to the error location.", "maxLength": 256, "type": "string" }, "supported_values": { "description": "List of allowed values.", "items": { "description": "A supported value.", "maxLength": 256, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "supported_values", "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2SupportedValuesApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Provides limit details for nested arrays.", "properties": { "api_name": { "description": "API name of the array that exceeded the limit.", "maxLength": 256, "type": "string" }, "available_limit": { "description": "Remaining available count, if positive.", "format": "int32", "type": "integer" }, "json_path": { "description": "JSON path to the array location.", "maxLength": 256, "type": "string" }, "limit": { "description": "Maximum allowed count.", "format": "int32", "type": "integer" } }, "required": [ "limit", "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2LimitAvailableLimitApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Indicates a missing dependent field.", "properties": { "api_name": { "description": "API name of the missing dependent field.", "maxLength": 256, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Information about the field that is causing the dependency.", "properties": { "api_name": { "description": "API name of the dependee field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the dependee field.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "JSON path of the missing dependent field.", "maxLength": 256, "type": "string" } }, "required": [ "dependee", "api_name", "json_path" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2DependeeApiNameJsonPathDetail" }, { "additionalProperties": false, "description": "Lists expected fields when both `id` and `api_name` are missing.", "properties": { "expected_fields": { "description": "List of expected field descriptors.", "items": { "additionalProperties": false, "description": "Descriptor for an expected field.", "properties": { "api_name": { "description": "API name of the expected field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the expected field.", "maxLength": 256, "type": "string" } }, "required": [ "json_path", "api_name" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "expected_fields" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2ExpectedFieldsDetail" }, { "additionalProperties": false, "description": "Indicates ambiguity when `id` and `api_name` refer to different fields.", "properties": { "ambiguity_due_to": { "description": "List of ambiguous field descriptors.", "items": { "additionalProperties": false, "description": "Descriptor for an ambiguous field.", "properties": { "api_name": { "description": "API name of the ambiguous field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "JSON path of the ambiguous field.", "maxLength": 256, "type": "string" } }, "required": [ "json_path", "api_name" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2AmbiguityDueToDetail" }, { "additionalProperties": false, "description": "Minimal or empty details fallback.", "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2EmptyDetail" } ], "description": "Detailed metadata for the configuration error. The structure varies by error type." }, "message": { "description": "An error message explaining the issue.", "maxLength": 256, "type": "string" }, "status": { "description": "Status indicator, always `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "record_locking_configurations" ], "type": "object", "x-zs-$id": "UpdateRecordLockingConfigurationById400Response2" } ], "description": "Union of a flat error object or an array-wrapped error envelope.", "x-zs-$id": "UpdateRecordLockingConfigurationById400ResponseWrapper" } } }, "description": "Bad Request - The request could not be processed due to invalid input, missing parameters, unsupported features, or permission issues." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.record_locking_configurations.UPDATE" ] } ], "summary": "Update specific record locking configuration", "tags": [ "record_locking_configurations" ], "x-zoho-document": "record_locking_configurations" } }, "/crm/v8/settings/recycle_bin": { "delete": { "description": "To permanently delete one or more records from the Recycle Bin in your Zoho CRM account. When deleting a parent record, Zoho CRM also removes all its associated child records from the Recycle Bin, such as Notes and Attachments. When the total number of records to delete is 1000 or fewer, the operation completes immediately and returns a 200 response with per-item results. When the total exceeds 1000, the deletion runs as a background job and returns a 202 response. Partial successes return a 207 multi-status response with individual success and error entries per record.", "operationId": "deleteRecycleBinRecords", "parameters": [ { "$ref": "#/components/parameters/RecycleBinFilters" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "value": { "recycle_bin": [ { "code": "SUCCESS", "details": { "id": "4794080000003267613" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ResultList" } } }, "description": "Returns the per-item results for each recycle-bin record that Zoho CRM permanently removes. The **recycle_bin** array contains one entry per processed record, each with the deletion status, result code, message, and the affected record ID." }, "202": { "content": { "application/json": { "examples": { "Scheduled": { "value": { "recycle_bin": [ { "code": "SCHEDULED", "details": { "id": "4794080000003267613" }, "message": "record has been scheduled for deletion", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ResultList" } } }, "description": "Indicates that the deletion has been accepted and scheduled as a background job. Zoho CRM returns this response when the total number of records to delete, including child records such as Notes and Attachments, exceeds 1000, or when the **filters** parameter is used." }, "207": { "$ref": "#/components/responses/RecycleBinMultiStatus" }, "400": { "$ref": "#/components/responses/RecycleBinBadRequest" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.DELETE" ] } ], "summary": "Delete recycle-bin records", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Permanently deletes recycle bin records selected by filters and returns per-item success or failure details." }, "get": { "description": "To retrieve a paginated list of records currently present in the Recycle Bin in your Zoho CRM account. The response contains up to 200 records per page, along with pagination metadata. The list can be filtered by display name, source module, the user who deleted the records, or the deletion timestamp. Sorting is supported by display name, deletion time, or deleted-by user in ascending or descending order.", "operationId": "getRecycleBinRecords", "responses": { "200": { "content": { "application/json": { "examples": { "RecycleBinListSample": { "description": "Shows a representative list response with one deleted record and pagination metadata indicating page size, current page, count, and whether more records are available.", "summary": "Sample paginated Recycle Bin list", "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 20 }, "recycle_bin": [ { "deleted_by": { "id": "456", "name": "Admin" }, "deleted_time": "2025-10-22T14:12:00Z", "display_name": "John Doe", "id": "12345", "module": { "api_name": "Leads" }, "owner": { "id": "789", "name": "Jane Smith" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload for a request to retrieve a paginated list of recycle-bin records, containing the records under **recycle_bin** and pagination metadata under **info**.", "properties": { "info": { "additionalProperties": false, "description": "Represents pagination and count information for the returned list of recycle-bin records.", "properties": { "count": { "description": "Represents the total number of records returned on the current page.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional pages of recycle-bin records are available. Possible values: **true** - More records exist beyond the current page. **false** - The current page contains the last set of records.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of records returned on the current page.", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "recycle_bin": { "description": "Represents the list of recycle-bin records that match the request, with up to 200 records per page.", "items": { "additionalProperties": false, "description": "Represents a single recycle-bin record, including its display name, source module, deletion timestamp, owner, and the user who deleted it.", "properties": { "deleted_by": { "additionalProperties": false, "description": "Represents the user who deleted the record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "id": { "description": "Represents the unique identifier of the user who deleted the record.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the display name of the user who deleted the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "deleted_time": { "description": "Represents the date and time at which the record was moved to the Recycle Bin, in ISO 8601 format.", "format": "date-time", "type": "string" }, "display_name": { "description": "Represents the display name of the deleted record as it appeared in its source module.", "maxLength": 500, "type": "string" }, "id": { "description": "Represents the unique identifier of the recycle-bin record.", "maxLength": 100, "type": "string", "x-zs-$id": "RecycleBinRecordId" }, "module": { "additionalProperties": false, "description": "Represents the source module of the deleted record. Refer to the [Get modules](modules.yaml#$.paths./settings/modules.get) endpoint for details.", "properties": { "api_name": { "description": "Represents the API name of the module the record originally belonged to.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the module the record originally belonged to.", "maxLength": 100, "type": "string" } }, "type": "object" }, "owner": { "additionalProperties": false, "description": "Represents the user who owned the record at the time of deletion. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "id": { "description": "Represents the unique identifier of the owning user.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the display name of the owning user.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "display_name", "deleted_time", "owner", "module", "deleted_by", "id" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "recycle_bin", "info" ], "type": "object", "x-zs-$id": "RecycleBinListResponse" } } }, "description": "Returns a paginated list of recycle-bin records that match the request, along with pagination metadata such as the current page, page size, and whether more records are available." }, "204": { "description": "Indicates that the request succeeded but no recycle-bin records were found. The response body is empty." }, "400": { "$ref": "#/components/responses/RecycleBinBadRequest" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.READ" ] } ], "summary": "Get recycle-bin records", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Lists deleted records from the recycle bin with pagination and optional filters, including the related module and user details for each item." } }, "/crm/v8/settings/recycle_bin/actions/count": { "get": { "description": "To retrieve the total count of records currently present in the Recycle Bin in your Zoho CRM account. The count reflects every entry across all modules.", "operationId": "getRecycleBinCounts", "responses": { "200": { "content": { "application/json": { "examples": { "CountExample": { "value": { "count": 150 } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload containing the total count of records present in the Recycle Bin.", "properties": { "count": { "description": "Represents the total number of records currently present in the Recycle Bin.", "format": "int32", "type": "integer" } }, "required": [ "count" ], "type": "object", "x-zs-$id": "RecycleBinCountResponse" } } }, "description": "Returns the total count of records currently present in the Recycle Bin." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.READ" ] } ], "summary": "Get recycle-bin record count", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Returns the total number of records currently present in the recycle bin." } }, "/crm/v8/settings/recycle_bin/actions/empty": { "post": { "description": "To permanently delete every record from the Recycle Bin in your Zoho CRM account. This action is irreversible - the records cannot be restored after this operation completes. When the Recycle Bin contains 1000 or fewer records, including child records such as Notes and Attachments, Zoho CRM deletes the records immediately and returns a 200 response. When the count exceeds 1000, the deletion runs as a background job and returns a 202 response. Only users with the Admin profile can empty the Recycle Bin.", "operationId": "emptyRecycleBin", "responses": { "200": { "content": { "application/json": { "examples": { "ImmediateSuccess": { "summary": "Recycle Bin emptied immediately", "value": { "code": "SUCCESS", "details": {}, "message": "recyclebin is cleared", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Represents the success payload returned when Zoho CRM deletes every record in the Recycle Bin immediately in a single synchronous call.", "properties": { "code": { "description": "Represents the result code for the empty operation. Possible values: **SUCCESS** - Every record in the Recycle Bin was permanently deleted.", "enum": [ "SUCCESS" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the empty operation. This is an empty object when the operation completes successfully.", "type": "object" }, "message": { "description": "Represents the message confirming that the Recycle Bin was emptied.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates the outcome of the empty operation. Possible values: **success** - Every record in the Recycle Bin was permanently deleted.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "EmptyRecycleBinSuccessResponse" } } }, "description": "Returns a confirmation that Zoho CRM has emptied the Recycle Bin immediately. The response includes the **SUCCESS** result code and the success status." }, "202": { "content": { "application/json": { "examples": { "ScheduledDeletion": { "summary": "Empty Recycle Bin scheduled as background job", "value": { "code": "SCHEDULED", "details": {}, "message": "Empty bin action has been scheduled", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Represents the accepted payload returned when the empty Recycle Bin action is scheduled as a background job.", "properties": { "code": { "description": "Represents the result code indicating that the empty operation is scheduled as a background job. Possible values: **SCHEDULED** - The empty Recycle Bin action was queued as a background job.", "enum": [ "SCHEDULED" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the scheduled empty operation. This is an empty object when the job is queued.", "type": "object" }, "message": { "description": "Represents the message confirming that the empty Recycle Bin action has been scheduled as a background job.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates the outcome of the scheduling request. Possible values: **success** - The empty Recycle Bin action was accepted and queued as a background job.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "EmptyRecycleBinScheduledResponse" } } }, "description": "Indicates that the empty Recycle Bin action has been accepted and scheduled as a background job. Zoho CRM returns this response when the Recycle Bin contains more than 1000 records, including child records." }, "400": { "$ref": "#/components/responses/RecycleBinBadRequest" }, "401": { "content": { "application/json": { "examples": { "OAuthScopeMismatch": { "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error payload returned when the OAuth token does not include the scope required to empty the Recycle Bin.", "properties": { "code": { "description": "Represents the error code identifying the cause of the authorization failure.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional context about the authorization failure. This is an empty object for scope mismatch errors.", "type": "object" }, "message": { "description": "Represents the message describing the cause of the authorization failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates that the request was not authorized. Possible values: **error** - The OAuth token does not include the required scope.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "EmptyRecycleBinUnauthorizedResponse" } } }, "description": "The OAuth token does not include the required scope to empty the Recycle Bin. **Resolution:** A new access token must be generated with the **ZohoCRM.settings.recycle_bin.UPDATE** scope." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error payload returned when the request targets an invalid URL pattern for the empty Recycle Bin action.", "properties": { "code": { "description": "Represents the error code identifying why the URL pattern is invalid.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional context about the invalid URL pattern. This is an empty object for URL pattern errors.", "type": "object" }, "message": { "description": "Represents the message describing the URL pattern issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates that the requested URL pattern is invalid. Possible values: **error** - The request did not match a valid endpoint pattern.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "EmptyRecycleBinNotFoundResponse" } } }, "description": "The request URL does not match a valid endpoint pattern for emptying the Recycle Bin in Zoho CRM. **Resolution:** The request path must be verified and reissued as a POST request to the correct empty Recycle Bin endpoint." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.UPDATE" ] } ], "summary": "Empty the Recycle Bin", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Empties the recycle bin by permanently deleting all recycle bin records and reports whether the action completed immediately or was scheduled." } }, "/crm/v8/settings/recycle_bin/actions/restore": { "post": { "description": "To restore one or more deleted records from the Recycle Bin in your Zoho CRM account. Supply the scope of restoration in the request body using exactly one of three options: **ids** to restore specific records, **filters** to restore records matching field-based criteria, or **restore_all_records** to restore every record currently in the Recycle Bin. When restoring a parent record, Zoho CRM also restores all its associated child records, such as Notes and Attachments. If the total number of records to restore, including child records, is 1000 or fewer, the operation completes immediately. When the total exceeds 1000, when the **filters** option is applied, or when **restore_all_records** is **true**, the restoration runs as a background job. Admin users can restore any record; non-admin users can restore only the records they own unless their profile grants broader access.", "operationId": "restoreRecycleBinRecords", "requestBody": { "content": { "application/json": { "examples": { "RestoreAll": { "summary": "Restore all records", "value": { "restore_all_records": true } }, "RestoreByFilters": { "summary": "Restore records matching filter criteria", "value": { "filters": { "group": [ { "comparator": "contains", "field": { "api_name": "display_name" }, "value": "Amazon Marketplace" }, { "comparator": "equal", "field": { "api_name": "module" }, "value": "Leads" } ], "group_operator": "AND" } } }, "RestoreByIds": { "summary": "Restore specific records by IDs", "value": { "ids": [ "111111000000077729", "111111000000077734" ] } } }, "schema": { "additionalProperties": false, "anyOf": [ { "description": "Restore only the recycle-bin records whose IDs are listed in **ids**.", "required": [ "ids" ], "x-zs-$id": "RestoreByIds" }, { "description": "Restore the recycle-bin records that match the conditions defined in **filters**.", "required": [ "filters" ], "x-zs-$id": "RestoreByFilters" }, { "description": "Restore every record currently in the Recycle Bin when **restore_all_records** is set to **true**.", "required": [ "restore_all_records" ], "x-zs-$id": "RestoreAll" } ], "description": "Request payload that specifies how to scope the restoration. Provide exactly one of **ids**, **filters**, or **restore_all_records**; supplying more than one results in an AMBIGUITY_DURING_PROCESSING error.", "properties": { "filters": { "additionalProperties": false, "description": "Specify the filter criteria to select recycle-bin records for restoration. Mutually exclusive with **ids** and **restore_all_records**. Restoration based on filters is always scheduled as a background job, regardless of the number of matching records.", "properties": { "group": { "description": "Specify the list of filter conditions used to select recycle-bin records for restoration.", "items": { "additionalProperties": false, "description": "Represents a single filter condition, including the field to filter on, the comparator, and the value to compare against.", "properties": { "comparator": { "description": "Specify the comparison operator to apply between the field and the value. Possible values: **equal**, **not_equal**, **contains**, **not_contains**, **starts_with**, **ends_with**, **greater_than**, **less_than**. The set of comparators supported depends on the field: **display_name** and **deleted_by** support equal, not_equal, contains, not_contains, starts_with, ends_with; **module** supports equal and not_equal; **deleted_time** supports equal, not_equal, greater_than, less_than.", "maxLength": 50, "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the field to filter on. The field is identified by its API name.", "properties": { "api_name": { "description": "Specify the API name of the field to filter on. Possible values: **display_name**, **module**, **deleted_by**, **deleted_time**.", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "anyOf": [ { "description": "String value used when filtering by **display_name**, **module**, **deleted_by**, or **deleted_time**.", "maxLength": 500, "type": "string", "x-zs-$id": "FilterValueString" }, { "description": "Numeric value used when filtering by a numeric attribute.", "type": "number", "x-zs-$id": "FilterValueNumber" }, { "description": "Boolean value used when filtering by a Boolean attribute.", "type": "boolean", "x-zs-$id": "FilterValueBoolean" } ], "description": "Specify the value to compare the field against. The data type depends on the field being filtered." } }, "required": [ "field", "comparator", "value" ], "type": "object" }, "maxItems": 20, "type": "array" }, "group_operator": { "description": "Specify the logical operator that combines the conditions inside the **group** array. Possible values: **AND**.", "enum": [ "AND" ], "type": "string" } }, "required": [ "group_operator", "group" ], "type": "object" }, "ids": { "description": "Specify the unique IDs of the recycle-bin records you want to restore. Mutually exclusive with **filters** and **restore_all_records**.", "items": { "description": "Represents the unique identifier of a single recycle-bin record to restore.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecycleBinRecords", "propertyId": "RecycleBinRecordId" } ], "resource": "recycle_bin" } }, "maxItems": 200, "type": "array" }, "restore_all_records": { "description": "Specify whether every record currently in the Recycle Bin should be restored. Possible values: **true** - Every record in the Recycle Bin is restored. This option cannot be combined with **ids** or **filters** and the operation is always scheduled as a background job. **false** - Either **ids** or **filters** must be supplied to scope the restoration.", "type": "boolean" } }, "type": "object", "x-zs-$id": "RestoreRecycleBinRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "ImmediateSuccess": { "summary": "Immediate restoration success", "value": { "recycle_bin": [ { "code": "SUCCESS", "details": { "id": "111111000000077729" }, "message": "record restored", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ResultList" } } }, "description": "Returns per-item results when records are restored immediately. The **recycle_bin** array contains one entry per processed record with the operation status, code, message, and the restored record ID." }, "202": { "content": { "application/json": { "examples": { "ScheduledByFilters": { "summary": "Bulk restoration scheduled based on filters", "value": { "recycle_bin": [ { "code": "SCHEDULED", "details": {}, "message": "Bulk restoration of records based on filters has been scheduled", "status": "success" } ] } }, "ScheduledByIds": { "summary": "Restoration scheduled for specific IDs", "value": { "recycle_bin": [ { "code": "SCHEDULED", "details": { "id": "111111000000077729" }, "message": "record has been scheduled for restoration", "status": "success" }, { "code": "SCHEDULED", "details": { "id": "111111000000077734" }, "message": "record has been scheduled for restoration", "status": "success" } ] } }, "ScheduledRestoreAll": { "summary": "All records scheduled for restoration", "value": { "recycle_bin": [ { "code": "SCHEDULED", "details": {}, "message": "Bulk restoration of records based on filters has been scheduled", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ResultList" } } }, "description": "Indicates that the restoration has been accepted and scheduled as a background job. Zoho CRM returns this response when the total number of records to restore, including child records, exceeds 1000, when the **filters** option is applied, or when **restore_all_records** is set to **true**." }, "207": { "$ref": "#/components/responses/RecycleBinMultiStatus" }, "400": { "$ref": "#/components/responses/RecycleBinBadRequest" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.UPDATE" ] } ], "summary": "Restore multiple Recycle Bin records", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Restores recycle bin records using record IDs, filter criteria, or a bulk restore flag and returns immediate or scheduled results." } }, "/crm/v8/settings/recycle_bin/{recordId}": { "delete": { "description": "To permanently delete a single record from the Recycle Bin in your Zoho CRM account using its unique ID. Deleting a parent record also removes all its associated child records from the Recycle Bin, such as Notes and Attachments. This operation is irreversible - the record cannot be restored after deletion. When the total number of records to delete, including child records, exceeds 1000, the operation runs as a background job.", "operationId": "deleteRecycleBinRecord", "parameters": [ { "description": "Specify the unique ID of the recycle-bin record you want to delete permanently.", "in": "path", "name": "recordId", "required": true, "schema": { "description": "Identifier", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecycleBinRecords", "propertyId": "RecycleBinRecordId" } ], "resource": "recycle_bin" } } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "value": { "recycle_bin": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Deleted permanently", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload for a successful permanent deletion of a single recycle-bin record, containing the per-item result under the **recycle_bin** array.", "properties": { "recycle_bin": { "description": "Represents the list of per-item results for the deletion request, with one entry for the single deleted record.", "items": { "additionalProperties": false, "description": "Represents the per-item outcome for a single recycle-bin record deletion, including the outcome status, result code, message, and deletion details.", "properties": { "code": { "description": "Represents the result code for the deletion. Possible values: **SUCCESS** - The record was permanently deleted. **CANNOT_DELETE** - The record could not be permanently deleted.", "enum": [ "SUCCESS", "CANNOT_DELETE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the per-item deletion result, including the ID of the affected record.", "properties": { "id": { "description": "Represents the unique identifier of the recycle-bin record that was permanently deleted.", "maxLength": 500, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the outcome of the deletion request.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates whether the deletion succeeded or failed for the record. Possible values: **success** - The record was permanently deleted. **error** - The deletion failed for this record.", "enum": [ "success", "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "recycle_bin" ], "type": "object", "x-zs-$id": "RecycleBinRecordDeleteResponse" } } }, "description": "Returns the per-item result confirming that the recycle-bin record was permanently deleted. The **recycle_bin** array contains one entry with the deletion status and the deleted record ID." }, "400": { "$ref": "#/components/responses/RecycleBinBadRequest" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.DELETE" ] } ], "summary": "Delete a recycle-bin record permanently", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Permanently deletes one recycle bin record identified by the path parameter recordId." }, "get": { "description": "To retrieve metadata for a single record from the Recycle Bin in your Zoho CRM account using its unique ID. The response includes the display name, source module, deletion timestamp, original owner, and the user who deleted the record.", "operationId": "getRecycleBinRecord", "parameters": [ { "description": "Specify the unique ID of the recycle-bin record you want to retrieve. The **recordId** in the URL takes precedence over any **filters** or **ids** values supplied as query parameters.", "examples": { "Example1": { "value": "4876876000007018006" } }, "in": "path", "name": "recordId", "required": true, "schema": { "description": "Identifier", "maxLength": 500, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "SingleRecordExample": { "description": "Shows the metadata returned for a single recycle-bin record, including its owner, source module, deleted-by user, and deletion timestamp.", "summary": "Recycle Bin record metadata", "value": { "recycle_bin": [ { "deleted_by": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "deleted_time": "2024-07-23T15:37:52+05:30", "display_name": "John Doe", "id": "4876876000007018006", "module": { "api_name": "Leads", "id": "4876876000000002175" }, "owner": { "id": "4876876000000327001", "name": "Patricia Boyle" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload for a request to retrieve a single recycle-bin record, containing the record metadata under **recycle_bin**.", "properties": { "recycle_bin": { "description": "Represents the list containing the single recycle-bin record matching the requested **recordId**.", "items": { "additionalProperties": false, "description": "Represents a single recycle-bin record, including its display name, source module, deletion timestamp, owner, and the user who deleted it.", "properties": { "deleted_by": { "additionalProperties": false, "description": "Represents the user who deleted the record. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "id": { "description": "Represents the unique identifier of the user who deleted the record.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the display name of the user who deleted the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "deleted_time": { "description": "Represents the date and time at which the record was moved to the Recycle Bin, in ISO 8601 format.", "format": "date-time", "type": "string" }, "display_name": { "description": "Represents the display name of the deleted record as it appeared in its source module.", "maxLength": 500, "type": "string" }, "id": { "description": "Represents the unique identifier of the recycle-bin record.", "maxLength": 100, "type": "string", "x-zs-$id": "RecycleBinRecordIdSingle" }, "module": { "additionalProperties": false, "description": "Represents the source module of the deleted record. Refer to the [Get modules](modules.yaml#$.paths./settings/modules.get) endpoint for details.", "properties": { "api_name": { "description": "Represents the API name of the module the record originally belonged to.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the module the record originally belonged to.", "maxLength": 100, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "owner": { "additionalProperties": false, "description": "Represents the user who owned the record at the time of deletion. Refer to the [Get users](users.yaml#$.paths./users.get) endpoint for details.", "properties": { "id": { "description": "Represents the unique identifier of the owning user.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the display name of the owning user.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "display_name", "deleted_time", "owner", "module", "deleted_by", "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "recycle_bin" ], "type": "object", "x-zs-$id": "RecycleBinRecordResponse" } } }, "description": "Returns metadata for the requested recycle-bin record, including its display name, source module, deletion timestamp, owner, and the user who deleted it." }, "400": { "$ref": "#/components/responses/RecycleBinBadRequest" }, "401": { "content": { "application/json": { "examples": { "OAuthScopeMismatch": { "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error payload returned when the OAuth token does not include the scope required to read recycle-bin records.", "properties": { "code": { "description": "Represents the error code identifying the authorization failure.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional context about the authorization failure. This is an empty object for OAuth scope mismatches.", "type": "object" }, "message": { "description": "Represents the message describing the authorization failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates that the request was not authorized. Possible values: **error** - The OAuth token does not include the required scope.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RecycleBinRecordUnauthorizedResponse" } } }, "description": "The OAuth token does not include the required scope to read recycle-bin records. **Resolution:** A new access token must be generated with the **ZohoCRM.settings.recycle_bin.READ** scope." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The request URL is incorrect.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error payload returned when the request URL does not match the valid endpoint pattern for retrieving a recycle-bin record.", "properties": { "code": { "description": "Represents the error code identifying why the URL pattern is invalid.", "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional context about the invalid URL pattern. This is an empty object for URL pattern errors.", "type": "object" }, "message": { "description": "Represents the message describing the URL pattern issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Indicates that the requested URL pattern is invalid. Possible values: **error** - The request did not match a valid endpoint pattern.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "RecycleBinRecordNotFoundResponse" } } }, "description": "The request URL does not match a valid endpoint pattern for retrieving a recycle-bin record in Zoho CRM. **Resolution:** The request path must be verified and reissued as a GET request to the correct endpoint." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.READ" ] } ], "summary": "Get a recycle-bin record", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Returns one recycle bin record by its recordId, including the deleted record details and related module metadata." } }, "/crm/v8/settings/recycle_bin/{recordId}/actions/restore": { "post": { "description": "To restore a single deleted record from the Recycle Bin in your Zoho CRM account. The record is moved back to its original module along with all its associated child records, such as Notes and Attachments. When the total number of restored records, including child records, is 1000 or fewer, the restoration completes immediately and returns a 200 response. When the total exceeds 1000, the operation is scheduled as a background job. Admin users can restore any record; non-admin users can restore only the records they own unless their profile grants broader access.", "operationId": "restoreRecycleBinRecord", "parameters": [ { "description": "Specify the unique ID of the recycle-bin record you want to restore. The **recordId** in the URL takes precedence over any restoration scope given in a request body.", "examples": { "Example1": { "value": "1234567890" } }, "in": "path", "name": "recordId", "required": true, "schema": { "description": "Represents the unique identifier of the recycle-bin record.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecycleBinRecords", "propertyId": "RecycleBinRecordId" } ], "resource": "recycle_bin" } } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "value": { "recycle_bin": [ { "code": "SUCCESS", "details": { "id": "12345" }, "message": "Restored", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ResultList" } } }, "description": "Returns a per-item result that confirms the recycle-bin record was restored to its original module. The **recycle_bin** array contains a single entry indicating success along with the restored record ID." }, "400": { "$ref": "#/components/responses/RecycleBinBadRequest" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.recycle_bin.UPDATE" ] } ], "summary": "Restore a Recycle Bin record", "tags": [ "recycle_bin" ], "x-zoho-document": "recycle_bin", "x-zs-llm-description": "Restores one recycle bin record identified by the path parameter recordId." } }, "/crm/v8/settings/related_lists": { "get": { "description": "To retrieve the configuration of related list panels for a specific module in your Zoho CRM organization, including display metadata, available record operations, and layout-specific settings.", "operationId": "getRelatedLists", "parameters": [ { "$ref": "#/components/parameters/RelatedListsModule" }, { "$ref": "#/components/parameters/RelatedListsLayoutId" }, { "$ref": "#/components/parameters/RelatedListsStatus" }, { "$ref": "#/components/parameters/ExtraProperties" }, { "$ref": "#/components/parameters/RelatedListsIncludeInnerDetails" } ], "responses": { "200": { "content": { "application/json": { "examples": { "AllNullableFieldsNull": { "description": "Shows a response where all nullable fields - including **module**, **action**, **href**, **connectedmodule**, **linkingmodule**, **parent_related_lists**, and **_layout_specific_properties** - return null values.", "summary": "Related list with all nullable fields set to null", "value": { "related_lists": [ { "_layout_specific_properties": null, "action": null, "api_name": "Notes", "connectedmodule": null, "customize_display_label": false, "customize_fields": false, "customize_sort": false, "display_label": "Notes", "href": null, "id": "4150868000000091023", "linkingmodule": null, "module": null, "name": "Notes", "parent_related_lists": null, "sequence_number": "1", "status": "visible", "type": "default" } ] } }, "FullResponseAllFieldsPopulated": { "description": "Shows a complete related list entry with all optional fields populated, including **record_operations**, **_layout_specific_properties**, **connectedmodule**, and **linkingmodule**.", "summary": "Related list with all optional fields populated", "value": { "related_lists": [ { "_layout_specific_properties": [ { "layout": { "id": "4150868000000091100", "name": "Standard" }, "sequence_number": "2", "status": "visible" } ], "action": "add_existing", "api_name": "Contacts", "connectedlookupApiName": "Account_Name", "connectedmodule": "Accounts", "customize_display_label": true, "customize_fields": true, "customize_sort": true, "display_label": "Contacts", "href": "Contacts/{ENTITYID}/Contacts", "id": "4150868000000091023", "linkingmodule": "Contacts_X_Accounts", "module": { "api_name": "Contacts", "id": "4150868000000002175" }, "name": "Contacts", "parent_related_lists": [ { "api_name": "Deals", "id": "4150868000000091050" } ], "personality_name": "contacts_personality", "record_operations": { "assign": false, "bulk_edit": false, "create": true, "delete": true, "disassociate": true, "edit": true }, "sequence_number": "1", "status": "visible", "type": "default", "visibility": 1 } ] } }, "MultipleLayoutSpecificProperties": { "description": "Shows a related list with two entries in **_layout_specific_properties**, each with a different **layout** identifier, **sequence_number**, and **status** override.", "summary": "Related list with multiple layout-specific property entries", "value": { "related_lists": [ { "_layout_specific_properties": [ { "layout": { "id": "4150868000000091100", "name": "Standard" }, "sequence_number": "1", "status": "visible" }, { "layout": { "id": "4150868000000091200", "name": "Custom Layout" }, "sequence_number": "3", "status": "user_hidden" } ], "action": null, "api_name": "Contacts", "customize_display_label": true, "customize_fields": true, "customize_sort": true, "display_label": "Contacts", "href": null, "id": "4150868000000091023", "module": { "api_name": "Contacts", "id": "4150868000000002175" }, "name": "Contacts", "parent_related_lists": [ { "api_name": "Deals", "id": "4150868000000091050" } ], "sequence_number": "1", "status": "visible", "type": "default" } ] } }, "MultiselectLookupRelatedList": { "description": "Shows a multiselectlookup related list with the complete **multiselectlookup** object, including **field**, **linking_details**, **connected_details**, and **field_enabled**.", "summary": "Related list of type multiselectlookup with full config", "value": { "related_lists": [ { "action": null, "api_name": "Products", "connectedlookupApiName": "Product_Name", "connectedmodule": "Products", "customize_display_label": true, "customize_fields": true, "customize_sort": true, "display_label": "Products", "href": null, "id": "4150868000000091080", "linkingmodule": "Deals_X_Products", "module": { "api_name": "Products", "id": "4150868000000002200", "plural_label": "Products" }, "multiselectlookup": { "connected_details": { "field": { "api_name": "Deal_Name", "field_label": "Deal Name", "id": "4150868000000002700" }, "module": { "api_name": "Deals", "id": "4150868000000002800", "plural_label": "Deals" }, "related_list": { "api_name": "Deals", "display_label": "Deals", "id": "4150868000000002900" } }, "field": { "api_name": "Product_Name", "field_label": "Product Name", "id": "4150868000000002300" }, "field_enabled": true, "linking_details": { "connected_lookup_field": { "api_name": "Product_Name", "id": "4150868000000002600" }, "lookup_field": { "api_name": "Deal_Name", "id": "4150868000000002500" }, "module": { "api_name": "Deals_X_Products", "id": "4150868000000002400", "plural_label": "Deals_X_Products" }, "visibility": 1 } }, "name": "Products", "parent_related_lists": null, "sequence_number": "5", "status": "visible", "type": "multiselectlookup" } ] } }, "ScheduledForDeletionRelatedList": { "description": "Shows a related list with **status** set to **scheduled_for_deletion**, representing a list that is marked for removal from the module layout.", "summary": "Related list scheduled for deletion", "value": { "related_lists": [ { "action": null, "api_name": "Deprecated_RL", "customize_display_label": false, "customize_fields": false, "customize_sort": false, "display_label": "Old List", "href": null, "id": "4150868000000091095", "module": { "api_name": "Old_Module", "id": "4150868000000003100" }, "name": "Deprecated RL", "parent_related_lists": [ { "api_name": "Leads", "id": "4150868000000091070" } ], "sequence_number": "15", "status": "scheduled_for_deletion", "type": "default" } ] } }, "SuccessResponse": { "description": "Shows a successful response for a module with one related list entry, including the module reference and a parent related list.", "summary": "Successful retrieval of related lists", "value": { "related_lists": [ { "action": null, "api_name": "Contacts", "customize_display_label": true, "customize_fields": true, "customize_sort": true, "display_label": "Contacts", "href": null, "id": "4150868000000091023", "module": { "api_name": "Contacts", "id": "4150868000000002175" }, "name": "Contacts", "parent_related_lists": [ { "api_name": "Deals", "id": "4150868000000091050" } ], "sequence_number": "1", "status": "visible", "type": "default" } ] } }, "UserHiddenRelatedList": { "description": "Shows a related list where the **status** field is **user_hidden**, indicating it has been hidden by the user in the layout.", "summary": "Related list with user_hidden status", "value": { "related_lists": [ { "action": null, "api_name": "Custom_RL", "customize_display_label": true, "customize_fields": true, "customize_sort": false, "display_label": "Hidden List", "href": null, "id": "4150868000000091090", "module": { "api_name": "Custom_Module", "id": "4150868000000003000" }, "name": "Custom RL", "parent_related_lists": [ { "api_name": "Accounts", "id": "4150868000000091060" } ], "sequence_number": "10", "status": "user_hidden", "type": "custom" } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing the related list configurations for the specified module.", "properties": { "related_lists": { "description": "Array of related list configurations for the specified module and layout.", "items": { "$ref": "#/components/schemas/RelatedList" }, "maxItems": 1000, "minItems": 1, "type": "array" } }, "required": [ "related_lists" ], "type": "object", "x-zs-$id": "GetRelatedListsResponse" } } }, "description": "Returns the related list configuration for the specified module, including display metadata, record operation permissions, and layout-specific overrides for each related list." }, "204": { "description": "No related lists matched the requested module, layout, or visibility filter." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "summary": "Invalid module name", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidParameterValue": { "description": "Shows the INVALID_DATA error returned when the **status** parameter receives an unsupported value, including the list of supported values.", "summary": "Invalid value for the status parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "status", "supported_values": [ "visible", "user_hidden", "scheduled_for_deletion" ] }, "message": "The status given is invalid.", "status": "error" } }, "NotSupported": { "description": "Shows the NOT_SUPPORTED error returned when the specified module exists in the CRM but is not supported by the Related Lists API.", "summary": "Module not supported by this API", "value": { "code": "NOT_SUPPORTED", "details": { "param_name": "module" }, "message": "the given module is not supported for this api", "status": "error" } }, "RequiredParamMissing": { "summary": "Required module parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedListsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedListsInvalidModuleError" }, { "$ref": "#/components/schemas/MissingModuleParameterError" }, { "$ref": "#/components/schemas/RelatedListsNotSupportedError" } ], "description": "Validation error response for the getRelatedLists operation. The error code and details identify the specific failure.", "x-zs-$id": "GetRelatedListsErrorResponse" } } }, "description": "The request contains invalid or missing parameters.\n**Resolution:** The **module** parameter must be a valid CRM module API name. The **status** parameter must be one of the supported values." }, "401": { "$ref": "#/components/responses/RelatedListsUnauthorizedResponse" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.related_lists.READ" ] }, { "OAuth2": [ "ZohoCRM.settings.related_lists.ALL" ] }, { "OAuth2": [ "ZohoCRM.settings.ALL" ] } ], "summary": "Related Lists", "tags": [ "related_lists" ], "x-zoho-document": "related_lists", "x-zs-llm-description": "This API returns the metadata configuration of related list panels (sections displayed on a record detail page showing linked records from other modules). It does not return the actual related records themselves." } }, "/crm/v8/settings/roles": { "get": { "description": "Returns the list of all roles configured in your Zoho CRM organization.", "operationId": "getRoles", "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response with the list of roles.", "summary": "Successful roles retrieval response", "value": { "roles": [ { "api_name": "sales_manager", "created_by__s": { "id": "4413524000000991004", "name": "Admin User" }, "created_time__s": "2023-11-01T09:00:00Z", "description": "Manages sales team and processes", "display_label": "Sales Manager", "forecast_manager": { "id": "4413524000000991002", "name": "John Doe" }, "id": "4413524000000991001", "modified_by__s": { "id": "4413524000000991005", "name": "Admin User" }, "modified_time__s": "2023-12-01T10:00:00Z", "name": "Sales Manager", "reporting_to": { "id": "4413524000000991003", "name": "VP Sales" }, "share_with_peers": true } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for retrieving all CRM roles in the organization.", "properties": { "roles": { "description": "Represents the list of CRM roles returned in the response. ", "items": { "additionalProperties": false, "description": "Represents an individual role in the organization. ", "properties": { "api_name": { "description": "Represents the API name identifier for the role, used to reference the role programmatically.", "maxLength": 100, "type": "string", "x-zs-$id": "RoleApiName" }, "created_by__s": { "additionalProperties": false, "description": "Represents the user who created this role. ", "properties": { "id": { "description": "Represents the unique ID of the user who created the role. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the user who created the role. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "created_time__s": { "description": "Represents the timestamp indicating when the role was added to the organization. ", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Represents the description of the role, providing additional context about its purpose and responsibilities. ", "maxLength": 1000, "type": [ "string", "null" ] }, "display_label": { "description": "Represents the display label of the role as shown in the Zoho CRM user interface. ", "maxLength": 200, "type": "string" }, "forecast_manager": { "additionalProperties": false, "description": "Represents the forecast manager assigned to this role. ", "properties": { "id": { "description": "Represents the unique ID of the forecast manager assigned to the role. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the forecast manager assigned to the role. ", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": [ "object", "null" ] }, "id": { "description": "Represents the unique ID of the role. ", "maxLength": 19, "type": "string", "x-zs-$id": "RoleId" }, "modified_by__s": { "additionalProperties": false, "description": "Represents the user who last modified this role. ", "properties": { "id": { "description": "Represents the unique ID of the user who last modified the role. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the user who last modified the role. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "modified_time__s": { "description": "Represents the timestamp at which the role was last modified. ", "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "Represents the display name of the role. ", "maxLength": 200, "type": "string" }, "reporting_to": { "additionalProperties": false, "description": "Represents the parent role to which this role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "properties": { "id": { "description": "Represents the unique ID of the parent role in the role hierarchy. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the parent role in the role hierarchy. ", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": [ "object", "null" ] }, "share_with_peers": { "description": "Indicates whether users assigned to this role can share records with users in peer roles at the same level. \nPossible values:\n**true** - Users assigned to this role can share records with peer role users.\n**false** - Users assigned to this role cannot share records with peer role users.", "type": "boolean" } }, "required": [ "display_label", "forecast_manager", "reporting_to", "share_with_peers", "description", "id", "name", "created_by__s", "modified_by__s", "modified_time__s", "created_time__s" ], "type": "object" }, "maxItems": 250, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "GetRolesResponse" } } }, "description": "Returns the list of all CRM roles configured in the organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.roles.READ" ] } ], "summary": "Get all roles", "tags": [ "roles" ], "x-zoho-document": "roles", "x-zs-llm-description": "Use it to look up role IDs before creating, updating, or deleting a role." }, "post": { "description": "Creates a new role in your Zoho CRM organization.", "operationId": "createRoles", "requestBody": { "content": { "application/json": { "examples": { "CreateRole": { "description": "Shows a create roles request specifying a new role with its name, parent role, description, and peer sharing setting.", "summary": "Create a new role with required and optional fields", "value": { "roles": [ { "description": "Manages marketing campaigns and strategies", "name": "Marketing Manager", "reporting_to": { "id": "4413524000000991006" }, "share_with_peers": true } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for creating one or more CRM roles.", "properties": { "roles": { "description": "Specify the array of role objects to create. You can include exactly one object per request (bulk create/update is not supported).", "items": { "additionalProperties": false, "description": "Specify the details of an individual role to create.", "properties": { "description": { "description": "Specify the description of the role to provide additional context about its purpose and responsibilities.", "maxLength": 250, "type": [ "string", "null" ] }, "name": { "description": "Specify the display name for the role.", "maxLength": 200, "type": "string" }, "reporting_to": { "additionalProperties": false, "description": "Specify the parent role to which this new role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "properties": { "id": { "description": "Specify the unique ID of the parent role in the role hierarchy.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } } }, "type": "object" }, "share_with_peers": { "description": "Specify whether users assigned to this role can share records with users in peer roles at the same level.\nPossible values:\n**true** - Users assigned to this role can share records with peer role users.\n**false** - Users assigned to this role cannot share records with peer role users.", "type": [ "boolean", "null" ] } }, "required": [ "name", "reporting_to" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object" }, "x-zs-llm-examples": [ "CreateRole" ] } }, "description": "The request body must contain a roles array. You can include exactly one object per request (bulk create/update is not supported).", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response returning the creation result with the ID of the newly created role.", "summary": "Successful role creation response", "value": { "roles": [ { "code": "SUCCESS", "details": { "id": "4413524000000991004" }, "message": "Role added", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for the role creation operation.", "properties": { "roles": { "description": "Represents the list of role creation results. ", "items": { "additionalProperties": false, "description": "Represents the creation result for an individual role in the request. ", "properties": { "code": { "description": "Represents the result code of the role creation operation. \nPossible values:\n**SUCCESS** - The role creation succeeded.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the created role. ", "properties": { "id": { "description": "Represents the unique ID of the newly created role. ", "maxLength": 19, "type": "string", "x-zs-$id": "RoleResultId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message for the role creation result. ", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the role creation operation. \nPossible values:\n**success** - The role creation succeeded.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "CreateRolesResponse" } } }, "description": "Returns the creation result for each role submitted in the request." }, "400": { "content": { "application/json": { "examples": { "Error": { "description": "Shows an error response when the request body contains invalid or duplicate role data.", "summary": "Validation error during role creation", "value": { "roles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.roles[0].name", "maximum_length": 200 }, "message": "Invalid role name", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response when one or more roles conflict with existing data.", "properties": { "roles": { "description": "Represents the list of role creation failure results for duplicate data errors. ", "items": { "additionalProperties": false, "description": "Represents the failure result for an individual role where a duplicate data error occurred. ", "properties": { "code": { "description": "Represents the error code for the role creation failure. \nPossible values:\n**DUPLICATE_DATA** - The role data conflicts with an existing role.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the field that caused the duplicate data error. ", "properties": { "api_name": { "description": "Represents the API name of the field that contains the duplicate value. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that contains the duplicate value. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the duplicate data issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role creation operation for this item. \nPossible values:\n**error** - The role creation failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "CreateRolesDuplicateDataErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response when one or more roles contain invalid data.", "properties": { "roles": { "description": "Represents the list of role creation failure results for invalid data errors. ", "items": { "additionalProperties": false, "description": "Represents the failure result for an individual role where an invalid data error occurred. ", "properties": { "code": { "description": "Represents the error code for the role creation failure. \nPossible values:\n**INVALID_DATA** - The provided data is invalid.", "enum": [ "INVALID_DATA", "invalid data" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the field that caused the invalid data error. ", "properties": { "api_name": { "description": "Represents the API name of the field that contains the invalid value. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that contains the invalid value. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role creation operation for this item. \nPossible values:\n**error** - The role creation failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "CreateRolesInvalidDataErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response when one or more role fields exceed the allowed length or contain validation errors.", "properties": { "roles": { "description": "Represents the list of role creation failure results for validation errors. ", "items": { "additionalProperties": false, "description": "Represents the failure result for an individual role where a validation error occurred. ", "properties": { "code": { "description": "Represents the error code for the validation failure. \nPossible values:\n**INVALID_DATA** - The provided data failed validation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the field that failed validation. ", "properties": { "api_name": { "description": "Represents the API name of the field that failed validation. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that failed validation. ", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that failed validation. ", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role creation operation for this item. \nPossible values:\n**error** - The role creation failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "CreateRolesValidationErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response when a required parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code indicating a required parameter is missing. \nPossible values:\n**MANDATORY_PARAM_MISSING** - A required parameter was not included in the request.", "enum": [ "MANDATORY_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the missing parameter.", "properties": { "api_name": { "description": "Represents the API name of the missing required parameter.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing parameter issue. ", "example": "Required parameter is missing", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateRolesMandatoryParamMissingError" }, { "additionalProperties": false, "description": "Represents the error response when the operation is not permitted.", "properties": { "code": { "description": "Represents the error code indicating the operation is not allowed. \nPossible values:\n**NOT_ALLOWED** - The operation is not permitted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about why the operation is not allowed.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation is not allowed. ", "example": "This operation is not allowed", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateRolesNotAllowedError" } ], "description": "Represents the error response for the role creation operation.", "x-zs-$id": "CreateRolesErrorResponse" } } }, "description": "The request is invalid. **Resolution**: Verify that all required fields are provided and that all field values conform to the allowed format and constraints." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.roles.CREATE" ] } ], "summary": "Create a role", "tags": [ "roles" ], "x-zoho-document": "roles", "x-zs-llm-description": "Creates a single role per request; bulk creation is not supported." }, "put": { "description": "Updates an existing role in your Zoho CRM organization.", "operationId": "updateRoles", "requestBody": { "content": { "application/json": { "examples": { "UpdateRoles": { "description": "Shows a request that updates a role.", "summary": "Update a role", "value": { "roles": [ { "description": "Updated description for senior sales manager role", "forecast_manager": { "id": "4413524000000991011", "name": "John Doe" }, "id": "4413524000000991001", "name": "Senior Sales Manager", "reporting_to": { "id": "4413524000000991010" }, "share_with_peers": false } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for updating a role.", "properties": { "roles": { "description": "Specify the array of role objects to update.", "items": { "additionalProperties": false, "description": "Specify the details of an individual role to update.", "properties": { "description": { "description": "Specify the updated description for the role.", "maxLength": 250, "type": [ "string", "null" ] }, "forecast_manager": { "additionalProperties": false, "description": "Specify the forecast manager to assign to this role.", "properties": { "id": { "description": "Specify the unique ID of the forecast manager to assign to the role.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } }, "name": { "description": "Specify the display name of the forecast manager to assign to the role.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": "object" }, "id": { "description": "Specify the unique ID of the role to update. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } }, "name": { "description": "Specify the updated display name for the role.", "maxLength": 200, "type": "string" }, "reporting_to": { "additionalProperties": false, "description": "Specify the updated parent role for this role in the CRM hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "properties": { "id": { "description": "Specify the unique ID of the updated parent role.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } } }, "type": "object" }, "share_with_peers": { "description": "Specify whether users assigned to this role can share records with users in peer roles at the same level.\nPossible values:\n**true** - Users assigned to this role can share records with peer role users.\n**false** - Users assigned to this role cannot share records with peer role users.", "type": "boolean" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateRoles" ] } }, "description": "The request body must contain a roles array. You can include exactly one object per request (bulk create/update is not supported).", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful role update response showing the update result for the submitted role in the request.", "summary": "Successful role update response", "value": { "roles": [ { "code": "SUCCESS", "details": { "id": "4413524000000991001" }, "message": "Role updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for the role update operation.", "properties": { "roles": { "description": "Represents the role update result. ", "items": { "additionalProperties": false, "description": "Represents the update result for an individual role. ", "properties": { "code": { "description": "Represents the result code of the role update operation. \nPossible values:\n**SUCCESS** - The role update succeeded.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the updated role. ", "properties": { "id": { "description": "Represents the unique ID of the updated role. ", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message for the role update result. ", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the role update operation. \nPossible values:\n**success** - The role update succeeded.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "UpdateRolesResponse" } } }, "description": "Returns the update result for each role submitted in the request." }, "400": { "content": { "application/json": { "examples": { "Error": { "description": "Shows an error response when the update request contains a role with invalid data.", "summary": "Validation error during role update", "value": { "roles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.roles[0].name", "maximum_length": 200 }, "message": "Invalid role name", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the response when the update request contains both successfully updated and failed roles.", "properties": { "roles": { "description": "Represents the list of role update results containing both success and error items. ", "items": { "additionalProperties": false, "description": "Represents the result for an individual role update, indicating success or failure. ", "properties": { "code": { "description": "Represents the result code for the role update operation. ", "enum": [ "SUCCESS", "INVALID_DATA", "NOT_ALLOWED", "MANDATORY_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the role update result.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the update result.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique ID of the role associated with the update result.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body associated with the update result.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that failed validation.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the status message for the role update result. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role update operation for this item. ", "enum": [ "success", "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "UpdateRolesValidationErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response when a required parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code indicating a required parameter is missing. \nPossible values:\n**MANDATORY_PARAM_MISSING** - A required parameter was not included in the request.", "enum": [ "MANDATORY_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the missing parameter.", "properties": { "api_name": { "description": "Represents the API name of the missing required parameter.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing parameter issue. ", "example": "Required parameter is missing", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateRolesMandatoryParamMissingError" }, { "additionalProperties": false, "description": "Represents the error response when the update operation is not permitted.", "properties": { "code": { "description": "Represents the error code indicating the operation is not allowed. \nPossible values:\n**NOT_ALLOWED** - The operation is not permitted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about why the operation is not allowed.", "type": "object" }, "message": { "description": "Represents the error message describing why the operation is not allowed. ", "example": "This operation is not allowed", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateRolesNotAllowedError" } ], "description": "Represents the error response for the role update operation.", "x-zs-$id": "UpdateRolesErrorResponse" } } }, "description": "The request contains invalid data or a required parameter is missing. **Resolution**: Verify that all roles include a valid **ID** field and that all updated fields conform to the allowed format and constraints." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.roles.UPDATE" ] } ], "summary": "Update a role", "tags": [ "roles" ], "x-zoho-document": "roles", "x-zs-llm-description": "Updates a single role per request (identified by its ID in the body); bulk update is not supported." } }, "/crm/v8/settings/roles/{role}": { "delete": { "description": "Deletes a role in your Zoho CRM organization and moves its users to another role.", "operationId": "deleteRole", "parameters": [ { "$ref": "#/components/parameters/RolesRole" }, { "$ref": "#/components/parameters/TransferToId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response returning the deletion result for the specified role.", "summary": "Successful single role deletion response", "value": { "roles": [ { "code": "SUCCESS", "details": { "id": "4413524000000991004" }, "message": "Role Deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for the single role deletion operation.", "properties": { "roles": { "description": "Represents the list containing the role deletion result. ", "items": { "additionalProperties": false, "description": "Represents the deletion result for the specified role. ", "properties": { "code": { "description": "Represents the result code of the role deletion operation. \nPossible values:\n**SUCCESS** - The role deletion succeeded.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the deleted role. ", "properties": { "id": { "description": "Represents the unique ID of the deleted role. ", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message for the role deletion result. ", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the role deletion operation. \nPossible values:\n**success** - The role deletion succeeded.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "DeleteRoleResponse" } } }, "description": "Returns the deletion result for the specified role." }, "400": { "content": { "application/json": { "examples": { "Error": { "description": "Shows an error response when the required transfer_to parameter is missing from the deletion request.", "summary": "Missing required parameter during single role deletion", "value": { "roles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.roles[0].transfer_to_id", "maximum_length": 200 }, "message": "invalid transferToId", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response when the request body contains invalid data for deletion.", "properties": { "roles": { "description": "Represents the list of role deletion failure results for invalid data errors. ", "items": { "additionalProperties": false, "description": "Represents the failure result for the role deletion where an invalid data error occurred. ", "properties": { "code": { "description": "Represents the error code for the invalid data failure. \nPossible values:\n**INVALID_DATA** - The provided data failed validation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the field that failed validation. ", "properties": { "api_name": { "description": "Represents the API name of the field that failed validation. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that failed validation. ", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that failed validation.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role deletion operation for this item. \nPossible values:\n**error** - The role deletion failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "DeleteRolesValidationError" }, { "additionalProperties": false, "description": "Represents the error response when the role cannot be deleted due to its current status.", "properties": { "code": { "description": "Represents the error code indicating that the role cannot be deleted in its current state. \nPossible values:\n**INVALID_DATA** - The role is not in a deletable state.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about why the role cannot be deleted. ", "properties": { "param_name": { "description": "Represents the name of the parameter related to the deletion error. ", "maxLength": 100, "type": "string" }, "role_status": { "description": "Represents the current status of the role that prevents deletion. ", "enum": [ "subordinate | invalid | same_role" ], "type": "string" } }, "required": [ "role_status", "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing why the role cannot be deleted. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DeleteRoleInvalidDataError" }, { "additionalProperties": false, "description": "Represents the error response when the role ID in the request URL is invalid.", "properties": { "code": { "description": "Represents the error code indicating that the role ID in the request URL is invalid. \nPossible values:\n**INVALID_DATA** - The provided data is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid URL error. ", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment that is invalid. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid URL issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DeleteRoleInvalidUrlError" }, { "additionalProperties": false, "description": "Represents the error response when the required transfer_to query parameter is missing.", "properties": { "code": { "description": "Represents the error code indicating that the required transfer_to parameter is missing. \nPossible values:\n**REQUIRED_PARAM_MISSING** - A required query parameter is absent from the request.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the missing required parameter. ", "properties": { "param_name": { "description": "Represents the name of the missing required parameter. ", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message indicating the missing required parameter. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DeleteRoleRequiredParamMissingError" } ], "description": "Represents the error response for the single role deletion operation.", "x-zs-$id": "DeleteRoleErrorResponse" } } }, "description": "The request failed due to an invalid role ID, missing required parameter, or a role that cannot be deleted. **Resolution**: Verify that the role ID is valid, include the transfer_to parameter, and confirm the role is in a deletable state." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.roles.DELETE" ] } ], "summary": "Delete a role", "tags": [ "roles" ], "x-zoho-document": "roles", "x-zs-llm-description": "transfer_to_id (query parameter) is required - the deleted role's users move to that role; without it the request fails with 400." }, "get": { "description": "Returns the details of a single role, specified by its ID in the URL.", "operationId": "getRole", "parameters": [ { "description": "Specify the unique ID of the role for which you want to retrieve the details. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "in": "path", "name": "role", "required": true, "schema": { "maxLength": 19, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response with the details of the requested role.", "summary": "Successful single role retrieval response", "value": { "roles": [ { "api_name": "sales_manager", "created_by__s": { "id": "4413524000000991010", "name": "Admin User" }, "created_time__s": "2023-11-01T09:00:00Z", "description": "Manages sales team and processes", "display_label": "Sales Manager", "forecast_manager": { "id": "4413524000000991008", "name": "John Doe" }, "id": "4413524000000991007", "modified_by__s": { "id": "4413524000000991011", "name": "Admin User" }, "modified_time__s": "2023-12-01T10:00:00Z", "name": "Sales Manager", "reporting_to": { "id": "4413524000000991009", "name": "VP Sales" }, "share_with_peers": true } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response containing the details of the specified CRM role.", "properties": { "roles": { "description": "Represents the list containing the requested CRM role. ", "items": { "additionalProperties": false, "description": "Represents the requested role. ", "properties": { "api_name": { "description": "Represents the API name identifier for the role, used to reference the role programmatically.", "maxLength": 100, "type": "string", "x-zs-$id": "GetRoleApiName" }, "created_by__s": { "additionalProperties": false, "description": "Represents the user who created this role. ", "properties": { "id": { "description": "Represents the unique ID of the user who created the role. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the user who created the role. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "created_time__s": { "description": "Represents the timestamp indicating when the role was added to the organization. ", "format": "date-time", "type": [ "string", "null" ] }, "description": { "description": "Represents the description of the role, providing additional context about its purpose and responsibilities. ", "maxLength": 255, "type": [ "string", "null" ] }, "display_label": { "description": "Represents the display label of the role as shown in the Zoho CRM user interface. ", "maxLength": 200, "type": "string" }, "forecast_manager": { "additionalProperties": false, "description": "Represents the forecast manager assigned to this role. ", "properties": { "id": { "description": "Represents the unique ID of the forecast manager assigned to the role. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the forecast manager assigned to the role. ", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": [ "object", "null" ] }, "id": { "description": "Represents the unique ID of the role. ", "maxLength": 19, "type": "string" }, "modified_by__s": { "additionalProperties": false, "description": "Represents the user who last modified this role. ", "properties": { "id": { "description": "Represents the unique ID of the user who last modified the role. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the user who last modified the role. ", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "modified_time__s": { "description": "Represents the timestamp at which the role was last modified. ", "format": "date-time", "type": [ "string", "null" ] }, "name": { "description": "Represents the display name of the role. ", "maxLength": 200, "type": "string" }, "reporting_to": { "additionalProperties": false, "description": "Represents the parent role to which this role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "properties": { "id": { "description": "Represents the unique ID of the parent role in the role hierarchy. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the parent role in the role hierarchy. ", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": [ "object", "null" ] }, "share_with_peers": { "description": "Indicates whether users assigned to this role can share records with users in peer roles at the same level. \nPossible values:\n**true** - Users assigned to this role can share records with peer role users.\n**false** - Users assigned to this role cannot share records with peer role users.", "type": "boolean" } }, "required": [ "display_label", "forecast_manager", "reporting_to", "share_with_peers", "description", "id", "name", "created_by__s", "modified_by__s", "modified_time__s", "created_time__s" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "GetRoleResponse" } } }, "description": "Returns the details of the specified CRM role." }, "204": { "description": "No content - the specified role was not found or the user does not have access to it." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.roles.READ" ] } ], "summary": "Get a role", "tags": [ "roles" ], "x-zoho-document": "roles", "x-zs-llm-description": "Returns one role by its ID (path parameter role)." }, "put": { "description": "Updates a single role, specified by its ID in the URL.", "operationId": "updateRole", "parameters": [ { "$ref": "#/components/parameters/RolesRole" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateRole": { "description": "Shows a single role update request specifying a new name and description for the role.", "summary": "Update a role with new name and description", "value": { "roles": [ { "description": "Updated description for senior sales manager role", "name": "Senior Sales Manager" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for updating a specific CRM role.", "properties": { "roles": { "description": "Specify the array containing the role object to update.", "items": { "additionalProperties": false, "description": "Specify the updated field values for the role.", "properties": { "description": { "description": "Specify the updated description for the role.", "maxLength": 250, "type": [ "string", "null" ] }, "name": { "description": "Specify the updated display name for the role.", "maxLength": 200, "type": "string" }, "reporting_to": { "additionalProperties": false, "description": "Specify the updated parent role for this role in the CRM hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values.", "properties": { "id": { "description": "Specify the unique ID of the updated parent role.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } } }, "type": "object" }, "share_with_peers": { "description": "Specify whether users assigned to this role can share records with users in peer roles at the same level.\nPossible values:\n**true** - Users assigned to this role can share records with peer role users.\n**false** - Users assigned to this role cannot share records with peer role users.", "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateRole" ] } }, "description": "The request body must contain a roles array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response returning the update result for the specified role.", "summary": "Successful single role update response", "value": { "roles": [ { "code": "SUCCESS", "details": { "id": "4413524000000991004" }, "message": "Role updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for the single role update operation.", "properties": { "roles": { "description": "Represents the list containing the role update result. ", "items": { "additionalProperties": false, "description": "Represents the update result for the specified role. ", "properties": { "code": { "description": "Represents the result code of the role update operation. \nPossible values:\n**SUCCESS** - The role update succeeded.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the updated role. ", "properties": { "id": { "description": "Represents the unique ID of the updated role. ", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message for the role update result. ", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the role update operation. \nPossible values:\n**success** - The role update succeeded.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "UpdateRoleResponse" } } }, "description": "Returns the update result for the specified role." }, "400": { "content": { "application/json": { "examples": { "Error": { "description": "Shows an error response when the request body contains invalid data for the role update.", "summary": "Validation error during single role update", "value": { "roles": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.roles[0].name", "maximum_length": 200 }, "message": "Invalid role name", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response when the role ID in the request URL is invalid.", "properties": { "code": { "description": "Represents the error code indicating an invalid URL pattern. \nPossible values:\n**INVALID_DATA** - The provided data is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid URL error. ", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment that is invalid. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid URL issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the error status of the request. \nPossible values:\n**error** - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UpdateRoleInvalidUrlError" }, { "additionalProperties": false, "description": "Represents the error response when the updated role data fails validation.", "properties": { "roles": { "description": "Represents the list of role update failure results for validation errors. ", "items": { "additionalProperties": false, "description": "Represents the failure result for the role update where a validation error occurred. ", "properties": { "code": { "description": "Represents the error code for the validation failure. \nPossible values:\n**INVALID_DATA** - The provided data failed validation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the field that failed validation. ", "properties": { "api_name": { "description": "Represents the API name of the field that failed validation. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that failed validation. ", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that failed validation. ", "format": "int32", "type": "integer" } }, "required": [ "maximum_length", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role update operation for this item. \nPossible values:\n**error** - The role update failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "UpdateRolesValidationError" }, { "additionalProperties": false, "description": "Represents the error response when the updated role contains invalid data.", "properties": { "roles": { "description": "Represents the list of role update failure results for invalid data errors. ", "items": { "additionalProperties": false, "description": "Represents the failure result for the role update where an invalid data error occurred. ", "properties": { "code": { "description": "Represents the error code for the invalid data failure. \nPossible values:\n**INVALID_DATA** - The provided data is invalid.", "enum": [ "INVALID_DATA", "invalid data" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the field that contains invalid data. ", "properties": { "api_name": { "description": "Represents the API name of the field that contains the invalid data. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that contains the invalid data. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role update operation for this item. \nPossible values:\n**error** - The role update failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "UpdateRoleInvalidDataValidationError" }, { "additionalProperties": false, "description": "Represents the error response when the updated role data conflicts with an existing role.", "properties": { "roles": { "description": "Represents the list of role update failure results for duplicate data errors. ", "items": { "additionalProperties": false, "description": "Represents the failure result for the role update where a duplicate data error occurred. ", "properties": { "code": { "description": "Represents the error code for the duplicate data failure. \nPossible values:\n**DUPLICATE_DATA** - The role data conflicts with an existing role.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the field that caused the duplicate data error. ", "properties": { "api_name": { "description": "Represents the API name of the field that contains the duplicate value. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that contains the duplicate value. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the duplicate data issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the role update operation for this item. \nPossible values:\n**error** - The role update failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "roles" ], "type": "object", "x-zs-$id": "UpdateRoleDuplicateDataValidationError" } ], "description": "Represents the error response for the single role update operation.", "x-zs-$id": "UpdateRoleErrorResponse" } } }, "description": "The request contains invalid data or the role ID is invalid. **Resolution**: Verify that the role ID in the request URL is valid and that all updated fields conform to the allowed format and constraints." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.roles.UPDATE" ] } ], "summary": "Update a role", "tags": [ "roles" ], "x-zoho-document": "roles", "x-zs-llm-description": "Updates one role by its ID (path parameter role)." } }, "/crm/v8/settings/service_preferences": { "get": { "description": "Retrieves the service preference settings of the organization, including whether the job sheet is enabled for service appointments. Use this API to check whether a job sheet can be generated once a service appointment is marked complete.", "operationId": "getServicePreference", "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Illustrates a successful response that returns the current service preference configuration of the organization, showing that the job sheet is enabled.", "summary": "An example successful response for retrieving service preferences.", "value": { "service_preferences": { "job_sheet_enabled": true } } } }, "schema": { "additionalProperties": false, "description": "Represents the response wrapper that contains the service preference settings of the organization.", "properties": { "service_preferences": { "additionalProperties": false, "description": "Represents the service preference settings configured for the organization.", "properties": { "job_sheet_enabled": { "description": "Denotes whether the job sheet is enabled for the\norganization. When the job sheet is enabled, a job\nsheet can be generated for a service appointment once\nthe appointment is marked complete.\n\n\nPossible values:\n\n\n- **true**: The job sheet is enabled for the\norganization. This is the default value.\n\n- **false**: The job sheet is disabled for the\norganization.\n", "type": "boolean" } }, "required": [ "job_sheet_enabled" ], "type": "object" } }, "required": [ "service_preferences" ], "type": "object", "x-zs-$id": "GetServicePreferenceResponse" } } }, "description": "The service preference settings of the organization were retrieved successfully." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.READ" ] } ], "summary": "Get service preferences", "tags": [ "service_preference" ], "x-zoho-document": "service_preference" }, "put": { "description": "Updates the service preference settings of the organization. Use this API to enable or disable the job sheet, which controls whether a job sheet can be generated for a service appointment once the appointment is marked complete.", "operationId": "updateServicePreference", "requestBody": { "content": { "application/json": { "examples": { "ExpectedRequest": { "description": "Illustrates a request that enables the job sheet for the organization.", "summary": "An example request to update service preferences.", "value": { "service_preferences": { "job_sheet_enabled": true } } } }, "schema": { "additionalProperties": false, "description": "Represents the request wrapper used to update the service preference settings of the organization.", "properties": { "service_preferences": { "additionalProperties": false, "description": "Represents the service preference settings to update for the organization.", "properties": { "job_sheet_enabled": { "description": "Denotes whether you want to enable the job sheet for the\norganization. When the job sheet is enabled, a job sheet\ncan be generated for a service appointment once the\nappointment is marked complete.\n\n\nPossible values:\n\n\n- **true**: enables the job sheet for the organization.\nThis is the default value.\n\n- **false**: disables the job sheet for the\norganization.\n", "type": "boolean" } }, "required": [ "job_sheet_enabled" ], "type": "object" } }, "required": [ "service_preferences" ], "type": "object" } } }, "description": "The request body contains the data required to perform the operation. ", "required": true, "x-zs-llm-examples": [ "ExpectedRequest" ] }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Illustrates a successful response that the API returns after it updates the service preferences of the organization.", "summary": "An example successful response for updating service preferences.", "value": { "service_preferences": { "code": "SUCCESS", "details": {}, "message": "Services preferences updated successfully", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Represents the response wrapper returned after the API updates the service preference settings of the organization.", "properties": { "service_preferences": { "additionalProperties": false, "description": "Represents the result of updating the service preference settings of the organization.", "properties": { "code": { "description": "Represents the code that indicates the result of the update operation.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the update operation. This object is empty when the update is successful.", "type": "object" }, "message": { "description": "Represents the message that describes the result of the update operation.", "enum": [ "Services preferences updated successfully" ], "type": "string" }, "status": { "description": "Represents the status of the update operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" } }, "required": [ "service_preferences" ], "type": "object", "x-zs-$id": "UpdateServicePreferenceResponse" } } }, "description": "The service preference settings of the organization were updated successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Illustrates the error response returned when the `job_sheet_enabled` key is provided with a value whose data type is not Boolean.", "summary": "An example error response when job_sheet_enabled has an invalid data type.", "value": { "service_preferences": { "code": "INVALID_DATA", "details": { "api_name": "job_sheet_enabled", "expected_data_type": "boolean", "json_path": "$.service_preferences.job_sheet_enabled" }, "message": "invalid data", "status": "error" } } }, "MandatoryNotFound": { "description": "Illustrates the error response returned when the `service_preferences` key is missing in the request payload.", "summary": "An example error response when the service_preferences key is missing.", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "service_preferences", "json_path": "$.service_preferences" }, "message": "required field not found", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": true, "description": "Represents the error response returned when a mandatory field is missing in the request to update service preferences.", "properties": { "service_preferences": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error details returned when a mandatory field is missing in the request payload.", "properties": { "code": { "description": "Represents the error code returned when a mandatory field is missing in the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing mandatory field.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing mandatory field in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the message that describes the missing mandatory field.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the failed request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MandatoryNotFoundErrorDetails" }, { "additionalProperties": false, "description": "Represents the error details returned when the request payload contains an invalid value for a field.", "properties": { "code": { "description": "Represents the error code returned when the request contains invalid data.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the identifying details of the invalid field in the request payload.", "properties": { "api_name": { "description": "Represents the API name of the invalid field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the invalid field in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "InvalidDataErrorFieldDetails" }, { "additionalProperties": false, "description": "Represents the identifying details of the invalid field along with the data type expected for the field.", "properties": { "api_name": { "description": "Represents the API name of the invalid field.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the invalid field.", "enum": [ "boolean" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the invalid field in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidDataErrorFieldTypeDetails" } ], "description": "Represents the details of the invalid field in the request payload." }, "message": { "description": "Represents the message that describes the invalid data error.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the failed request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataErrorDetails" } ], "description": "Represents the error details returned when the request to update service preferences fails because of a missing mandatory field or invalid data." } }, "required": [], "type": "object", "x-zs-$id": "MandatoryNotFoundErrorResponse" }, { "additionalProperties": true, "description": "Represents the error response returned when the request payload contains an invalid value for a field.", "properties": { "code": { "description": "Represents the error code returned when the request contains invalid data.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the identifying details of the invalid field in the request payload.", "properties": { "api_name": { "description": "Represents the API name of the invalid field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the invalid field in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "InvalidDataFieldDetails" }, { "additionalProperties": false, "description": "Represents the identifying details of the invalid field along with the data type expected for the field.", "properties": { "api_name": { "description": "Represents the API name of the invalid field.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected for the invalid field.", "enum": [ "boolean" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the invalid field in the request payload.", "maxLength": 1000, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidDataFieldTypeDetails" } ], "description": "Represents the details of the invalid field in the request payload." }, "message": { "description": "Represents the message that describes the invalid data error.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the failed request.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidDataErrorResponse" } ], "description": "Represents the error response returned when the request to update service preferences is invalid.", "x-zs-$id": "ErrorResponse" } } }, "description": "The request to update the service preference settings failed because of a missing mandatory field or invalid data in the request payload." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.UPDATE" ] } ], "summary": "Update service preferences", "tags": [ "service_preference" ], "x-zoho-document": "service_preference" } }, "/crm/v8/settings/tags": { "get": { "description": "To retrieve all tags associated with a module in your Zoho CRM organization.", "operationId": "getTags", "parameters": [ { "$ref": "#/components/parameters/TagsParamQueryModule" }, { "$ref": "#/components/parameters/TagsParamQueryInclude" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response for retrieving tags with status 200.", "summary": "Successful response for tag list retrieval", "value": { "info": { "allowed_count": 500, "count": 484, "record_limit": 20 }, "tags": [ { "color_code": "#F48435", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T10:43:05+05:30", "id": "111111000000071739", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T10:43:05+05:30", "name": "new" }, { "color_code": "#658BA8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T10:55:07+05:30", "id": "111111000000071766", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T10:55:07+05:30", "name": "new2" }, { "color_code": "#969696", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:34:29+05:30", "id": "111111000000115121", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:34:29+05:30", "name": "new1" }, { "color_code": "#A1E5F2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115126", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag2" }, { "color_code": "#F2B6A0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115127", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag3" }, { "color_code": "#C2F27E", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115128", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag4" }, { "color_code": "#E3A0F2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115129", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag5" }, { "color_code": "#F28D8D", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115130", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag6" }, { "color_code": "#7DF2D5", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115131", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag7" }, { "color_code": "#F2D6A0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115132", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag8" }, { "color_code": "#B0A6F2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115133", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag9" }, { "color_code": "#A0F2A8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115134", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag10" }, { "color_code": "#F2A0C4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115135", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag11" }, { "color_code": "#62FED2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115136", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag12" }, { "color_code": "#F2E062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115137", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag13" }, { "color_code": "#62A8FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115138", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag14" }, { "color_code": "#FEBE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115139", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag15" }, { "color_code": "#62FE8A", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115140", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag16" }, { "color_code": "#D462FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115141", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag17" }, { "color_code": "#FE6262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115142", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag18" }, { "color_code": "#62FECC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115143", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag19" }, { "color_code": "#FEA662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115144", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag20" }, { "color_code": "#B7FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115145", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag21" }, { "color_code": "#6269FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115146", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag22" }, { "color_code": "#FE62A3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115147", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag23" }, { "color_code": "#7AFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115148", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag24" }, { "color_code": "#62C2FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115149", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag25" }, { "color_code": "#FEE162", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115150", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag26" }, { "color_code": "#62FEF1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115151", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag27" }, { "color_code": "#F28F62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115152", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag28" }, { "color_code": "#C562FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115153", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag29" }, { "color_code": "#62FE73", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115154", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag30" }, { "color_code": "#FE62D3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115155", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag31" }, { "color_code": "#FEB762", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115157", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag33" }, { "color_code": "#62FEA0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115158", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag34" }, { "color_code": "#8762FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115159", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag35" }, { "color_code": "#FE626B", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115160", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag36" }, { "color_code": "#62FEDF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115161", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag37" }, { "color_code": "#FECA62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115162", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag38" }, { "color_code": "#9FFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115163", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag39" }, { "color_code": "#62C0FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115164", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag40" }, { "color_code": "#62FE8F", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115166", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag42" }, { "color_code": "#C062FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115167", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag43" }, { "color_code": "#FE6262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115168", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag44" }, { "color_code": "#62FEE6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115169", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag45" }, { "color_code": "#FEDE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115170", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag46" }, { "color_code": "#83FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115171", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag47" }, { "color_code": "#62AEFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115172", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag48" }, { "color_code": "#FE62C8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115173", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag49" }, { "color_code": "#62FE9B", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115174", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag50" }, { "color_code": "#A662FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115175", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag51" }, { "color_code": "#FE6662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115176", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag52" }, { "color_code": "#62FEF6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115177", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag53" }, { "color_code": "#FEC462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115178", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag54" }, { "color_code": "#9AFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115179", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag55" }, { "color_code": "#62B6FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115180", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag56" }, { "color_code": "#FE62B9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115181", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag57" }, { "color_code": "#62FE93", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115182", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag58" }, { "color_code": "#BA62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115183", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag59" }, { "color_code": "#FE6D62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115184", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag60" }, { "color_code": "#62FEEA", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115185", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag61" }, { "color_code": "#FEEB62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115186", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag62" }, { "color_code": "#8FFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115187", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag63" }, { "color_code": "#62A9FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115188", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag64" }, { "color_code": "#FE62D9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115189", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag65" }, { "color_code": "#62FEA6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115190", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag66" }, { "color_code": "#CA62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115191", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag67" }, { "color_code": "#FE7262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115192", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag68" }, { "color_code": "#62FEEC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115193", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag69" }, { "color_code": "#FEE762", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115194", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag70" }, { "color_code": "#94FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115195", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag71" }, { "color_code": "#62B2FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115196", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag72" }, { "color_code": "#FE62E5", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115197", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag73" }, { "color_code": "#62FEB1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115198", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag74" }, { "color_code": "#D762FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115199", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag75" }, { "color_code": "#FE7E62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115200", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag76" }, { "color_code": "#62FEF2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115201", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag77" }, { "color_code": "#FED662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115202", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag78" }, { "color_code": "#A6FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115203", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag79" }, { "color_code": "#62C9FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115204", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag80" }, { "color_code": "#FE62F1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115205", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag81" }, { "color_code": "#62FEBE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115206", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag82" }, { "color_code": "#DE62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115207", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag83" }, { "color_code": "#FE8962", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115208", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag84" }, { "color_code": "#62FEFB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115209", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag85" }, { "color_code": "#FEB362", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115210", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag86" }, { "color_code": "#BAFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115211", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag87" }, { "color_code": "#62D0FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115212", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag88" }, { "color_code": "#FE62FD", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115213", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag89" }, { "color_code": "#62FEC8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115214", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag90" }, { "color_code": "#E162FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115215", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag91" }, { "color_code": "#FE9262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115216", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag92" }, { "color_code": "#62FEEE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115217", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag93" }, { "color_code": "#FED162", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115218", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag94" }, { "color_code": "#BEFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115219", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag95" }, { "color_code": "#62D6FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115220", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag96" }, { "color_code": "#FE62A8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115221", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag97" }, { "color_code": "#62FE82", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115222", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag98" }, { "color_code": "#C862FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115223", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag99" }, { "color_code": "#FE626F", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:35:03+05:30", "id": "111111000000115224", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:35:03+05:30", "name": "tag100" }, { "color_code": "#62FE9E", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115327", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag101" }, { "color_code": "#FEA162", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115328", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag102" }, { "color_code": "#9C62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115329", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag103" }, { "color_code": "#62FECF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115330", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag104" }, { "color_code": "#FEDA62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115331", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag105" }, { "color_code": "#62A2FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115332", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag106" }, { "color_code": "#FE62B2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115333", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag107" }, { "color_code": "#62FE88", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115334", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag108" }, { "color_code": "#C162FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115335", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag109" }, { "color_code": "#FE6F62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115336", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag110" }, { "color_code": "#62FEDE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115337", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag111" }, { "color_code": "#FEDC62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115338", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag112" }, { "color_code": "#A3FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115339", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag113" }, { "color_code": "#62BDFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115340", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag114" }, { "color_code": "#FE62D0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115341", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag115" }, { "color_code": "#62FEA3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115342", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag116" }, { "color_code": "#CC62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115343", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag117" }, { "color_code": "#FE7A62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115344", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag118" }, { "color_code": "#62FEE8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115345", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag119" }, { "color_code": "#FEE562", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115346", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag120" }, { "color_code": "#8BFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115347", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag121" }, { "color_code": "#62ACFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115348", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag122" }, { "color_code": "#FE62DF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115349", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag123" }, { "color_code": "#62FEB4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115350", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag124" }, { "color_code": "#D262FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115351", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag125" }, { "color_code": "#FE8462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115352", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag126" }, { "color_code": "#62FEF4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115353", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag127" }, { "color_code": "#FECF62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115354", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag128" }, { "color_code": "#AAFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115355", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag129" }, { "color_code": "#62C5FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115356", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag130" }, { "color_code": "#FE62ED", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115357", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag131" }, { "color_code": "#62FEC2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115358", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag132" }, { "color_code": "#DA62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115359", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag133" }, { "color_code": "#FE8F62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115360", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag134" }, { "color_code": "#62FEFA", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115361", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag135" }, { "color_code": "#FEB962", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115362", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag136" }, { "color_code": "#B3FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115363", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag137" }, { "color_code": "#62CEFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115364", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag138" }, { "color_code": "#FE62F9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115365", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag139" }, { "color_code": "#62FEC9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115366", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag140" }, { "color_code": "#E462FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115367", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag141" }, { "color_code": "#FE9962", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115368", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag142" }, { "color_code": "#62FEF0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115369", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag143" }, { "color_code": "#FED762", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115370", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag144" }, { "color_code": "#BFFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115371", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag145" }, { "color_code": "#62D9FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115372", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag146" }, { "color_code": "#FE62A1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115373", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag147" }, { "color_code": "#62FE7D", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115374", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag148" }, { "color_code": "#CE62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115375", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag149" }, { "color_code": "#FE6278", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115376", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag150" }, { "color_code": "#62FEE1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115377", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag151" }, { "color_code": "#FEEF62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115378", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag152" }, { "color_code": "#97FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115379", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag153" }, { "color_code": "#62B8FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115380", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag154" }, { "color_code": "#FE62C2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115381", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag155" }, { "color_code": "#62FE95", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115382", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag156" }, { "color_code": "#BC62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115383", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag157" }, { "color_code": "#FE6A62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115384", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag158" }, { "color_code": "#62FEED", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115385", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag159" }, { "color_code": "#FEE062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115386", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag160" }, { "color_code": "#A0FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115387", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag161" }, { "color_code": "#62AFFF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115388", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag162" }, { "color_code": "#FE62E1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115389", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag163" }, { "color_code": "#62FEB8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115390", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag164" }, { "color_code": "#D562FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115391", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag165" }, { "color_code": "#FE8162", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115392", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag166" }, { "color_code": "#62FEF8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115393", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag167" }, { "color_code": "#FEC962", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115394", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag168" }, { "color_code": "#ACFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115395", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag169" }, { "color_code": "#62C1FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115396", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag170" }, { "color_code": "#FE62F5", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115397", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag171" }, { "color_code": "#62FEBF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115398", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag172" }, { "color_code": "#DF62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115399", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag173" }, { "color_code": "#FE8B62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115400", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag174" }, { "color_code": "#62FEFD", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115401", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag175" }, { "color_code": "#FEB062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115402", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag176" }, { "color_code": "#B6FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115403", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag177" }, { "color_code": "#62D3FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115404", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag178" }, { "color_code": "#FE62FF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115405", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag179" }, { "color_code": "#62FEC6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115406", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag180" }, { "color_code": "#E762FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115407", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag181" }, { "color_code": "#FE9462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115408", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag182" }, { "color_code": "#62FEF3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115409", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag183" }, { "color_code": "#FED462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115410", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag184" }, { "color_code": "#C3FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115411", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag185" }, { "color_code": "#62DFFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115412", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag186" }, { "color_code": "#FE62AD", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115413", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag187" }, { "color_code": "#62FE86", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115414", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag188" }, { "color_code": "#D162FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115415", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag189" }, { "color_code": "#FE6273", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115416", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag190" }, { "color_code": "#62FEE4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115417", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag191" }, { "color_code": "#FEF362", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115418", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag192" }, { "color_code": "#9AFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115419", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag193" }, { "color_code": "#62B3FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115420", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag194" }, { "color_code": "#FE62C9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115421", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag195" }, { "color_code": "#62FE9A", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115422", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag196" }, { "color_code": "#C762FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115423", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag197" }, { "color_code": "#FE6E62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115424", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag198" }, { "color_code": "#62FEEF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115425", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag199" }, { "color_code": "#FEDD62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:36:32+05:30", "id": "111111000000115426", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:36:32+05:30", "name": "tag200" }, { "color_code": "#62FEA4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115529", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag201" }, { "color_code": "#FEA762", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115530", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag202" }, { "color_code": "#A162FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115531", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag203" }, { "color_code": "#62FEDA", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115532", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag204" }, { "color_code": "#FEE062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115533", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag205" }, { "color_code": "#62A5FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115534", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag206" }, { "color_code": "#FE62BC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115535", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag207" }, { "color_code": "#62FE8C", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115536", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag208" }, { "color_code": "#C562FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115537", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag209" }, { "color_code": "#FE7362", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115538", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag210" }, { "color_code": "#62FEE0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115539", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag211" }, { "color_code": "#FEDF62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115540", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag212" }, { "color_code": "#A6FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115541", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag213" }, { "color_code": "#62C1FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115542", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag214" }, { "color_code": "#FE62D4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115543", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag215" }, { "color_code": "#62FEA8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115544", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag216" }, { "color_code": "#CF62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115545", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag217" }, { "color_code": "#FE7F62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115546", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag218" }, { "color_code": "#62FEEB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115547", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag219" }, { "color_code": "#FEE662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115548", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag220" }, { "color_code": "#8EFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115549", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag221" }, { "color_code": "#62B0FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115550", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag222" }, { "color_code": "#FE62E2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115551", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag223" }, { "color_code": "#62FEB9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115552", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag224" }, { "color_code": "#D762FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115553", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag225" }, { "color_code": "#FE8562", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115554", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag226" }, { "color_code": "#62FEF7", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115555", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag227" }, { "color_code": "#FECC62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115556", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag228" }, { "color_code": "#AFFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115557", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag229" }, { "color_code": "#62C6FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115558", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag230" }, { "color_code": "#FE62EF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115559", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag231" }, { "color_code": "#62FEC3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115560", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag232" }, { "color_code": "#DB62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115561", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag233" }, { "color_code": "#FE9062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115562", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag234" }, { "color_code": "#62FEFC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115563", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag235" }, { "color_code": "#FEBB62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115564", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag236" }, { "color_code": "#B8FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115565", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag237" }, { "color_code": "#62CFFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115566", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag238" }, { "color_code": "#FE62FB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115567", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag239" }, { "color_code": "#62FEC7", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115568", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag240" }, { "color_code": "#E862FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115569", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag241" }, { "color_code": "#FE9C62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115570", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag242" }, { "color_code": "#62FEF1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115571", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag243" }, { "color_code": "#FED862", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115572", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag244" }, { "color_code": "#C6FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115573", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag245" }, { "color_code": "#62E0FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115574", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag246" }, { "color_code": "#FE62A6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115575", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag247" }, { "color_code": "#62FE80", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115576", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag248" }, { "color_code": "#D462FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115577", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag249" }, { "color_code": "#FE627C", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115578", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag250" }, { "color_code": "#62FEE2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115579", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag251" }, { "color_code": "#FEF062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115580", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag252" }, { "color_code": "#9DFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115581", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag253" }, { "color_code": "#62B5FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115582", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag254" }, { "color_code": "#FE62C4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115583", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag255" }, { "color_code": "#62FE98", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115584", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag256" }, { "color_code": "#BF62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115585", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag257" }, { "color_code": "#FE6C62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115586", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag258" }, { "color_code": "#62FEEE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115587", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag259" }, { "color_code": "#FEE262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115588", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag260" }, { "color_code": "#A3FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115589", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag261" }, { "color_code": "#62ABFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115590", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag262" }, { "color_code": "#FE62E6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115591", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag263" }, { "color_code": "#62FEB5", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115592", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag264" }, { "color_code": "#D962FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115593", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag265" }, { "color_code": "#FE8262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115594", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag266" }, { "color_code": "#62FEF9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115595", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag267" }, { "color_code": "#FEC762", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115596", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag268" }, { "color_code": "#B2FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115597", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag269" }, { "color_code": "#62C3FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115598", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag270" }, { "color_code": "#FE62F6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115599", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag271" }, { "color_code": "#62FEC0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115600", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag272" }, { "color_code": "#E062FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115601", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag273" }, { "color_code": "#FE8D62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115602", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag274" }, { "color_code": "#62FEFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115603", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag275" }, { "color_code": "#FEB262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115604", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag276" }, { "color_code": "#BBFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115605", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag277" }, { "color_code": "#62D5FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115606", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag278" }, { "color_code": "#FE62FA", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115607", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag279" }, { "color_code": "#62FECB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115608", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag280" }, { "color_code": "#EB62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115609", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag281" }, { "color_code": "#FE9662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115610", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag282" }, { "color_code": "#62FEF5", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115611", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag283" }, { "color_code": "#FED262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115612", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag284" }, { "color_code": "#C9FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115613", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag285" }, { "color_code": "#62DCFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115614", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag286" }, { "color_code": "#FE62B1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115615", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag287" }, { "color_code": "#62FE84", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115616", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag288" }, { "color_code": "#D762FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115617", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag289" }, { "color_code": "#FE6271", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115618", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag290" }, { "color_code": "#62FEE5", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115619", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag291" }, { "color_code": "#FEF462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115620", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag292" }, { "color_code": "#A0FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115621", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag293" }, { "color_code": "#62B7FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115622", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag294" }, { "color_code": "#FE62CB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115623", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag295" }, { "color_code": "#62FE9C", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115624", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag296" }, { "color_code": "#CA62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115625", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag297" }, { "color_code": "#FE7062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115626", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag298" }, { "color_code": "#62FEEF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115627", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag299" }, { "color_code": "#FEDA62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:39:09+05:30", "id": "111111000000115628", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:39:09+05:30", "name": "tag300" }, { "color_code": "#62FEA7", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115731", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag301" }, { "color_code": "#FEAA62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115732", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag302" }, { "color_code": "#A562FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115733", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag303" }, { "color_code": "#62FEDB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115734", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag304" }, { "color_code": "#FEE362", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115735", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag305" }, { "color_code": "#62A8FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115736", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag306" }, { "color_code": "#FE62BE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115737", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag307" }, { "color_code": "#62FE8E", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115738", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag308" }, { "color_code": "#C862FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115739", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag309" }, { "color_code": "#FE7562", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115740", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag310" }, { "color_code": "#62FEE3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115741", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag311" }, { "color_code": "#FEE162", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115742", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag312" }, { "color_code": "#A9FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115743", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag313" }, { "color_code": "#62C4FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115744", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag314" }, { "color_code": "#FE62D6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115745", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag315" }, { "color_code": "#62FEAB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115746", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag316" }, { "color_code": "#D262FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115747", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag317" }, { "color_code": "#FE8062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115748", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag318" }, { "color_code": "#62FEEE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115749", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag319" }, { "color_code": "#FEE862", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115750", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag320" }, { "color_code": "#91FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115751", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag321" }, { "color_code": "#62B2FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115752", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag322" }, { "color_code": "#FE62E4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115753", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag323" }, { "color_code": "#62FEBB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115754", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag324" }, { "color_code": "#DA62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115755", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag325" }, { "color_code": "#FE8762", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115756", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag326" }, { "color_code": "#62FEF6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115757", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag327" }, { "color_code": "#FECF62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115758", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag328" }, { "color_code": "#B2FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115759", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag329" }, { "color_code": "#62C8FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115760", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag330" }, { "color_code": "#FE62F0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115761", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag331" }, { "color_code": "#62FEC5", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115762", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag332" }, { "color_code": "#DE62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115763", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag333" }, { "color_code": "#FE9262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115764", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag334" }, { "color_code": "#62FEFD", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115765", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag335" }, { "color_code": "#FEBE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115766", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag336" }, { "color_code": "#BBFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115767", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag337" }, { "color_code": "#62D1FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115768", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag338" }, { "color_code": "#FE62FC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115769", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag339" }, { "color_code": "#62FEC9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115770", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag340" }, { "color_code": "#EB62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115771", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag341" }, { "color_code": "#FE9E62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115772", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag342" }, { "color_code": "#62FEF2", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115773", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag343" }, { "color_code": "#FEDA62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115774", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag344" }, { "color_code": "#C9FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115775", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag345" }, { "color_code": "#62E2FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115776", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag346" }, { "color_code": "#FE62A9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115777", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag347" }, { "color_code": "#62FE83", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115778", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag348" }, { "color_code": "#D762FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115779", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag349" }, { "color_code": "#FE627E", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115780", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag350" }, { "color_code": "#62FEE4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115781", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag351" }, { "color_code": "#FEF262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115782", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag352" }, { "color_code": "#9FFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115783", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag353" }, { "color_code": "#62B9FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115784", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag354" }, { "color_code": "#FE62C6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115785", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag355" }, { "color_code": "#62FE9A", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115786", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag356" }, { "color_code": "#C262FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115787", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag357" }, { "color_code": "#FE6E62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115788", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag358" }, { "color_code": "#62FEEF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115789", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag359" }, { "color_code": "#FEE562", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115790", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag360" }, { "color_code": "#A6FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115791", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag361" }, { "color_code": "#62ADFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115792", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag362" }, { "color_code": "#FE62E8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115793", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag363" }, { "color_code": "#62FEB7", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115794", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag364" }, { "color_code": "#DD62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115795", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag365" }, { "color_code": "#FE8462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115796", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag366" }, { "color_code": "#62FEFA", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115797", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag367" }, { "color_code": "#FEC962", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115798", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag368" }, { "color_code": "#B5FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115799", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag369" }, { "color_code": "#62C6FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115800", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag370" }, { "color_code": "#FE62F7", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115801", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag371" }, { "color_code": "#62FEC1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115802", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag372" }, { "color_code": "#E262FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115803", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag373" }, { "color_code": "#FE8F62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115804", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag374" }, { "color_code": "#62FEFF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115805", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag375" }, { "color_code": "#FEB462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115806", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag376" }, { "color_code": "#BEFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115807", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag377" }, { "color_code": "#62D7FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115808", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag378" }, { "color_code": "#FE62FB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115809", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag379" }, { "color_code": "#62FECD", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115810", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag380" }, { "color_code": "#EE62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115811", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag381" }, { "color_code": "#FE9862", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115812", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag382" }, { "color_code": "#62FEF4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115813", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag383" }, { "color_code": "#FED462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115814", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag384" }, { "color_code": "#CCFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115815", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag385" }, { "color_code": "#62DEFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115816", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag386" }, { "color_code": "#FE62B3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115817", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag387" }, { "color_code": "#62FE86", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115818", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag388" }, { "color_code": "#DA62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115819", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag389" }, { "color_code": "#FE6272", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115820", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag390" }, { "color_code": "#62FEE6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115821", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag391" }, { "color_code": "#FEF662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115822", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag392" }, { "color_code": "#A2FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115823", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag393" }, { "color_code": "#62BAFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115824", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag394" }, { "color_code": "#FE62CD", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115825", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag395" }, { "color_code": "#62FE9E", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115826", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag396" }, { "color_code": "#CD62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115827", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag397" }, { "color_code": "#FE7162", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115828", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag398" }, { "color_code": "#62FEF0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115829", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag399" }, { "color_code": "#FEDD62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:49:07+05:30", "id": "111111000000115830", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:49:07+05:30", "name": "tag400" }, { "color_code": "#AAFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115933", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag401" }, { "color_code": "#62B4FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115934", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag402" }, { "color_code": "#FE62EA", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115935", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag403" }, { "color_code": "#62FEBC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115936", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag404" }, { "color_code": "#E162FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115937", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag405" }, { "color_code": "#FE8A62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115938", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag406" }, { "color_code": "#62FEFB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115939", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag407" }, { "color_code": "#FECB62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115940", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag408" }, { "color_code": "#B7FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115941", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag409" }, { "color_code": "#62CAFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115942", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag410" }, { "color_code": "#FE62F9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115943", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag411" }, { "color_code": "#62FEC6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115944", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag412" }, { "color_code": "#E662FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115945", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag413" }, { "color_code": "#FE9462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115946", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag414" }, { "color_code": "#62FEFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115947", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag415" }, { "color_code": "#FEB662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115948", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag416" }, { "color_code": "#C1FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115949", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag417" }, { "color_code": "#62D9FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115950", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag418" }, { "color_code": "#FE62FD", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115951", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag419" }, { "color_code": "#62FED0", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115952", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag420" }, { "color_code": "#F162FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115953", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag421" }, { "color_code": "#FE9A62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115954", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag422" }, { "color_code": "#62FEF6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115955", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag423" }, { "color_code": "#FED662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115956", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag424" }, { "color_code": "#CFFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115957", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag425" }, { "color_code": "#62E1FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115958", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag426" }, { "color_code": "#FE62B6", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115959", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag427" }, { "color_code": "#62FE89", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115960", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag428" }, { "color_code": "#DF62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115961", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag429" }, { "color_code": "#FE6276", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115962", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag430" }, { "color_code": "#62FEE9", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115963", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag431" }, { "color_code": "#FEF962", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115964", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag432" }, { "color_code": "#A5FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115965", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag433" }, { "color_code": "#62BCFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115966", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag434" }, { "color_code": "#FE62CF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115967", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag435" }, { "color_code": "#62FEA1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115968", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag436" }, { "color_code": "#D262FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115969", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag437" }, { "color_code": "#FE7262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115970", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag438" }, { "color_code": "#62FEF1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115971", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag439" }, { "color_code": "#FEE062", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115972", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag440" }, { "color_code": "#ADFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115973", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag441" }, { "color_code": "#62B6FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115974", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag442" }, { "color_code": "#FE62EC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115975", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag443" }, { "color_code": "#62FEBE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115976", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag444" }, { "color_code": "#E562FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115977", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag445" }, { "color_code": "#FE8C62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115978", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag446" }, { "color_code": "#62FEFC", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115979", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag447" }, { "color_code": "#FECD62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115980", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag448" }, { "color_code": "#BAFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115981", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag449" }, { "color_code": "#62CCFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115982", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag450" }, { "color_code": "#FE62FA", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115983", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag451" }, { "color_code": "#62FEC8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115984", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag452" }, { "color_code": "#EA62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115985", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag453" }, { "color_code": "#FE9662", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115986", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag454" }, { "color_code": "#62FEFF", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115987", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag455" }, { "color_code": "#FEB862", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115988", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag456" }, { "color_code": "#C4FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115989", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag457" }, { "color_code": "#62DBFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115990", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag458" }, { "color_code": "#FE62FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115991", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag459" }, { "color_code": "#62FED3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115992", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag460" }, { "color_code": "#F462FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115993", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag461" }, { "color_code": "#FE9D62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115994", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag462" }, { "color_code": "#62FEF7", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115995", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag463" }, { "color_code": "#FED962", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115996", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag464" }, { "color_code": "#D3FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115997", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag465" }, { "color_code": "#62E3FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115998", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag466" }, { "color_code": "#FE62B8", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000115999", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag467" }, { "color_code": "#62FE8B", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116000", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag468" }, { "color_code": "#E062FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116001", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag469" }, { "color_code": "#FE627A", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116002", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag470" }, { "color_code": "#62FEEB", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116003", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag471" }, { "color_code": "#FEFC62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116004", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag472" }, { "color_code": "#A8FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116005", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag473" }, { "color_code": "#62BEFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116006", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag474" }, { "color_code": "#FE62D1", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116007", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag475" }, { "color_code": "#62FEA4", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116008", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag476" }, { "color_code": "#D562FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116009", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag477" }, { "color_code": "#FE7462", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116010", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag478" }, { "color_code": "#62FEF3", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116011", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag479" }, { "color_code": "#FEE262", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116012", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag480" }, { "color_code": "#B0FE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116013", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag481" }, { "color_code": "#62BFFE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116014", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag482" }, { "color_code": "#FE62EE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116015", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag483" }, { "color_code": "#E862FE", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T11:52:15+05:30", "id": "111111000000116017", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T11:52:15+05:30", "name": "tag485" } ] } } }, "schema": { "$ref": "#/components/schemas/GettagsResponse200" } } }, "description": "Returns a list of tags for the specified module, along with pagination and limit details." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse1": { "description": "Demonstrates an error response when the specified module name is not recognized.\n**Resolution:** Use a valid module API name from the Get Modules API.", "summary": "Error response for invalid module name", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "description": "Demonstrates an error response when the specified module does not support tags.\n**Resolution:** Use a module that supports tag operations.", "summary": "Error response for unsupported module", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Demonstrates an error response when the request uses an unsupported HTTP method.\n**Resolution:** Use the correct HTTP method as specified in the API documentation.", "summary": "Error response for invalid HTTP method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "RequiredParamMissingResponse1": { "description": "Demonstrates an error response when the required **module** query parameter is missing.\n**Resolution:** Include the **module** query parameter in the request.", "summary": "Error response for missing module parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequiredModuleParamError" }, { "$ref": "#/components/schemas/TagsInvalidModuleError" }, { "$ref": "#/components/schemas/TagsModuleTagsNotSupportedError" }, { "$ref": "#/components/schemas/TagsInvalidRequestMethodError" } ], "description": "Represents one of the possible error responses returned for a 400 Bad Request.", "x-zs-$id": "GettagsError400" } } }, "description": "Returns an error response when the request contains invalid parameters.\n**Resolution:** Check the error code and verify the module name is correct." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the user does not have the required permissions.\n**Resolution:** Ensure the access token includes the required tags scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Leads", "Crm_Implied_Tags_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoTagPermissionError", "description": "When the user does not have sufficient permissions to access the resource", "x-zs-$id": "GettagsError403" } } }, "description": "Returns an error response when the user does not have permission to read tags.\n**Resolution:** Ensure the access token includes the **ZohoCRM.settings.tags.READ** scope." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPatternResponse1": { "description": "Demonstrates an error response when the request URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation.", "summary": "Error response for invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsInvalidUrlPatternError", "description": "When the requested resource is not found", "x-zs-$id": "GettagsError404" } } }, "description": "Returns an error response when the URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.READ" ] } ], "summary": "Tags", "tags": [ "tags" ], "x-zoho-document": "tags" }, "post": { "description": "To create tags for a module in your Zoho CRM organization.", "operationId": "createTags", "parameters": [ { "$ref": "#/components/parameters/TagsParamQueryModule" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Demonstrates a sample request body for creating a tag.", "summary": "Sample tag creation request body", "value": { "tags": [ { "color_code": "#AAFE62", "name": "NewTag" } ] } } }, "schema": { "$ref": "#/components/schemas/PosttagsRequest" } } }, "description": "The request body must contain a **tags** array with one tag object. Each object must include the **name** and an optional **color_code**." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Demonstrates a successful tag creation response with status 201.", "summary": "Successful response for tag creation", "value": { "tags": [ { "code": "SUCCESS", "details": { "color_code": "#AAFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T17:58:36+05:30", "id": "111111000000116258", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T17:58:36+05:30", "name": "NewTag" }, "message": "tags created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PosttagsResponse201" } } }, "description": "Returns a success response for a successful tag creation. The response includes the tag details and metadata." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Demonstrates a partial success response with status 207, indicating mixed operation results.", "summary": "Partial success response for tag creation", "value": { "tags": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "id": "111111000000116258", "json_path": "$.tags[0].name" }, "message": "duplicate data", "status": "error" }, { "code": "SUCCESS", "details": { "color_code": null, "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T17:59:54+05:30", "id": "111111000000116262", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T17:59:54+05:30", "name": "Newtag2" }, "message": "tags created successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents a multi-status response containing the operation result for each tag in the request.", "properties": { "tags": { "description": "Represents an array of tag operation result objects. Each item indicates whether the operation succeeded or contains the failure reason.", "items": { "anyOf": [ { "$ref": "#/components/schemas/TagsPost207multistatusResponse207" }, { "$ref": "#/components/schemas/DuplicateTagError" } ], "description": "Represents a single tag operation result, which can be a success or failure item." }, "maxItems": 200, "minItems": 2, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PosttagsResponse207" } } }, "description": "Returns a multi-status response when the request partially succeeds or fails. Each item in the **tags** array indicates whether the operation succeeded or provides the failure reason." }, "400": { "content": { "application/json": { "examples": { "DuplicateDataResponse1": { "description": "Demonstrates an error response when a tag with the same name already exists.\n**Resolution:** Use a different tag name.", "summary": "Error response for duplicate tag name", "value": { "tags": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "id": "111111000000116258", "json_path": "$.tags[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error response when the color code value is invalid.\n**Resolution:** Provide a valid hex color code, such as **#FF0000**.", "summary": "Error response for invalid color code value", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[0].color_code", "maximum_length": 7 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates an error response when the tag name field has an invalid data type.\n**Resolution:** Provide a string value for the tag name.", "summary": "Error response for invalid tag name data type", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tags[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error response when the tag name value is invalid.\n**Resolution:** Ensure the tag name does not exceed 26 characters.", "summary": "Error response for invalid tag name", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tags[*].name", "maximum_length": 26 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error response when the color code field has an invalid data type.\n**Resolution:** Provide a string hex color code or null.", "summary": "Error response for invalid color code data type", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "expected_data_type": "text", "json_path": "$.tags[*].color_code" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error response when the color code value is invalid.\n**Resolution:** Provide a valid hex color code or null.", "summary": "Error response for invalid color code", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[*].color_code", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "description": "Demonstrates an error response when the specified module name is not recognized.\n**Resolution:** Use a valid module API name from the Get Modules API.", "summary": "Error response for invalid module name", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "description": "Demonstrates an error response when the specified module does not support tags.\n**Resolution:** Use a module that supports tag operations.", "summary": "Error response for unsupported module", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Demonstrates an error response when the request uses an unsupported HTTP method.\n**Resolution:** Use the correct HTTP method as specified in the API documentation.", "summary": "Error response for invalid HTTP method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "LicenseLimitExceededResponse1": { "description": "Demonstrates an error response when the tag creation limit for the module has been reached.\n**Resolution:** Delete unused tags or upgrade your plan.", "summary": "Error response for tag limit exceeded", "value": { "tags": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "tags edition limit exceeded", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error response when the required **name** field is missing from the request body.\n**Resolution:** Include the **name** field in the request body.", "summary": "Error response for missing required field name (case 1)", "value": { "tags": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tags[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Demonstrates an error response when the **name** field is absent from the request body.\n**Resolution:** Include the **name** field in the request body.", "summary": "Error response for missing required field name (case 2)", "value": { "tags": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tags[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "description": "Demonstrates an error response when the required **module** query parameter is missing.\n**Resolution:** Include the **module** query parameter in the request.", "summary": "Error response for missing module parameter", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response containing a **tags** array of error objects.", "properties": { "tags": { "description": "Represents an array of error objects for the invalid tag request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/TagsLicenseLimitExceededError" }, { "$ref": "#/components/schemas/InvalidTagColorCodeError" }, { "$ref": "#/components/schemas/TagInvalidDataError" }, { "$ref": "#/components/schemas/TagsMandatoryFieldNotFoundError" }, { "$ref": "#/components/schemas/DuplicateTagError" }, { "$ref": "#/components/schemas/RequiredFieldMissingError" }, { "$ref": "#/components/schemas/TagsInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsTagFieldMaxLengthError" } ], "description": "Represents a single error object for an invalid tag in the request." }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PosttagsError400Wrapper" }, { "$ref": "#/components/schemas/TagsInvalidModuleError" }, { "$ref": "#/components/schemas/TagsModuleTagsNotSupportedError" }, { "$ref": "#/components/schemas/RequiredModuleParamError" }, { "$ref": "#/components/schemas/TagsInvalidRequestMethodError" } ], "description": "Represents one of the possible error responses returned for a 400 Bad Request.", "x-zs-$id": "PosttagsError400" } } }, "description": "Returns an error response when the request contains invalid data.\n**Resolution:** Check the error code and details to identify and correct the invalid field values." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the user does not have the required permissions.\n**Resolution:** Ensure the access token includes the required tags scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Tags_Leads", "Crm_Implied_Edit_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoTagPermissionError", "description": "When the user does not have sufficient permissions", "x-zs-$id": "PosttagsError403" } } }, "description": "Returns an error response when the user does not have permission to create tags.\n**Resolution:** Ensure the access token includes the **ZohoCRM.settings.tags.CREATE** scope." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPatternResponse1": { "description": "Demonstrates an error response when the request URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation.", "summary": "Error response for invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsInvalidUrlPatternError", "description": "When the requested URL pattern is invalid", "x-zs-$id": "PosttagsError404" } } }, "description": "Returns an error response when the URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.CREATE" ] } ], "summary": "Tags", "tags": [ "tags" ], "x-zoho-document": "tags" }, "put": { "description": "To update an existing tag in your Zoho CRM organization.", "operationId": "updateTags", "parameters": [ { "$ref": "#/components/parameters/TagsParamQueryModule" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Demonstrates a sample request body for updating a tag.", "summary": "Sample update tags request body", "value": { "tags": [ { "color_code": "#AAFE62", "id": "123456789012345678", "name": "NewTag" } ] } } }, "schema": { "$ref": "#/components/schemas/PuttagsRequest" } } }, "description": "The request body must contain a **tags** array with one tag object. Include the tag **ID** in the object to identify which tag to update." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response for updating a tag with status 200.", "summary": "Successful response for tag update", "value": { "tags": [ { "code": "SUCCESS", "details": { "color_code": "#AAFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T10:43:05+05:30", "id": "111111000000071739", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T18:56:59+05:30", "name": "NewTagupdate" }, "message": "tags updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PuttagsResponse200" } } }, "description": "Returns a success response when the tag update completes. The response includes the updated tag details." }, "400": { "content": { "application/json": { "examples": { "DuplicateDataResponse1": { "description": "Demonstrates an error response when a tag with the same name already exists.\n**Resolution:** Use a different tag name.", "summary": "Error response for duplicate tag name", "value": { "tags": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "id": "111111000000116258", "json_path": "$.tags[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error response when the color code value is invalid.\n**Resolution:** Provide a valid hex color code, such as **#FF0000**.", "summary": "Error response for invalid color code value", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[0].color_code", "maximum_length": 7 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates an error response when the tag name field has an invalid data type.\n**Resolution:** Provide a string value for the tag name.", "summary": "Error response for invalid tag name data type", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tags[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error response when the tag name value is invalid.\n**Resolution:** Ensure the tag name does not exceed 26 characters.", "summary": "Error response for invalid tag name", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tags[*].name", "maximum_length": 26 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error response when the color code field has an invalid data type.\n**Resolution:** Provide a string hex color code or null.", "summary": "Error response for invalid color code data type", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "expected_data_type": "text", "json_path": "$.tags[*].color_code" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error response when the color code value is invalid.\n**Resolution:** Provide a valid hex color code or null.", "summary": "Error response for invalid color code", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[*].color_code", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponseAPI": { "description": "Demonstrates an error response when the color code contains invalid data.\n**Resolution:** Provide a valid hex color code or null.", "summary": "Error response for invalid color code data", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[0].color_code" }, "message": "special characters found in the given name", "status": "error" } ] } }, "InvalidModuleResponse1": { "description": "Demonstrates an error response when the specified module name is not recognized.\n**Resolution:** Use a valid module API name from the Get Modules API.", "summary": "Error response for invalid module name", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "description": "Demonstrates an error response when the specified module does not support tags.\n**Resolution:** Use a module that supports tag operations.", "summary": "Error response for unsupported module", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Demonstrates an error response when the request uses an unsupported HTTP method.\n**Resolution:** Use the correct HTTP method as specified in the API documentation.", "summary": "Error response for invalid HTTP method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error response when the required **name** field is missing from the request body.\n**Resolution:** Include the **name** field in the request body.", "summary": "Error response for missing required field name (case 1)", "value": { "tags": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tags[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Demonstrates an error response when the **name** field is absent from the request body.\n**Resolution:** Include the **name** field in the request body.", "summary": "Error response for missing required field name (case 2)", "value": { "tags": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tags[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "description": "Demonstrates an error response when a required parameter is missing from the request.\n**Resolution:** Include all required parameters in the request.", "summary": "Error response for missing required parameter (case 1)", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "module" }, "message": "One of the expected parameter is missing", "status": "error" } }, "RequiredParamMissingResponse2": { "description": "Demonstrates an error response when a required parameter is absent from the request.\n**Resolution:** Include all required parameters in the request.", "summary": "Error response for missing required parameter (case 2)", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected param is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TagsInvalidModuleError" }, { "$ref": "#/components/schemas/TagsModuleTagsNotSupportedError" }, { "additionalProperties": false, "description": "Represents an error response containing a **tags** array of error objects.", "properties": { "tags": { "description": "Represents an array of error objects for the invalid tag update request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidTagColorCodeError" }, { "$ref": "#/components/schemas/TagInvalidDataError" }, { "$ref": "#/components/schemas/TagsMandatoryFieldNotFoundError" }, { "$ref": "#/components/schemas/DuplicateTagError" }, { "$ref": "#/components/schemas/RequiredFieldMissingError" }, { "$ref": "#/components/schemas/TagsInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsTagFieldMaxLengthError" } ], "description": "Represents a single error object for an invalid tag update request." }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PuttagsError400Wrapper" }, { "$ref": "#/components/schemas/RequiredModuleParamError" }, { "$ref": "#/components/schemas/TagsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RequiredIdParamError" } ], "description": "Represents one of the possible error responses returned for a 400 Bad Request.", "x-zs-$id": "PuttagsError400" } } }, "description": "Returns an error response when the request contains invalid data.\n**Resolution:** Check the error code and verify the field values and tag ID are correct." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the user does not have the required permissions.\n**Resolution:** Ensure the access token includes the required tags scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Tags_Leads", "Crm_Implied_Edit_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoTagPermissionError", "description": "When the user does not have sufficient permissions", "x-zs-$id": "PuttagsError403" } } }, "description": "Returns an error response when the user does not have permission to update tags.\n**Resolution:** Ensure the access token includes the **ZohoCRM.settings.tags.UPDATE** scope." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPatternResponse1": { "description": "Demonstrates an error response when the request URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation.", "summary": "Error response for invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsInvalidUrlPatternError", "description": "When the requested resource is not found", "x-zs-$id": "PuttagsError404" } } }, "description": "Returns an error response when the URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.UPDATE" ] } ], "summary": "Tags", "tags": [ "tags" ], "x-zoho-document": "tags" } }, "/crm/v8/settings/tags/actions/mass_delete": { "get": { "description": "To retrieve the current status, the scheduled time, and the success and failure counts for a previously scheduled mass delete tag job in your Zoho CRM organization, using the job ID returned by the Mass Delete Tags POST operation.", "operationId": "getMassDeleteTagsStatus", "parameters": [ { "description": "Specify the unique identifier of the mass delete tag job for which you want to retrieve the status. Use the job ID returned by the [Mass Delete Tags API](mass_delete_tags.yaml#$.paths./settings/tags/actions/mass_delete.post).", "in": "query", "name": "job_id", "required": true, "schema": { "format": "int64", "maxLength": 19, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the status payload for a mass delete tag job that is currently running, with the job identifier and the scheduled time.", "summary": "An example of in-progress mass delete tag job status.", "value": { "mass_delete": [ { "created_time": "2025-11-21T18:00:00Z", "job_id": "job_789", "status": "in_progress" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the status payload returned for the queried mass delete tag job, including the job identifier, current execution state, scheduled time, and counts of total, deleted, and failed tags.", "properties": { "mass_delete": { "description": "Represents the list of mass delete tag jobs returned for the queried job ID, with one entry per job.", "items": { "additionalProperties": false, "description": "Each object represents a single mass delete tag job, including its identifier, current status, and tag deletion counts.", "properties": { "created_time": { "description": "Represents the timestamp at which the mass delete tag job was scheduled, in ISO 8601 format.", "format": "date-time", "type": "string" }, "deleted_count": { "description": "Represents the number of tags that the job has deleted successfully.", "format": "int32", "minimum": 0, "type": "integer" }, "failed_count": { "description": "Represents the number of tags that the job failed to delete.", "format": "int32", "minimum": 0, "type": "integer" }, "job_id": { "description": "Represents the unique identifier of the mass delete tag job scheduled through the [Mass Delete Tags API](mass_delete_tags.yaml#$.paths./settings/tags/actions/mass_delete.post).", "maxLength": 50, "type": "string" }, "status": { "description": "Represents the current execution state of the mass\ndelete tag job.\n\nPossible values:\n\nCOMPLETED - The job has finished processing all\ntags.\n\nSCHEDULED - The job is queued and waiting to begin\nprocessing.\n\nFAILED - The job ended without completing the\ndeletion.\n", "maxLength": 20, "type": "string" }, "total_count": { "description": "Represents the total number of tags that were submitted for deletion in the mass delete tag job.", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "job_id", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "mass_delete" ], "type": "object", "x-zs-$id": "MassDeleteTagsStatusResponse" } } }, "description": "Returns the current status and tag deletion counts for the requested mass delete tag job." }, "400": { "content": { "application/json": { "examples": { "InvalidJobId": { "description": "Demonstrates the response when the job_id query parameter contains the literal string null and cannot be parsed as a valid identifier.", "summary": "Invalid job ID supplied as a literal null string", "value": { "mass_delete": [ { "code": "INVALID_DATA", "details": { "job_id": "null" }, "message": "invalid data", "status": "error" } ] } }, "JobNotFound": { "description": "Demonstrates the response when the supplied job_id cannot be resolved to any existing mass delete tag job in the organization.", "summary": "Job ID does not match any scheduled mass delete tag job", "value": { "mass_delete": [ { "code": "INVALID_DATA", "details": { "job_id": "999999999999999999" }, "message": "job details not found", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/MassDeleteTagsErrorResponse" } } }, "description": "The job ID provided in the request is invalid or does not match any scheduled mass delete tag job. \nResolution: The job ID must be a valid identifier returned by the [Mass Delete Tags API](mass_delete_tags.yaml#$.paths./settings/tags/actions/mass_delete.post) call.\n" }, "401": { "content": { "application/json": { "examples": { "OAuthScopeMismatch": { "description": "Shows the response when the access token does not include the ZohoCRM.settings.tags.READ scope required to query the job status.", "summary": "An example of OAuth scope missing the tags read permission.", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": { "method": "GET", "url": "/crm/v8/settings/tags/actions/mass_delete" }, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error payload returned when the OAuth access token does not include the ZohoCRM.settings.tags.READ scope required to retrieve the mass delete tag job status.", "properties": { "code": { "description": "Represents the error code that identifies the OAuth scope mismatch.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "maxLength": 30, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the OAuth scope mismatch, including the request method and the URL that was called.", "properties": { "method": { "description": "Represents the HTTP method of the request that triggered the OAuth scope mismatch.", "maxLength": 10, "type": "string" }, "url": { "description": "Represents the request URL that was called when the OAuth scope mismatch occurred.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the OAuth scope mismatch.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the API call when the OAuth scope mismatch occurs.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsGet401OAuthScopeMismatch" } ], "description": "Represents the error payload returned when the request cannot be authenticated because the OAuth access token does not include the required scope.", "x-zs-$id": "MassDeleteTagsGet401" } } }, "description": "The OAuth access token does not include the scope required to\nretrieve the mass delete tag job status. \n\nResolution: A new access token must be generated with the\nZohoCRM.settings.tags.READ scope.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Demonstrates the response when the requesting user profile is not assigned the tag management permission needed to view the job status.", "summary": "User profile lacks the tag management permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Tags" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/MassDeleteTagsErrorResponse" } } }, "description": "The user does not have permission to view the status of a mass delete tag job. Resolution: The CRM administrator must grant the required tag management permission to the user profile.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.READ" ] } ], "summary": "Mass Delete Tags Status", "tags": [ "mass_delete_tags" ], "x-zoho-document": "mass_delete_tags" }, "post": { "description": "To schedule a background job that deletes multiple tags in bulk from a single module in your Zoho CRM organization. You can delete tags in bulk from one module per API call. The response returns a job identifier that can be used with the Mass Delete Tags Status GET operation to track the progress of the deletion.", "operationId": "massDeleteTags", "requestBody": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows a request that schedules a mass delete tag job for one tag in the Leads module, identified by the module ID, the module API name, and the tag ID.", "summary": "An example of the schedule deletion of a single tag from the Leads module.", "value": { "mass_delete": [ { "module": { "api_name": "Leads", "id": "123" }, "tags": [ { "id": "456", "name": "Priority" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload for scheduling a mass delete tag job, containing the target module and the tags to delete.", "properties": { "mass_delete": { "description": "Specify the list of mass delete tag jobs. Each entry identifies the module and the tags to delete in that module within a single job.", "items": { "additionalProperties": false, "description": "Each object specifies the module and the tags to delete in that module for one mass delete tag job.", "properties": { "module": { "additionalProperties": false, "description": "Specify the module from which the tags must be deleted, identified by its unique ID and API name.", "properties": { "api_name": { "description": "Specify the API name of the module from which the tags must be deleted.", "maxLength": 50, "type": "string" }, "id": { "description": "Specify the unique ID of the module from which the tags must be deleted. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get the valid values. ", "maxLength": 50, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "tags": { "description": "Specify the tags to delete from the module. Each entry identifies a single tag by its unique ID. Use the [Get Tags API](tags.yaml#$./settings/tags.get) to get the valid ID. ", "items": { "additionalProperties": false, "description": "Each object specifies a tag to delete from the module.", "properties": { "id": { "description": "Specify the unique ID of the tag to delete.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTags", "propertyId": "TagId" } ], "resource": "tags" } }, "name": { "description": "Specify the name of the tag to delete.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "module", "tags" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "mass_delete" ], "type": "object" } } }, "description": "The request body contains the data required to perform the operation. ", "required": true }, "responses": { "202": { "content": { "application/json": { "examples": { "Sample": { "description": "Shows the response when a mass delete tag job is scheduled successfully, returning the job identifier that the client can use to track job progress.", "summary": "An example of mass delete tag job scheduled successfully.", "value": { "code": "202", "details": { "job_id": "job_789" }, "message": "Mass delete job scheduled successfully", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload returned when a mass delete tag job is scheduled successfully, including the job identifier and the schedule code.", "properties": { "code": { "description": "Represents the code that identifies the result of scheduling the mass delete tag job. For a successful schedule, the value is SCHEDULED.", "maxLength": 10, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the scheduled mass delete tag job, including the job identifier returned by the system.", "properties": { "job_id": { "description": "Represents the unique identifier assigned to the scheduled mass delete tag job. Use this value with the [Mass Delete Tags Status](mass_delete_tags.yaml#$.paths./settings/tags/actions/mass_delete.get) API call to know the job state.", "maxLength": 50, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the message that describes the outcome of scheduling the mass delete tag job.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the API call. For a scheduled job, the value is success.", "maxLength": 20, "type": "string" } }, "required": [ "status", "code", "details", "message" ], "type": "object", "x-zs-$id": "MassDeleteTagsResponse" } } }, "description": "Returns the job identifier and the schedule code for the mass delete tag job that was queued for processing." }, "400": { "content": { "application/json": { "examples": { "AmbiguousModule": { "description": "Demonstrates the response when the module ID and the module API name in the request identify different modules and cannot be resolved unambiguously.", "summary": "Module ID and module API name refer to different modules", "value": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.mass_delete[0].module.id" }, { "api_name": "api_name", "json_path": "$.mass_delete[0].module.api_name" } ] }, "message": "ambiguous module identifiers", "status": "error" } }, "EmptyMassDeleteArray": { "description": "Demonstrates the response when the mass_delete array in the request body is empty and no job can be scheduled.", "summary": "mass_delete array is empty", "value": { "code": "INVALID_DATA", "details": { "api_name": "mass_delete", "json_path": "$.mass_delete" }, "message": "invalid data", "status": "error" } }, "InvalidTagId": { "description": "Demonstrates the response when a tag ID in the request body does not match any tag known to the CRM.", "summary": "Tag ID does not exist in the CRM", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.mass_delete[0].tags[0].id" }, "message": "tags not found", "status": "error" } }, "MassDeleteArrayTooLong": { "description": "Demonstrates the response when the mass_delete array exceeds the maximum allowed length for a single request.", "summary": "mass_delete array exceeds the allowed length", "value": { "code": "INVALID_DATA", "details": { "api_name": "mass_delete", "json_path": "$.mass_delete", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "ModuleApiNameMissing": { "description": "Demonstrates the response when the api_name field of the module object is missing or null in the request body.", "summary": "module.api_name is missing in the module object", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.mass_delete[0].module.api_name" }, "message": "required field not found", "status": "error" } }, "ModuleIdMissing": { "description": "Demonstrates the response when the module.id field of the module object is missing from the request body.", "summary": "The module.id field is missing from the module object", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.mass_delete[0].module.id" }, "message": "required field not found", "status": "error" } }, "ModuleMissing": { "description": "Demonstrates the response when a mass_delete entry omits the module object that identifies the target module.", "summary": "module key is missing inside a mass_delete item", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.mass_delete[0].module" }, "message": "required field not found", "status": "error" } }, "ModuleNotObject": { "description": "Demonstrates the response when the module field in the request body is not provided as a JSON object.", "summary": "module field is not a JSON object", "value": { "code": "INVALID_DATA", "details": { "api_name": "module", "expected_data_type": "jsonobject", "json_path": "$.mass_delete[0].module" }, "message": "invalid data", "status": "error" } }, "RootKeyMissing": { "description": "Demonstrates the response when the request body does not contain the required mass_delete array.", "summary": "mass_delete root key is missing from the request body", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "mass_delete", "json_path": "$.mass_delete" }, "message": "required field not found", "status": "error" } }, "TagsArrayTooLong": { "description": "Demonstrates the response when the tags array for a module exceeds the maximum allowed number of tag entries in a single request.", "summary": "tags array exceeds the allowed length", "value": { "code": "INVALID_DATA", "details": { "api_name": "tags", "json_path": "$.mass_delete[0].tags", "maximum_length": 200 }, "message": "invalid data", "status": "error" } }, "TagsAssociatedWithFeatures": { "description": "Demonstrates the response when one or more tags listed for deletion are still associated with CRM features such as Blueprint or Workflow Rules.", "summary": "Tags are associated with features and cannot be deleted", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.mass_delete[0].tags[0].id" }, "message": "tags has been associated to features", "status": "error" } }, "TagsMissing": { "description": "Demonstrates the response when a mass_delete entry omits the tags array that lists the tag identifiers to delete.", "summary": "tags key is missing inside a mass_delete item", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "tags", "json_path": "$.mass_delete[0].tags" }, "message": "required field not found", "status": "error" } }, "TagsNotArray": { "description": "Demonstrates the response when the tags field for a module is not provided as a JSON array.", "summary": "tags field is not a JSON array", "value": { "code": "INVALID_DATA", "details": { "api_name": "tags", "expected_data_type": "jsonarray", "json_path": "$.mass_delete[0].tags" }, "message": "invalid data", "status": "error" } }, "TagsNotAvailable": { "description": "Demonstrates the response when a tag exists in the CRM but has not been attached to the specified module.", "summary": "Tag exists but is not available in the specified module", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.mass_delete[0].tags[0].id" }, "message": "one of the tags seems not found.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/MassDeleteTagsErrorResponse" } } }, "description": "The request payload is missing required fields, references unknown\nor restricted tags, or violates the structural constraints of the\nmass delete tag operation. \n\nResolution: The request payload must include the mass_delete array,\nthe module, and a valid tags array that references existing tags not\ncurrently associated with CRM features.\n" }, "401": { "content": { "application/json": { "examples": { "OAuthScopeMismatch": { "description": "Shows the response when the access token does not include the ZohoCRM.settings.tags.DELETE scope required to schedule the mass delete tag job.", "summary": "An example of invalid OAuth scope for the tags delete permission.", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": { "method": "POST", "url": "/crm/v8/settings/tags/actions/mass_delete" }, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error payload returned when the OAuth access token does not include the ZohoCRM.settings.tags.DELETE scope required to schedule a mass delete tag job.", "properties": { "code": { "description": "Represents the error code that identifies the OAuth scope mismatch.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "maxLength": 30, "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the OAuth scope mismatch, including the request method and the URL that was called.", "properties": { "method": { "description": "Represents the HTTP method of the request that triggered the OAuth scope mismatch.", "maxLength": 10, "type": "string" }, "url": { "description": "Represents the request URL that was called when the OAuth scope mismatch occurred.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the message that describes the OAuth scope mismatch.", "maxLength": 200, "type": "string" }, "status": { "description": "Represents the status of the API call when the OAuth scope mismatch occurs.", "enum": [ "error" ], "maxLength": 10, "type": "string" } }, "required": [ "code", "status", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteTagsPost401OAuthScopeMismatch" } ], "description": "Represents the error payload returned when the request cannot be authenticated because the OAuth access token does not include the required scope.", "x-zs-$id": "MassDeleteTagsPost401" } } }, "description": "The OAuth access token does not include the scope required to\nschedule a mass delete tag job. \n\nResolution: A new access token must be generated with the\nZohoCRM.settings.tags.DELETE scope.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Demonstrates the response when the requesting user profile is not assigned the tag management permission needed to schedule the mass delete tag job.", "summary": "User profile lacks the tag management permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Tags" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/MassDeleteTagsErrorResponse" } } }, "description": "The user does not have enough permission to delete tags from the\nspecified module. \n\nResolution: The CRM administrator must grant the required tag\nmanagement permission to the user profile.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.DELETE" ] } ], "summary": "Mass delete tags", "tags": [ "mass_delete_tags" ], "x-zoho-document": "mass_delete_tags" } }, "/crm/v8/settings/tags/{id}": { "delete": { "description": "To delete a tag by its ID from your Zoho CRM organization.", "operationId": "deleteTags", "parameters": [ { "$ref": "#/components/parameters/TagsParamPathId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful tag deletion response with status 200.", "summary": "Successful response for tag deletion", "value": { "tags": [ { "code": "SUCCESS", "details": { "id": "111111000000071739" }, "message": "tags deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeletetagsResponse200" } } }, "description": "Returns a success response for a successful tag deletion. The response includes the deleted tag details." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates an error response when the specified tag ID does not exist.\n**Resolution:** Verify the tag ID is correct and the tag has not been deleted.", "summary": "Error response for tag not found", "value": { "code": "INVALID_DATA", "details": { "id": "111111000000071739" }, "message": "tags not found", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Demonstrates an error response when the request uses an unsupported HTTP method.\n**Resolution:** Use the correct HTTP method as specified in the API documentation.", "summary": "Error response for invalid HTTP method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TagsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/TagNotFoundError" }, { "$ref": "#/components/schemas/TagsInvalidModuleError" } ], "description": "Represents one of the possible error responses returned for a 400 Bad Request.", "x-zs-$id": "DeletetagsError400" } } }, "description": "Returns an error response when the request is invalid or the tag is not found.\n**Resolution:** Check the error code and verify the tag ID is correct." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the user does not have the required permissions.\n**Resolution:** Ensure the access token includes the required tags scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Tags_Leads", "Crm_Implied_Edit_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoTagPermissionError", "description": "When Tag read permission is not available.", "x-zs-$id": "DeletetagsError403" } } }, "description": "Returns an error response when the user does not have permission to delete tags.\n**Resolution:** Ensure the access token includes the **ZohoCRM.settings.tags.DELETE** scope." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPatternResponse1": { "description": "Demonstrates an error response when the request URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation.", "summary": "Error response for invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsInvalidUrlPatternError", "description": "When a invalid URL Pattern is given", "x-zs-$id": "DeletetagsError404" } } }, "description": "Returns an error response when the URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.DELETE" ] } ], "summary": "Delete tag by ID", "tags": [ "tags" ], "x-zoho-document": "tags" }, "put": { "description": "To update the details of a specific tag by its ID in your Zoho CRM organization.", "operationId": "updateTagById", "parameters": [ { "$ref": "#/components/parameters/TagsParamQueryModule" }, { "$ref": "#/components/parameters/TagsParamQueryId" }, { "$ref": "#/components/parameters/TagsParamPathId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Demonstrates a sample request body for updating a tag by its ID.", "summary": "Sample update tag by ID request body", "value": { "tags": [ { "color_code": "#AAFE62", "name": "NewTag" } ] } } }, "schema": { "$ref": "#/components/schemas/PuttagsRequest" } } }, "description": "The request body must contain a **tags** array with one tag object specifying the updated **name** and optional **color_code**." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response for updating a tag by ID with status 200.", "summary": "Successful response for tag update by ID", "value": { "tags": [ { "code": "SUCCESS", "details": { "color_code": "#AAFE62", "created_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "created_time": "2025-12-29T10:43:05+05:30", "id": "111111000000071739", "modified_by": { "id": "111111000000059475", "name": "Roobini Devi" }, "modified_time": "2025-12-29T18:50:34+05:30", "name": "NewTagupdate" }, "message": "tags updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PuttagsResponse200" } } }, "description": "Returns a success response for a successful tag update. The response includes the updated tag details." }, "400": { "content": { "application/json": { "examples": { "DuplicateDataResponse1": { "description": "Demonstrates an error response when a tag with the same name already exists.\n**Resolution:** Use a different tag name.", "summary": "Error response for duplicate tag name", "value": { "tags": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "id": "111111000000116258", "json_path": "$.tags[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error response when the color code value is invalid.\n**Resolution:** Provide a valid hex color code, such as **#FF0000**.", "summary": "Error response for invalid color code value", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[0].color_code", "maximum_length": 7 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates an error response when the tag name field has an invalid data type.\n**Resolution:** Provide a string value for the tag name.", "summary": "Error response for invalid tag name data type", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tags[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error response when the tag name value is invalid.\n**Resolution:** Ensure the tag name does not exceed 26 characters.", "summary": "Error response for invalid tag name", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tags[*].name", "maximum_length": 26 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error response when the color code field has an invalid data type.\n**Resolution:** Provide a string hex color code or null.", "summary": "Error response for invalid color code data type", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "expected_data_type": "text", "json_path": "$.tags[*].color_code" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error response when the color code value is invalid.\n**Resolution:** Provide a valid hex color code or null.", "summary": "Error response for invalid color code", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[*].color_code", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "description": "Demonstrates an error response when the specified module name is not recognized.\n**Resolution:** Use a valid module API name from the Get Modules API.", "summary": "Error response for invalid module name", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "description": "Demonstrates an error response when the specified module does not support tags.\n**Resolution:** Use a module that supports tag operations.", "summary": "Error response for unsupported module", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "description": "Demonstrates an error response when the request uses an unsupported HTTP method.\n**Resolution:** Use the correct HTTP method as specified in the API documentation.", "summary": "Error response for invalid HTTP method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error response when the required **name** field is missing from the request body.\n**Resolution:** Include the **name** field in the request body.", "summary": "Error response for missing required field name (case 1)", "value": { "tags": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tags[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Demonstrates an error response when the **name** field is absent from the request body.\n**Resolution:** Include the **name** field in the request body.", "summary": "Error response for missing required field name (case 2)", "value": { "tags": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.tags[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "RequiredParamMissingResponse1": { "description": "Demonstrates an error response when a required parameter is missing from the request.\n**Resolution:** Include all required parameters in the request.", "summary": "Error response for missing required parameter (case 1)", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "id" }, "message": "One of the expected param is missing", "status": "error" } }, "RequiredParamMissingResponse2": { "description": "Demonstrates an error response when a required parameter is absent from the request.\n**Resolution:** Include all required parameters in the request.", "summary": "Error response for missing required parameter (case 2)", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param": "module" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequiredIdParamError" }, { "$ref": "#/components/schemas/TagsInvalidModuleError" }, { "$ref": "#/components/schemas/TagsModuleTagsNotSupportedError" }, { "additionalProperties": false, "description": "Represents an error response containing a **tags** array of error objects.", "properties": { "tags": { "description": "Represents an array of error objects for the invalid tag update request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvalidTagColorCodeError" }, { "$ref": "#/components/schemas/TagInvalidDataError" }, { "$ref": "#/components/schemas/TagsMandatoryFieldNotFoundError" }, { "$ref": "#/components/schemas/DuplicateTagError" }, { "$ref": "#/components/schemas/RequiredFieldMissingError" }, { "$ref": "#/components/schemas/TagsInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsTagFieldMaxLengthError" } ], "description": "Represents a single error object for an invalid tag update request." }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PuttagsError400Wrap" }, { "$ref": "#/components/schemas/RequiredModuleParamError" }, { "$ref": "#/components/schemas/TagsInvalidRequestMethodError" } ], "description": "Represents one of the possible error responses returned for a 400 Bad Request.", "x-zs-$id": "PuttagsError" } } }, "description": "Returns an error response when the request contains invalid data or the tag is not found.\n**Resolution:** Check the error code and verify the tag ID and field values are correct." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the user does not have the required permissions.\n**Resolution:** Ensure the access token includes the required tags scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Tags_Leads", "Crm_Implied_Edit_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/NoTagPermissionError", "description": "When Tag read permission is not available.", "x-zs-$id": "PuttagsPermissionError" } } }, "description": "Returns an error response when the user does not have permission to update tags.\n**Resolution:** Ensure the access token includes the **ZohoCRM.settings.tags.UPDATE** scope." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPatternResponse1": { "description": "Demonstrates an error response when the request URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation.", "summary": "Error response for invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsInvalidUrlPatternError", "description": "When a invalid URL Pattern is given", "x-zs-$id": "PuttagsInValidUrlError" } } }, "description": "Returns an error response when the URL does not match a known endpoint.\n**Resolution:** Verify the request URL against the API documentation." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.UPDATE" ] } ], "summary": "Update tag by ID", "tags": [ "tags" ], "x-zoho-document": "tags" } }, "/crm/v8/settings/tags/{id}/actions/merge": { "post": { "description": "Merges two tags into one, combining their associated records and metadata. The tag specified in the path parameter (id) is the master tag that will remain after the merge. The conflict_id in the request body specifies the tag to be merged into the master tag.", "operationId": "mergeTags", "parameters": [ { "$ref": "#/components/parameters/TagsActionsParamPathId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "tags": [ { "conflict_id": "3060320000001987032", "modified_time": "2025-09-25T12:00:04+05:30" } ] } } }, "schema": { "$ref": "#/components/schemas/PostmergeRequest" } } }, "description": "Request body containing the tag to merge into the master tag." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "tags": [ { "code": "SUCCESS", "details": { "color_code": "#1DB9B4", "created_by": { "id": "3060320000000520001", "name": "Amelia Burrows" }, "created_time": "2025-09-25T12:00:04+05:30", "id": "3060320000001987032", "modified_by": { "id": "3060320000000520001", "name": "Amelia Burrows" }, "modified_time": "2025-12-30T17:35:44+05:30" }, "message": "tags merged successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostmergeResponse200" } } }, "description": "OK - Tags merged successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: tags)", "value": { "code": "INVALID_DATA", "details": { "api_name": "tags", "expected_data_type": "jsonarray", "json_path": "$.tags" }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: invalid data (Field: id)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.tags[0].id" }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: conflict_id)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "conflict_id", "expected_data_type": "bigint", "json_path": "$.tags[*].conflict_id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: conflict_id)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "conflict_id", "json_path": "$.tags[*].conflict_id", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: modified_time)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "modified_time", "expected_data_type": "datetime", "json_path": "$.tags[*].modified_time" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: modified_time)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "modified_time", "json_path": "$.tags[*].modified_time", "maximum_length": 25 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidRequestMethodResponse1": { "summary": "Error response with code INVALID_REQUEST_METHOD: The http request method type is not a valid one", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TagInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsActionsInvalidRequestMethodError" }, { "additionalProperties": false, "description": "Wrapped error response with tag-level validation errors", "properties": { "tags": { "description": "Array of tag error objects for validation failures", "items": { "anyOf": [ { "$ref": "#/components/schemas/MergeTagInvalidIdError" }, { "$ref": "#/components/schemas/TagsActionsNoPermissionError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PostmergeError400Wrapper" } ], "description": "Error response for status 400", "x-zs-$id": "PostmergeError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax or validation errors. Review the error details and correct the issues before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "tags": [ { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Leads", "Crm_Implied_Tags_Leads" ] }, "message": "permission denied", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped error response with tag-level permission errors", "properties": { "tags": { "description": "Array of permission error objects", "items": { "$ref": "#/components/schemas/TagsActionsNoPermissionError" }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "MergeOperationNoPermissionTagsErrorResponse" } } }, "description": "Forbidden - The client does not have access rights to perform the operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.all" ] } ], "summary": "Merge Tags", "tags": [ "tags_actions" ], "x-zoho-document": "tags_actions" } }, "/crm/v8/settings/tags/{id}/actions/records_count": { "get": { "description": "Retrieves the number of records associated with a specific tag, including workflow, blueprint, and orchestration usage details.", "operationId": "getTagRecordsCount", "parameters": [ { "$ref": "#/components/parameters/TagsActionsParamQueryId" }, { "$ref": "#/components/parameters/TagsActionsParamQueryModule" }, { "$ref": "#/components/parameters/TagsActionsParamPathId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "configured_areas": { "custom_view": { "cvids": [], "cvmodules": [], "cvnames": [], "inaccessible_custom_view_present": false }, "workflow_tagActionRecords": { "Blueprint": { "3060320000000666022": { "AddTags": [ { "id": "3060320000001828044", "name": "blue, newtd, newraf, test, 34ytwerfdgjhfwgerfs, new2, three, asf, daf, das, f, dw, fr, e, gfe, ht, jryi, oy, kjtd, hfsdgfas", "rules": [ { "execution_type": "instant", "id": "3060320000001828051", "module": "Leads", "name": "new", "source": 1, "subtype": "transition", "subtype_id": "3060320000001828038", "subtype_name": "qwertyu" } ] } ], "RemoveTags": [ { "id": "3060320000002372109", "name": "newtd, newraf, test, new, new2, three, asf, daf, f, das, dw, fr, e, gfe, ht, jryi, 34ytwerfdgjhfwgerfs, oy, hfsdgfas, d", "rules": [ { "execution_type": "instant", "id": "3060320000001828051", "module": "Leads", "name": "new", "source": 1, "subtype": "transition", "subtype_id": "3060320000001828038", "subtype_name": "qwertyu" } ] } ] } }, "Orchestration": { "3060320000000666022": { "AddTags": [ { "id": "3060320000002372688", "name": "34ytwerfdgjhfwgerfs, newtd, newraf, new2, three, asf, daf, das, f, dw, fr, e, gfe, ht, jryi, oy, new, kjtd, hfsdgfas, d", "rules": [ { "execution_type": "instant", "id": "3060320000002372133", "module": "Leads", "name": "qwert - V1", "source": 1, "status": "Active", "subtype": "state", "subtype_id": "3060320000002372686", "subtype_name": "test" } ] } ], "RemoveTags": [ { "id": "3060320000002372782", "name": "newtd, newraf, test, new, new2, three, 34ytwerfdgjhfwgerfs, asf, daf, das, dw, fr, e, gfe, ht, oy, kjtd, hfsdgfas, d, ds", "rules": [ { "execution_type": "instant", "id": "3060320000002372133", "module": "Leads", "name": "qwert - V1", "source": 1, "status": "Active", "subtype": "transition", "subtype_id": "3060320000002183036", "subtype_name": "rewq" } ] } ] } }, "Workflow": { "3060320000000666022": { "AddTags": [ { "id": "3060320000002372081", "name": "newtd, newraf, test, new, new2, three, asf, daf, das, f, dw, fr, e, gfe, 34ytwerfdgjhfwgerfs, ht, jryi, kjtd, hfsdgfas, d", "rules": [ { "execution_type": "instant", "id": "3060320000002072019", "module": "Leads", "name": "qwerty", "source": 1, "subtype": "rule_condition", "subtype_id": "3060320000002072020" } ] }, { "id": "3060320000002072235", "name": "34ytwerfdgjhfwgerfs, test, new, new2, three, newraf, asf, daf, das, f, dw, fr, e, gfe, ht, jryi, oy, kjtd, hfsdgfas, d", "rules": [ { "execution_type": "schedule", "id": "3060320000002072019", "module": "Leads", "name": "qwerty", "source": 1, "subtype": "rule_condition", "subtype_id": "3060320000002072020" } ] }, { "id": "3060320000000666870", "name": "newraf, 34ytwerfdgjhfwgerfs, test", "rules": [ { "execution_type": "instant", "id": "3060320000000666866", "module": "Leads", "name": "New Rule", "source": 1, "subtype": "rule_condition", "subtype_id": "3060320000000666867" } ] } ], "RemoveTags": [ { "id": "3060320000002372082", "name": "newraf, test, new, new2, three, 34ytwerfdgjhfwgerfs, newtd, daf, das, f, dw, fr, e, gfe, ht, jryi, asf, oy, kjtd, hfsdgfas", "rules": [ { "execution_type": "instant", "id": "3060320000002072019", "module": "Leads", "name": "qwerty", "source": 1, "subtype": "rule_condition", "subtype_id": "3060320000002072020" } ] }, { "id": "3060320000002372091", "name": "newtd, newraf, test, new, new2, three, asf, daf, das, 34ytwerfdgjhfwgerfs, fr, e, gfe, dw, ht, jryi, oy, kjtd, hfsdgfas, d", "rules": [ { "execution_type": "schedule", "id": "3060320000002072019", "module": "Leads", "name": "qwerty", "source": 1, "subtype": "rule_condition", "subtype_id": "3060320000002072020" } ] } ] } } } }, "count": "18" } } }, "schema": { "$ref": "#/components/schemas/GetrecordscountResponse200" } } }, "description": "OK - Successfully retrieved the tag records count with configured areas." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "summary": "Error response with code INVALID_MODULE: the given module is not supported for this api", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "summary": "Error response with code INVALID_REQUEST_METHOD: The http request method type is not a valid one", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected param is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected param is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TagsActionsRequiredParamMissingError" }, { "$ref": "#/components/schemas/TagsActionsInvalidModuleNameError" }, { "$ref": "#/components/schemas/TagsActionsModuleTagsNotSupportedError" }, { "$ref": "#/components/schemas/TagsActionsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/ErrorResponseTagIdNotFound" } ], "description": "Error response for status 400", "x-zs-$id": "GetrecordscountError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax or missing required parameters." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Leads", "Crm_Implied_Tags_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsActionsNoPermissionError", "description": "Error response for status 403", "x-zs-$id": "GetrecordscountError403" } } }, "description": "Forbidden - The client does not have access rights to perform the operation." }, "404": { "content": { "application/json": { "examples": { "TagIdNotFoundResponse1": { "summary": "Error response with code INVALID_DATA: invalid tag id", "value": { "code": "INVALID_DATA", "details": { "api_name": "id" }, "message": "tags not found", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ErrorResponseTagIdNotFound", "description": "Error response when the given tag ID is invalid or not found", "x-zs-$id": "ErrorResponseTagIdNotFound" } } }, "description": "Not Found - The specified tag ID does not exist." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.tags.all" ] } ], "summary": "Get Tag Records Count", "tags": [ "tags_actions" ], "x-zoho-document": "tags_actions" } }, "/crm/v8/settings/territories": { "delete": { "description": "To delete one or more territories from your Zoho CRM organization. The territories to delete are specified using the **ids** query parameter. Deleting a territory is irreversible; child territories must be transferred before a parent territory can be deleted.", "operationId": "deleteTerritories", "parameters": [ { "description": "Specify the unique IDs of the territories you want to delete. Accepts comma-separated territory IDs.", "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "description": "Comma-separated Territory Id param used to specify particular territories for deletion.", "items": { "description": "Individual territory ID used in a comma-separated list for retrieval or operations on multiple territories.", "format": "int64", "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "style": "form" }, { "$ref": "#/components/parameters/DeletePreviousForecasts", "description": "Delete Previous Forecasts for these territories" } ], "responses": { "200": { "content": { "application/json": { "examples": { "TerritoryDeleteByIds": { "summary": "Delete territories using the ids parameter", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "431581000000798016" }, "message": "Given Territory Removed Successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryDeleteSuccessResponse" } } }, "description": "Returns the deletion result for each territory in the request. Each item in the territories array contains a **code** field indicating **SUCCESS** for deleted territories or the relevant error code for failed ones." }, "400": { "content": { "application/json": { "examples": { "InvalidRequestIdsLimitExceeded": { "summary": "Invalid request — ids parameter exceeds maximum limit", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.", "status": "error" } }, "TerritoryDisabled": { "summary": "Territory disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory management not yet enabled", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotAllowedDeleteErrorResponse" }, { "$ref": "#/components/schemas/RequiredParamMissing" }, { "$ref": "#/components/schemas/TerritoriesInvalidDataWithId" }, { "$ref": "#/components/schemas/TerritoryOrgNoPermission" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/TerritoriesInvalidRequestError" } ], "description": "Represents the error response for an invalid or failed territory deletion request.\n", "x-zs-$id": "TerritoryDeleteByIdsErrorResponseSchema" } } }, "description": "The territory deletion request contains an invalid or missing query parameter.\n**Resolution:** The **ids** query parameter must be present and must contain valid territory IDs." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to a missing, expired, or invalid OAuth token.\n**Resolution:** A valid OAuth access token with the **ZohoCRM.settings.territories.DELETE** scope must be included in the request." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.DELETE" ] } ], "summary": "Delete territories", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Deletes one or more territories by passing their ids as a query parameter. Territories that have child territories cannot be deleted directly - use transferAndDeleteTerritories to reassign child territories and delete in one step. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." }, "get": { "description": "To retrieve the list of territories enabled for your Zoho CRM organization.", "operationId": "getTerritories", "parameters": [ { "$ref": "#/components/parameters/TerritoriesInclude", "description": "Include account_rule_criteria, lead_rule_criteria (or) deal_rule_criteria." }, { "$ref": "#/components/parameters/TerritoriesIds", "description": "List of Territory Ids" }, { "$ref": "#/components/parameters/TerritoriesPage", "description": "Page Numeber" }, { "$ref": "#/components/parameters/TerritoriesPerPage", "description": "Per Page Number" }, { "$ref": "#/components/parameters/TerritoriesFilters", "description": "Filter Out the Territories based on Given Criteria" }, { "$ref": "#/components/parameters/TerritoriesIncludeInnerDetails", "description": "Include manager status & zuid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetAllByIncludingIdsParam": { "summary": "Get territories filtered by specific IDs", "value": { "territories": [ { "api_name": "zoho", "created_by": { "id": "2276164000000471001", "name": "Patricia" }, "created_time": "2024-07-09T20:50:29+05:30", "description": "Organization Parent Territory", "id": "2276164000001054020", "manager": { "id": "2276164000000471001", "name": "Patricia", "status": "active", "zuid": "8186088" }, "modified_by": { "id": "2276164000000471001", "name": "Patricia" }, "modified_time": "2024-07-09T20:50:29+05:30", "name": "zoho", "permission_type": "read_only", "reporting_to": null } ] } }, "GetAllTerritories": { "summary": "Get all territories with pagination", "value": { "info": { "count": 0, "more_records": false, "page": 1, "per_page": 1 }, "territories": [ { "api_name": "zoho", "created_by": { "id": "2276164000000471001", "name": "Patricia" }, "created_time": "2024-07-09T20:50:29+05:30", "description": "Organization Parent Territory", "id": "2276164000001054020", "manager": { "id": "2276164000000471001", "name": "Patricia", "status": "active", "zuid": "8186088" }, "modified_by": { "id": "2276164000000471001", "name": "Patricia" }, "modified_time": "2024-07-09T20:50:29+05:30", "name": "zoho", "permission_type": "read_only", "reporting_to": null } ] } }, "GetTerritoriesByIncludeParam": { "summary": "Get territories with criteria rules using the include parameter", "value": { "info": { "count": 0, "more_records": false, "page": 1, "per_page": 1 }, "territories": [ { "account_rule_criteria": { "comparator": "equal", "field": { "api_name": "Billing_City", "id": "431581000000000657" }, "value": "Chennai" }, "api_name": "Chennai", "created_by": { "id": "431581000000258001", "name": "Patricia Boyle" }, "created_time": "2023-06-10T12:17:53+05:30", "deal_rule_criteria": null, "description": null, "id": "431581000000744113", "lead_rule_criteria": null, "manager": { "id": "431581000000278001", "name": "J Smith" }, "modified_by": { "id": "431581000000258001", "name": "Patricia Boyle" }, "modified_time": "2023-06-10T12:23:23+05:30", "name": "Chennai", "permission_type": "read_write_delete", "reporting_to": { "id": "431581000000272796", "name": "Zoho" } } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryListResponse" } } }, "description": "Returns the list of territories enabled for the Zoho CRM organization. Use the **info** object to navigate through paginated results." }, "204": { "description": "No territories found for the given query parameters." }, "400": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Territory management disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory management not yet enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotSupportedFieldsInFilters" }, { "$ref": "#/components/schemas/FilterNotSupportedApiName" }, { "$ref": "#/components/schemas/FilterEmptyFilterObject" }, { "$ref": "#/components/schemas/FilterMandatoryNotFound" }, { "$ref": "#/components/schemas/FilterInvalidComparator" }, { "$ref": "#/components/schemas/FilterFieldComparatorValueMissing" }, { "$ref": "#/components/schemas/FilterFieldComparatorMismatch" }, { "$ref": "#/components/schemas/FilterFieldValueMismatch" }, { "$ref": "#/components/schemas/FilterComparatorValueMismatch" }, { "$ref": "#/components/schemas/FilterInvalidParamDataType" }, { "$ref": "#/components/schemas/FilterInvalidFieldDataType" }, { "$ref": "#/components/schemas/FilterFieldNotSupportedInCriteria" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" } ], "description": "Represents the error response for the GET /settings/territories request. Contains either an unsupported filter field error or a territory feature not enabled error.", "x-zs-$id": "FiltersErrorResponse" } } }, "description": "The request contains an invalid filter parameter.\\n**Resolution:** The **filters** query parameter must use a supported field name." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\\n**Resolution:** A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.READ" ] } ], "summary": "Get all territories", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Use this API to list all territories. Supports filtering by ids, pagination, and including rule criteria (account_rule_criteria, lead_rule_criteria, deal_rule_criteria) via the include parameter. Returns 204 when no territories exist. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." }, "post": { "description": "To create one or more territories in your Zoho CRM organization.", "operationId": "createTerritories", "requestBody": { "content": { "application/json": { "examples": { "TerritoryCreate": { "summary": "Create a territory with name, manager, and account rule criteria", "value": { "territories": [ { "account_rule_criteria": { "comparator": "greater_than", "field": { "api_name": "Annual_Revenue", "id": "431581000000000625" }, "value": "1001" }, "deal_rule_criteria": { "comparator": "greater_than", "field": { "api_name": "Amount", "id": "431581000000000799" }, "value": "100000" }, "description": "null", "lead_rule_criteria": { "comparator": "greater_than", "field": { "api_name": "Annual_Revenue", "id": "431581000000000893" }, "value": "1000" }, "manager": { "id": "431581000000258001" }, "name": "Territory1000", "permission_type": "read_only", "reporting_to": { "id": "431581000000272796" } } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the territories to create in your organization.", "properties": { "territories": { "description": "Specify the list of territories to create.", "items": { "additionalProperties": false, "description": "Specify the details for each territory to create.", "properties": { "account_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents the absence of an account rule criteria. Set this value to remove any existing account rule criteria from the territory.", "type": "null", "x-zs-$id": "AccountRuleCriteriaNullPOST" } ], "description": "Specify the criteria for auto-assigning accounts to the territory. To remove an existing criteria, set this field to **null**." }, "deal_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents the absence of a deal rule criteria. Set this value to remove any existing deal rule criteria from the territory.", "type": "null", "x-zs-$id": "DealRuleCriteriaNullPOST" } ], "description": "Specify the criteria for auto-assigning deals to the territory. To remove an existing criteria, set this field to **null**." }, "description": { "description": "Specify the description for the territory.", "maxLength": 250, "type": [ "string", "null" ] }, "lead_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents the absence of a lead rule criteria. Set this value to remove any existing lead rule criteria from the territory.", "type": "null", "x-zs-$id": "LeadRuleCriteriaNullPOST" } ], "description": "Specify the criteria for auto-assigning leads to the territory. To remove an existing criteria, set this field to **null**." }, "manager": { "anyOf": [ { "additionalProperties": false, "description": "Represents a territory manager specified by user ID.", "properties": { "id": { "description": "Specify the unique ID of the user to assign as the territory manager.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } } }, "required": [ "id" ], "type": "object", "x-zs-$id": "ManagerIdPOST" }, { "const": null, "description": "Represents the absence of a territory manager. Set this value to remove any assigned manager from the territory.", "type": "null", "x-zs-$id": "ManagerNullPOST" } ] }, "name": { "description": "Specify the name of the territory.", "maxLength": 50, "type": "string" }, "permission_type": { "description": "Specify the access permission for users in this territory.\nPossible values:\nread_write_delete - Grants users read, write, and delete access to records assigned to the territory.\nread_only - Grants users read-only access to records assigned to the territory.", "enum": [ "read_write_delete", "read_only" ], "type": "string" }, "reporting_to": { "anyOf": [ { "additionalProperties": false, "description": "Represents the parent territory to which this territory reports in the hierarchy.", "properties": { "id": { "description": "Specify the unique ID of the parent territory.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object", "x-zs-$id": "ReportingToIdPOST" }, { "const": null, "description": "Represents the absence of a parent territory. Set this field to **null** when the territory has no parent in the hierarchy.", "type": "null", "x-zs-$id": "ReportingToNullPOST" } ] } }, "required": [ "reporting_to", "permission_type", "name" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "CreateTerritoriesRequestBody" }, "x-zs-llm-examples": [ "TerritoryCreate" ] } }, "description": "The request body must contain a **territories** array. You can include a maximum of 100 territory objects per request.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Successful territory creation response", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "431581000000734292" }, "message": "Territory Created Successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryCreateSuccessResponse" } } }, "description": "Returns the result of the territory creation request for each territory in the **territories** array. The **code** field indicates **SUCCESS** for created territories and **ERROR** for failed ones, with the territory ID in the **details** object for successful entries." }, "400": { "content": { "application/json": { "examples": { "CriteriaFieldComparatorMismatch": { "summary": "Field and comparator mismatch in criteria", "value": { "territories": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "json_path": "$.territories[0].account_rule_criteria.comparator", "supported_values": [ "equal", "not_equal", "greater_than", "less_than" ] }, "message": "The comparator is not compatible with the given field", "status": "error" } ] } }, "CriteriaFieldComparatorValueMissing": { "summary": "Dependent field missing in criteria", "value": { "territories": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "json_path": "$.territories[0].account_rule_criteria.comparator" }, "message": "required field not found", "status": "error" } ] } }, "CriteriaFieldNotSupported": { "summary": "Field not supported in territory rule criteria", "value": { "territories": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "File_Upload", "json_path": "$.territories[0].account_rule_criteria.field.api_name" }, "message": "The given field api_name is not supported in criteria", "status": "error" } ] } }, "CriteriaFieldValueMismatch": { "summary": "Field value type mismatch in criteria", "value": { "territories": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "expected_data_type": "integer", "json_path": "$.territories[0].account_rule_criteria.value" }, "message": "The value is not compatible with the given field", "status": "error" } ] } }, "CriteriaInvalidFieldDataType": { "summary": "Invalid field data type in criteria", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.territories[0].account_rule_criteria.field" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFoundName": { "summary": "Mandatory field name missing in request", "value": { "territories": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.territories[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundPermissionType": { "summary": "Mandatory field permission_type missing in request", "value": { "territories": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "permission_type", "json_path": "$.territories[0].permission_type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundReportingTo": { "summary": "Mandatory field reporting_to missing in request", "value": { "territories": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "reporting_to", "json_path": "$.territories[0].reporting_to" }, "message": "required field not found", "status": "error" } ] } }, "TerritoryDisabled": { "summary": "Territory feature disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryMaximumLimit": { "summary": "Territory maximum limit reached", "value": { "territories": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 250 }, "message": "Territory Limit reached", "status": "error" } ] } }, "TerritoryNotYetEnabled": { "summary": "Territory management not yet enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/TerritoriesInvalidDataWithSupportedValues" }, { "$ref": "#/components/schemas/TerritoriesDuplicateDataError" }, { "$ref": "#/components/schemas/TerritoriesMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundErrorWithSupportedValues" }, { "$ref": "#/components/schemas/TerritoryMaxLimitExceededErrorSchema" }, { "$ref": "#/components/schemas/TerritoryMaxLimitExceededErrorSchemaForCriteria" }, { "$ref": "#/components/schemas/InvalidDataWithMaximumLength" }, { "$ref": "#/components/schemas/InvalidDataWithMaximumLengthAsString" }, { "$ref": "#/components/schemas/NotSupportedForCriteriaOnModuleDisable" }, { "$ref": "#/components/schemas/TerritoryParentNoPermission" }, { "$ref": "#/components/schemas/TerritoryCriteriaError" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" } ], "description": "Represents the error response for an invalid or failed territory creation request.", "x-zs-$id": "TerritoryCreateErrorResponseSchema" } } }, "description": "The territory creation request contains invalid or missing data. Resolution: All required fields must be provided, field values must not exceed the allowed length or limits, and the permission type must be valid." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure error", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token. Resolution: A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.CREATE" ] } ], "summary": "Create Territories", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Creates one or more territories in a single request. Requires territory name and parent territory, permission type. Optionally configure manager, description, and rule criteria for automatic record assignment. Territory hierarchy must already be initialized via the Territory Configuration API before calling this. To provide the deal_rule_criteria and lead_rule_criteria, the territory_rules.module.api_name (Deals and Leads module) corresponding status key must be set to \"enable\" state. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." }, "put": { "description": "To update the details of one or more territories in your Zoho CRM organization.\n", "operationId": "updateTerritories", "requestBody": { "content": { "application/json": { "examples": { "TerritoryUpdateExample": { "summary": "Update a territory with deal rule criteria and read-only permission\n", "value": { "territories": [ { "account_rule_criteria": null, "deal_rule_criteria": { "comparator": "greater_than", "field": { "api_name": "Amount", "id": "431581000000000799" }, "value": "2000000" }, "description": null, "id": "431581000000798016", "lead_rule_criteria": null, "manager": null, "name": "Territory1234", "permission_type": "read_only", "reporting_to": { "id": "431581000000272796" } } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the territories to update.\n", "properties": { "territories": { "description": "Specify the list of territories to update.\n", "items": { "additionalProperties": false, "description": "Specify the details of each territory to update.\n", "properties": { "account_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents a null value that removes the account rule criteria from the territory.\n", "type": "null", "x-zs-$id": "AccountRuleCriteriaNullPUT" } ], "description": "Specify the account rule criteria for the territory. Use a criteria object or a group criteria object to define the conditions. Set to **null** to remove the existing criteria.\n" }, "deal_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents a null value that removes the deal rule criteria from the territory.\n", "type": "null", "x-zs-$id": "DealRuleCriteriaNullPUT" } ], "description": "Specify the deal rule criteria for the territory. Use a criteria object or a group criteria object to define the conditions. Set to **null** to remove the existing criteria.\n" }, "description": { "description": "Specify the description of the territory.\n", "maxLength": 250, "type": [ "string", "null" ] }, "id": { "description": "Specify the unique ID of the territory to update.\n", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } }, "lead_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents a null value that removes the lead rule criteria from the territory.\n", "type": "null", "x-zs-$id": "LeadRuleCriteriaNullPUT" } ], "description": "Specify the lead rule criteria for the territory. Use a criteria object or a group criteria object to define the conditions. Set to **null** to remove the existing criteria.\n" }, "manager": { "anyOf": [ { "additionalProperties": false, "description": "Specify the manager of this territory by providing the user's unique ID.\n", "properties": { "id": { "description": "Specify the unique ID of the user to assign as the manager of this territory.\n", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } } }, "required": [ "id" ], "type": "object", "x-zs-$id": "ManagerIdPUT" }, { "const": null, "description": "Specify **null** to remove the manager from this territory.\n", "type": "null", "x-zs-$id": "ManagerNullPUT" } ] }, "name": { "description": "Specify the name of the territory.\n", "maxLength": 50, "type": "string" }, "permission_type": { "description": "Specify the permission type for the territory.\nPossible values:\nread_write_delete - Grants full access to the territory, including read, write, and delete operations.\nread_only - Restricts users to read-only access for the territory.\n", "enum": [ "read_write_delete", "read_only" ], "type": "string" }, "reporting_to": { "anyOf": [ { "additionalProperties": false, "description": "Specify the parent territory of this territory by providing its unique ID.\n", "properties": { "id": { "description": "Specify the unique ID of the parent territory.\n", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object", "x-zs-$id": "ReportingToIdPUT" }, { "const": null, "description": "Specify **null** when this territory has no parent territory.\n", "type": "null", "x-zs-$id": "ReportingToNullPUT" } ] } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "UpdateTerritoriesRequestBody" }, "x-zs-llm-examples": [ "TerritoryUpdateExample" ] } }, "description": "The request body must contain a **territories** array. You can include a maximum of 100 territory objects per request.\n", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Successful territory update response\n", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "431581000000798016" }, "message": "Territory Updated Successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryUpdateSuccessResponse" } } }, "description": "Returns the result of the territory update for each territory in the **territories** array. The **code** field indicates **SUCCESS** for updated territories and **ERROR** for failures.\n" }, "400": { "content": { "application/json": { "examples": { "CriteriaFieldComparatorMismatch": { "summary": "Field and comparator mismatch in criteria\n", "value": { "territories": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "json_path": "$.territories[0].account_rule_criteria.comparator", "supported_values": [ "equal", "not_equal", "greater_than", "less_than" ] }, "message": "The comparator is not compatible with the given field", "status": "error" } ] } }, "CriteriaFieldComparatorValueMissing": { "summary": "Dependent field missing in criteria\n", "value": { "territories": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "json_path": "$.territories[0].account_rule_criteria.comparator" }, "message": "required field not found", "status": "error" } ] } }, "CriteriaFieldNotSupported": { "summary": "Field not supported in territory rule criteria\n", "value": { "territories": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "File_Upload", "json_path": "$.territories[0].account_rule_criteria.field.api_name" }, "message": "The given field api_name is not supported in criteria", "status": "error" } ] } }, "CriteriaFieldValueMismatch": { "summary": "Field value type mismatch in criteria\n", "value": { "territories": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "expected_data_type": "integer", "json_path": "$.territories[0].account_rule_criteria.value" }, "message": "The value is not compatible with the given field", "status": "error" } ] } }, "CriteriaInvalidFieldDataType": { "summary": "Invalid field data type in criteria\n", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.territories[0].account_rule_criteria.field" }, "message": "invalid data", "status": "error" } ] } }, "TerritoryDisabled": { "summary": "Territory Management disabled error\n", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory Management not yet enabled error\n", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/TerritoriesInvalidDataWithSupportedValues" }, { "$ref": "#/components/schemas/TerritoriesDuplicateDataError" }, { "$ref": "#/components/schemas/TerritoryParentNoPermission" }, { "$ref": "#/components/schemas/TerritoriesMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundTerritoriesError" }, { "$ref": "#/components/schemas/TerritoryMaxLimitExceededErrorSchemaForCriteria" }, { "$ref": "#/components/schemas/InvalidDataWithMaximumLength" }, { "$ref": "#/components/schemas/NotSupportedForCriteriaOnModuleDisable" }, { "$ref": "#/components/schemas/TerritoryParentNoPermissionDetailed" }, { "$ref": "#/components/schemas/NotAllowedOrgTerritoryUpdate" }, { "$ref": "#/components/schemas/TerritoryReportingToChildError" }, { "$ref": "#/components/schemas/TerritoryUpdateDeleteNoPermission" }, { "$ref": "#/components/schemas/TerritoryCriteriaError" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" } ], "description": "Represents the error response for an invalid or failed territory update request.\n", "x-zs-$id": "TerritoryUpdateErrorResponseSchema" } } }, "description": "The territory update request contains invalid or missing data.\n**Resolution:** The territory IDs, required fields, and field values in the request body must be valid.\n" }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure due to invalid OAuth token\n", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.UPDATE" ] } ], "summary": "Update territories\n", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Updates one or more territories in a single request. Each object in the request body must include the territory id. Supports modifying name, parent territory, manager, permission type, description, and rule criteria. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/actions/associated_users_count": { "get": { "description": "To retrieve the number of users associated with each territory in your Zoho CRM organization.\n", "operationId": "getTerritoryAssociatedUsersCount", "parameters": [ { "$ref": "#/components/parameters/TerritoriesPage", "description": "Page Number" }, { "$ref": "#/components/parameters/TerritoriesPerPage", "description": "Per Page Number" } ], "responses": { "200": { "content": { "application/json": { "examples": { "TerritoryAssociatedUsersCountResponse": { "summary": "Successful retrieval of territory-associated user counts\n", "value": { "associated_users_count": [ { "count": 5, "territory": { "id": "2276164000001054020", "name": "zoho" } }, { "count": 1, "territory": { "id": "431581000000744183", "name": "Chennai Leads" } } ], "info": { "count": 2, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "$ref": "#/components/schemas/TerritoryAssociatedUsersCountResponse" } } }, "description": "Returns the list of territories with the count of users associated with each territory.\n" }, "204": { "description": "Indicates that the request was processed successfully but no territory user count data was returned.\n" }, "400": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Territory Management disabled error\n", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory Management not yet enabled error\n", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" } } }, "description": "The territory feature is not enabled for this organization.\n**Resolution:** The CRM administrator must enable Territory Management for the organization in Zoho CRM settings." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure due to invalid or expired OAuth token\n", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.READ" ] } ], "summary": "Get territory-associated user counts\n", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Retrieves the count of users associated with each territory. Use this before performing bulk territory operations to understand user distribution. Supports filtering by territory ids. Returns 204 when no data is found. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/actions/run_rules": { "post": { "description": "To schedule territory assignment rules to run against records in a specified module in your Zoho CRM organization. The rules can be applied based on filter criteria, a Custom View, or specific territories, and the execution is queued as a background job.", "operationId": "runTerritoryRules", "requestBody": { "content": { "application/json": { "examples": { "RunRulesExample": { "summary": "Criteria-based territory rule execution for a module", "value": { "run_rules": { "based_on": "criteria", "criteria": { "comparator": "equal", "field": { "api_name": "Account_Name" }, "value": "test" }, "module": { "id": "11111000736439" } } } } }, "schema": { "additionalProperties": false, "description": "Specify the configuration for scheduling territory rule execution. The schema supports three execution methods: criteria-based, Custom View-based, and territory-based.", "properties": { "run_rules": { "anyOf": [ { "additionalProperties": false, "description": "Specify the criteria-based configuration for territory rule execution. Use this option to run territory assignment rules against records matching a filter criterion.", "properties": { "based_on": { "description": "Specify the execution method for territory assignment rules.\nPossible values:\n**criteria** - Runs territory rules against records matching a specified filter criterion.", "enum": [ "criteria" ], "type": "string" }, "criteria": { "$ref": "#/components/schemas/FilterCriterionRequest", "description": "Filter criteria for territory rule execution." }, "module": { "$ref": "#/components/schemas/TerritoryRuleModuleReference", "description": "Specify the API name of the module for which to run territory assignment rules." } }, "required": [ "module", "based_on", "criteria" ], "type": "object", "x-zs-$id": "RunRulesBasedOnCriteriaObject" }, { "additionalProperties": false, "description": "Specify the Custom View-based configuration for territory rule execution. Use this option to run territory assignment rules against records in a specified Custom View.", "properties": { "based_on": { "description": "Specify the execution method for territory assignment rules.\nPossible values:\n**custom_view** - Runs territory rules against records included in a specified Custom View.", "enum": [ "custom_view" ], "type": "string" }, "custom_view": { "additionalProperties": false, "anyOf": [ { "description": "Specify the Custom View using its unique identifier. Provide the **id** field to identify the Custom View by its numeric ID.", "required": [ "id" ], "x-zs-$id": "CustomViewRequiresWithIdVariant5" }, { "description": "Specify the Custom View using its API name. Provide the **api_name** field to identify the Custom View by its string identifier.", "required": [ "api_name" ], "x-zs-$id": "CustomViewRequiresWithApiNameVariant6" } ], "description": "Specify the Custom View for which the territory assignment rules apply. Provide either the **ID** or the **api_name** of the Custom View.", "properties": { "api_name": { "description": "Specify the API name of the Custom View for which the territory assignment rules apply.", "maxLength": 100, "type": "string" }, "id": { "description": "Specify the unique identifier of the Custom View for which the territory assignment rules apply.", "format": "int64", "maxLength": 25, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getCustomViews", "propertyId": "CustomViewId" } ], "resource": "custom_views" } } }, "type": "object" }, "module": { "$ref": "#/components/schemas/TerritoryRuleModuleReference", "description": "Specify the API name of the module for which to run territory assignment rules." } }, "required": [ "module", "based_on", "custom_view" ], "type": "object", "x-zs-$id": "RunRulesBasedOnCustomViewObject" }, { "additionalProperties": false, "description": "Specify the territory-based configuration for territory rule execution. Use this option to run territory assignment rules against records associated with one or more specific territories.", "properties": { "based_on": { "description": "Specify the execution method for territory assignment rules.\nPossible values:\n**territory** - Runs territory rules against records associated with specified territories.", "enum": [ "territory" ], "type": "string" }, "include_child": { "description": "Specify whether to include child territories when running the territory assignment rules.\nPossible values:\n**true** - Includes child territories of the specified territories in the rule execution.\n**false** - Runs rules only for the specified territories, without their child territories.", "type": "boolean" }, "module": { "$ref": "#/components/schemas/TerritoryRuleModuleReference", "description": "Specify the API name of the module for which to run territory assignment rules." }, "territories": { "description": "Specify the list of territories for which the territory assignment rules apply.", "items": { "additionalProperties": false, "description": "Specify a territory for which the assignment rules apply. Provide the **ID** of the territory.", "properties": { "id": { "description": "Specify the unique identifier of the territory for which the assignment rules apply.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "module", "based_on", "territories" ], "type": "object", "x-zs-$id": "RunRulesBasedOnTerritoriesObject" } ], "description": "Specify the configuration for territory rule execution. The **run_rules** object must match one of three execution methods: criteria-based, Custom View-based, or territory-based." } }, "required": [ "run_rules" ], "type": "object", "x-zs-$id": "RunTerritoryRulesRequestBody" }, "x-zs-llm-examples": [ "RunRulesExample" ] } }, "description": "The request body must contain a **run_rules** object with one of the following execution configurations: criteria-based, Custom View-based, or territory-based.", "required": true }, "responses": { "202": { "content": { "application/json": { "examples": { "TerritoryRulesScheduled": { "summary": "Scheduled response for territory rules execution", "value": { "run_rules": { "code": "SCHEDULED", "details": { "job_id": "111111678900087967" }, "message": "Territory rules scheduled successfully.Once done, completion email will be sent.", "status": "success" } } } }, "schema": { "$ref": "#/components/schemas/TerritoryRunRulesScheduledResponse" } } }, "description": "Returns a scheduled status response indicating that the territory assignment rules execution has been queued as a background job. The response includes a **job_id** for tracking the scheduled execution." }, "400": { "content": { "application/json": { "examples": { "AlreadyScheduled": { "summary": "Territory rules execution already scheduled", "value": { "code": "ALREADY_SCHEDULED", "details": { "job_id": "4476574676432" }, "message": "Previously scheduled Run Rules Action was not yet Completed. Please try again once it's completed", "status": "error" } }, "AmbiguityDuringProcessing": { "summary": "Ambiguity error when both module.id and module.api_name are provided", "value": { "run_rules": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "api_name", "json_path": "$.run_rules.module.api_name" }, { "api_name": "id", "json_path": "$.run_rules.module.id" } ] }, "message": "Ambiguity while processing the request", "status": "error" } } }, "DealRuleNotEnabled": { "summary": "Territory deal rule not enabled for the organization", "value": { "run_rules": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Deal Rule Disabled", "status": "error" } } }, "DependentFieldMissing": { "summary": "Dependent field missing when custom_view is provided without based_on", "value": { "run_rules": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "based_on", "json_path": "$.run_rules.based_on" }, "json_path": "$.run_rules.custom_view" }, "message": "Dependent Field missing", "status": "error" } } }, "ExpectedFieldMissing": { "summary": "Expected field missing — module identifier not provided", "value": { "run_rules": { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.run_rules.module.api_name" }, { "api_name": "id", "json_path": "$.run_rules.module.id" } ] }, "message": "one of the expected field is missing", "status": "error" } } }, "InvalidBasedOnValue": { "summary": "Invalid value provided for the based_on field", "value": { "run_rules": { "code": "INVALID_DATA", "details": { "api_name": "based_on", "json_path": "$.run_rules.based_on" }, "message": "the given filter value is invalid", "status": "error" } } }, "InvalidCustomViewId": { "summary": "Invalid Custom View ID in the request", "value": { "run_rules": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.run_rules.custom_view.id" }, "message": "the given value is invalid", "status": "error" } } }, "InvalidDataForIncludeChild": { "summary": "Invalid data type for the include_child field", "value": { "run_rules": { "code": "INVALID_DATA", "details": { "api_name": "include_child", "expected_data_type": "boolean", "json_path": "$.run_rules.include_child" }, "message": "invalid data", "status": "error" } } }, "InvalidDataOnTerritoryOption": { "summary": "Invalid territory ID in the territories array", "value": { "run_rules": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.run_rules.territories[0].id" }, "message": "the given value is invalid", "status": "error" } } }, "InvalidModuleApiName": { "summary": "Invalid module API name — only Leads, Accounts, and Deals are supported", "value": { "run_rules": { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.run_rules.module.api_name" }, "message": "invalid data", "status": "error" } } }, "InvalidModuleId": { "summary": "Invalid module ID in the request", "value": { "run_rules": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.run_rules.module.id" }, "message": "invalid data", "status": "error" } } }, "LeadRuleNotEnabled": { "summary": "Territory lead rule not enabled for the organization", "value": { "run_rules": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Lead Rule Disabled", "status": "error" } } }, "MandatoryNotFound": { "summary": "Missing mandatory field in the territory run rules request", "value": { "run_rules": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "module", "json_path": "$.run_rules.module" }, "message": "required field not found", "status": "error" } } }, "TerritoryDisabled": { "summary": "Territory management disabled for the organization", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory management not yet enabled for the organization", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RunRulesInvalidData" }, { "$ref": "#/components/schemas/RunRulesInvalidIncludeChild" }, { "$ref": "#/components/schemas/RunRulesMandatoryNotFound" }, { "$ref": "#/components/schemas/RunRulesAlreadyScheduled" }, { "$ref": "#/components/schemas/AmbiguityDuringProcessing" }, { "$ref": "#/components/schemas/RunRulesLeadModuleNotEnabled" }, { "$ref": "#/components/schemas/RunRulesDealModuleNotEnabled" }, { "$ref": "#/components/schemas/RunRulesExpectedFieldMissing" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/TerritoriesDependentFieldMissingError" }, { "$ref": "#/components/schemas/RunRulesDependentFieldMissing", "description": "Represents the error response when the territory run rules request contains invalid data. The schema supports multiple error variants, each corresponding to a specific validation failure." } ], "x-zs-$id": "TerritoryRunRulesInvalidErrorResponse" } } }, "description": "Returns an error response when the request contains invalid or missing data. The response identifies the specific validation failure, such as invalid field values, missing required fields, or unsupported module names." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure due to an invalid or missing OAuth token", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failed.\n**Resolution:** A new access token must be generated with the required scope for this API." }, "403": { "content": { "application/json": { "examples": { "PermissionDenied": { "summary": "Permission denied to run territory assignment rules", "value": { "run_rules": { "code": "NO_PERMISSION", "details": {}, "message": "You don't have permission to run rules based on criteria filter.", "status": "error" } } }, "RunRulesModuleNoPermission": { "summary": "Permission denied for the specified module in territory rule execution", "value": { "run_rules": { "code": "NO_PERMISSION", "details": {}, "message": "You don't have permission for the module.", "status": "error" } } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RunRulesNoPermission" }, { "$ref": "#/components/schemas/RunRulesModuleNoPermission" } ], "description": "Represents the error response when the requesting user does not have permission to run territory assignment rules.", "x-zs-$id": "TerritoryRunRulesForbiddenError" } } }, "description": "Permission denied to run territory assignment rules.\n**Resolution:** The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Run territory assignment rules", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Schedules territory assignment rules to run against records in the specified module. Supports scoping by criteria, custom view, or specific territory ids. Returns 202 - the job runs asynchronously. Use getTerritoryScheduledRunRuleJobs to poll the job status. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/actions/scheduled_run_rule_jobs": { "get": { "description": "To retrieve the status of a scheduled territory rule execution job in your Zoho CRM organization by specifying the **job_id** parameter.", "operationId": "getTerritoryScheduledRunRuleJobs", "parameters": [ { "$ref": "#/components/parameters/TerritoriesJobId", "description": "The unique identifier of the scheduled run rule job." } ], "responses": { "200": { "content": { "application/json": { "examples": { "JobStatusCompleted": { "summary": "Run rule job completed", "value": { "scheduled_run_rule_jobs": { "job_id": "482367546723546372", "scheduled_by": { "id": "3477061000000002001", "name": "John Doe" }, "scheduled_time": "2026-03-22T10:30:00+05:30", "status": "COMPLETED" } } }, "JobStatusFailed": { "summary": "Run rule job failed", "value": { "scheduled_run_rule_jobs": { "job_id": "482367546723546372", "scheduled_by": { "id": "3477061000000002001", "name": "John Doe" }, "scheduled_time": "2026-03-22T10:30:00+05:30", "status": "FAILED" } } }, "JobStatusInProgress": { "summary": "Run rule job in progress", "value": { "scheduled_run_rule_jobs": { "job_id": "482367546723546372", "scheduled_by": { "id": "3477061000000002001", "name": "John Doe" }, "scheduled_time": "2026-03-22T10:30:00+05:30", "status": "IN_PROGRESS" } } } }, "schema": { "$ref": "#/components/schemas/TerritoryScheduledRunRuleJobsResponse" } } }, "description": "Returns the status and details of the specified scheduled territory run rule job.\n" }, "204": { "description": "Indicates that no scheduled territory run rule job was found for the specified **job_id**.\n" }, "400": { "content": { "application/json": { "examples": { "RequiredParamMissing": { "summary": "Required parameter job_id missing from the request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "job_id" }, "message": "One of the expected parameter is missing", "status": "error" } }, "TerritoryDisabled": { "summary": "Territory management disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory management not yet enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/ScheduledRunRuleJobsRequiredParamMissing" } ], "description": "Represents the error response for a 400 Bad Request, which occurs when the territory feature is not enabled or the required **job_id** parameter is missing.\n", "x-zs-$id": "ScheduledRunRuleJobsBadRequestError" } } }, "description": "The request could not be processed due to a missing required parameter or a disabled territory feature.\n**Resolution:** The **job_id** query parameter must be included in the request, and territory management must be enabled in the Zoho CRM organization." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure error", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failed for the request.\n**Resolution:** A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.READ" ] }, { "OAuth2": [ "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Get scheduled territory run rule job status", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Use this API to check the status of a scheduled territory rule run job. Pass the job_id returned in the 202 response from runTerritoryRules. Returns 204 when the job_id is not found. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/actions/transfer_and_delete": { "post": { "description": "To transfer records from one or more territories to a target territory and then delete those territories in your Zoho CRM organization.", "operationId": "transferAndDeleteTerritories", "requestBody": { "content": { "application/json": { "examples": { "TerritoryTransferAndDelete": { "summary": "Transfer and delete territories", "value": { "territories": [ { "delete_previous_forecasts": true, "id": "431581000000798016", "transfer_to_id": "431581000000272796" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the territories to transfer records from and delete.", "properties": { "territories": { "description": "Specify the list of territories to transfer records from and delete.", "items": { "additionalProperties": false, "description": "Specify the details for each territory to transfer and delete.", "properties": { "delete_previous_forecasts": { "description": "Specify whether to delete previous forecasts associated with the territory. Set to **true** to delete forecasts, or **false** to retain them.", "type": "boolean" }, "id": { "description": "Specify the unique ID of the territory to delete.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } }, "transfer_to_id": { "description": "Specify the unique ID of the territory to which the records are transferred before deletion. If not specified, the records are removed without being transferred to another territory.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "TransferAndDeleteTerritoriesRequestBody" }, "x-zs-llm-examples": [ "TerritoryTransferAndDelete" ] } }, "description": "The request body must contain a **territories** array. You can include a maximum of 100 territory objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Successful territory transfer and delete", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "431581000000798016" }, "message": "Territory Transferred And Deleted Successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryTransferAndDeleteSuccessResponse" } } }, "description": "Returns the result of the territory transfer-and-delete operation for each territory in the **territories** array. The **code** field indicates **SUCCESS** for processed territories and **ERROR** for failed ones." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissing": { "summary": "Dependent transfer_to_id missing error when territory has child territories", "value": { "territories": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "transfer_to_id", "dependee": { "api_name": "id", "json_path": "$.territories[0].id" }, "json_path": "$.territories[0].transfer_to_id" }, "message": "This territory has its child. Please Give the transfer_to_id field value", "status": "error" } ] } }, "InvalidTerritoryIdError": { "summary": "Territory invalid data error", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.territories[0].id" }, "message": "Given Territoryid isn't valid one", "status": "error" } ] } }, "InvalidTransferToTerritoryIdError": { "summary": "Invalid transfer_to_id territory error", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "transfer_to_id", "json_path": "$.territories[0].transfer_to_id" }, "message": "Given transfer_to_id isn't valid one", "status": "error" } ] } }, "TerritoryDisabled": { "summary": "Territory Management disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory Management not yet enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/TerritoriesMandatoryNotFoundError" }, { "$ref": "#/components/schemas/TerritoriesDependentFieldMissingError" }, { "$ref": "#/components/schemas/NotAllowedDeleteErrorResponse" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryReportingToChildError" }, { "$ref": "#/components/schemas/TerritoryOrgNoPermission" }, { "$ref": "#/components/schemas/TerritoryParentNoPermissionDetailed" } ], "description": "Represents the error response for an invalid or failed territory transfer-and-delete operation.", "x-zs-$id": "TerritoryTransferAndDeleteErrorResponse" } } }, "description": "The territory transfer-and-delete operation contains invalid or missing data.\n**Resolution:** The territory IDs in the request must be valid, the transfer target territory must exist, and all required fields must be present in each territory object." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failed due to a missing, expired, or invalid OAuth token.\n**Resolution:** A valid OAuth token with the required scope must be included in the request." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.DELETE" ] } ], "summary": "Transfer and delete territories", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Use this when deleting territories that have associated child territories. Transfer child territories from parent territories to target territories and then deletes the source territories. Returns 200 with per-territory success or error status. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/{id}": { "delete": { "description": "To delete a specific territory from your Zoho CRM organization using its unique ID.", "operationId": "deleteTerritoryById", "parameters": [ { "$ref": "#/components/parameters/TerritoriesId", "description": "The unique ID of the territory to delete." }, { "$ref": "#/components/parameters/DeletePreviousForecasts", "description": "Delete Previous Forecasts for these territories" } ], "responses": { "200": { "content": { "application/json": { "examples": { "TerritoryDeleteById": { "summary": "Delete territory by URL ID — success response", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "431581000000798016" }, "message": "Given Territory Removed Successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryDeleteSuccessResponse" } } }, "description": "Returns the details of the deleted territory, including the result code and territory ID in the **details** object." }, "400": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Territory Management disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory Management not yet enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotAllowedDeleteErrorResponseInURL" }, { "$ref": "#/components/schemas/TerritoryInvalidUrlPathErrorSchema" }, { "$ref": "#/components/schemas/TerritoryByIdNoPermission" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" } ], "description": "Represents the error response for an invalid or failed territory deletion request.", "x-zs-$id": "TerritoryDeleteByIDErrorResponseSchema" } } }, "description": "The request is invalid or the territory cannot be deleted.\n**Resolution:** The territory ID in the request URL must be valid, and the territory must be eligible for deletion." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure error", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.DELETE" ] } ], "summary": "Delete a territory by ID", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Deletes a single territory by its id in the URL path. The territory must not have child territories. Use transferAndDeleteTerritoryById to reassign child territories. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." }, "get": { "description": "To retrieve the details of a specific territory in your Zoho CRM organization using its unique ID.", "operationId": "getTerritoryById", "parameters": [ { "$ref": "#/components/parameters/TerritoriesId", "description": "The unique ID of the territory to retrieve." }, { "$ref": "#/components/parameters/TerritoriesInclude", "description": "Specify the additional details to include in the response, such as **account_rule_criteria**, **lead_rule_criteria**, or **deal_rule_criteria**." }, { "$ref": "#/components/parameters/TerritoriesIncludeInnerDetails", "description": "Specifies additional manager details to include, such as ZUID and account status." } ], "responses": { "200": { "content": { "application/json": { "examples": { "TerritoryByIDSuccessResponse": { "summary": "Get territory data by territory ID", "value": { "territories": [ { "account_rule_criteria": { "comparator": "equal", "field": { "api_name": "Account_line_1", "id": "809216000000711017" }, "type": "value", "value": "432432" }, "api_name": "rew", "created_by": { "id": "809216000000299001", "name": "Deiva Vigneshwari Deiva Vigneshwari" }, "created_time": "2023-05-29T16:00:54+05:30", "description": "", "id": "809216000009380013", "lead_rule_criteria": { "comparator": "equal", "field": { "api_name": "Annual_Revenue", "id": "809216000000000581" }, "type": "value", "value": "423" }, "manager": null, "modified_by": { "id": "809216000000299001", "name": "Deiva Vigneshwari Deiva Vigneshwari" }, "modified_time": "2025-11-25T18:44:17+05:30", "name": "rew", "permission_type": "read_only", "reporting_to": { "id": "809216000000306373", "name": "Zoho89dewvvew" } } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryGetByIdResponse" } } }, "description": "Returns the details of the specified territory, including its name, manager, permission type, rule criteria, and audit timestamps.\n" }, "204": { "description": "No territory found for the specified territory ID." }, "400": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Territory Management disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory Management not yet enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError", "x-zs-$id": "TerritoryGetErrorResponseSchemaById" } } }, "description": "Territory Management is not enabled for this organization.\n**Resolution:** The CRM administrator must enable Territory Management in the organization settings." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.READ" ] } ], "summary": "Get territory by ID", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Retrieves full details of a single territory by its id in the URL path, including hierarchy position, manager, permission type, and rule criteria. Returns 204 when the territory does not exist. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." }, "put": { "description": "To update the details of a specific territory by its unique ID in your Zoho CRM organization.", "operationId": "updateTerritoryById", "parameters": [ { "$ref": "#/components/parameters/TerritoriesId", "description": "The unique ID of the territory to update." } ], "requestBody": { "content": { "application/json": { "examples": { "TerritoryUpdateById": { "summary": "Update territory by ID", "value": { "territories": [ { "account_rule_criteria": null, "deal_rule_criteria": { "comparator": "greater_than", "field": { "api_name": "Amount", "id": "431581000000000799" }, "value": "2000000" }, "description": null, "id": "431581000000798016", "lead_rule_criteria": null, "manager": null, "name": "Territory1234", "permission_type": "read_only", "reporting_to": { "id": "431581000000272796" } } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the territory to update.", "properties": { "territories": { "description": "Specify the list containing the territory to update.", "items": { "additionalProperties": false, "description": "Specify the details of the territory to update.", "properties": { "account_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents a null value that removes the account rule criteria from the territory.", "type": "null", "x-zs-$id": "AccountRuleCriteriaNull" } ], "description": "Specify the account rule criteria for the territory. Use a criteria object or a group criteria object to define conditions." }, "deal_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents a null value that removes the deal rule criteria from the territory.", "type": "null", "x-zs-$id": "DealRuleCriteriaNull" } ], "description": "Specify the deal rule criteria for the territory. Use a criteria object or a group criteria object to define conditions." }, "description": { "description": "Specify the description for the territory.", "maxLength": 250, "type": [ "string", "null" ] }, "id": { "description": "Specify the unique ID of the territory to update. This must match the territory **ID** in the request URL path.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } }, "lead_rule_criteria": { "anyOf": [ { "$ref": "#/components/schemas/SimpleFilterCriterionRequest" }, { "$ref": "#/components/schemas/GroupedFilterCriterionRequest" }, { "const": null, "description": "Represents a null value that removes the lead rule criteria from the territory.", "type": "null", "x-zs-$id": "LeadRuleCriteriaNull" } ], "description": "Specify the lead rule criteria for the territory. Use a criteria object or a group criteria object to define conditions." }, "manager": { "anyOf": [ { "additionalProperties": false, "description": "Represents the manager object with the manager's unique ID.", "properties": { "id": { "description": "Specify the unique ID of the manager to assign to the territory.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } } }, "required": [ "id" ], "type": "object", "x-zs-$id": "ManagerObjectPut" }, { "const": null, "description": "Represents a null value that removes the manager from the territory.", "type": "null", "x-zs-$id": "ManagerNull" } ] }, "name": { "description": "Specify the name of the territory.", "maxLength": 50, "type": "string" }, "permission_type": { "description": "Specify the permission type for the territory.\nPossible values:\n**read_write_delete** - Grants full access to read, write, and delete records in the territory.\n**read_only** - Restricts users to read-only access in the territory.", "enum": [ "read_write_delete", "read_only" ], "type": "string" }, "reporting_to": { "anyOf": [ { "additionalProperties": false, "description": "Represents the parent territory to which this territory reports in the hierarchy.", "properties": { "id": { "description": "Specify the unique ID of the parent territory.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object", "x-zs-$id": "ReportingToObjectPut" }, { "const": null, "description": "Represents a null value, indicating that no parent territory is configured.", "type": "null", "x-zs-$id": "ReportingToNullPut" } ] } }, "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "UpdateTerritoryByIdRequestBody" }, "x-zs-llm-examples": [ "TerritoryUpdateById" ] } }, "description": "The request body must contain a **territories** array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Territory update success", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "431581000000798016" }, "message": "Territory Updated Successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryUpdateSuccessResponse" } } }, "description": "Returns the result of the territory update. The **code** field indicates **SUCCESS** for the updated territory and **ERROR** for failures." }, "400": { "content": { "application/json": { "examples": { "CriteriaFieldComparatorMismatch": { "summary": "Field and comparator mismatch in criteria", "value": { "territories": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "json_path": "$.territories[0].account_rule_criteria.comparator", "supported_values": [ "equal", "not_equal", "greater_than", "less_than" ] }, "message": "The comparator is not compatible with the given field", "status": "error" } ] } }, "CriteriaFieldComparatorValueMissing": { "summary": "Dependent field missing in criteria", "value": { "territories": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "comparator", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "json_path": "$.territories[0].account_rule_criteria.comparator" }, "message": "required field not found", "status": "error" } ] } }, "CriteriaFieldNotSupported": { "summary": "Field not supported in territory rule criteria", "value": { "territories": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "File_Upload", "json_path": "$.territories[0].account_rule_criteria.field.api_name" }, "message": "The given field api_name is not supported in criteria", "status": "error" } ] } }, "CriteriaFieldValueMismatch": { "summary": "Field value type mismatch in criteria", "value": { "territories": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "value", "dependee": { "api_name": "field", "json_path": "$.territories[0].account_rule_criteria.field" }, "expected_data_type": "integer", "json_path": "$.territories[0].account_rule_criteria.value" }, "message": "The value is not compatible with the given field", "status": "error" } ] } }, "CriteriaInvalidFieldDataType": { "summary": "Invalid field data type in criteria", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.territories[0].account_rule_criteria.field" }, "message": "invalid data", "status": "error" } ] } }, "TerritoryDisabled": { "summary": "Territory disabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Territory not yet enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/TerritoriesInvalidDataWithSupportedValues" }, { "$ref": "#/components/schemas/TerritoriesDuplicateDataError" }, { "$ref": "#/components/schemas/TerritoryParentNoPermission" }, { "$ref": "#/components/schemas/TerritoriesMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundTerritoriesError" }, { "$ref": "#/components/schemas/TerritoryMaxLimitExceededErrorSchemaForCriteria" }, { "$ref": "#/components/schemas/InvalidDataWithMaximumLength" }, { "$ref": "#/components/schemas/InvalidDataWithMaximumLengthAsString" }, { "$ref": "#/components/schemas/NotSupportedForCriteriaOnModuleDisable" }, { "$ref": "#/components/schemas/TerritoryInvalidUrlPathErrorSchema" }, { "$ref": "#/components/schemas/TerritoryByIdNoPermission" }, { "$ref": "#/components/schemas/TerritoryReportingToChildError" }, { "$ref": "#/components/schemas/TerritoryCriteriaError" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryParentNoPermissionDetailed" } ], "description": "Represents the error response for an invalid or failed territory update request.", "x-zs-$id": "TerritoryUpdateErrorResponseSchemaById" } } }, "description": "The territory update request contains invalid or missing data.\n**Resolution:** Verify that the territory ID is valid and all required fields contain correct values." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.UPDATE" ] } ], "summary": "Update a specific territory by its ID", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Updates a single territory identified by its id in the URL path. Equivalent to updateTerritories for a single territory. Supports modifying name, parent territory, manager, permission type, description, and rule criteria. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/{id}/__child_territories": { "get": { "description": "To retrieve the list of child territories for a specific parent territory in your Zoho CRM organization. Use the **ID** path parameter to specify the parent territory, and optional query parameters such as **filters**, **include**, **include_inner_details**, **page**, and **per_page** to narrow results and control pagination.\n", "operationId": "getChildTerritoriesByParentId", "parameters": [ { "$ref": "#/components/parameters/TerritoriesInclude", "description": "Include account_rule_criteria, lead_rule_criteria (or) deal_rule_criteria." }, { "$ref": "#/components/parameters/TerritoriesId", "description": "List of Territory Id" }, { "$ref": "#/components/parameters/TerritoriesPage", "description": "Page Numeber" }, { "$ref": "#/components/parameters/TerritoriesPerPage", "description": "Per Page Number" }, { "$ref": "#/components/parameters/TerritoriesFilters", "description": "Filter Out the Territories based on Given Criteria" }, { "$ref": "#/components/parameters/TerritoriesIncludeInnerDetails", "description": "Include manager status & zuid" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetAllTerritories": { "summary": "Get child territories of a territory\n", "value": { "info": { "count": 0, "more_records": false, "page": 1, "per_page": 1 }, "territories": [ { "api_name": "zoho", "created_by": { "id": "2276164000000471001", "name": "Patricia" }, "created_time": "2024-07-09T20:50:29+05:30", "description": "Organization Parent Territory", "id": "2276164000001054020", "manager": { "id": "2276164000000471001", "name": "Patricia", "status": "active", "zuid": "8186088" }, "modified_by": { "id": "2276164000000471001", "name": "Patricia" }, "modified_time": "2024-07-09T20:50:29+05:30", "name": "zoho", "permission_type": "read_only", "reporting_to": null } ] } }, "GetTerritoriesByIncludeParam": { "summary": "Get child territories with rule criteria using the include parameter\n", "value": { "info": { "count": 0, "more_records": false, "page": 1, "per_page": 1 }, "territories": [ { "account_rule_criteria": { "comparator": "equal", "field": { "api_name": "Billing_City", "id": "431581000000000657" }, "value": "Chennai" }, "api_name": "Chennai", "created_by": { "id": "431581000000258001", "name": "Patricia Boyle" }, "created_time": "2023-06-10T12:17:53+05:30", "deal_rule_criteria": null, "description": null, "id": "431581000000744113", "lead_rule_criteria": null, "manager": { "id": "431581000000278001", "name": "J Smith" }, "modified_by": { "id": "431581000000258001", "name": "Patricia Boyle" }, "modified_time": "2023-06-10T12:23:23+05:30", "name": "Chennai", "permission_type": "read_write_delete", "reporting_to": { "id": "431581000000272796", "name": "Zoho" } } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryChildListResponse" } } }, "description": "Returns the list of child territories for the specified territory. Use the **info** object to navigate through paginated results.\n" }, "204": { "description": "No child territories exist for the specified territory. The response body is empty.\n" }, "400": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "FEATURE_NOT_ENABLED error when territory management is disabled\n", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "FEATURE_NOT_ENABLED error when territory management is not yet enabled\n", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryInvalidUrlPathErrorSchema" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" } ], "description": "Represents the error response returned when the request to retrieve child territories fails due to an invalid territory ID in the URL or because the territory management feature is not enabled.\n", "x-zs-$id": "GetChildTerritoriesByParentIdErrorResponse" } } }, "description": "The territory ID in the request URL is invalid, or the territory management feature is not enabled for this organization.\n**Resolution:** The territory ID in the URL must be a valid, existing territory identifier, and the territory management feature must be enabled in the organization settings.\n" }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "AUTHENTICATION_FAILURE error for an invalid OAuth token\n", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.READ" ] } ], "summary": "Get child territories by parent territory ID\n", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Retrieves direct child territories of a specific parent territory by its id in the URL path. Supports pagination, include (rule criteria), and include_inner_details (manager status and zuid). Returns 204 when no child territories exist. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/{id}/actions/transfer_and_delete": { "post": { "description": "To transfer child territories to a target parent territory and then delete a specific territory from your Zoho CRM organization. This operation is required for territories that have child territories, as they cannot be directly deleted using the Delete Territories API.", "operationId": "transferAndDeleteTerritoryById", "parameters": [ { "$ref": "#/components/parameters/TerritoriesId", "description": "The unique ID of the territory to transfer child territories from and then delete." } ], "requestBody": { "content": { "application/json": { "examples": { "TerritoryTransferAndDeleteById": { "summary": "Transfer and delete a specific territory by ID", "value": { "territories": [ { "delete_previous_forecasts": true, "transfer_to_id": "431581000000272796" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the transfer configuration for the territory to delete.", "properties": { "territories": { "description": "Specify the transfer details for the territory to delete.", "items": { "additionalProperties": false, "description": "Specify the transfer configuration for the territory to delete, including the target territory for child territory reassignment and the forecast deletion preference.", "properties": { "delete_previous_forecasts": { "description": "Specify whether to delete previous forecasts associated with the territory.\nPossible values:\n**true** - Deletes the previous forecasts for the territory.\n**false** - Retains the previous forecasts for the territory.", "type": "boolean" }, "id": { "description": "Specify the unique ID of the territory to delete. If omitted, the operation uses the territory ID from the URL path parameter.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } }, "transfer_to_id": { "description": "Specify the unique ID of the parent territory to which child territories are transferred before deleting the specified territory. The target territory must be higher in the hierarchy than the territory to delete.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "transfer_to_id" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "territories" ], "type": "object", "x-zs-$id": "TransferAndDeleteTerritoryByIdRequestBody" }, "x-zs-llm-examples": [ "TerritoryTransferAndDeleteById" ] } }, "description": "The request body must contain a **territories** array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Successful territory transfer and delete response", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "431581000000798016" }, "message": "Territory Transferred And Deleted Successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryTransferAndDeleteSuccessResponse" } } }, "description": "Returns the result of the territory transfer-and-delete operation for the specified territory." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissing": { "summary": "DEPENDENT_FIELD_MISSING error when transfer_to_id is absent", "value": { "territories": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "transfer_to_id", "dependee": { "resource_path_index": 2 }, "json_path": "$.territories[0].transfer_to_id" }, "message": "This territory has its child. Please Give the transfer_to_id field value", "status": "error" } ] } }, "InvalidTransferToTerritoryIdError": { "summary": "INVALID_DATA error for an invalid transfer_to_id value", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "transfer_to_id", "json_path": "$.territories[0].transfer_to_id" }, "message": "Given transfer_to_id isn't valid one", "status": "error" } ] } }, "TerritoryDisabled": { "summary": "FEATURE_NOT_ENABLED error when territory management is disabled", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "FEATURE_NOT_ENABLED error when territory management is not yet enabled", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidData" }, { "$ref": "#/components/schemas/DependentFieldMissingErrorInURL" }, { "$ref": "#/components/schemas/TerritoryInvalidUrlPathErrorSchema" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryByIdNoPermission" } ], "description": "Represents the error response for an invalid or failed territory transfer-and-delete operation.", "x-zs-$id": "TerritoryTransferAndDeleteByIDErrorResponse" } } }, "description": "The territory transfer-and-DELETE request contains invalid or missing data.\n**Resolution:** The request must specify a valid **transfer_to_id** that references an existing territory higher in the hierarchy than the territory to delete." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "AUTHENTICATION_FAILURE error for missing or invalid OAuth token", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } }, "description": "The access token does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.DELETE" ] } ], "summary": "Transfer and delete a specific territory by ID", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Transfers child territories from a single parent territory (identified by id in the URL path) to a target territory and deletes the source territory. Optionally removes forecast data associated with the deleted territory. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/settings/territories/{territory}/users": { "delete": { "description": "To disassociate one or more users from a territory in your Zoho CRM organization.", "operationId": "deassociateUsersFromTerritories", "parameters": [ { "$ref": "#/components/parameters/TerritoryUsersTerritory", "description": "Territory Id Param in URL" }, { "$ref": "#/components/parameters/TerritoryUsersIds", "description": "Ids to be removed from territory" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "value": { "users": [ [ { "code": "SUCCESS", "details": { "id": "111111000000044193" }, "message": "Given User Removed from the mentioned territory Successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111111000000044453" }, "message": "Given User Removed from the mentioned territory Successfully", "status": "success" } ] ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the response body containing the list of user disassociation results.", "properties": { "users": { "description": "Represents the list of user-territory disassociation results.", "items": { "anyOf": [ { "description": "Represents an array of error details associated with the user entry.", "items": { "additionalProperties": false, "description": "Represents an error detail for an invalid user ID in the request.", "properties": { "code": { "description": "Represents the status code of the disassociation operation for the user.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the disassociation operation.", "properties": { "id": { "description": "Represents the unique ID of the user.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message of the disassociation operation.", "maxLength": 250, "type": "string" }, "status": { "description": "Represents the status of the disassociation operation for the user.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "UsersArray" } ], "description": "Represents a user entry in the territory user list." }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "UsersUsersObject2" } ], "description": "Represents the success response body returned after disassociating users from the territory.", "x-zs-$id": "DeleteUsersSuccess" } } }, "description": "Returns the result of the user-territory disassociation." }, "400": { "content": { "application/json": { "examples": { "InvalidTerritoryId": { "summary": "Invalid Territory ID", "value": { "users": [ { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the given id given seems to be invalid", "status": "error" } ] } }, "InvalidUserIds": { "summary": "Invalid User ID", "value": { "users": [ { "code": "INVALID_DATA", "details": { "id": "111111000000084453" }, "message": "the given user id given seems to be invalid", "status": "error" } ] } }, "UserNotPartOfTerritory": { "value": { "users": [ { "code": "INVALID_DATA", "details": { "id": "111111000000044473" }, "message": "Given user is not a member of this territory.", "status": "error" }, { "code": "INVALID_DATA", "details": { "id": "111111000000084453" }, "message": "Given user is not a member of this territory.", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UserInvalidErrorSchemaOnRequestBody", "description": "Represents the invalid-request error schema returned when one or more user IDs in the request fail validation." } ], "description": "Represents the error response body returned when the request contains invalid parameters.", "x-zs-$id": "DeleteUsersBadrequest" } } }, "description": "Returns an error when the request contains invalid user IDs or missing required parameters. **Resolution:** Verify the user IDs and ensure all required parameters are provided." }, "403": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Example For Territory Diabled Error", "value": { "code": "TERRITORY_DISABLED", "details": {}, "message": "the territory feature is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Example For Territory Not yet Enabled", "value": { "code": "TERRITORY_NOT_ENABLED", "details": {}, "message": "the territory feature is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryErrorPermissionDenied", "description": "Territory Not yet Enabled." } ], "description": "Represents the error response body returned when access is denied or the territory feature is not enabled.", "x-zs-$id": "DeleteUsersForbidden" } } }, "description": "Returns an error when the territory feature is not yet enabled, is disabled, or access is denied. **Resolution:** Ensure the Territories feature is active and that your OAuth token includes the required scopes." }, "500": { "content": { "application/json": { "examples": { "InternalServerError": { "summary": "Internal Server Error", "value": { "code": "INTERNAL_SERVER_ERROR", "details": {}, "message": "", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the TerritoryInternalServerErrorSchema for the 500 Internal Server Error response.", "properties": { "code": { "description": "Represents the error code for the internal server error.", "enum": [ "INTERNAL_SERVER_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the internal server error.", "type": "object" }, "message": { "description": "Represents the error message describing the internal server error.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the internal server error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UsersInternalservererrorObject2" } ], "description": "Represents the error response body returned when an internal server error occurs.", "x-zs-$id": "DeleteUsersInternalservererror" } } }, "description": "An internal server error occurred while processing the request. **Resolution:** Retry the request after some time. If the error persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.ALL", "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Territory Users", "tags": [ "territory_users" ], "x-zoho-document": "territory_users" }, "get": { "description": "To retrieve the list of users associated with a territory in your Zoho CRM organization.", "operationId": "getTerritoryUsers", "parameters": [ { "description": "Specify the unique ID of the territory for which you want to retrieve the list of users. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID.", "in": "path", "name": "territory", "required": true, "schema": { "description": "Represents the unique ID of the territory as a string, with a maximum length of 100 characters.", "maxLength": 100, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 20 }, "users": [ { "$current_shift": null, "$next_shift": null, "$shift_effective_from": null, "Isonline": true, "Modified_By": { "id": "431581000000258001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-24T17:37:14+05:30", "alias": null, "category": "regular_user", "city": null, "confirm": true, "country": "IN", "country_locale": "en_US", "created_by": { "id": "431581000000258001", "name": "Patricia Boyle" }, "created_time": "2023-02-01T10:09:10+05:30", "customize_info": { "bc_view": null, "notes_desc": null, "show_detail_view": true, "show_home": false, "show_right_panel": null, "unpin_recent_item": null }, "date_format": "dd/MM/yyyy", "decimal_separator": "Period", "default_tab_group": "0", "dob": null, "email": "patricia@zohotest.com", "fax": null, "first_name": "Patricia Boyle", "full_name": "Patricia Boyle", "id": "431581000000258001", "language": "en_US", "last_name": null, "locale": "en_US", "microsoft": false, "mobile": null, "name_format__s": "Salutation,First Name,Last Name", "number_separator": "Comma", "offset": 19800000, "personal_account": false, "phone": null, "profile": { "id": "431581000000031157", "name": "Administrator" }, "role": { "id": "431581000000031151", "name": "CEO" }, "sandboxDeveloper": false, "signature": null, "sort_order_preference__s": "First Name,Last Name", "state": "Karnataka", "status": "active", "status_reason__s": null, "street": null, "theme": { "background": "#F3F0EB", "new_background": null, "normal_tab": { "background": "#222222", "font_color": "#FFFFFF" }, "screen": "fixed", "selected_tab": { "background": "#222222", "font_color": "#FFFFFF" }, "type": "default" }, "time_format": "hh:mm a", "time_zone": "Asia/Kolkata", "website": null, "zip": null, "zuid": "60019394663" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response body containing the list of users associated with the territory.", "properties": { "info": { "additionalProperties": false, "description": "Represents the pagination metadata for the response.", "properties": { "count": { "description": "Represents the total number of records returned.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether there are more records available beyond the current page.", "type": "boolean" }, "page": { "description": "Represents the current page number.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of records per page.", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "users": { "description": "Represents the list of users associated with the territory.", "items": { "$ref": "#/components/schemas/User", "description": "Represents an individual user record associated with the territory." }, "maxItems": 100, "type": "array" } }, "required": [ "users", "info" ], "type": "object", "x-zs-$id": "GetUsersSuccess" } } }, "description": "Returns the list of users associated with the specified territory." }, "204": { "description": "No users found for the specified territory." }, "400": { "content": { "application/json": { "examples": { "ErrorExample": { "summary": "Invalid ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the given id given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UserInvalidErrorSchemaInURL", "description": "Represents the invalid-request error schema when the territory ID in the URL is invalid." } ], "description": "Represents the error response body returned when the request contains invalid parameters.", "x-zs-$id": "GetUsersBadrequest" } } }, "description": "Returns an error when the request contains invalid parameters. **Resolution:** Verify the territory ID and ensure all required parameters are provided." }, "403": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Example For Territory Diabled Error", "value": { "code": "TERRITORY_DISABLED", "details": {}, "message": "the territory feature is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Example For Territory Not yet Enabled", "value": { "code": "TERRITORY_NOT_ENABLED", "details": {}, "message": "the territory feature is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryErrorPermissionDenied", "description": "Territory Not yet Enabled." } ], "description": "Represents the error response body returned when access is denied or the territory feature is not enabled.", "x-zs-$id": "GetUsersForbidden" } } }, "description": "Returns an error when the territory feature is not yet enabled, is disabled, or access is denied. **Resolution:** Ensure the Territories feature is active and that your OAuth token includes the required scopes." }, "500": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Auto-generated example to satisfy zest rule", "value": { "code": "INTERNAL_SERVER_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryInternalServerErrorSchema", "description": "Internal server error." } ], "description": "Represents the error response body returned when an internal server error occurs.", "x-zs-$id": "GetUsersInternalservererror" } } }, "description": "An internal server error occurred while processing the request. **Resolution:** Retry the request after some time. If the error persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.READ", "ZohoCRM.settings.territories.READ" ] }, { "OAuth2": [ "ZohoCRM.users.ALL", "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Territory Users", "tags": [ "territory_users" ], "x-zoho-document": "territory_users" }, "put": { "description": "To associate one or more users with a territory in your Zoho CRM organization.", "operationId": "associateUsersToTerritory", "parameters": [ { "description": "Specify the unique ID of the territory for which you want to add users.", "in": "path", "name": "territory", "required": true, "schema": { "description": "Specify the unique ID of the territory for which you want to add users. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to retrieve the territory ID.", "maxLength": 100, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "UserAssociationViaRequestBody": { "summary": "Example request body to associate users to a territory", "value": { "users": [ { "id": "111111000000042726" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body for associating users with a territory.", "properties": { "users": { "description": "Specify the list of users to associate with the territory.", "items": { "additionalProperties": false, "description": "Represents a user to associate with the territory.", "properties": { "id": { "description": "Specify the unique ID of the user to associate with the territory.", "maxLength": 100, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object" } } }, "description": "The request body must contain a **users** array. You can include a maximum of 100 objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "summary": "Example success response for adding user to Territory", "value": { "users": [ { "code": "SUCCESS", "details": { "id": "111111000000044193" }, "message": "Given User added to the mentioned territory Successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response body returned after associating users with the territory.", "properties": { "users": { "description": "Represents the list of user-territory association results.", "items": { "additionalProperties": false, "description": "Represents the result of a user-territory association operation.", "properties": { "code": { "description": "Represents the status code of the association operation for the user.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the association operation.", "properties": { "id": { "description": "Represents the unique ID of the user.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message of the association operation.", "maxLength": 250, "type": "string" }, "status": { "description": "Represents the status of the association operation for the user.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "UpdateUsersSuccess" } } }, "description": "Returns the result of the user-territory association." }, "400": { "content": { "application/json": { "examples": { "DuplicateUserAddition": { "summary": "Example error response for adding existing user to Territory", "value": { "users": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Given user id already exists for that record", "status": "error" } ] } }, "InvalidUserAddition": { "summary": "Invalid User Addition", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.users[0].id", "owner_status": "deleted" }, "message": "The user to whom you are trying to update is deleted.", "status": "error" } ] } }, "LimitExceeded": { "summary": "Example error response for Limit Exceeded", "value": { "users": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 100 }, "message": "Maximum Users Limit reached for a territory", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UserInvalidErrorSchemaOnRequestBody", "description": "Represents the invalid-request error schema returned when the users array in the request body fails validation." }, { "additionalProperties": false, "description": "Represents the limit exceeded error schema for the 400 Bad Request response.", "properties": { "users": { "description": "Represents the list of users whose association exceeded the territory limit.", "items": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryUsersLimitExceededErrorSchema", "description": "Represents the limit exceeded error schema returned when the territory user limit is reached." } ] }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "UsersUsersObject" } ], "description": "Represents the error response body returned when the request data is invalid.", "x-zs-$id": "UpdateUsersBadrequest" } } }, "description": "Returns an error when the request body contains invalid user IDs or duplicate entries. **Resolution:** Verify the user IDs provided and ensure they are valid and unique." }, "403": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Example For Territory Diabled Error", "value": { "code": "TERRITORY_DISABLED", "details": {}, "message": "the territory feature is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Example For Territory Not yet Enabled", "value": { "code": "TERRITORY_NOT_ENABLED", "details": {}, "message": "the territory feature is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryErrorPermissionDenied", "description": "Territory Not yet Enabled." } ], "description": "Represents the error response body returned when access is denied or the territory feature is not enabled.", "x-zs-$id": "UpdateUsersForbidden" } } }, "description": "Returns an error when the territory feature is not yet enabled, is disabled, or access is denied. **Resolution:** Ensure the Territories feature is active and that your OAuth token includes the required scopes." }, "500": { "content": { "application/json": { "examples": { "InternalServerError": { "summary": "Internal Server Error", "value": { "code": "INTERNAL_SERVER_ERROR", "details": {}, "message": "", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the TerritoryInternalServerErrorSchema for the 500 Internal Server Error response.", "properties": { "code": { "description": "Represents the error code for the internal server error.", "enum": [ "INTERNAL_SERVER_ERROR" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the internal server error.", "type": "object" }, "message": { "description": "Represents the error message describing the internal server error.", "maxLength": 100, "type": "string" }, "status": { "description": "Represents the status of the internal server error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UsersInternalservererrorObject" } ], "description": "Represents the error response body returned when an internal server error occurs.", "x-zs-$id": "UpdateUsersInternalservererror" } } }, "description": "An internal server error occurred while processing the request. **Resolution:** Retry the request after some time. If the error persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.ALL", "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Territory Users", "tags": [ "territory_users" ], "x-zoho-document": "territory_users" } }, "/crm/v8/settings/territories/{territory}/users/{user}": { "delete": { "description": "To disassociate a specific user from a territory in your Zoho CRM organization.", "operationId": "deassociateUserFromSpecificTerritory", "parameters": [ { "$ref": "#/components/parameters/TerritoryUsersTerritory", "description": "Territory Id Param in URL" }, { "$ref": "#/components/parameters/TerritoryUsersUser", "description": "User Id Param in URL" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "value": { "users": [ [ { "code": "SUCCESS", "details": { "id": "431581000000258001" }, "message": "Given User Removed from the mentioned territory Successfully", "status": "success" } ] ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the response body containing the list of user disassociation results.", "properties": { "users": { "description": "Represents the list of user-territory disassociation results.", "items": { "anyOf": [ { "description": "Represents an array of error details associated with the user entry.", "items": { "additionalProperties": false, "description": "Represents an error detail for an invalid user ID in the request.", "properties": { "code": { "description": "Represents the status code of the disassociation operation for the user.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the disassociation operation.", "properties": { "id": { "description": "Represents the unique ID of the user.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message of the disassociation operation.", "maxLength": 250, "type": "string" }, "status": { "description": "Represents the status of the disassociation operation for the user.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "UsersArray3" } ], "description": "Represents a user entry in the territory user list." }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "UsersUsersObject4" } ], "description": "Represents the success response body returned after disassociating the user from the territory.", "x-zs-$id": "DeleteUsersSuccess2" } } }, "description": "Returns the result of the user-territory disassociation." }, "400": { "content": { "application/json": { "examples": { "ErrorExample": { "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 4 }, "message": "the id given seems to be invalid.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error details for an invalid user ID in the URL.", "properties": { "code": { "description": "Represents the error code for the invalid request.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the validation error.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource path in the request.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation error.", "maxLength": 250, "type": "string" }, "status": { "description": "Represents the status of the validation error response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UsersInvaliddataObject" }, { "additionalProperties": false, "description": "Represents the error details for an invalid territory ID in the URL.", "type": "object", "x-zs-$id": "UsersObject" } ], "description": "Represents the error response body returned when the request contains invalid user IDs.", "x-zs-$id": "DeleteUsersBadrequest2" } } }, "description": "Returns an error when the request contains invalid user IDs or missing required parameters. **Resolution:** Verify the user ID and ensure all required parameters are provided." }, "403": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Example For Territory Diabled Error", "value": { "code": "TERRITORY_DISABLED", "details": {}, "message": "the territory feature is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Example For Territory Not yet Enabled", "value": { "code": "TERRITORY_NOT_ENABLED", "details": {}, "message": "the territory feature is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryErrorPermissionDenied", "description": "Territory Not yet Enabled." } ], "description": "Represents the error response body returned when access is denied or the territory feature is not enabled.", "x-zs-$id": "DeleteUsersForbidden2" } } }, "description": "Returns an error when the territory feature is not yet enabled, is disabled, or access is denied. **Resolution:** Ensure the Territories feature is active and that your OAuth token includes the required scopes." }, "500": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Auto-generated example to satisfy zest rule", "value": { "code": "INTERNAL_SERVER_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryInternalServerErrorSchema", "description": "Internal server error." } ], "description": "Represents the error response body returned when an internal server error occurs.", "x-zs-$id": "DeleteUsersInternalservererror2" } } }, "description": "An internal server error occurred while processing the request. **Resolution:** Retry the request after some time. If the error persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.ALL", "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Territory User", "tags": [ "territory_users" ], "x-zoho-document": "territory_users" }, "get": { "description": "To retrieve the details of a specific user associated with a territory in your Zoho CRM organization.", "operationId": "getUserDetailsFromTerritory", "parameters": [ { "$ref": "#/components/parameters/TerritoryUsersTerritory", "description": "Territory Id Param in URL" }, { "$ref": "#/components/parameters/TerritoryUsersUser", "description": "User Id Param in URL" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 20 }, "users": [ { "$current_shift": null, "$next_shift": null, "$shift_effective_from": null, "Isonline": true, "Modified_By": { "id": "431581000000258001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-24T17:37:14+05:30", "alias": null, "category": "regular_user", "city": null, "confirm": true, "country": "IN", "country_locale": "en_US", "created_by": { "id": "431581000000258001", "name": "Patricia Boyle" }, "created_time": "2023-02-01T10:09:10+05:30", "customize_info": { "bc_view": null, "notes_desc": null, "show_detail_view": true, "show_home": false, "show_right_panel": null, "unpin_recent_item": null }, "date_format": "dd/MM/yyyy", "decimal_separator": "Period", "default_tab_group": "0", "dob": null, "email": "patricia@zohotest.com", "fax": null, "first_name": "Patricia Boyle", "full_name": "Patricia Boyle", "id": "431581000000258001", "language": "en_US", "last_name": null, "locale": "en_US", "microsoft": false, "mobile": null, "name_format__s": "Salutation,First Name,Last Name", "number_separator": "Comma", "offset": 19800000, "personal_account": false, "phone": null, "profile": { "id": "431581000000031157", "name": "Administrator" }, "role": { "id": "431581000000031151", "name": "CEO" }, "sandboxDeveloper": false, "signature": null, "sort_order_preference__s": "First Name,Last Name", "state": "Karnataka", "status": "active", "status_reason__s": null, "street": null, "theme": { "background": "#F3F0EB", "new_background": null, "normal_tab": { "background": "#222222", "font_color": "#FFFFFF" }, "screen": "fixed", "selected_tab": { "background": "#222222", "font_color": "#FFFFFF" }, "type": "default" }, "time_format": "hh:mm a", "time_zone": "Asia/Kolkata", "website": null, "zip": null, "zuid": "60019394663" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response body containing the details of the specified user associated with the territory.", "properties": { "info": { "additionalProperties": false, "description": "Represents the pagination metadata for the response.", "properties": { "count": { "description": "Represents the total number of records returned.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether there are more records available beyond the current page.", "type": "boolean" }, "page": { "description": "Represents the current page number.", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of records per page.", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "users": { "description": "Represents the list of users associated with the territory.", "items": { "$ref": "#/components/schemas/User", "description": "Represents an individual user record associated with the territory." }, "maxItems": 100, "type": "array" } }, "required": [ "users", "info" ], "type": "object", "x-zs-$id": "GetUsersSuccess2" } } }, "description": "Returns the details of the specified user associated with the territory." }, "204": { "description": "No content found for the specified user in the territory." }, "400": { "content": { "application/json": { "examples": { "InvalidTerritoryIdExample": { "summary": "Invalid Territory ID in URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the given id given seems to be invalid", "status": "error" } }, "InvalidUserIdExample": { "summary": "Invalid User ID in URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 4 }, "message": "the given id given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UserInvalidErrorSchemaInURL", "description": "Represents the invalid-request error schema when the territory or user ID in the URL is invalid." } ], "description": "Represents the error response body returned when the request contains invalid parameters.", "x-zs-$id": "GetUsersBadrequest2" } } }, "description": "Returns an error when the request contains invalid parameters. **Resolution:** Verify the territory ID and user ID and ensure all required parameters are provided." }, "403": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Example For Territory Diabled Error", "value": { "code": "TERRITORY_DISABLED", "details": {}, "message": "the territory feature is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Example For Territory Not yet Enabled", "value": { "code": "TERRITORY_NOT_ENABLED", "details": {}, "message": "the territory feature is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryErrorPermissionDenied", "description": "Territory Not yet Enabled." } ], "description": "Represents the error response body returned when access is denied or the territory feature is not enabled.", "x-zs-$id": "GetUsersForbidden2" } } }, "description": "Returns an error when the territory feature is not yet enabled, is disabled, or access is denied. **Resolution:** Ensure the Territories feature is active and that your OAuth token includes the required scopes." }, "500": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Auto-generated example to satisfy zest rule", "value": { "code": "INTERNAL_SERVER_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryInternalServerErrorSchema", "description": "Internal server error." } ], "description": "Represents the error response body returned when an internal server error occurs.", "x-zs-$id": "GetUsersInternalservererror2" } } }, "description": "An internal server error occurred while processing the request. **Resolution:** Retry the request after some time. If the error persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.READ", "ZohoCRM.settings.territories.READ" ] }, { "OAuth2": [ "ZohoCRM.users.ALL", "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Specific Territory User", "tags": [ "territory_users" ], "x-zoho-document": "territory_users" }, "put": { "description": "To associate a specific user with a territory in your Zoho CRM organization.", "operationId": "associateUserToSpecificTerritory", "parameters": [ { "$ref": "#/components/parameters/TerritoryUsersTerritory", "description": "Territory Id Param in URL" }, { "$ref": "#/components/parameters/TerritoryUsersUser", "description": "User Id Param in URL" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessExample": { "value": { "users": [ [ { "code": "SUCCESS", "details": { "id": "431581000000258001" }, "message": "Given User added to the mentioned territory Successfully", "status": "success" } ] ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the response body containing the list of user-territory association results.", "properties": { "users": { "description": "Represents the list of user-territory association results.", "items": { "anyOf": [ { "description": "Represents an array of error details associated with the user entry.", "items": { "additionalProperties": false, "description": "Represents an error detail for an invalid user ID in the request.", "properties": { "code": { "description": "Represents the status code of the association operation for the user.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the association operation.", "properties": { "id": { "description": "Represents the unique ID of the user.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the status message of the association operation.", "maxLength": 250, "type": "string" }, "status": { "description": "Represents the status of the association operation for the user.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array", "x-zs-$id": "UsersArray2" } ], "description": "Represents a user entry in the territory user list." }, "maxItems": 100, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "UsersUsersObject3" } ], "description": "Represents the success response body returned after associating the user with the territory.", "x-zs-$id": "UpdateUsersSuccess2" } } }, "description": "Returns the result of the user-territory association." }, "400": { "content": { "application/json": { "examples": { "DuplicateDataInURL": { "value": { "users": [ { "code": "DUPLICATE_DATA", "details": { "resource_path_index": 4 }, "message": "Given user id already exists for that record", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UserInvalidErrorSchemaOnRequestBody", "description": "Represents the invalid-request error schema returned when the user or territory ID in the URL fails validation." } ], "description": "Represents the error response body returned when the request data is invalid.", "x-zs-$id": "UpdateUsersBadrequest2" } } }, "description": "Returns an error when the request body contains invalid user IDs or duplicate entries. **Resolution:** Verify the user IDs provided and ensure they are valid and unique." }, "403": { "content": { "application/json": { "examples": { "TerritoryDisabled": { "summary": "Example For Territory Diabled Error", "value": { "code": "TERRITORY_DISABLED", "details": {}, "message": "the territory feature is disabled", "status": "error" } }, "TerritoryNotYetEnabled": { "summary": "Example For Territory Not yet Enabled", "value": { "code": "TERRITORY_NOT_ENABLED", "details": {}, "message": "the territory feature is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryErrorPermissionDenied", "description": "Territory Not yet Enabled." } ], "description": "Represents the error response body returned when access is denied or the territory feature is not enabled.", "x-zs-$id": "UpdateUsersForbidden2" } } }, "description": "Returns an error when the territory feature is not yet enabled, is disabled, or access is denied. **Resolution:** Ensure the Territories feature is active and that your OAuth token includes the required scopes." }, "500": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Auto-generated example to satisfy zest rule", "value": { "code": "INTERNAL_SERVER_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryInternalServerErrorSchema", "description": "Internal server error." } ], "description": "Represents the error response body returned when an internal server error occurs.", "x-zs-$id": "UpdateUsersInternalservererror2" } } }, "description": "An internal server error occurred while processing the request. **Resolution:** Retry the request after some time. If the error persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.ALL", "ZohoCRM.settings.territories.ALL" ] } ], "summary": "Territory User", "tags": [ "territory_users" ], "x-zoho-document": "territory_users" } }, "/crm/v8/settings/unsubscribe_link/actions/associations": { "get": { "description": "To retrieve information about where unsubscribe links are being used (associated places) in your CRM account, such as in email templates.", "operationId": "getAssociations", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response listing the places where each unsubscribe link is currently associated.", "summary": "Success response for status 200", "value": { "associations": [ { "associated_places": [ { "details": { "module": { "api_name": "Leads", "id": "111111000000002652" } }, "resource": { "id": "111111000000116051", "name": "Asd" }, "type": "email_templates" } ], "id": "111111000000116043" } ] } } }, "schema": { "$ref": "#/components/schemas/FetchAssociatedPlacesResponse" } } }, "description": "Success - Returns a list of associated places for each unsubscribe link" }, "204": { "description": "No Content - No associated places found for any unsubscribe link" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows a NO_PERMISSION error when the user does not have the required read permission.", "summary": "NO_PERMISSION error: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Unsubscribe_Form" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinksPermissionDeniedError" } } }, "description": "Forbidden - The request requires the ZohoCRM.settings.unsubscribe.READ scope" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.unsubscribe.READ" ] } ], "summary": "Get Unsubscribe Link Associations", "tags": [ "unsubscribe_links" ], "x-zoho-document": "unsubscribe_links" } }, "/crm/v8/settings/unsubscribe_links": { "get": { "description": "To retrieve the details of all unsubscribe links configured in your CRM account. This API returns a list of unsubscribe links with their complete configuration, including page type, submission behavior, timestamps, and creator information.", "operationId": "getUnsubscribeLinks", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response listing all unsubscribe links configured in the organization.", "summary": "Success response for status 200", "value": { "unsubscribe_links": [ { "created_by": { "id": "111111000000057843", "name": "Kk" }, "created_time": "2025-11-18T20:18:40+05:30", "custom_location_url": "", "id": "111111000000115014", "modified_by": { "id": "111111000000057843", "name": "Kk" }, "modified_time": "2025-11-18T20:18:40+05:30", "name": "Default", "page_type": "standard", "standard_page_message": null, "submission_action_type": "display_message", "submission_message": "", "submission_redirect_url": "" } ] } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinksResponse" } } }, "description": "Success - Returns a list of unsubscribe links with their configurations" }, "204": { "description": "No content - No unsubscribe links found in the account" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows a NO_PERMISSION error when the user does not have the required read permission.", "summary": "NO_PERMISSION error: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Unsubscribe_Form" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinksPermissionDeniedError" } } }, "description": "Forbidden - The request requires the ZohoCRM.settings.unsubscribe.READ scope" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.unsubscribe.READ" ] } ], "summary": "Get Unsubscribe Links", "tags": [ "unsubscribe_links" ], "x-zoho-document": "unsubscribe_links" }, "post": { "description": "To create an unsubscribe link that can be used in email templates or email footers. You can configure the link to display a standard Zoho CRM unsubscribe page or redirect to a custom webpage.", "operationId": "postUnsubscribeLinks", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a sample POST request body for creating a new unsubscribe link with name, page_type, and submission_action_type.", "summary": "Sample request body for creating an unsubscribe link", "value": { "unsubscribe_links": [ { "custom_location_url": "https://www.zoho.com/crm/developer/docs/api/v8/create-unsubscribe-link.html", "name": "Unsubscribe", "page_type": "standard", "standard_page_message": "standard message", "submission_action_type": "display_message", "submission_message": "display message", "submission_redirect_url": "https://www.zoho.com/crm/developer/docs/api/v8/create-unsubscribe-link.html" } ] } } }, "schema": { "$ref": "#/components/schemas/InitiateUnsubscribeLinksRequest" } } }, "description": "Request body containing the unsubscribe link configuration. The name, page_type, and submission_action_type fields are mandatory." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "description": "Shows a successful 201 response with the action status for the newly created unsubscribe link.", "summary": "Success response for status 201", "value": { "unsubscribe_links": [ { "code": "SUCCESS", "details": { "id": "111111000000115581" }, "message": "Unsubscribe Link created successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateUnsubscribeLinksSuccessResponse" } } }, "description": "Created - Unsubscribe link created successfully" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_action_type is missing but required by the selected page_type.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_action_type", "dependee": { "api_name": "submission_redirect_url", "json_path": "$.unsubscribe_links[0].submission_redirect_url" }, "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows a DEPENDENT_FIELD_MISSING error when page_type is missing but required by the selected submission_action_type.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (page_type)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "page_type", "dependee": { "api_name": "standard_page_message", "json_path": "$.unsubscribe_links[0].standard_page_message" }, "json_path": "$.unsubscribe_links[0].page_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "description": "Shows a DEPENDENT_FIELD_MISSING error when page_type is missing but required for the submission action.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (page_type)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "page_type", "dependee": { "api_name": "custom_location_url", "json_path": "$.unsubscribe_links[0].custom_location_url" }, "json_path": "$.unsubscribe_links[0].page_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_action_type is required but not provided.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_action_type", "dependee": { "api_name": "submission_message", "json_path": "$.unsubscribe_links[0].submission_message" }, "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse5": { "description": "Shows a DEPENDENT_FIELD_MISSING error when custom_location_url is required by the page_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "custom_location_url", "dependee": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.custom_location_url" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse6": { "description": "Shows a DEPENDENT_FIELD_MISSING error when standard_page_message is required by the page_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "standard_page_message", "dependee": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.standard_page_message" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse7": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_redirect_url is required by the submission_action_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_redirect_url", "dependee": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.submission_redirect_url" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse8": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_message is required by the submission_action_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (submission_message)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_message", "dependee": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.submission_message" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Shows a DUPLICATE_DATA error when the provided unsubscribe link name already exists in the organization.", "summary": "DUPLICATE_DATA error: Unsubscribe Link name already exists", "value": { "unsubscribe_links": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[0].name" }, "message": "Unsubscribe Link name already exists", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows an INVALID_DATA error when the request body is missing or has an invalid format.", "summary": "INVALID_DATA error: invalid body", "value": { "code": "INVALID_DATA", "details": { "expected_data_type": "jsonobject" }, "message": "body", "status": "error" } }, "InvalidDataResponse10": { "description": "Shows an INVALID_DATA error when the custom_location_url field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "standard_page_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].standard_page_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an INVALID_DATA error when the custom_location_url field value is invalid.", "summary": "INVALID_DATA error: Invalid data (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "standard_page_message", "json_path": "$.unsubscribe_links[*].standard_page_message", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an INVALID_DATA error when the standard_page_message field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_redirect_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[*].submission_redirect_url" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows an INVALID_DATA error when the standard_page_message field value is invalid.", "summary": "INVALID_DATA error: Invalid data (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_redirect_url", "json_path": "$.unsubscribe_links[*].submission_redirect_url", "maximum_length": 250 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an INVALID_DATA error when the submission_redirect_url field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].submission_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows an INVALID_DATA error when the submission_redirect_url field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "json_path": "$.unsubscribe_links[*].submission_message", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows an INVALID_DATA error when the submission_message field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].page_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows an INVALID_DATA error when the submission_message field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type", "maximum_length": 8 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows an INVALID_DATA error when the page_type field value is not supported.", "summary": "INVALID_DATA error: Invalid data (page_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type", "supported_values": [ "standard", "custom" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Shows an INVALID_DATA error when the submission_action_type field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an INVALID_DATA error when the unsubscribe_links field has invalid data.", "summary": "INVALID_DATA error: invalid data (unsubscribe_links)", "value": { "code": "INVALID_DATA", "details": { "api_name": "unsubscribe_links", "json_path": "$.unsubscribe_links", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse20": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type", "maximum_length": 15 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported submission_action_type value", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type", "supported_values": [ "display_message", "redirect" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an INVALID_DATA error when the custom_location_url field value does not meet the required format.", "summary": "INVALID_DATA error: invalid data (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_location_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[0].custom_location_url" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows an INVALID_DATA error when the submission_redirect_url field value does not meet the required format.", "summary": "INVALID_DATA error: invalid data (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_redirect_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[0].submission_redirect_url" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows a MANDATORY_NOT_FOUND error when the name field is missing from the request.", "summary": "MANDATORY_NOT_FOUND error: required field not found (name)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].name" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an INVALID_DATA error when the name field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (name)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[*].name", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows an INVALID_DATA error when the name field value is invalid.", "summary": "INVALID_DATA error: Invalid data (name)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[*].name", "minimum_length": 1 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows a MANDATORY_NOT_FOUND error when the page_type field is missing from the request.", "summary": "MANDATORY_NOT_FOUND error: Required field is missing (page_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_location_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[*].custom_location_url" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows an INVALID_DATA error when the page_type field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (page_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_location_url", "json_path": "$.unsubscribe_links[*].custom_location_url", "maximum_length": 250 }, "message": "invalid data", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows a LIMIT_EXCEEDED error when the organization has reached the maximum allowed number of unsubscribe links.", "summary": "LIMIT_EXCEEDED error: Unsubscribe Link limit exceeded", "value": { "unsubscribe_links": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 10, "limit_due_to": [ { "api_name": "unsubscribe_links", "json_path": "$.unsubscribe_links" } ] }, "message": "Unsubscribe Link limit exceeded", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows a MANDATORY_NOT_FOUND error when the unsubscribe_links field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error: required field not found (unsubscribe_links)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "unsubscribe_links", "json_path": "$.unsubscribe_links" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Shows a MANDATORY_NOT_FOUND error when the name field is missing from the request.", "summary": "MANDATORY_NOT_FOUND error: required field not found (name)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "description": "Shows a MANDATORY_NOT_FOUND error when the page_type field is missing from the request.", "summary": "MANDATORY_NOT_FOUND error: required field not found (page_type)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[0].page_type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "description": "Shows a MANDATORY_NOT_FOUND error when the name field is present but empty.", "summary": "MANDATORY_NOT_FOUND error: required field not found (name) - empty string", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "description": "Shows a MANDATORY_NOT_FOUND error when the page_type field is present but empty.", "summary": "MANDATORY_NOT_FOUND error: required field not found (page_type) - empty string", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[0].page_type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "description": "Shows a MANDATORY_NOT_FOUND error when the submission_action_type field is missing from the request.", "summary": "MANDATORY_NOT_FOUND error: required field not found (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "description": "Shows a MANDATORY_NOT_FOUND error when the name field is missing or null.", "summary": "MANDATORY_NOT_FOUND error: Required field is missing (name)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[*].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "description": "Shows a MANDATORY_NOT_FOUND error when the page_type field is missing or null.", "summary": "MANDATORY_NOT_FOUND error: Required field is missing (page_type)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "description": "Shows a MANDATORY_NOT_FOUND error when the submission_action_type field is missing or null.", "summary": "MANDATORY_NOT_FOUND error: Required field is missing (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response containing an array of individual unsubscribe link validation errors.", "properties": { "unsubscribe_links": { "description": "Represents the list of individual error objects for each unsubscribe link in the create request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/UnsubscribeLinksMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/UnsubscribeLinksDuplicateDataError" }, { "$ref": "#/components/schemas/LinkLimitExceededError" }, { "$ref": "#/components/schemas/InvalidCustomLocationURLError" }, { "$ref": "#/components/schemas/UnsubscribeLinksDependentFieldMissingError" }, { "$ref": "#/components/schemas/GeneralInvalidDataError" }, { "$ref": "#/components/schemas/GenericInvalidDataError" }, { "$ref": "#/components/schemas/InvalidDataValueErrorAlt" }, { "$ref": "#/components/schemas/InvalidDataErrorType" }, { "$ref": "#/components/schemas/UnsupportedPageTypeError" }, { "$ref": "#/components/schemas/RequiredFieldDependencyError" } ], "description": "Represents an individual error object for a specific unsubscribe link in the create request." }, "maxItems": 25, "type": "array" } }, "required": [ "unsubscribe_links" ], "type": "object", "x-zs-$id": "CreateInvalidRequestBodyErrors" }, { "$ref": "#/components/schemas/UnsubscribeLinksInvalidDataTypeError" }, { "$ref": "#/components/schemas/RequestBodyNotFoundError" }, { "$ref": "#/components/schemas/InvalidDataBodyError" }, { "$ref": "#/components/schemas/RequestBodyEmptyArray" } ], "description": "Validation error response for the POST request, covering invalid data type, missing required fields, duplicate data, limit exceeded, and dependent field failures.", "x-zs-$id": "CreateInvalidRequestErrors" } } }, "description": "Bad Request - Invalid data provided. Check field types, mandatory fields, dependencies, or refer to the Input JSON keys section in the help doc." }, "403": { "content": { "application/json": { "examples": { "MandatoryNotFoundResponse1": { "description": "Shows a MANDATORY_NOT_FOUND error returned as a 403 response when the submission_action_type field is missing.", "summary": "MANDATORY_NOT_FOUND error in 403 response: required field not found (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped error response containing an array of unsubscribe link errors returned when a required field is missing.", "properties": { "unsubscribe_links": { "description": "Represents the list of error objects for unsubscribe links in this response.", "items": { "$ref": "#/components/schemas/UnsubscribeLinksMandatoryFieldMissingError" }, "maxItems": 25, "type": "array" } }, "required": [ "unsubscribe_links" ], "type": "object", "x-zs-$id": "CreateResponseBodyError" } } }, "description": "Forbidden - The request requires the ZohoCRM.settings.unsubscribe.CREATE scope. The submission_action_type field is mandatory when submission_action_type is not provided." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.unsubscribe.CREATE" ] } ], "summary": "Create Unsubscribe Link", "tags": [ "unsubscribe_links" ], "x-zoho-document": "unsubscribe_links" }, "put": { "description": "To update one or more unsubscribe links in bulk. You can modify the link's name, page type, custom URL, standard page message, submission action type, redirect URL, or submission message.", "operationId": "putUnsubscribeLinks", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows a sample PUT request body for bulk-updating an unsubscribe link with the required `id` field.", "summary": "Sample request body for bulk-updating an unsubscribe link", "value": { "unsubscribe_links": [ { "custom_location_url": "https://www.zoho.com/crm/developer/docs/api/v8/create-unsubscribe-link.html", "id": "123456789012345678", "name": "Unsubscribe", "page_type": "standard", "standard_page_message": "standard message", "submission_action_type": "display_message", "submission_message": "display message", "submission_redirect_url": "https://www.zoho.com/crm/developer/docs/api/v8/create-unsubscribe-link.html" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateUnsubscribeLinksRequest" } } }, "description": "Request body containing the unsubscribe links to update. The id field is mandatory for each link." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful bulk update response with the action status for the updated unsubscribe link.", "summary": "Success response for status 200", "value": { "unsubscribe_links": [ { "code": "SUCCESS", "details": { "id": "111111000000115722" }, "message": "Unsubscribe Link updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinkModificationResultList" } } }, "description": "Success - Unsubscribe link updated successfully" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_action_type is missing but required for the update.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_action_type", "dependee": { "api_name": "submission_redirect_url", "json_path": "$.unsubscribe_links[0].submission_redirect_url" }, "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_action_type is required but not provided - alternate scenario.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (submission_action_type) - variant", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_action_type", "dependee": { "api_name": "submission_message", "json_path": "$.unsubscribe_links[0].submission_message" }, "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "description": "Shows a DEPENDENT_FIELD_MISSING error when custom_location_url is required by the page_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "custom_location_url", "dependee": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.custom_location_url" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "description": "Shows a DEPENDENT_FIELD_MISSING error when standard_page_message is required by the page_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "standard_page_message", "dependee": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.standard_page_message" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse5": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_redirect_url is required by the submission_action_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_redirect_url", "dependee": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.submission_redirect_url" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse6": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_message is required by the submission_action_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (submission_message)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_message", "dependee": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.submission_message" }, "message": "Dependent field is missing", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows an INVALID_DATA error when the unsubscribe_links field has invalid data.", "summary": "INVALID_DATA error: invalid data (unsubscribe_links)", "value": { "code": "INVALID_DATA", "details": { "api_name": "unsubscribe_links", "json_path": "$.unsubscribe_links", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse10": { "description": "Shows an INVALID_DATA error when the custom_location_url field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_location_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[*].custom_location_url" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an INVALID_DATA error when the custom_location_url field value is invalid.", "summary": "INVALID_DATA error: Invalid data (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_location_url", "json_path": "$.unsubscribe_links[*].custom_location_url", "maximum_length": 250 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an INVALID_DATA error when the standard_page_message field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "standard_page_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].standard_page_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows an INVALID_DATA error when the standard_page_message field value is invalid.", "summary": "INVALID_DATA error: Invalid data (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "standard_page_message", "json_path": "$.unsubscribe_links[*].standard_page_message", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an INVALID_DATA error when the submission_redirect_url field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_redirect_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[*].submission_redirect_url" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows an INVALID_DATA error when the submission_redirect_url field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_redirect_url", "json_path": "$.unsubscribe_links[*].submission_redirect_url", "maximum_length": 250 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows an INVALID_DATA error when the submission_message field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].submission_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows an INVALID_DATA error when the submission_message field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "json_path": "$.unsubscribe_links[*].submission_message", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows an INVALID_DATA error when the page_type field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (page_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].page_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an INVALID_DATA error when the page_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported page_type value - variant 1", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[0].page_type", "supported_values": [ "standard", "custom" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Shows an INVALID_DATA error when the page_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported page_type value", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type", "supported_values": [ "standard", "custom" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows an INVALID_DATA error when the submission_action_type field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type", "maximum_length": 15 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported submission_action_type value", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type", "supported_values": [ "display_message", "redirect" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Shows an INVALID_DATA error when the `id` field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (ID field)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.unsubscribe_links[*].id" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse25": { "description": "Shows an INVALID_DATA error when the `id` field value is invalid.", "summary": "INVALID_DATA error: Invalid data (ID field)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.unsubscribe_links[*].id", "maximum_length": 18 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported submission_action_type value - variant 1", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[0].submission_action_type", "supported_values": [ "display_message", "redirect" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows an INVALID_DATA error when the page_type field value is not supported - alternate pattern.", "summary": "INVALID_DATA error: unsupported page_type value - variant 2", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[0].page_type", "supported_values": [ "standard", "custom" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is not supported - alternate pattern.", "summary": "INVALID_DATA error: unsupported submission_action_type value - variant 2", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[0].submission_action_type", "supported_values": [ "display_message", "redirect" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an INVALID_DATA error when the submission_message field value is invalid.", "summary": "INVALID_DATA error: invalid data (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[0].submission_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows an INVALID_DATA error when the name field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (name)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].name" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows an INVALID_DATA error when the name field value is invalid.", "summary": "INVALID_DATA error: Invalid data (name)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[*].name", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows an INVALID_DATA error when the name field value is empty or invalid.", "summary": "INVALID_DATA error: Invalid data (name) - empty string", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[*].name", "minimum_length": 1 }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows a MANDATORY_NOT_FOUND error when the `id` field is missing from the request.", "summary": "MANDATORY_NOT_FOUND error: Required field is missing (ID)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.unsubscribe_links[*].id" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UnsubscribeLinksInvalidDataTypeError" }, { "$ref": "#/components/schemas/RequestBodyNotFoundError" }, { "$ref": "#/components/schemas/InvalidDataBodyError" }, { "$ref": "#/components/schemas/RequestBodyEmptyArray" }, { "additionalProperties": false, "description": "Wrapped error response containing an array of individual unsubscribe link validation errors for the bulk PUT request.", "properties": { "unsubscribe_links": { "description": "Represents the list of individual error objects for each unsubscribe link in the bulk update request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/UnsupportedPageTypeError" }, { "$ref": "#/components/schemas/InvalidUnsubscribeLinkIdInBody" }, { "$ref": "#/components/schemas/NotAllowedOperationError" }, { "$ref": "#/components/schemas/UnsubscribeLinksDuplicateDataError" }, { "$ref": "#/components/schemas/UnsubscribeLinksDependentFieldMissingError" }, { "$ref": "#/components/schemas/InvalidCustomLocationURLError" }, { "$ref": "#/components/schemas/GeneralInvalidDataError" }, { "$ref": "#/components/schemas/GenericInvalidDataError" }, { "$ref": "#/components/schemas/InvalidDataValueErrorAlt" }, { "$ref": "#/components/schemas/InvalidDataErrorType" }, { "$ref": "#/components/schemas/RequiredFieldDependencyError" }, { "$ref": "#/components/schemas/UnsubscribeLinksMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/InvalidDataTypeMismatchError" } ], "description": "Represents an individual error object for a specific unsubscribe link in the bulk update request." }, "maxItems": 25, "type": "array" } }, "required": [ "unsubscribe_links" ], "type": "object", "x-zs-$id": "UpdateInvalidRequestBodyErrors" } ], "description": "Validation error response for the PUT request, covering invalid data type, missing required fields, empty array, and dependent field failures.", "x-zs-$id": "UpdateInvalidRequestErrors" } } }, "description": "Bad Request - Invalid data provided. Check field types, dependencies, or refer to the Input JSON keys section in the help doc." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.unsubscribe.UPDATE" ] } ], "summary": "Update Unsubscribe Links", "tags": [ "unsubscribe_links" ], "x-zoho-document": "unsubscribe_links" } }, "/crm/v8/settings/unsubscribe_links/{id}": { "delete": { "description": "To delete a specific unsubscribe link. Note that the default unsubscribe link cannot be deleted.", "operationId": "deleteUnsubscribeLinksById", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful delete operation with the action status for the specified unsubscribe link ID.", "summary": "Success response for status 200", "value": { "unsubscribe_links": [ { "code": "SUCCESS", "details": { "id": "111111000000116037" }, "message": "Unsubscribe Link deleted successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinkRemovalResultList" } } }, "description": "Success - Unsubscribe link deleted successfully" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows an INVALID_DATA error when the given unsubscribe link ID does not belong to the organization.", "summary": "INVALID_DATA error: The given Unsubscribe Link ID is not part of Org", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The given Unsubscribe Link id is not part of Org", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/NotAllowedUnsubscribeLinkIdError" }, { "$ref": "#/components/schemas/InvalidUnsubscribeLinkIdError" } ], "description": "Validation error response for the DELETE by ID request, covering invalid or not-allowed unsubscribe link IDs.", "x-zs-$id": "DeleteUnsubscribeLinkByIdInvalidRequestErrors" } } }, "description": "Bad Request - The unsubscribe link ID is invalid or you are trying to delete the default unsubscribe link, which is not allowed." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows a NO_PERMISSION error when the user does not have the required delete permission.", "summary": "NO_PERMISSION error: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Unsubscribe_Form" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinksPermissionDeniedError" } } }, "description": "Forbidden - The request requires the ZohoCRM.settings.unsubscribe.DELETE scope. You cannot delete the default unsubscribe link." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.unsubscribe.DELETE" ] } ], "summary": "Delete Unsubscribe Link by ID", "tags": [ "unsubscribe_links" ], "x-zoho-document": "unsubscribe_links" }, "get": { "description": "To retrieve the complete configuration details of a specific unsubscribe link using its ID. This includes page settings, submission behavior, timestamps, and creator information.", "operationId": "getUnsubscribeLinkById", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response with the full configuration details of the specified unsubscribe link.", "summary": "Success response for status 200", "value": { "unsubscribe_links": [ { "created_by": { "id": "111111000000057843", "name": "Kk" }, "created_time": "2025-11-19T17:26:43+05:30", "custom_location_url": null, "id": "111111000000115722", "modified_by": { "id": "111111000000057843", "name": "Kk" }, "modified_time": "2025-11-19T17:26:43+05:30", "name": "Unsubscribe", "page_type": "standard", "standard_page_message": "standard message", "submission_action_type": "display_message", "submission_message": "display message", "submission_redirect_url": null } ] } } }, "schema": { "$ref": "#/components/schemas/RetrieveUnsubscribeLinksResponse" } } }, "description": "Success - Returns the full configuration of the specified unsubscribe link" }, "204": { "description": "No Content - No unsubscribe link found with the specified ID" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows a NO_PERMISSION error when the user does not have the required read permission.", "summary": "NO_PERMISSION error: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Unsubscribe_Form" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinksPermissionDeniedError" } } }, "description": "Forbidden - The request requires the ZohoCRM.settings.unsubscribe.READ scope" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.unsubscribe.READ" ] } ], "summary": "Get Unsubscribe Link by ID", "tags": [ "unsubscribe_links" ], "x-zoho-document": "unsubscribe_links" }, "parameters": [ { "description": "The unique ID of the unsubscribe link to retrieve, update, or delete. This ID is returned in the response when creating or fetching unsubscribe links.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "put": { "description": "To update a specific unsubscribe link. You can modify the link's name, page type, custom URL, standard page message, submission action type, redirect URL, or submission message.", "operationId": "putUnsubscribeLinksById", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Shows a sample PUT request body for updating an unsubscribe link by ID with the required `id` field.", "summary": "Sample request body for updating an unsubscribe link by ID", "value": { "unsubscribe_links": [ { "custom_location_url": "https://www.zoho.com/crm/developer/docs/api/v8/create-unsubscribe-link.html", "id": "123456789012345678", "name": "Unsubscribe", "page_type": "standard", "standard_page_message": "standard message", "submission_action_type": "display_message", "submission_message": "display message", "submission_redirect_url": "https://www.zoho.com/crm/developer/docs/api/v8/create-unsubscribe-link.html" } ] } } }, "schema": { "$ref": "#/components/schemas/UnsubscribeLinkModificationByIdRequest" } } }, "description": "Request body containing the unsubscribe link configuration to update. The id field is mandatory to identify which link to update." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful update-by-ID response with the action status for the updated unsubscribe link.", "summary": "Success response for status 200", "value": { "unsubscribe_links": [ { "code": "SUCCESS", "details": { "id": "111111000000115722" }, "message": "Unsubscribe Link updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UpdateUnsubscribeLinksSuccessResponse" } } }, "description": "Success - Unsubscribe link updated successfully" }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingResponse1": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_action_type is missing but required for the update.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_action_type", "dependee": { "api_name": "submission_redirect_url", "json_path": "$.unsubscribe_links[0].submission_redirect_url" }, "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse2": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_action_type is required but not provided - alternate scenario.", "summary": "DEPENDENT_FIELD_MISSING error: required field not found (submission_action_type) - variant", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_action_type", "dependee": { "api_name": "submission_message", "json_path": "$.unsubscribe_links[0].submission_message" }, "json_path": "$.unsubscribe_links[0].submission_action_type" }, "message": "required field not found", "status": "error" } ] } }, "DependentFieldMissingResponse3": { "description": "Shows a DEPENDENT_FIELD_MISSING error when custom_location_url is required by the page_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "custom_location_url", "dependee": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.custom_location_url" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse4": { "description": "Shows a DEPENDENT_FIELD_MISSING error when standard_page_message is required by the page_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "standard_page_message", "dependee": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.standard_page_message" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse5": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_redirect_url is required by the submission_action_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_redirect_url", "dependee": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.submission_redirect_url" }, "message": "Dependent field is missing", "status": "error" } ] } }, "DependentFieldMissingResponse6": { "description": "Shows a DEPENDENT_FIELD_MISSING error when submission_message is required by the submission_action_type but is missing.", "summary": "DEPENDENT_FIELD_MISSING error: Dependent field is missing (submission_message)", "value": { "unsubscribe_links": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "submission_message", "dependee": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "json_path": "$.unsubscribe_links[*].unsubscribe_links.submission_message" }, "message": "Dependent field is missing", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Shows an INVALID_DATA error when the unsubscribe_links field has invalid data.", "summary": "INVALID_DATA error: invalid data (unsubscribe_links)", "value": { "code": "INVALID_DATA", "details": { "api_name": "unsubscribe_links", "json_path": "$.unsubscribe_links", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse10": { "description": "Shows an INVALID_DATA error when the custom_location_url field value is invalid.", "summary": "INVALID_DATA error: Invalid data (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_location_url", "json_path": "$.unsubscribe_links[*].custom_location_url", "maximum_length": 250 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Shows an INVALID_DATA error when the standard_page_message field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "standard_page_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].standard_page_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Shows an INVALID_DATA error when the standard_page_message field value is invalid.", "summary": "INVALID_DATA error: Invalid data (standard_page_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "standard_page_message", "json_path": "$.unsubscribe_links[*].standard_page_message", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse13": { "description": "Shows an INVALID_DATA error when the submission_redirect_url field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_redirect_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[*].submission_redirect_url" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "description": "Shows an INVALID_DATA error when the submission_redirect_url field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_redirect_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_redirect_url", "json_path": "$.unsubscribe_links[*].submission_redirect_url", "maximum_length": 250 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "description": "Shows an INVALID_DATA error when the submission_message field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].submission_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse16": { "description": "Shows an INVALID_DATA error when the submission_message field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "json_path": "$.unsubscribe_links[*].submission_message", "maximum_length": 2000 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse17": { "description": "Shows an INVALID_DATA error when the page_type field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (page_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].page_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "description": "Shows an INVALID_DATA error when the page_type field value is invalid.", "summary": "INVALID_DATA error: Invalid data (page_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type", "maximum_length": 8 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse19": { "description": "Shows an INVALID_DATA error when the page_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported page_type value", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[*].page_type", "supported_values": [ "standard", "custom" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Shows an INVALID_DATA error when the page_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported page_type value - variant 1", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[0].page_type", "supported_values": [ "standard", "custom" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse20": { "description": "Shows an INVALID_DATA error when the submission_action_type field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].submission_action_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse21": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is invalid.", "summary": "INVALID_DATA error: Invalid data (submission_action_type)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type", "maximum_length": 15 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse22": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported submission_action_type value", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[*].submission_action_type", "supported_values": [ "display_message", "redirect" ] }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "description": "Shows an INVALID_DATA error when the `id` field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (ID field)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.unsubscribe_links[*].id" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse24": { "description": "Shows an INVALID_DATA error when the `id` field value is invalid.", "summary": "INVALID_DATA error: Invalid data (ID field)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.unsubscribe_links[*].id", "maximum_length": 18 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is not a supported option.", "summary": "INVALID_DATA error: unsupported submission_action_type value - variant 1", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[0].submission_action_type", "supported_values": [ "display_message", "redirect" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Shows an INVALID_DATA error when the page_type field value is not supported - alternate pattern.", "summary": "INVALID_DATA error: unsupported page_type value - variant 2", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "page_type", "json_path": "$.unsubscribe_links[0].page_type", "supported_values": [ "standard", "custom" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Shows an INVALID_DATA error when the submission_action_type field value is not supported - alternate pattern.", "summary": "INVALID_DATA error: unsupported submission_action_type value - variant 2", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_action_type", "json_path": "$.unsubscribe_links[0].submission_action_type", "supported_values": [ "display_message", "redirect" ] }, "message": "the given module is not supported in create or update", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Shows an INVALID_DATA error when the submission_message field value is invalid.", "summary": "INVALID_DATA error: invalid data (submission_message)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "submission_message", "expected_data_type": "text", "json_path": "$.unsubscribe_links[0].submission_message" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Shows an INVALID_DATA error when the name field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (name)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.unsubscribe_links[*].name" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Shows an INVALID_DATA error when the name field value is invalid.", "summary": "INVALID_DATA error: Invalid data (name)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.unsubscribe_links[*].name", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Shows an INVALID_DATA error when the custom_location_url field has an invalid data type.", "summary": "INVALID_DATA error: Invalid data type (custom_location_url)", "value": { "unsubscribe_links": [ { "code": "INVALID_DATA", "details": { "api_name": "custom_location_url", "expected_data_type": "website", "json_path": "$.unsubscribe_links[*].custom_location_url" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Shows a MANDATORY_NOT_FOUND error when the `id` field is missing from the request body.", "summary": "MANDATORY_NOT_FOUND error: Required field is missing (ID)", "value": { "unsubscribe_links": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.unsubscribe_links[*].id" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UnsubscribeLinksInvalidDataTypeError" }, { "$ref": "#/components/schemas/RequestBodyEmptyArray" }, { "$ref": "#/components/schemas/RequestBodyNotFoundError" }, { "$ref": "#/components/schemas/NotAllowedUnsubscribeLinkIdError" }, { "$ref": "#/components/schemas/InvalidUnsubscribeLinkIdError" }, { "additionalProperties": false, "description": "Wrapped error response containing an array of individual unsubscribe link validation errors for the PUT by ID request.", "properties": { "unsubscribe_links": { "description": "Represents the list of individual error objects for the unsubscribe link in the update-by-ID request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/UnsupportedPageTypeError" }, { "$ref": "#/components/schemas/UnsubscribeLinksDuplicateDataError" }, { "$ref": "#/components/schemas/UnsubscribeLinksDependentFieldMissingError" }, { "$ref": "#/components/schemas/InvalidCustomLocationURLError" }, { "$ref": "#/components/schemas/GeneralInvalidDataError" }, { "$ref": "#/components/schemas/GenericInvalidDataError" }, { "$ref": "#/components/schemas/InvalidDataErrorType" }, { "$ref": "#/components/schemas/RequiredFieldDependencyError" }, { "$ref": "#/components/schemas/UnsubscribeLinksMandatoryFieldMissingError" } ], "description": "Represents an individual error object for the unsubscribe link in the update-by-ID request." }, "maxItems": 25, "type": "array" } }, "required": [ "unsubscribe_links" ], "type": "object", "x-zs-$id": "UpdatedInvalidRequestBodyErrors" } ], "description": "Validation error response for the PUT by ID request, covering invalid data type, empty array, missing required fields, and not-allowed or invalid ID errors.", "x-zs-$id": "UpdatedInvalidRequestErrors" } } }, "description": "Bad Request - Invalid data provided or the unsubscribe link ID is not part of your organization. Check field types, dependencies, or refer to the Input JSON keys section in the help doc." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.unsubscribe.UPDATE" ] } ], "summary": "Update Unsubscribe Link by ID", "tags": [ "unsubscribe_links" ], "x-zoho-document": "unsubscribe_links" } }, "/crm/v8/settings/user_groups": { "get": { "description": "To retrieve a paginated list of user groups configured in your Zoho CRM organization, with optional filtering by name or criteria, and optional inclusion of member source counts.", "operationId": "getUserGroups", "parameters": [ { "$ref": "#/components/parameters/UserGroupsFilters" }, { "$ref": "#/components/parameters/UserGroupsInclude" }, { "$ref": "#/components/parameters/UserGroupsIds" }, { "$ref": "#/components/parameters/UserGroupsName" }, { "$ref": "#/components/parameters/UserGroupsPage" }, { "$ref": "#/components/parameters/UserGroupsPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a paginated response containing two user groups with their ID, name, description, creation and modification metadata, and pagination info.", "summary": "Successful response with user groups", "value": { "info": { "count": 2, "more_records": false, "page": 1, "per_page": 200 }, "user_groups": [ { "created_by": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "created_time": "2022-11-21T12:33:12+05:30", "description": "groups API", "id": "3652397000009949005", "modified_by": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "modified_time": "2022-11-21T13:21:46+05:30", "name": "group 1", "sources_count": { "groups": 1, "roles": 2, "territories": 1, "users": 2 } }, { "created_by": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "created_time": "2023-12-01T10:00:00Z", "description": null, "id": "3652397000009952001", "modified_by": null, "modified_time": null, "name": "group test", "sources_count": { "roles": 2 } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response for retrieving the list of user groups in the Zoho CRM organization, containing a paginated array of user group objects and pagination metadata.", "properties": { "info": { "additionalProperties": false, "description": "Represents the pagination metadata for the current page of results. ", "properties": { "count": { "description": "Represents the number of user group records returned in the current page. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional pages of user group records are available beyond the current page. \nPossible values:\n**true** - More records are available on subsequent pages.\n**false** - No more records remain after the current page.", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the number of user group records returned per page. ", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "user_groups": { "description": "Represents the list of user group objects returned for the current page. ", "items": { "additionalProperties": false, "description": "Represents a single user group configured in the Zoho CRM organization, including its name, description, member sources, and creation and modification metadata.", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the CRM user who created this user group. ", "properties": { "id": { "description": "Represents the unique ID of the CRM user who created the user group. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the CRM user who created the user group. ", "maxLength": 512, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the date and time of user group creation, in ISO 8601 format. ", "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "description": "Represents the text description of the user group.", "maxLength": 250, "type": "string", "x-zs-$id": "GroupDescriptionText" }, { "description": "Indicates that no description was provided for this user group.", "type": "null", "x-zs-$id": "NoDescriptionProvided" } ], "description": "Represents the description of the user group, or null if no description was provided. " }, "id": { "description": "Represents the unique ID of the user group. ", "maxLength": 19, "type": "string", "x-zs-$id": "UserGroupId" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "Represents the CRM user who last modified the user group, containing the user ID and display name.", "properties": { "id": { "description": "Represents the unique ID of the CRM user who last modified the user group. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the CRM user who last modified the user group. ", "maxLength": 512, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ModifiedBy" }, { "description": "Indicates that the user group has not been modified since its creation.", "type": "null", "x-zs-$id": "NoModifierInfo" } ], "description": "Represents the CRM user who last modified this user group, or null if the group has not been modified since creation. " }, "modified_time": { "anyOf": [ { "description": "Represents the date and time of the most recent modification to the user group, in ISO 8601 format.", "format": "date-time", "type": "string", "x-zs-$id": "ModificationTimestamp" }, { "description": "Indicates that the user group has not been modified since its creation.", "type": "null", "x-zs-$id": "NoModificationTimestamp" } ], "description": "Represents the date and time at which the user group was last modified, in ISO 8601 format, or null if the group has not been modified since creation. " }, "name": { "description": "Represents the name of the user group. ", "maxLength": 250, "type": "string", "x-zs-$id": "UserGroupName" }, "sources_count": { "additionalProperties": false, "description": "Represents the count of member sources for the user group, categorized by source type. Returned when the **include** parameter is set to **sources_count**.", "properties": { "groups": { "description": "Represents the number of other user groups configured as member sources of this group.", "format": "int32", "type": "integer" }, "roles": { "description": "Represents the number of CRM roles configured as member sources of this group.", "format": "int32", "type": "integer" }, "territories": { "description": "Represents the number of CRM territories configured as member sources of this group.", "format": "int32", "type": "integer" }, "users": { "description": "Represents the count of CRM users configured as member sources of this group, categorized by user status.", "format": "int32", "type": "integer" } }, "type": "object" } }, "required": [ "created_by", "modified_by", "modified_time", "created_time", "description", "id", "name" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "user_groups", "info" ], "type": "object", "x-zs-$id": "UserGroupsResponse" } } }, "description": "Returns a paginated list of user groups configured in your Zoho CRM organization." }, "204": { "description": "No user groups have been created for this Zoho CRM organization." }, "400": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response when the filters parameter value is not a valid JSON string.", "summary": "Invalid filters parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "filters" }, "message": "The given filters is not a valid json", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when a request parameter contains invalid data.", "properties": { "code": { "description": "Represents the error code for the request validation failure. \nPossible values:\n**INVALID_DATA** - One or more request parameters contain invalid data.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the validation error, including the name of the parameter that caused the failure. ", "properties": { "param_name": { "description": "Represents the name of the request parameter that contains invalid data. ", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request outcome. \nPossible values:\n**error** - The request failed due to a validation error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupsInvalidDataError" } } }, "description": "The filters parameter contains invalid data. **Resolution:** Provide a valid filter expression in the **filters** parameter." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response when the authenticated user does not have the required CRM permission to access user groups.", "summary": "User does not have permission to access groups", "value": { "code": "NO_PERMISSION", "details": { "permissions": "Crm_Implied_Manage_Groups" }, "message": "You do not have permission to access user groups", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the authenticated user lacks the required CRM permission to access user groups.", "properties": { "code": { "description": "Represents the error code for the authorization failure. \nPossible values:\n**NO_PERMISSION** - The authenticated user does not have permission to access user groups.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the authorization failure, including the missing permissions. ", "properties": { "permissions": { "description": "Represents the name of the CRM permission that the authenticated user lacks to access user groups. ", "maxLength": 100, "type": "string" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the authorization failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request outcome. \nPossible values:\n**error** - The request failed due to an authorization error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupsPermissionError" } } }, "description": "The authenticated user does not have permission to access user groups. **Resolution:** Grant the **Crm_Implied_Manage_Groups** permission in the CRM profile settings." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.READ" ] } ], "summary": "Get user groups", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" }, "post": { "description": "To create a new user group in your Zoho CRM organization with a specified name, optional description, and member sources (users, roles, or territories).", "operationId": "createGroup", "requestBody": { "content": { "application/json": { "examples": { "CreateGroupExample": { "description": "Shows a request body for creating a user group named \"Sample Group\" with a role source (including subordinates) and a territory source (including sub-territories).", "summary": "Create a user group with role and territory sources", "value": { "user_groups": [ { "description": "Sales department user group", "name": "Sales Team", "sources": [ { "source": { "id": "3652397000000186017" }, "type": "users" }, { "source": { "id": "3652397000000026008" }, "subordinates": true, "type": "roles" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body schema for creating a user group.", "properties": { "user_groups": { "description": "Specify an array containing up to 10 user group objects to create.", "items": { "additionalProperties": false, "description": "Specify the details of the user group to create, including its name, optional description, and member sources.", "properties": { "description": { "anyOf": [ { "description": "Specify the text description for the user group.", "maxLength": 250, "type": "string", "x-zs-$id": "UserGroupDescriptionText" }, { "description": "Use null to indicate no description.", "type": "null", "x-zs-$id": "NoDescriptionProvidedForCreateUserGroup" } ], "description": "Specify an optional text description for the user group." }, "name": { "description": "Specify the name of the user group.", "maxLength": 250, "type": "string" }, "sources": { "description": "Specify the array of member sources for the user group.", "items": { "additionalProperties": false, "description": "Specify one member source entry for the user group, including the source type, the source identifier, and optional flags for subordinates or sub-territories.", "properties": { "source": { "additionalProperties": false, "description": "Specify the identifier of the source to add to the user group.", "properties": { "id": { "description": "Specify the unique ID of the user, role, or territory to add as a member source.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "sub_territories": { "anyOf": [ { "description": "Specify true to include members from sub-territories, or false to exclude them.", "type": "boolean", "x-zs-$id": "BooleanFlagToIncludeTerritories" }, { "description": "Use null to omit the sub-territories flag.", "type": "null", "x-zs-$id": "ToNoSubTerritoriesFlagProvided" } ], "description": "Specify whether to include members from sub-territories when the source type is **territories**.\nPossible values:\n**true** - Include members from sub-territories.\n**false** - Do not include members from sub-territories." }, "subordinates": { "anyOf": [ { "description": "Specify true to include users in subordinate roles, or false to exclude them.", "type": "boolean", "x-zs-$id": "BooleanFlagToIncludeSubordinates" }, { "description": "Use null to omit the subordinates flag.", "type": "null", "x-zs-$id": "NoSubordinatesFlagProvided" } ], "description": "Specify whether to include users in subordinate roles when the source type is **roles**.\nPossible values:\n**true** - Include users in subordinate roles.\n**false** - Do not include users in subordinate roles." }, "type": { "description": "Specify the type of the member source being added to the user group.\nPossible values:\n**territories** - Add a CRM territory as a member source.\n**roles** - Add a CRM role as a member source.\n**users** - Add individual CRM users as a member source.", "enum": [ "territories", "roles", "users" ], "type": "string" } }, "required": [ "type", "source" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "name", "sources" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "user_groups" ], "type": "object" } } }, "description": "Provide the user group details including the name, optional description, and member sources (users, roles, or territories).", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessWithId": { "description": "Shows the success response for a user group creation, returning the new group ID and a SUCCESS code.", "summary": "User group created successfully", "value": { "user_groups": [ { "code": "SUCCESS", "details": { "id": "3652397000009949005" }, "message": "User group created successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema for a successful user group creation.", "properties": { "user_groups": { "description": "Represents the array containing the result of the user group creation operation. ", "items": { "additionalProperties": false, "description": "Represents the creation result for the user group, including the status, result code, message, and the ID of the newly created group.", "properties": { "code": { "description": "Represents the result code for the user group creation operation. \nPossible values:\n**SUCCESS** - The user group creation succeeded.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the created user group. ", "properties": { "id": { "description": "Represents the unique ID of the newly created user group. ", "maxLength": 19, "type": "string", "x-zs-$id": "UserGroupResultId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for the user group creation operation. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the user group creation operation. \nPossible values:\n**success** - The user group creation succeeded.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "user_groups" ], "type": "object", "x-zs-$id": "ResponseForUserGroupCreation" } } }, "description": "User group created successfully. Returns the new group ID and a success status." }, "400": { "content": { "application/json": { "examples": { "CreateGroupError": { "description": "Shows the error response when the request body is invalid, such as a missing required field or a duplicate group name.", "summary": "Invalid request body for group creation", "value": { "user_groups": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.user_groups[0].name" }, "message": "A user group with the same name already exists.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema for a failed user group creation.", "properties": { "user_groups": { "description": "Represents the array containing the error details for the failed user group creation operation. ", "items": { "additionalProperties": false, "description": "Represents the error details for a user group creation failure, including the error code, message, status, and field-level details.", "properties": { "code": { "description": "Represents the error code for the user group creation failure. \nPossible values:\n**DUPLICATE_DATA** - A user group with the same name already exists.\n**INVALID_DATA** - One or more field values are invalid.\n**MANDATORY_NOT_FOUND** - A required field is missing from the request.", "enum": [ "DUPLICATE_DATA", "INVALID_DATA", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the creation error, including the API name and JSON path of the problematic field. ", "properties": { "api_name": { "description": "Represents the API name of the field that caused the creation error. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that caused the creation error. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the user group creation failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the user group creation operation. \nPossible values:\n**error** - The user group creation failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "user_groups" ], "type": "object", "x-zs-$id": "UserGroupCreationFailures" } } }, "description": "The user group could not be created. **Resolution:** Check that the **name** field is provided and unique, all required fields are present, and source IDs are valid." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.CREATE" ] } ], "summary": "Create a user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" } }, "/crm/v8/settings/user_groups/actions/associated_users_count": { "get": { "description": "To retrieve the count of users associated with user groups in your Zoho CRM organization, optionally filtered by group criteria.", "operationId": "getUserGroupAssociatedUsersCount", "parameters": [ { "$ref": "#/components/parameters/UserGroupsFilters" }, { "$ref": "#/components/parameters/UserGroupsPage" }, { "$ref": "#/components/parameters/UserGroupsPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a list of user groups with the count of users associated with each, including pagination information.", "summary": "Successful response with associated user counts", "value": { "associated_users_count": [ { "count": 2, "user_group": { "id": "4413474000003538005", "name": "Sales Team Updated" } }, { "count": 2, "user_group": { "id": "4413474000003538020", "name": "Sales Team 1766826714258" } } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "additionalProperties": false, "description": "Response schema containing the paginated associated user counts per user group.", "properties": { "associated_users_count": { "description": "Represents the array of user group entries with their associated user counts. ", "items": { "additionalProperties": false, "description": "Represents a user group and the count of users associated with it based on the provided filter criteria.", "properties": { "count": { "description": "Represents the number of users associated with this user group. ", "format": "int32", "type": "integer" }, "user_group": { "additionalProperties": false, "description": "Represents the user group details for this entry. ", "properties": { "id": { "description": "Represents the unique ID of the user group. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the user group. ", "maxLength": 512, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "user_group", "count" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents pagination information for the response. ", "properties": { "count": { "description": "Represents the total number of user group entries returned in the current response. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional user group entries are available beyond the current page. ", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the maximum number of user group entries returned per page. ", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "associated_users_count", "info" ], "type": "object", "x-zs-$id": "GetAssociatedUsersCountResponse" } } }, "description": "Returns a paginated list of user groups with the count of users associated with each group." }, "204": { "description": "No user groups match the provided filter criteria." }, "404": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the request URL does not match any configured API endpoint pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid URL pattern error.", "properties": { "code": { "description": "Represents the error code for the URL pattern failure. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any configured API endpoint.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the URL pattern error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request URL pattern was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidURLPatternAssoUserCount" } } }, "description": "The request URL does not match any configured endpoint pattern. **Resolution:** Verify the URL follows the pattern /settings/user_groups/actions/associated_users_count." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.READ" ] } ], "summary": "Get associated users count per user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" } }, "/crm/v8/settings/user_groups/actions/get_assigned": {}, "/crm/v8/settings/user_groups/actions/get_unassigned": {}, "/crm/v8/settings/user_groups/{group}": { "delete": { "description": "To delete an existing user group from your Zoho CRM organization. The deletion may be immediate or scheduled for background processing, depending on group size and active references.", "operationId": "deleteGroup", "parameters": [ { "$ref": "#/components/parameters/Group" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ScheduledWithJobId": { "description": "Shows the response when a user group deletion is queued for background processing, returning a job ID for tracking.", "summary": "Deletion scheduled with job ID", "value": { "user_groups": [ { "code": "SCHEDULED", "details": { "job_id": "3652397000009950001" }, "message": "User group deletion has been scheduled", "status": "scheduled" } ] } }, "SuccessWithId": { "description": "Shows the response for an immediate user group deletion, returning the deleted group ID and a SUCCESS code.", "summary": "User group deleted immediately", "value": { "user_groups": [ { "code": "SUCCESS", "details": { "id": "3652397000009949005" }, "message": "User group deleted successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema for a successful user group deletion or scheduled deletion.", "properties": { "user_groups": { "description": "Represents the array containing the result of the user group deletion operation. ", "items": { "additionalProperties": false, "description": "Represents the deletion result for the user group, indicating whether it completes immediately or queues for background processing.", "properties": { "code": { "description": "Represents the result code for the user group deletion operation. \nPossible values:\n**SUCCESS** - The user group deletion completes immediately.\n**SCHEDULED** - The user group deletion queues for background processing; the response includes a **job ID**.", "enum": [ "SUCCESS", "SCHEDULED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Present when deletion completes immediately. Contains the deleted group ID.", "properties": { "id": { "description": "Represents the unique ID of the user group for which deletion completes immediately. Present in immediate-deletion responses.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "DetailsContainingTheDeletedGroupId" }, { "additionalProperties": false, "description": "Present when the deletion was queued for background processing. Contains the scheduled job ID.", "properties": { "job_id": { "description": "Represents the ID of the scheduled deletion job. Present when the deletion is queued for background processing.", "maxLength": 19, "type": "string" } }, "required": [ "job_id" ], "type": "object", "x-zs-$id": "DetailsContainingTheScheduledJobID" } ], "description": "Represents additional details about the deletion result, containing either the deleted group ID or a scheduled job ID. " }, "message": { "description": "Represents the result message for the user group deletion operation. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the user group deletion operation. \nPossible values:\n**success** - The user group deletion completes immediately.\n**scheduled** - The user group deletion queues for background processing.", "enum": [ "success", "scheduled" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "user_groups" ], "type": "object", "x-zs-$id": "UserGroupDeletionFailure" } } }, "description": "User group deletion completed. Returns a success code with the group ID if deleted immediately, or a scheduled status with a job ID if queued for processing." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the group ID in the URL does not match an existing user group.", "summary": "Invalid group ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The provided group ID is invalid.", "status": "error" } }, "MissingGroupId": { "description": "Shows the error response when no group ID is provided in the request URL.", "summary": "Missing group ID in request URL", "value": { "user_groups": [ { "code": "MANDATORY_NOT_FOUND", "details": { "param_name": "ids" }, "message": "Group ID missing in URL", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Indicates that the group ID in the URL is invalid or does not reference an existing user group.", "properties": { "code": { "description": "Represents the error code for the request failure. \nPossible values:\n**INVALID_DATA** - The group ID in the URL is invalid or does not reference an existing user group.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the request error. ", "properties": { "resource_path_index": { "description": "Represents the index of the path segment where the invalid resource ID was found. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the request failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the operation. \nPossible values:\n**error** - The request failed because the group ID is invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteGroupInvalidIdError" }, { "additionalProperties": false, "description": "Indicates that the group ID is absent from the URL.", "properties": { "user_groups": { "description": "Represents the array containing the error details for the failed deletion operation. ", "items": { "additionalProperties": false, "description": "Represents the error details for a user group deletion failure due to a missing group ID in the URL.", "properties": { "code": { "description": "Represents the error code for the deletion failure. \nPossible values:\n**MANDATORY_NOT_FOUND** - The group ID is missing from the request URL.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the deletion error, including the name of the missing parameter. ", "properties": { "param_name": { "description": "Represents the name of the missing request parameter. ", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the deletion failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the deletion operation. \nPossible values:\n**error** - The user group deletion failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "user_groups" ], "type": "object", "x-zs-$id": "DeleteGroupMissingIdError" } ], "description": "Response schema for a failed user group deletion, covering both invalid group ID and missing group ID errors.", "x-zs-$id": "ErrorResponseForGroupsPermission" } } }, "description": "The request failed due to an invalid or missing group ID. **Resolution:** Provide a valid numeric user group ID in the **group** path parameter." }, "404": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the request URL does not match any configured API endpoint pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid URL pattern error.", "properties": { "code": { "description": "Represents the error code for the URL pattern failure. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any configured API endpoint.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the URL pattern error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request URL pattern was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidURLPatternErrorSingleDelete" } } }, "description": "The request URL does not match any configured endpoint pattern. **Resolution:** Verify the request URL follows the pattern /settings/user_groups/{group}." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.DELETE" ] } ], "summary": "Delete a user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" }, "get": { "description": "To retrieve the details of a specific user group in your Zoho CRM organization by its unique ID, with optional inclusion of member source counts.", "operationId": "getGroup", "parameters": [ { "$ref": "#/components/parameters/Group" }, { "$ref": "#/components/parameters/UserGroupsInclude" }, { "$ref": "#/components/parameters/UserGroupsFilters" }, { "$ref": "#/components/parameters/UserGroupsIds" }, { "$ref": "#/components/parameters/UserGroupsName" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the details of a specific user group, including its name, description, creation and modification metadata, and member source counts.", "summary": "Successful response with the user group details", "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 }, "user_groups": [ { "created_by": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "created_time": "2022-11-21T12:33:12+05:30", "description": "groups API", "id": "3652397000009949005", "modified_by": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "modified_time": "2022-11-21T13:21:46+05:30", "name": "group 1", "sources_count": { "groups": 1, "roles": 2, "territories": 1, "users": 3 } } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema containing the details of the specified user group.", "properties": { "info": { "additionalProperties": false, "description": "Represents pagination information for the response. ", "properties": { "count": { "description": "Represents the total number of user groups returned in the current response. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional user group records are available beyond the current page. ", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the maximum number of user group records returned per page. ", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "user_groups": { "description": "Represents an array containing the details of the specified user group. ", "items": { "additionalProperties": false, "description": "Represents the details of a user group, including its name, description, creation and modification metadata, and optional member source counts.", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the user who created this user group. ", "properties": { "id": { "description": "Represents the unique ID of the user who created this group. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the user who created this group. ", "maxLength": 512, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the date and time of user group creation, in ISO 8601 format. ", "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "description": "Represents the text description of the user group.", "maxLength": 250, "type": "string", "x-zs-$id": "GroupDescription" }, { "description": "Indicates that no description was provided for the user group.", "type": "null", "x-zs-$id": "NoGroupDescription" } ], "description": "Represents the text description of the user group. Present in the response when a description was provided during group creation." }, "id": { "description": "Represents the unique identifier of the user group. ", "maxLength": 19, "type": "string", "x-zs-$id": "GroupId" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "Represents the user who last modified this group, with their ID and name.", "properties": { "id": { "description": "Represents the unique ID of the user who last modified this group. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the user who last modified this group. ", "maxLength": 512, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ModifierUserInformation" }, { "description": "Indicates that this group has not been modified since creation.", "type": "null", "x-zs-$id": "NoModifierInformationAvailable" } ], "description": "Represents the user who last modified this user group. " }, "modified_time": { "anyOf": [ { "description": "Represents the timestamp of the last modification in ISO 8601 format.", "format": "date-time", "type": "string", "x-zs-$id": "LastModificationTimestamp" }, { "description": "Indicates that the group has not been modified since creation.", "type": "null", "x-zs-$id": "NoModificationTimeAvailable" } ], "description": "Represents the date and time when the user group was last modified. " }, "name": { "description": "Represents the name of the user group. ", "maxLength": 250, "type": "string" }, "sources_count": { "additionalProperties": false, "description": "Represents the count of member sources by type for this user group. Present when the **include** query parameter includes **sources_count**.", "properties": { "groups": { "description": "Represents the number of group sources in this user group. Present when **sources_count** is included.", "format": "int32", "type": "integer" }, "roles": { "description": "Represents the number of role sources in this user group. Present when **sources_count** is included.", "format": "int32", "type": "integer" }, "territories": { "description": "Represents the number of territory sources in this user group. Present when **sources_count** is included.", "format": "int32", "type": "integer" }, "users": { "description": "Represents the count of individual user sources in this group, broken down by user status. Present when **sources_count** is included.", "format": "int32", "type": "integer" } }, "type": "object" } }, "required": [ "created_by", "modified_by", "modified_time", "created_time", "description", "id", "name" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "user_groups" ], "type": "object", "x-zs-$id": "UserGroupSuccessResponse" } } }, "description": "Returns the details of the specified user group, including name, description, creation and modification metadata, and optional source counts." }, "204": { "description": "The specified user group was not found or has no data to return." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the group ID in the URL does not match an existing user group.", "summary": "Invalid group ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid group ID error.", "properties": { "code": { "description": "Represents the error code for the request failure. \nPossible values:\n**INVALID_DATA** - The group ID in the URL is invalid or does not reference an existing user group.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the request error. ", "properties": { "resource_path_index": { "description": "Represents the index of the path segment where the invalid resource ID was found. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the request failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request operation. \nPossible values:\n**error** - The request failed due to an invalid group ID.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupPermissionIssue" } } }, "description": "The group ID in the URL is invalid. **Resolution:** Provide a valid numeric user group ID in the **group** path parameter." }, "404": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the request URL does not match any configured API endpoint pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid URL pattern error.", "properties": { "code": { "description": "Represents the error code for the URL pattern failure. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any configured API endpoint.\n**URL_RULE_NOT_CONFIGURED** - The URL routing rule for this endpoint is not configured.", "enum": [ "INVALID_URL_PATTERN", "URL_RULE_NOT_CONFIGURED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the URL pattern error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request operation. \nPossible values:\n**error** - The request URL pattern was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidURLPatternErrorSingleGet" } } }, "description": "The request URL does not match any configured endpoint pattern. **Resolution:** Verify the request URL follows the pattern /settings/user_groups/{group}." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.READ" ] } ], "summary": "Get a user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" }, "put": { "description": "To update the name, description, and member sources of an existing user group in your Zoho CRM organization.", "operationId": "updateGroup", "parameters": [ { "$ref": "#/components/parameters/Group" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateGroupExample": { "description": "Shows a request body for updating a user group with a new name, description, and a single territory source with sub-territories.", "summary": "Update a user group name, description, and sources", "value": { "user_groups": [ { "description": "Updated sales department user group", "name": "Updated Sales Team", "sources": [ { "source": { "id": "3652397000000186017" }, "type": "users" }, { "source": { "id": "3652397000000026008" }, "subordinates": true, "type": "roles" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body schema for updating a user group.", "properties": { "user_groups": { "description": "Specify an array containing one user group object to update.", "items": { "additionalProperties": false, "description": "Specify the updated details for the user group, including the name, optional description, and member sources.", "properties": { "description": { "anyOf": [ { "description": "Specify the updated text description for the user group.", "maxLength": 250, "type": "string", "x-zs-$id": "UserGroupDescription" }, { "description": "Use null to remove the existing description.", "type": "null", "x-zs-$id": "NoUserGroupDescriptionProvided" } ], "description": "Specify an updated text description for the user group, or null to remove the description." }, "name": { "description": "The name to be updated for the user group. Accepts alphanumeric characters. Note that the name must be unique for each group.", "maxLength": 250, "type": "string" }, "sources": { "description": "Specify the updated array of member sources for the user group. Replaces all existing sources.", "items": { "additionalProperties": false, "description": "Specify one member source entry to add to the user group, including the source type, identifier, and optional flags.", "properties": { "source": { "additionalProperties": false, "description": "Specify the identifier of the source to add to the user group.", "properties": { "id": { "description": "Specify the unique ID of the user, role, or territory to add as a member source.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "sub_territories": { "anyOf": [ { "description": "Specify true to include members from sub-territories, or false to exclude them.", "type": "boolean", "x-zs-$id": "FlagToIncludeTerritoriesForGET" }, { "description": "Use null to omit the sub-territories flag.", "type": "null", "x-zs-$id": "NoSubTerritoriesFlagProvided" } ], "description": "Specify whether to include members from sub-territories when the source type is **territories**.\nPossible values:\n**true** - Include members from sub-territories.\n**false** - Do not include members from sub-territories." }, "subordinates": { "anyOf": [ { "description": "Specify **true** to include users in subordinate roles, or false to exclude them.", "type": "boolean", "x-zs-$id": "FlagToIncludeSubordinatesForGET" }, { "description": "Use null to omit the subordinates flag.", "type": "null", "x-zs-$id": "NoSubordinatesFlagProvidedForGET" } ], "description": "Specify whether to include users in subordinate roles when the source type is **roles** or **territories**.\nPossible values:\n**true** - Include users in subordinate roles.\n**false** - Do not include users in subordinate roles." }, "type": { "description": "Specify the type of the member source being updated for the user group.\nPossible values:\n**territories** - Add a CRM territory as a member source.\n**roles** - Add a CRM role as a member source.\n**users** - Add individual CRM users as a member source.", "enum": [ "territories", "roles", "users" ], "type": "string" } }, "required": [ "type", "source" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "name", "sources" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "user_groups" ], "type": "object" } } }, "description": "Provide the updated user group details including the name, optional description, and member sources.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessWithId": { "description": "Shows the success response for a user group update, returning the group ID and a SUCCESS code.", "summary": "User group updated successfully", "value": { "user_groups": [ { "code": "SUCCESS", "details": { "id": "3652397000009949005" }, "message": "User group updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema for a successful user group update.", "properties": { "user_groups": { "description": "Represents the array containing the result of the user group update operation. ", "items": { "additionalProperties": false, "description": "Represents the update result for the user group, including the status, result code, message, and the group ID.", "properties": { "code": { "description": "Represents the result code for the user group update operation. \nPossible values:\n**SUCCESS** - The user group update succeeds.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the updated user group. ", "properties": { "id": { "description": "Represents the unique ID of the updated user group. ", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for the user group update operation. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the user group update operation. \nPossible values:\n**success** - The user group update succeeds.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "user_groups" ], "type": "object", "x-zs-$id": "UserGroupUpdateResponse" } } }, "description": "User group updated successfully. Returns the group ID and a success status." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the group ID in the URL does not match an existing user group.", "summary": "Invalid group ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The provided group ID is invalid.", "status": "error" } }, "SourceError": { "description": "Shows the error response when the sources array contains invalid data, such as a non-existent source ID.", "summary": "Invalid source ID in sources array", "value": { "user_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.user_groups[0].source[0].id" }, "message": "The User Id given seems to be Invalid", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Indicates that the request body contains an invalid field value, with field-level error details.", "properties": { "user_groups": { "description": "Represents the array containing the error details for the failed update operation. ", "items": { "additionalProperties": false, "description": "Represents the error details for a user group update failure due to invalid field values.", "properties": { "code": { "description": "Represents the error code for the update failure. \nPossible values:\n**INVALID_DATA** - One or more field values in the request body are invalid.\n**MANDATORY_NOT_FOUND** - A required field is missing from the request body.\n**DUPLICATE_DATA** - A user group with the same name already exists.", "enum": [ "INVALID_DATA", "MANDATORY_NOT_FOUND", "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the update error, including the problematic field information. ", "properties": { "api_name": { "description": "Represents the API name of the field that caused the update error. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that caused the update error. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the update failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the update operation. \nPossible values:\n**error** - The user group update failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "user_groups" ], "type": "object", "x-zs-$id": "GroupUpdateSinglePutSourceError" }, { "additionalProperties": false, "description": "Indicates that the group ID in the URL does not match an existing user group.", "properties": { "code": { "description": "Represents the error code for the invalid group ID failure. \nPossible values:\n**INVALID_DATA** - The group ID in the URL does not reference an existing user group.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid group ID error. ", "properties": { "resource_path_index": { "description": "Represents the index of the path segment where the invalid resource ID was found. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid group ID failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the update request. \nPossible values:\n**error** - The request failed because the group ID is invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SingleGroupUpdateFailureInvalid" } ], "description": "Response schema for a failed user group update, covering both invalid field values and invalid group ID errors.", "x-zs-$id": "GroupUpdateSinglePutFailure" } } }, "description": "The user group could not be updated. **Resolution:** Verify the group ID is valid and all field values in the request body are correct." }, "404": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the request URL does not match any configured API endpoint pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid URL pattern error.", "properties": { "code": { "description": "Represents the error code for the URL pattern failure. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any configured API endpoint.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the URL pattern error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request URL pattern was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidURLPatternErrorSinglePut" } } }, "description": "The request URL does not match any configured endpoint pattern. **Resolution:** Verify the request URL follows the pattern /settings/user_groups/{group}." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.UPDATE" ] } ], "summary": "Update a user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" } }, "/crm/v8/settings/user_groups/{group}/actions/associations": { "get": { "description": "To retrieve the list of CRM resources, such as sharing rules, workflows, assignment rules, and approval processes, that are associated with a specific user group in your Zoho CRM organization.", "operationId": "getUserGroupAssociations", "parameters": [ { "$ref": "#/components/parameters/Group" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows the list of CRM resources associated with a user group, including sharing rules and workflow entries with their module context.", "summary": "Successful response with group associations", "value": { "associations": [ { "details": { "module": { "api_name": "Leads", "id": "16045511334961105" } }, "resource": { "id": "16045511334961104", "name": "Sharing Rule Name" }, "type": "data_sharing" }, { "details": null, "resource": { "id": "16045511334961105", "name": "Workflow Name" }, "type": "workflow_rules" }, { "details": { "module": { "api_name": "Leads", "id": "16045511334961105" } }, "resource": { "id": "16045511334961106", "name": "Assignment Rule Name" }, "type": "assignment_rules" }, { "details": null, "resource": { "id": "16045511334961107", "name": "Email Notification Name" }, "type": "email_notifications" }, { "details": null, "resource": { "id": "16045511334961108", "name": "Approval Process Name" }, "type": "approval_process" }, { "details": null, "resource": { "id": "16045511334961109", "name": "Review Process Name" }, "type": "review_process" }, { "details": { "module": { "api_name": "Leads", "id": "16045511334961105" } }, "resource": { "id": "16045511334961110", "name": "Calendar Booking Name" }, "type": "calendar_bookings" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema containing the list of CRM resources associated with the specified user group.", "properties": { "associations": { "description": "Represents the array of CRM resources associated with the specified user group. ", "items": { "additionalProperties": false, "description": "Represents one CRM resource association for the user group, including the resource identifier, association type, and module details.", "properties": { "details": { "additionalProperties": false, "description": "Represents the CRM module details for this association. ", "properties": { "module": { "additionalProperties": false, "description": "Represents the CRM module in which the associated resource is defined. ", "properties": { "api_name": { "description": "Represents the API name of the module containing the associated resource. ", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the module containing the associated resource. ", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "module" ], "type": [ "object", "null" ] }, "resource": { "additionalProperties": false, "description": "Represents the CRM resource that is associated with the user group. ", "properties": { "id": { "description": "Represents the unique ID of the associated resource (such as a sharing rule or workflow). ", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the associated resource. ", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "type": { "description": "Represents the category of CRM resource associated with the user group, such as **sharing rules**, **workflows**, or **automation rules**. ", "maxLength": 255, "type": "string" } }, "required": [ "details", "resource", "type" ], "type": "object", "x-zs-$id": "GETAssociationsNested" }, "maxItems": 200, "type": "array" } }, "required": [ "associations" ], "type": "object", "x-zs-$id": "GetassociationsResponse200" } } }, "description": "Returns the list of CRM resources, such as sharing rules, workflows, and assignment rules, that are associated with the specified user group." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Shows the error response when the group ID in the URL does not match an existing user group.", "summary": "Invalid group ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the related id given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid group ID error.", "properties": { "code": { "description": "Represents the error code for the request failure. \nPossible values:\n**INVALID_DATA** - The group ID in the URL is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the request error. ", "properties": { "resource_path_index": { "description": "Represents the index of the path segment where the invalid resource ID was found. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the request failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request failed because the group ID is invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "title": "Error Response Core", "type": "object", "x-zs-$id": "GetassociationsError400" } } }, "description": "The group ID in the URL is invalid. **Resolution:** Provide a valid numeric user group ID in the **group** path parameter." }, "404": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the request URL does not match any configured API endpoint pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid URL pattern error.", "properties": { "code": { "description": "Represents the error code for the URL pattern failure. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any configured API endpoint.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the URL pattern error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request URL pattern was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidUrlGetAssoGrps" } } }, "description": "The request URL does not match any configured endpoint pattern. **Resolution:** Verify the URL follows the pattern /settings/user_groups/{group}/actions/associations." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.READ" ] } ], "summary": "Get associations for a user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" } }, "/crm/v8/settings/user_groups/{group}/actions/sources_count": { "get": { "description": "To retrieve the count of member sources by type (users, roles, territories, and groups) for a specific user group in your Zoho CRM organization.", "operationId": "getUserGroupSourcesCount", "parameters": [ { "$ref": "#/components/parameters/Group" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the source counts for a user group, including counts for roles, territories, and active, inactive, and deleted users.", "summary": "Successful response with source counts", "value": { "sources_count": [ { "roles": 2, "territories": 1, "users": { "active": 2, "deleted": 0, "inactive": 0 } } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema containing the source counts for the specified user group.", "properties": { "sources_count": { "description": "Represents the array containing the member source counts for the specified user group. ", "items": { "additionalProperties": false, "description": "Represents the count of each type of member source configured in the user group.", "properties": { "groups": { "description": "Represents the number of group sources in this user group. Present when group sources are configured.", "format": "int32", "type": "integer" }, "roles": { "description": "Represents the number of role sources in this user group. Present when role sources are configured.", "format": "int32", "type": "integer" }, "territories": { "description": "Represents the number of territory sources in this user group. Present when territory sources are configured.", "format": "int32", "type": "integer" }, "users": { "additionalProperties": false, "description": "Represents the count of individual user sources by status. Present when user sources are configured.", "properties": { "active": { "description": "Represents the number of active users in this user group. ", "format": "int32", "type": "integer" }, "deleted": { "description": "Represents the number of deleted users in this user group. ", "format": "int32", "type": "integer" }, "inactive": { "description": "Represents the number of inactive users in this user group. ", "format": "int32", "type": "integer" } }, "required": [ "inactive", "deleted", "active" ], "type": "object" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "sources_count" ], "type": "object", "x-zs-$id": "SourceCountResponseForUserGroup" } } }, "description": "Returns the count of each type of member source configured in the specified user group." }, "204": { "description": "The specified user group has no member sources configured." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the group ID in the URL does not match an existing user group.", "summary": "Invalid group ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid group ID error.", "properties": { "code": { "description": "Represents the error code for the request failure. \nPossible values:\n**INVALID_DATA** - The group ID in the URL is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the request error. ", "properties": { "resource_path_index": { "description": "Represents the index of the path segment where the invalid resource ID was found. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the request failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request failed because the group ID is invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupPermissionError" } } }, "description": "The group ID in the URL is invalid. **Resolution:** Provide a valid numeric user group ID in the **group** path parameter." }, "404": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the request URL does not match any configured API endpoint pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid URL pattern error.", "properties": { "code": { "description": "Represents the error code for the URL pattern failure. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any configured API endpoint.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the URL pattern error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request URL pattern was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidURLPatternErrorSourcesCount" } } }, "description": "The request URL does not match any configured endpoint pattern. **Resolution:** Verify the URL follows the pattern /settings/user_groups/{group}/actions/sources_count." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.READ" ] } ], "summary": "Get source counts for a user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" } }, "/crm/v8/settings/user_groups/{group}/sources": { "get": { "description": "To retrieve the paginated list of member sources configured for a specific user group in your Zoho CRM organization.", "operationId": "getUserGroupSources", "parameters": [ { "$ref": "#/components/parameters/Group" }, { "$ref": "#/components/parameters/UserGroupsFilters" }, { "$ref": "#/components/parameters/UserGroupsInclude" }, { "description": "Filter sources by source type.\nPossible values:\n**users** - Return only user-type sources.\n**roles** - Return only role-type sources.\n**territories** - Return only territory-type sources.\n**groups** - Return only group-type sources.", "in": "query", "name": "type", "required": false, "schema": { "enum": [ "users", "roles", "territories", "groups" ], "type": "string" } }, { "description": "Filter user-type sources by the user's status or type classification.", "in": "query", "name": "user_type", "required": false, "schema": { "maxLength": 100, "type": "string" } }, { "$ref": "#/components/parameters/UserGroupsPage" }, { "$ref": "#/components/parameters/UserGroupsPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a paginated list of member sources for a user group, including a role source with subordinates and a territory source.", "summary": "Successful response with member sources", "value": { "info": { "count": 2, "more_records": false, "page": 1, "per_page": 200 }, "sources": [ { "source": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "type": "users" }, { "source": { "id": "3652397000000026008", "name": "Sales Manager" }, "subordinates": false, "type": "roles" }, { "source": { "id": "3652397000000095001", "name": "APAC Region" }, "sub_territories": true, "type": "roles" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema containing the paginated list of member sources for the user group.", "properties": { "info": { "additionalProperties": false, "description": "Represents pagination information for the response. ", "properties": { "count": { "description": "Represents the total number of member sources returned in the current response. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional member source records are available beyond the current page. ", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the maximum number of member source records returned per page. ", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "sources": { "description": "Represents the array of member sources configured for the user group. ", "items": { "additionalProperties": false, "description": "Represents one member source entry for the user group, including the source type, identifier, and optional flags for subordinates or sub-territories.", "properties": { "source": { "additionalProperties": false, "description": "Represents the identifier and name of the source. ", "properties": { "id": { "description": "Represents the unique ID of the user, role, territory, or group configured as a member source. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the source configured as a member. ", "maxLength": 250, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "sub_territories": { "description": "Indicates whether members from sub-territories are included for territory-type sources. Present when configured during group creation or update.", "type": "boolean" }, "subordinates": { "description": "Indicates whether users in subordinate roles are included for role-type sources. Present when configured during group creation or update.", "type": "boolean" }, "type": { "description": "Represents the type of this member source. \nPossible values:\n**users** - Individual CRM users.\n**roles** - CRM roles.\n**territories** - CRM territories.\n**groups** - CRM user groups.", "enum": [ "users", "roles", "territories", "groups" ], "type": "string" } }, "required": [ "source", "type" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "sources", "info" ], "type": "object", "x-zs-$id": "UserGroupGetSuccessResponse" } } }, "description": "Returns the paginated list of member sources configured for the specified user group." }, "204": { "description": "The specified user group has no member sources configured." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the group ID in the URL does not match an existing user group.", "summary": "Invalid group ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The provided group ID is invalid.", "status": "error" } }, "PatternNotMatched": { "description": "Shows the error response when a query parameter value does not match the required pattern of valid source types.", "summary": "Query parameter value does not match required pattern", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "type", "regex": "users|roles|groups|territories" }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Indicates that the group ID in the URL path is invalid or does not match an existing user group.", "properties": { "code": { "description": "Represents the error code for the request failure. \nPossible values:\n**INVALID_DATA** - The group ID in the URL is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the request error. ", "properties": { "resource_path_index": { "description": "Represents the index of the path segment where the invalid resource ID was found. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the request failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request failed because the group ID is invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetGroupSourcesInvalidDataError" }, { "additionalProperties": false, "description": "Indicates that a query parameter value does not match the required pattern for valid source types.", "properties": { "code": { "description": "Represents the error code for the failed pattern validation. \nPossible values:\n**PATTERN_NOT_MATCHED** - The query parameter value does not match the expected pattern.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the pattern validation failure. ", "properties": { "param_name": { "const": "type", "description": "Represents the name of the query parameter that failed the pattern validation. ", "type": "string" }, "regex": { "const": "users|roles|groups|territories", "description": "Represents the regex pattern that the parameter value failed to match. ", "type": "string" } }, "required": [ "regex", "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the pattern validation failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request failed because the parameter value did not match the allowed pattern.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetGroupSourcesPatternError" } ], "description": "Response schema for a failed sources request, covering both invalid group ID and parameter pattern errors.", "x-zs-$id": "UserGroupSourcesFailures" } } }, "description": "The request failed due to an invalid group ID or an invalid query parameter value. **Resolution:** Verify the group ID and ensure the **type** parameter uses a valid value (users, roles, territories, or groups)." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.READ" ] } ], "summary": "Get sources for a user group", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" } }, "/crm/v8/settings/variable_groups": { "get": { "description": "To retrieve a list of all variable groups in your Zoho CRM organization.", "operationId": "getVariableGroups", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response containing the list of all variable groups in the organization.", "summary": "Successful list variable groups response", "value": { "variable_groups": [ { "api_name": "NewFToNew", "description": null, "display_label": "NewFToNew", "id": "111114000000473989", "name": "NewFToNew", "source": "crm" }, { "api_name": "NewFToNew2", "description": null, "display_label": "NewFToNew2", "id": "111114000000473995", "name": "NewFToNew2", "source": "crm" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupListResponse" } } }, "description": "Returns a list of all variable groups in the CRM organization." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.READ` scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariableGroupsPermissionDeniedError" } } }, "description": "Returns an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.READ` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variable_groups.READ" ] } ], "summary": "Variable Groups", "tags": [ "variable_groups" ], "x-zoho-document": "variable_groups" }, "put": { "description": "To update the details of one or more variable groups in your Zoho CRM organization. The request accepts a maximum of 10 variable group items. When individual items succeed or fail independently, the API returns a 207 multi-status response with per-item results.", "operationId": "updateVariableGroups", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Demonstrates a sample request body for the bulk update variable groups operation.", "summary": "Sample bulk update variable groups request body", "value": { "variable_groups": [ { "api_name": "VarGroup", "description": "description", "id": "111111000000117081", "name": "VarGroup" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupUpdateRequestAlt" } } }, "description": "Accepts a JSON request body containing an array of up to 10 variable group items to update." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response after updating all variable groups in the request.", "summary": "Successful bulk update variable groups response", "value": { "variable_groups": [ { "code": "SUCCESS", "details": { "id": "111111000000117081" }, "message": "variable group updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupCollectionResponse" } } }, "description": "Returns the operation statuses for all updated variable groups when all items succeed." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Demonstrates a multi-status response when some variable group items succeed and others fail in the same bulk update request.", "summary": "Multi-status bulk update variable groups response", "value": { "variable_groups": [ { "code": "SUCCESS", "details": { "id": "111111000000117081" }, "message": "variable group updated successfully", "status": "success" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[1].name" }, "message": "duplicate data", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupMultiStatusResponseAlt" } } }, "description": "Returns a multi-status response when individual variable group items in the bulk update have different outcomes, with per-item success or error results." }, "400": { "content": { "application/json": { "examples": { "CannotPerformActionResponse1": { "description": "Demonstrates an error response when the bulk update targets a system-defined variable group.\n**Resolution:** System-defined variable groups do not support modification. Use user-defined variable group IDs.", "summary": "Error response for system variable group action not allowed", "value": { "variable_groups": [ { "code": "CANNOT_PERFORM_ACTION", "details": { "api_name": "id", "json_path": "$.variable_groups[0].id" }, "message": "the given operation is not supported for system defined variable group", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Demonstrates an error response when the updated value duplicates an existing variable group name or API name.\n**Resolution:** Provide a unique `api_name` or `name` value that does not conflict with existing variable groups.", "summary": "Error response for duplicate variable group data", "value": { "variable_groups": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[0].name" }, "message": "duplicate data", "status": "error" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[1].name" }, "message": "duplicate data", "status": "error" } ] } }, "DuplicateDataResponse2": { "description": "Demonstrates an error response when the updated fields contain duplicate values.\n**Resolution:** Ensure the updated field values are unique across all variable groups.", "summary": "Error response for duplicate field value", "value": { "variable_groups": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "DuplicateDataResponse3": { "description": "Demonstrates an error response when duplicate data is detected for multiple variable groups in the request.\n**Resolution:** Ensure that each variable group item has unique field values.", "summary": "Error response for multiple duplicate entries", "value": { "variable_groups": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.variable_groups[0].api_name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error response when the `variable_groups` field in the request contains invalid data.\n**Resolution:** Verify that the `variable_groups` array contains valid data for all fields.", "summary": "Error response for invalid variable groups field data", "value": { "code": "INVALID_DATA", "details": { "api_name": "variable_groups", "json_path": "$.variable_groups", "maximum_length": 10 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse10": { "description": "Demonstrates an error response when a field value contains an invalid data type.\n**Resolution:** Provide a value with the expected data type for the field.", "summary": "Error response for invalid field data type", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.variable_groups[*].api_name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse11": { "description": "Demonstrates an error response when the request contains invalid data for a field.\n**Resolution:** Verify that all field values match the expected data types and formats.", "summary": "Error response for invalid field data", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.variable_groups[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse12": { "description": "Demonstrates an error response when the provided variable group ID in the request is invalid.\n**Resolution:** Provide a valid variable group ID in each item of the request body.", "summary": "Error response for invalid variable group ID", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.variable_groups[*].description", "maximum_length": 3000 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse2": { "description": "Demonstrates an error response when a field value exceeds the maximum allowed length.\n**Resolution:** Reduce the field value length to within the allowed limit.", "summary": "Error response for data exceeding maximum length", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.variable_groups[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error response when the `api_name` value does not match the required naming pattern.\n**Resolution:** Provide an `api_name` value that complies with the required naming pattern.", "summary": "Error response for API name pattern mismatch", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.variable_groups[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error response when ambiguity occurs during request processing.\n**Resolution:** Ensure that field references in the request are unique and non-conflicting.", "summary": "Error response for ambiguity during processing", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.variable_groups[*].id", "maximum_length": 18 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error response when a required field is missing from the request.\n**Resolution:** Include all required fields in each variable group item.", "summary": "Error response for missing required field", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "rid", "expected_data_type": "text", "json_path": "$.variable_groups[*].rid" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Demonstrates an error response when the required `id` field is missing from a variable group item.\n**Resolution:** Include the required `id` field in each variable group item.", "summary": "Error response for missing required field ID", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "rid", "json_path": "$.variable_groups[*].rid", "maximum_length": 36 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Demonstrates an error response when the provided variable group ID is invalid.\n**Resolution:** Provide a valid variable group ID in the request body.", "summary": "Error response for invalid variable group ID in item", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.variable_groups[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Demonstrates an error response when the request contains invalid data.\n**Resolution:** Review the field values and correct any invalid entries.", "summary": "Error response for invalid request data", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[*].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse9": { "description": "Demonstrates an error response when the `variable_groups` field contains invalid data type.\n**Resolution:** Ensure the `variable_groups` field contains a valid array of objects.", "summary": "Error response for invalid variable groups field type", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.variable_groups[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error response when the required `id` field is missing from the variable group item.\n**Resolution:** Include the `id` field in each variable group update item.", "summary": "Error response for missing required ID field", "value": { "variable_groups": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.variable_groups[0].id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Demonstrates an error response when a required field is missing from the request body.\n**Resolution:** Include all required fields in each variable group update item.", "summary": "Error response for missing required field in update request", "value": { "variable_groups": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.variable_groups[*].id" }, "message": "Required field is missing", "status": "error" } ] } }, "PatternNotMatchedResponse1": { "description": "Demonstrates an error response when the `api_name` value does not comply with the required naming pattern.\n**Resolution:** Provide an `api_name` value that matches the required naming convention.", "summary": "Error response for API name pattern mismatch", "value": { "variable_groups": [ { "code": "PATTERN_NOT_MATCHED", "details": { "api_name": "variable_group.api_name", "json_path": "$.variable_groups[0].variable_group.api_name" }, "message": "Please check whether the input values are correct", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidVariableGroupsTypeError" }, { "additionalProperties": false, "description": "Represents an error response returned when the `variable_groups` field in the bulk update request contains invalid data.", "properties": { "variable_groups": { "description": "Represents an array of error objects, one for each variable group item in the request that failed validation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/DuplicateVariableGroupError" }, { "$ref": "#/components/schemas/SystemVariableGroupActionNotAllowedError" }, { "$ref": "#/components/schemas/MandatoryFieldIdMissingError" }, { "$ref": "#/components/schemas/ApiNamePatternMismatchError" }, { "$ref": "#/components/schemas/InvalidVariableGroupIdError" }, { "$ref": "#/components/schemas/ProcessingAmbiguityError" }, { "$ref": "#/components/schemas/VariableGroupsMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/InvalidFieldDataTypeError" }, { "$ref": "#/components/schemas/VariableGroupsInvalidDataError" } ], "description": "Represents a single validation error for a variable group item in the bulk update request." }, "maxItems": 25, "type": "array" } }, "required": [ "variable_groups" ], "type": "object", "x-zs-$id": "UpdatenvalidRequestBodyErrors" } ], "description": "Represents an error response returned when the bulk update variable groups request fails validation.", "x-zs-$id": "UpdatenvalidRequestErrors" } } }, "description": "Returns an error response when the request contains invalid or missing data.\n**Resolution:** Verify that all field values are valid and each ID refers to a user-defined variable group." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.UPDATE` scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariableGroupsPermissionDeniedError" } } }, "description": "Returns an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.UPDATE` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variable_groups.UPDATE" ] } ], "summary": "Variable Groups", "tags": [ "variable_groups" ], "x-zoho-document": "variable_groups" } }, "/crm/v8/settings/variable_groups/actions/generate_api_name": { "post": { "description": "To generate an available API name for a new variable group in your Zoho CRM organization. Submit the proposed display name in the request, and the API returns a suggested `api_name` that complies with the naming requirements.", "operationId": "generateAPIName", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Demonstrates a sample request body for the generate API name operation.", "summary": "Sample generate API name request body", "value": { "variable_groups": [ { "name": "asdasd" } ] } } }, "schema": { "$ref": "#/components/schemas/ApiNameGenerationRequestAlt" } } }, "description": "Accepts a JSON request body containing the proposed variable group name for which an available API name is generated." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response containing the generated API name for the submitted variable group.", "summary": "Successful generate API name response", "value": { "variable_groups": [ { "code": "SUCCESS", "details": { "api_name": "variable" }, "message": "the api name is generated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupsApiNameGenerationResponse" } } }, "description": "Returns the generated API name for each submitted variable group." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates an error response when the request contains invalid data for a field.\n**Resolution:** Verify that all field values match the expected data types and formats.", "summary": "Error response for invalid data", "value": { "code": "INVALID_DATA", "details": { "api_name": "variable_groups", "json_path": "$.variable_groups", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "description": "Demonstrates an error response when a field value exceeds the maximum allowed length.\n**Resolution:** Reduce the field value length to within the allowed limit.", "summary": "Error response for data exceeding maximum length", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[0].name", "maximum_length": 50 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "description": "Demonstrates an error response when a field contains an invalid data type.\n**Resolution:** Provide a value with the expected data type for the field.", "summary": "Error response for invalid field data type", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.variable_groups[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error response when the request contains invalid data.\n**Resolution:** Review the field values and correct any invalid entries.", "summary": "Error response for invalid request data", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[*].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "description": "Demonstrates an error response when the required `id` field is missing from the request.\n**Resolution:** Include the required `id` field in each variable group item.", "summary": "Error response for missing required field ID", "value": { "variable_groups": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.variable_groups[0].name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "description": "Demonstrates an error response when a required field is missing from the request.\n**Resolution:** Include all required fields in each variable group item.", "summary": "Error response for missing required field", "value": { "variable_groups": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.variable_groups[*].name" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidVariableGroupsTypeError" }, { "additionalProperties": false, "description": "Represents an error response returned when the `variable_groups` field in the generate API name request contains invalid data.", "properties": { "variable_groups": { "description": "Represents an array of error objects, one for each variable group item in the request that failed validation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandatoryFieldIdMissingError" }, { "$ref": "#/components/schemas/InvalidVariableGroupsTypeError" }, { "$ref": "#/components/schemas/VariableGroupsMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/InvalidFieldDataTypeError" }, { "$ref": "#/components/schemas/VariableGroupsInvalidDataError" } ], "description": "Represents a single validation error for a variable group item in the generate API name request." }, "maxItems": 25, "type": "array" } }, "required": [ "variable_groups" ], "type": "object", "x-zs-$id": "GenerateApiNameInvalidRequestBodyErrors" } ], "description": "Represents an error response returned when the generate API name request fails validation.", "x-zs-$id": "GenerateApiNameInvalidRequestErrors" } } }, "description": "Returns an error response when the request contains missing or invalid data.\n**Resolution:** Ensure all required fields are present and contain valid values." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.CREATE` scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariableGroupsPermissionDeniedError" } } }, "description": "Returns an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.CREATE` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variable_groups.CREATE" ] } ], "summary": "Generate API Name", "tags": [ "variable_groups" ], "x-zoho-document": "variable_groups" } }, "/crm/v8/settings/variable_groups/{id}": { "get": { "description": "To retrieve the details of a specific variable group by its ID in your Zoho CRM organization.", "operationId": "getVariableGroupById", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response containing the details of the specified variable group.", "summary": "Successful get variable group by ID response", "value": { "variable_groups": [ { "api_name": "General", "description": null, "display_label": "General", "id": "111111000000117077", "name": "General", "source": "crm" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupQueryResponse" } } }, "description": "Returns the details of the variable group matching the specified ID." }, "204": { "description": "Returns no content when no variable group is found for the specified ID." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "description": "Demonstrates an error response when the provided variable group ID in the request path is invalid.\n**Resolution:** Provide a valid variable group ID in the request path.", "summary": "Error response for invalid variable group ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "Invalid ID", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/InvalidIdentifierError" } } }, "description": "Returns an error response when the provided ID in the request path is invalid.\n**Resolution:** Verify that the ID is a valid variable group ID before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.READ` scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariableGroupsPermissionDeniedError" } } }, "description": "Returns an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.READ` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variable_groups.READ" ] } ], "summary": "Get variable group by ID", "tags": [ "variable_groups" ], "x-zoho-document": "variable_groups" }, "parameters": [ { "description": "Specifies the unique ID of the variable group to retrieve or update.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "put": { "description": "To update the details of a specific variable group by its ID in your Zoho CRM organization.", "operationId": "updateVariableGroupById", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "description": "Demonstrates a sample request body for the update variable group by ID operation.", "summary": "Sample update variable group by ID request body", "value": { "variable_groups": [ { "api_name": "VarGroup", "description": "description", "name": "VarGroup" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupDefinitionRequestAlt" } } }, "description": "Accepts a JSON request body containing the updated variable group fields for the specified variable group." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Demonstrates a successful response after updating the specified variable group.", "summary": "Successful update variable group by ID response", "value": { "variable_groups": [ { "code": "SUCCESS", "details": { "id": "111111000000117094" }, "message": "variable group updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariableGroupOperationResponse" } } }, "description": "Returns the operation status for the updated variable group." }, "400": { "content": { "application/json": { "examples": { "CannotPerformActionResponse1": { "description": "Demonstrates an error response when the update targets a system-defined variable group.\n**Resolution:** System-defined variable groups do not support modification. Use a user-defined variable group ID.", "summary": "Error response for system variable group action not allowed", "value": { "variable_groups": [ { "code": "CANNOT_PERFORM_ACTION", "details": { "api_name": "id", "json_path": "$.variable_groups[0].id" }, "message": "the given operation is not supported for system defined variable group", "status": "error" } ] } }, "DuplicateDataResponse1": { "description": "Demonstrates an error response when the updated `api_name` or `name` value duplicates an existing variable group.\n**Resolution:** Provide a unique `api_name` or `name` value that does not conflict with an existing variable group.", "summary": "Error response for duplicate variable group data", "value": { "variable_groups": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "DuplicateDataResponse2": { "description": "Demonstrates an error response when the updated fields contain duplicate values for another field.\n**Resolution:** Ensure the updated field values are unique across all variable groups in the organization.", "summary": "Error response for duplicate field value", "value": { "variable_groups": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.variable_groups[0].api_name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse1": { "description": "Demonstrates an error response when the `variable_groups` field contains invalid data.\n**Resolution:** Verify that the `variable_groups` array contains valid data for all fields.", "summary": "Error response for invalid variable groups field data", "value": { "code": "INVALID_DATA", "details": { "api_name": "variable_groups", "json_path": "$.variable_groups", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "description": "Demonstrates an error response when a field value exceeds the maximum allowed length.\n**Resolution:** Reduce the field value length to within the allowed limit.", "summary": "Error response for data exceeding maximum length", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "Invalid ID", "status": "error" } }, "InvalidDataResponse3": { "description": "Demonstrates an error response when the provided variable group ID is invalid.\n**Resolution:** Provide a valid variable group ID in the request body.", "summary": "Error response for invalid variable group ID", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.variable_groups[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "description": "Demonstrates an error response when a field contains an invalid data type.\n**Resolution:** Provide a value with the expected data type for the field.", "summary": "Error response for invalid field data type", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.variable_groups[*].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "description": "Demonstrates an error response when the request contains invalid data.\n**Resolution:** Review the field values and correct any invalid entries.", "summary": "Error response for invalid request data", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.variable_groups[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "description": "Demonstrates an error response when the ambiguity occurs while processing the request.\n**Resolution:** Ensure that field references in the request are unique and non-conflicting.", "summary": "Error response for ambiguity during processing", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.variable_groups[*].api_name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "description": "Demonstrates an error response when a required field is missing from the request.\n**Resolution:** Include all required fields in each variable group item.", "summary": "Error response for missing required field", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.variable_groups[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse8": { "description": "Demonstrates an error response when the required `id` field is missing from the request.\n**Resolution:** Include the required `id` field in each variable group item.", "summary": "Error response for missing required field ID", "value": { "variable_groups": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.variable_groups[*].description", "maximum_length": 3000 }, "message": "Invalid data", "status": "error" } ] } }, "PatternNotMatchedResponse1": { "description": "Demonstrates an error response when the `api_name` value does not match the required naming pattern.\n**Resolution:** Provide an `api_name` value that complies with the required naming pattern.", "summary": "Error response for API name pattern mismatch", "value": { "variable_groups": [ { "code": "PATTERN_NOT_MATCHED", "details": { "api_name": "variable_group.api_name", "json_path": "$.variable_groups[0].variable_group.api_name" }, "message": "Please check whether the input values are correct", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidVariableGroupsTypeError" }, { "additionalProperties": false, "description": "Represents an error response returned when the `variable_groups` field in the update by ID request contains invalid data.", "properties": { "variable_groups": { "description": "Represents an array of error objects, one for each variable group item in the request that failed validation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/DuplicateVariableGroupError" }, { "$ref": "#/components/schemas/ApiNamePatternMismatchError" }, { "$ref": "#/components/schemas/SystemVariableGroupActionNotAllowedError" }, { "$ref": "#/components/schemas/InvalidFieldDataTypeError" }, { "$ref": "#/components/schemas/VariableGroupsInvalidDataError" } ], "description": "Represents a single validation error for a variable group item in the update by ID request." }, "maxItems": 25, "type": "array" } }, "required": [ "variable_groups" ], "type": "object", "x-zs-$id": "UpdateByIdInvalidRequestBodyErrors" }, { "$ref": "#/components/schemas/InvalidIdentifierError" } ], "description": "Represents an error response returned when the update variable group by ID request fails validation.", "x-zs-$id": "UpdateByIdInvalidRequestErrors" } } }, "description": "Returns an error response when the request contains invalid or missing data.\n**Resolution:** Verify that all field values are valid and the ID refers to a user-defined variable group." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Demonstrates an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.UPDATE` scope.", "summary": "Error response for insufficient permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariableGroupsPermissionDeniedError" } } }, "description": "Returns an error response when the client does not have the required permissions.\n**Resolution:** Ensure the OAuth token includes the `ZohoCRM.settings.variable_groups.UPDATE` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variable_groups.UPDATE" ] } ], "summary": "Update variable group by ID", "tags": [ "variable_groups" ], "x-zoho-document": "variable_groups" } }, "/crm/v8/settings/variables": { "delete": { "description": "Deletes one or more CRM variables by their IDs. Pass variable IDs as a comma-separated list in the ids query parameter, or pass rids in the rids query parameter. A variable that is associated with other features such as email templates, webhooks, or functions cannot be deleted until the association is removed. Requires the ZohoCRM.settings.variables.DELETE scope.", "operationId": "deleteVariables", "parameters": [ { "$ref": "#/components/parameters/VariablesParamQueryIds" } ], "responses": { "207": { "content": { "application/json": { "examples": { "Success207": { "summary": "Success response for status 207", "value": { "variables": [ { "code": "SUCCESS", "details": { "id": "111114000000454011" }, "message": "variable deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "111114000000454008" }, "message": "variable deleted", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "234576960" }, "message": "variable not deleted", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesBatchRemovalMultiStatusResponse" } } }, "description": "Multi-Status - Response contains mixed status results" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: variables)", "value": { "code": "INVALID_DATA", "details": { "api_name": "variables", "json_path": "$.variables", "maximum_length": 1 }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/VariablesInvalidTypeError" }, { "additionalProperties": false, "description": "Error response for required parameter missing", "properties": { "code": { "description": "Represents the error code.", "enum": [ "REQUIRED_PARAM_MISSING", "EXPECTED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "param_name": { "description": "The name of the parameter that caused the error.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "A human-readable error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteVariablesRequiredParamMissingError" }, { "additionalProperties": false, "description": "Error response for variable deletion failures", "properties": { "variables": { "description": "Array of error details", "items": { "additionalProperties": false, "description": "Individual error object", "properties": { "code": { "description": "Represents the error code.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "id": { "description": "The ID of the variable that could not be deleted.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "A human-readable error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "DeleteVariablesInvalidParamError" } ], "description": "Error response for invalid request", "x-zs-$id": "DeleteInvalidRequestErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.DELETE" ] } ], "summary": "Delete variables", "tags": [ "variables" ], "x-zoho-document": "variables" }, "get": { "description": "Retrieves all available CRM variables. Returns the API name, display name, description, type, value, and variable group for each variable. Requires the ZohoCRM.settings.variables.READ scope.", "operationId": "getVariables", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "variables": [ { "api_name": "NewTEST", "description": null, "id": "111115000000091005", "name": "NewTEST", "read_only": false, "source": "crm", "type": "integer", "value": "", "variable_group": { "api_name": "General", "id": "111115000000088076" } }, { "api_name": "newtotest", "description": null, "id": "111115000000094003", "name": "newtotest", "read_only": false, "source": "crm", "type": "integer", "value": "", "variable_group": { "api_name": "General", "id": "111115000000088076" } }, { "api_name": "NTEST", "description": null, "id": "111115000000091001", "name": "NTEST", "read_only": false, "source": "crm", "type": "integer", "value": "", "variable_group": { "api_name": "General", "id": "111115000000088076" } } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesListResponse" } } }, "description": "OK - Successful response" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariablesPermissionDeniedError" } } }, "description": "Forbidden - The client does not have access rights to the content." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.READ" ] } ], "summary": "Retrieve all variables", "tags": [ "variables" ], "x-zoho-document": "variables" }, "post": { "description": "Creates one or more CRM variables. The name, api_name, and variable_group keys are mandatory. The type key specifies the data type of the variable. Possible types: integer, text, percent, decimal, currency, date, datetime, email, phone, url, checkbox, textarea, long. Requires the ZohoCRM.settings.variables.CREATE scope.", "operationId": "createVariables", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "variables": [ { "api_name": "Variable33", "description": "This denotes variable 3 description", "name": "Variable33", "type": "integer", "value": 33, "variable_group": { "id": "400000000470050090988" } } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesBatchInput" } } }, "description": "The request body containing the variable definitions to create." }, "responses": { "201": { "content": { "application/json": { "examples": { "Success201": { "summary": "Success response for status 201", "value": { "variables": [ { "code": "SUCCESS", "details": { "id": "40000000047009" }, "message": "variable added", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesBatchOperationCreated" } } }, "description": "Created - Resource created successfully" }, "207": { "content": { "application/json": { "examples": { "Success207": { "summary": "Success response for status 207", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "variables", "json_path": "$.variables[0].variables" }, "message": "Mandatory field variables not found", "status": "error" }, { "code": "SUCCESS", "details": { "id": "1234567890123456" }, "message": "Proper success message", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesBatchOperationMultiStatus" } } }, "description": "Multi-Status - Response contains mixed status results" }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse1": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity while processing the request", "value": { "variables": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.variables[0].variable_group.id" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse2": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity while processing the request", "value": { "variables": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.variables[0].variable_group.id" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DuplicateDataResponse1": { "summary": "Error response with code DUPLICATE_DATA: duplicate data (Field: api_name)", "value": { "variables": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.variables[0].api_name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: body", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "jsonobject" }, "message": "body", "status": "error" } ] } }, "InvalidDataResponse10": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.variables[*].variable_group.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse11": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.variables[*].variable_group.id", "maximum_length": 21 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse12": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.variables[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse13": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.variables[*].type", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse14": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.variables[*].type", "supported_values": [ "text", "integer", "boolean", "date", "float" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse15": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "integer", "json_path": "$.variables[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse16": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: description)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.variables[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse17": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: description)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.variables[*].description", "maximum_length": 250 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse18": { "summary": "Error response with code INVALID_DATA: body", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "jsonobject" }, "message": "body", "status": "error" } ] } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: invalid data (Field: variables)", "value": { "code": "INVALID_DATA", "details": { "api_name": "variables", "json_path": "$.variables", "maximum_length": 2 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse21": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.variables[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse22": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.variables[*].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse23": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.variables[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse24": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.variables[*].api_name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse25": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.variables[*].api_name", "regex": "^[a-zA-Z]+\\\\w*[a-zA-Z0-9]*$" }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse26": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: variable_group)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "variable_group", "expected_data_type": "jsonobject", "json_path": "$.variables[*].variable_group" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse27": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: variable_group)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "variable_group", "json_path": "$.variables[*].variable_group", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse28": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.variables[*].variable_group.id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse29": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.variables[*].variable_group.id", "maximum_length": 21 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.variables[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse32": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: type)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "expected_data_type": "text", "json_path": "$.variables[*].type" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse33": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.variables[*].type", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse34": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: type)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.variables[*].type", "supported_values": [ "text", "integer", "boolean", "date", "float" ] }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse35": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "integer", "json_path": "$.variables[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse36": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: description)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "expected_data_type": "text", "json_path": "$.variables[*].description" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse37": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: description)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "description", "json_path": "$.variables[*].description", "maximum_length": 250 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.variables[*].name", "maximum_length": 50 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: api_name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "expected_data_type": "text", "json_path": "$.variables[*].api_name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.variables[*].api_name", "maximum_length": 100 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse7": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: api_name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.variables[*].api_name", "regex": "^[a-zA-Z]+\\\\w*[a-zA-Z0-9]*$" }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: variable_group)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "variable_group", "expected_data_type": "jsonobject", "json_path": "$.variables[*].variable_group" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse9": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: variable_group)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "variable_group", "json_path": "$.variables[*].variable_group", "maximum_length": 2 }, "message": "Invalid data", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: variables)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "variables" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse10": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: variable_group)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "variable_group", "json_path": "$.variables[*].variable_group" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse11": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: id)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.variables[*].variable_group.id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse12": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: type)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.variables[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.variables[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse3": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: api_name)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.variables[*].api_name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse4": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: variable_group)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "variable_group", "json_path": "$.variables[*].variable_group" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse5": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: id)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.variables[*].variable_group.id" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse6": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: type)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "type", "json_path": "$.variables[*].type" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse7": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: variables)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "variables" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse8": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.variables[*].name" }, "message": "Required field is missing", "status": "error" } ] } }, "MandatoryNotFoundResponse9": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: api_name)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.variables[*].api_name" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response for limit exceeded", "properties": { "variables": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/VariablesRequestBodyMissingError" }, { "$ref": "#/components/schemas/VariablesRequiredFieldMissingError" }, { "$ref": "#/components/schemas/VariablesDuplicateDataError" }, { "$ref": "#/components/schemas/VariablesDuplicateDataExtendedError" }, { "$ref": "#/components/schemas/VariablesMandatoryFieldMissingError" }, { "$ref": "#/components/schemas/VariablesInvalidDataTypeError" }, { "$ref": "#/components/schemas/VariablesInvalidDataError" }, { "$ref": "#/components/schemas/VariablesInvalidDataGenericError" }, { "$ref": "#/components/schemas/VariablesInvalidDataGeneralError" }, { "$ref": "#/components/schemas/VariableGroupInvalidReferenceError" }, { "$ref": "#/components/schemas/VariableGroupAmbiguityError" }, { "$ref": "#/components/schemas/VariableValueInvalidDataError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "CreateInvalidRequestBodyErrors" }, { "$ref": "#/components/schemas/VariablesInvalidTypeError" }, { "additionalProperties": false, "description": "Error response for limit exceeded", "properties": { "variables": { "description": "Array of error details", "items": { "additionalProperties": false, "description": "Individual error object", "properties": { "code": { "description": "Represents the error code.", "enum": [ "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": {}, "required": [], "type": "object" }, "message": { "description": "A human-readable error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "CreateLimitExceededError" }, { "additionalProperties": false, "description": "Error response when the operation is not allowed for a specific field.", "properties": { "variables": { "description": "Array of error details", "items": { "additionalProperties": false, "description": "Individual error object", "properties": { "code": { "description": "Represents the error code.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "api_name": { "description": "The API name of the field that is not allowed.", "maxLength": 100, "type": "string" }, "json_path": { "description": "The JSON path to the field that is not allowed.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "A human-readable error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "CreateNotAllowedError" }, { "additionalProperties": false, "description": "Error response for pattern not matched", "properties": { "variables": { "description": "Array of error details", "items": { "additionalProperties": false, "description": "Individual error object", "properties": { "code": { "description": "Represents the error code.", "enum": [ "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "api_name": { "description": "The API name of the field that is not allowed.", "maxLength": 100, "type": "string" }, "json_path": { "description": "The JSON path to the field that is not allowed.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "A human-readable error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "CreatePatternNotMatchedError" }, { "additionalProperties": false, "description": "Error response for required parameter missing", "properties": { "code": { "description": "Represents the error code.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "properties": { "api_name": { "description": "The API name of the missing required parameter.", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "A human-readable error message.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the error.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateVariableRequiredParamMissingError" } ], "description": "Error response for invalid request", "x-zs-$id": "CreateInvalidRequestErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.CREATE" ] } ], "summary": "Create variables", "tags": [ "variables" ], "x-zoho-document": "variables" }, "put": { "description": "Updates one or more CRM variables in a single request. The id key is mandatory in the request body to identify each variable. You cannot update the type or variable group of a variable. Requires the ZohoCRM.settings.variables.UPDATE scope.", "operationId": "updateVariables", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample request body", "value": { "variables": [ { "id": "111115000000091005", "value": "This is a new value" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesBatchUpdateRequestAlt1" } } }, "description": "The request body containing the variable data to update." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "variables": [ { "code": "SUCCESS", "details": { "id": "111111000000114001" }, "message": "variable updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesBatchUpdateResponse" } } }, "description": "OK - Successful response" }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessingResponse1": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity while processing the request", "value": { "variables": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.variables[0].id" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "AmbiguityDuringProcessingResponse2": { "summary": "Error response with code AMBIGUITY_DURING_PROCESSING: Ambiguity while processing the request", "value": { "variables": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.variables[0].id" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: variables)", "value": { "code": "INVALID_DATA", "details": { "api_name": "variables", "json_path": "$.variables", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: invalid data (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "integer", "json_path": "$.variables[0].value" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.variables[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.variables[*].id", "maximum_length": 14 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.variables[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse6": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.variables[*].value", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/VariablesInvalidTypeError" }, { "additionalProperties": false, "description": "Wrapped error response with variables", "properties": { "variables": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/VariableValueInvalidDataError" }, { "$ref": "#/components/schemas/VariablesInvalidDataTypeError" }, { "$ref": "#/components/schemas/VariablesInvalidDataError" }, { "$ref": "#/components/schemas/VariableGroupAmbiguityError" }, { "$ref": "#/components/schemas/VariablesDuplicateDataExtendedError" }, { "$ref": "#/components/schemas/VariableGroupInvalidReferenceError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "UpdateInvalidRequestBodyErrors" } ], "description": "Error response for invalid request", "x-zs-$id": "UpdateInvalidRequestErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.UPDATE" ] } ], "summary": "Update variables", "tags": [ "variables" ], "x-zoho-document": "variables" } }, "/crm/v8/settings/variables/actions/generate_api_name": { "post": { "description": "generates api name", "operationId": "postGenerateApiName", "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "variables": [ { "name": "nothingGenerate2", "variable_group": { "api_name": "General", "id": "400000000470050090988", "name": "General" } } ] } } }, "schema": { "$ref": "#/components/schemas/ApiNameGenerationRequestBody" } } }, "description": "The request body containing the variable definitions to create." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "variables": [ { "code": "SUCCESS", "details": { "api_name": "nothingGenerate2" }, "message": "the api name is generated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesApiNameGenerationResponse" } } }, "description": "OK - Successful response" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.variables[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.variables[*].name", "maximum_length": 16 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: variable_group)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "variable_group", "expected_data_type": "jsonobject", "json_path": "$.variables[*].variable_group" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.variables[*].variable_group.id", "maximum_length": 21 }, "message": "Invalid data", "status": "error" } ] } }, "MandatoryNotFoundResponse1": { "summary": "Error response with code MANDATORY_NOT_FOUND: required field not found (Field: variable_group)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "variable_group", "json_path": "$.variables[0].variable_group" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundResponse2": { "summary": "Error response with code MANDATORY_NOT_FOUND: Required field is missing (Field: name)", "value": { "variables": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "name", "json_path": "$.variables[*].name" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapped error response with variables", "properties": { "variables": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/ErrorApiNameGenerationMandatoryMissingResponse" }, { "$ref": "#/components/schemas/ErrorMandatoryFieldMissingResponse" }, { "$ref": "#/components/schemas/ErrorInvalidDataTypeResponse" }, { "$ref": "#/components/schemas/ErrorInvalidDataResponse" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "PostGenerateApiNameVariablesBodyErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.CREATE" ] } ], "summary": "Generate API Name", "tags": [ "variables" ], "x-zoho-document": "variables" } }, "/crm/v8/settings/variables/{id}": { "delete": { "description": "Deletes a specific CRM variable identified by its ID. A variable that is associated with other features such as email templates, webhooks, or functions cannot be deleted until the association is removed. Requires the ZohoCRM.settings.variables.DELETE scope.", "operationId": "deleteVariablesById", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "variables": [ { "code": "SUCCESS", "details": { "id": "40000000047003" }, "message": "variable deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesScopedRemovalResponse" } } }, "description": "OK - Successful response" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: Invalid ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: variable not deleted", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "id": "40000000047007" }, "message": "variable not deleted", "status": "error" } ] } }, "InvalidRequestMethodResponse1": { "summary": "Error response with code INVALID_REQUEST_METHOD: The http request method type is not a valid one", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidResourceIdError" }, { "additionalProperties": false, "description": "Wrapped error response with variables", "properties": { "variables": { "description": "Array of error objects", "items": { "$ref": "#/components/schemas/VariablesRemovalFailedError" }, "maxItems": 25, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "DeleteByIdInvalidRequestBodyErrors" }, { "$ref": "#/components/schemas/VariablesInvalidRequestMethodError" } ], "description": "Error response for invalid request", "x-zs-$id": "DeleteByIdInvalidRequestErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariablesPermissionDeniedError" } } }, "description": "Forbidden - The client does not have access rights to the content." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.DELETE" ] } ], "summary": "Specific variable", "tags": [ "variables" ], "x-zoho-document": "variables" }, "get": { "description": "Retrieves the details of a specific CRM variable by its ID. The group query parameter, specifying the variable group ID or API name, is mandatory when retrieving a specific variable. Requires the ZohoCRM.settings.variables.READ scope.", "operationId": "getVariableById", "parameters": [ { "$ref": "#/components/parameters/ParamQueryGroup" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "variables": [ { "api_name": "Variable1", "description": "This denotes variable 1 description", "id": "40000000047003", "name": "Variable1", "source": "crm", "type": "text", "value": "This denotes variable one value", "variable_group": { "api_name": "Group1", "id": "40000000047001" } } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesbyGroupResponse" } } }, "description": "OK - Successful response" }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: Invalid data", "value": { "code": "INVALID_DATA", "details": { "param_name": " group_id" }, "message": "Invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: Invalid ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "invalid data", "status": "error" } }, "InvalidUrlPatternResponse1": { "summary": "Error response with code INVALID_URL_PATTERN: Please check if the URL trying to access is a correct one", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/VariableGroupInvalidIDError" }, { "$ref": "#/components/schemas/VariablesInvalidUrlPatternError" }, { "$ref": "#/components/schemas/InvalidResourceIdError" } ], "description": "Error response for invalid request", "x-zs-$id": "GetByIdInvalidRequestErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.READ" ] } ], "summary": "specific variable", "tags": [ "variables" ], "x-zoho-document": "variables" }, "parameters": [ { "description": "The unique ID of the variable. Mandatory.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ], "put": { "description": "Updates a specific CRM variable identified by its ID or API name. You cannot update the type or variable group of the variable. For the list of updatable input keys, refer to the Create Variables operation. Requires the ZohoCRM.settings.variables.UPDATE scope.", "operationId": "updateVariableById", "requestBody": { "content": { "application/json": { "examples": { "SamplePutRequest": { "summary": "Sample request body", "value": { "variables": [ { "id": "40000000047003", "value": "This is a new value" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesScopedBatchUpdateRequestAlt1" } } }, "description": "The request body containing the variable data to update." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "variables": [ { "code": "SUCCESS", "details": { "id": "40000000047003" }, "message": "variable updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/VariablesScopedBatchUpdateResponse" } } }, "description": "OK - Successful response" }, "400": { "content": { "application/json": { "examples": { "DuplicateDataResponse1": { "summary": "Error response with code DUPLICATE_DATA: duplicate data (Field: name)", "value": { "variables": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variables[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "DuplicateDataResponse2": { "summary": "Error response with code DUPLICATE_DATA: duplicate data (Field: name)", "value": { "variables": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variables[0].api_name" }, "message": "duplicate data", "status": "error" } ] } }, "DuplicateDataResponse3": { "summary": "Error response with code DUPLICATE_DATA: duplicate data (Field: name)", "value": { "variables": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variables[0].name" }, "message": "duplicate data", "status": "error" } ] } }, "DuplicateDataResponse4": { "summary": "Error response with code DUPLICATE_DATA: duplicate data (Field: name)", "value": { "variables": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "name", "json_path": "$.variables[0].api_name" }, "message": "duplicate data", "status": "error" } ] } }, "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: invalid data (Field: variables)", "value": { "code": "INVALID_DATA", "details": { "api_name": "variables", "json_path": "$.variables", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: invalid data (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "integer", "json_path": "$.variables[0].value" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "expected_data_type": "bigint", "json_path": "$.variables[*].id" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: id)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.variables[*].id", "maximum_length": 14 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse6": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "text", "json_path": "$.variables[*].value" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse7": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "json_path": "$.variables[*].value", "maximum_length": 19 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse8": { "summary": "Error response with code INVALID_DATA: invalid data (Field: value)", "value": { "variables": [ { "code": "INVALID_DATA", "details": { "api_name": "value", "expected_data_type": "integer", "json_path": "$.variables[0].value" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/VariablesDomainNotSupportedError" }, { "$ref": "#/components/schemas/VariablesInvalidTypeError" }, { "additionalProperties": false, "description": "Wrapped error response with variables", "properties": { "variables": { "description": "Array of error objects", "items": { "anyOf": [ { "$ref": "#/components/schemas/VariablesDuplicateDataExtendedError" }, { "$ref": "#/components/schemas/VariableValueInvalidDataError" }, { "$ref": "#/components/schemas/VariablesInvalidDataTypeError" }, { "$ref": "#/components/schemas/VariablesInvalidDataError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "variables" ], "type": "object", "x-zs-$id": "UpdateByIdInvalidRequestBodyErrors" } ], "description": "Error response for invalid request", "x-zs-$id": "UpdateByIdInvalidRequestErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.UPDATE" ] } ], "summary": "Specific variable", "tags": [ "variables" ], "x-zoho-document": "variables" } }, "/crm/v8/settings/variables/{id}/actions/associations": { "get": { "description": "Get associated variables", "operationId": "getVariableAssociations", "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "variables_associations": [ { "name": "email_templates", "resources": [ { "details": { "module": { "api_name": "Leads", "id": "111111000000000042" } }, "id": "111111000000058477", "name": "Variable Email Template" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/VariableAssociationsResponse" } } }, "description": "OK - Successful response" }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Variables_Access" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/VariablesPermissionDeniedError" } } }, "description": "Forbidden - The client does not have access rights to the content." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.variables.READ" ] } ], "summary": "Variable Associations", "tags": [ "variables" ], "x-zoho-document": "variables" }, "parameters": [ { "description": "The unique ID of the variable. Mandatory.", "in": "path", "name": "id", "required": true, "schema": { "examples": [ "111112000000092007" ], "maxLength": 255, "type": "string" } } ] }, "/crm/v8/settings/wizards": { "get": { "description": "To retrieve the wizard configurations available in your Zoho CRM organization. The response can be filtered by module using the `**module**` query parameter. When you set up conditional rules for a wizard, the response contains the keys execute_on and type. execute_on represents when the conditional rule is executed. The values are create, edit, and create_edit. type represents the action you want to take when the condition is met. The values are set_values, set_lock, show_component, and show_widget. When type=set_lock, the response contains the key exempted_profiles. This array contains the list of profiles that allow edits even after locking specific fields. The color_palette key is added that displays the colors available for a button on a screen. Note that this key is available in the response only if you have chosen at least one custom color for the button on a screen. Changes made to this API from version 5 when you fetch a specific wizard in a layout: - A new JSON array portal_user_types is added to the response that displays the list of portal user types that have access to the wizard. - A new JSON array exempted_portal_user_types is added to the response that represents the list of portal user types that have access to wizards that are blocked for other user types. - Under the segments, for buttons, the Profiles JSON array is added. This indicates the profiles that have access to that button in that screen. - In the Screens JSON array, the \"type\" of segments JSON object is changed from fields to composite. - In the segments JSON array, the fields JSON array is renamed to elements. - Each object in the elements JSON array contains the sequence number, resource, and type keys. Resource includes the \"name\" and \"id\" of the field or the query component on the screen. type indicates whether the resource is a field or query component. From V6, you can get the list of available screens in Wizards. See the sample response for reference.", "operationId": "getAllWizards", "parameters": [ { "$ref": "#/components/parameters/WizardsModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Represents a successful retrieval of all wizards configured in the CRM organization. Each wizard entry includes its associated module, assigned profiles, and applicable portal types.", "summary": "Successful retrieval of all configured wizards in the organization", "value": { "wizards": [ { "active": true, "containers": [ { "id": "3733145000000570510", "layout": { "display_label": "Standard", "id": "3733145000000570510", "name": "Standard" }, "screens": [ { "api_name": "screen1", "display_label": "Screen 1", "id": "3733145000001209037" } ] } ], "created_by": { "id": "3733145000000556001", "name": "Bob" }, "created_time": "2025-11-26T08:59:44+05:30", "display_label": "Example Wizard", "id": "3733145000001209011", "modified_by": { "id": "3733145000000556001", "name": "Alice" }, "modified_time": "2025-11-26T15:58:16+05:30", "module": { "api_name": "Contacts", "id": "3733145000000570138" }, "name": "example_wizard", "portal_user_types": [ { "display_label": "ClientPortal", "id": "3733145000000570124", "name": "ClientPortal" } ], "profiles": [ { "display_label": "Administrator", "id": "3733145000000570117", "name": "Administrator" } ], "source": "crm" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains a list of wizard objects returned for the account.", "properties": { "wizards": { "description": "Contains the list of wizards configured in the Zoho CRM organization.", "items": { "additionalProperties": false, "description": "Represents a wizard and its basic configuration details.", "properties": { "active": { "description": "Indicates whether the wizard is currently enabled.\n\nPossible values:\ntrue - The wizard is active and available for use.\nfalse - The wizard is inactive and not available for use.\n", "type": "boolean" }, "containers": { "description": "Contains the list of containers within the wizard, each defining a layout and the screens through which users progress.", "items": { "additionalProperties": false, "description": "Represents a container that groups the layout and screens used within the wizard flow.", "properties": { "id": { "description": "Represents the unique identifier of the container.", "format": "int64", "maxLength": 19, "type": "string" }, "layout": { "additionalProperties": false, "description": "Represents the layout associated with the container, from which the wizard fields are sourced.", "properties": { "display_label": { "description": "Represents the display label of the layout, localized based on the active language setting.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the layout.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the layout.", "maxLength": 50, "type": "string" } }, "required": [ "name", "display_label", "id" ], "type": "object" }, "screens": { "description": "Contains the list of screens that define the step-by-step flow a user navigates within this container.", "items": { "additionalProperties": false, "description": "Represents a single screen within the container, defining one step in the wizard's guided data-entry flow.", "properties": { "api_name": { "description": "Represents the programmatic name used to identify the screen in API requests and responses.", "maxLength": 255, "type": "string" }, "display_label": { "description": "Represents the display label of the screen, localized based on the active language setting.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the screen.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "api_name", "id", "display_label" ], "type": "object" }, "maxItems": 75, "type": "array" } }, "required": [ "layout", "screens", "id" ], "type": "object" }, "maxItems": 7, "type": "array" }, "created_by": { "additionalProperties": false, "description": "Represents the user who originally created the wizard, including their identifier and display name.", "properties": { "id": { "description": "Represents the unique numeric identifier of the user who created the wizard.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the full name of the user who created the wizard, as it appears in Zoho CRM.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "created_time": { "description": "Represents the creation date and time of the wizard.", "format": "date-time", "type": "string" }, "display_label": { "description": "Represents the display label of the wizard, localized based on the active language setting in the user's CRM environment.", "maxLength": 255, "type": "string" }, "id": { "description": "Numeric unique identifier of the wizard.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$id": "WizardId" }, "modified_by": { "additionalProperties": false, "description": "Represents the details of the user who last modified the wizard.", "properties": { "id": { "description": "Represents the unique numeric identifier of the user who last modified the wizard.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the full name of the user who last modified the wizard, as it appears in Zoho CRM.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "modified_time": { "description": "Represents the last modification date and time of the wizard.", "format": "date-time", "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the CRM module associated with the wizard. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values.", "properties": { "api_name": { "description": "API name of the module associated with the wizard.", "maxLength": 255, "type": "string" }, "id": { "description": "Numeric unique identifier of the module.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Represents the unique name of the wizard used in API requests and responses.", "maxLength": 30, "type": "string" }, "portal_user_types": { "description": "Contains the client portal user types associated with the wizard. Returns null if no portal user types are configured.", "items": { "additionalProperties": false, "description": "Client portal associated with the wizard.", "properties": { "display_label": { "description": "Represents the display label of the client portal, translated into the user's language where a translation is available.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique numeric identifier of the client portal user type.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Internal name of the client portal.", "maxLength": 255, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "profiles": { "description": "Contains the list of CRM profiles associated with the wizard. Returns null when no profiles are associated.", "items": { "additionalProperties": false, "description": "Represents a CRM profile associated with the wizard.", "properties": { "display_label": { "description": "Represents the display label of the profile, translated into the user's language where a translation is available.", "maxLength": 255, "type": "string" }, "id": { "description": "Numeric unique identifier of the profile.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the profile.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "source": { "description": "Indicates the origin from which the wizard originates.\n\nPossible values:\ncrm - Created natively within Zoho CRM.\nplatform_plugin - Created via a Zoho platform plugin.\nmarketplace_plugin - Created through a Zoho Marketplace plugin.\n", "enum": [ "crm", "platform_plugin", "marketplace_plugin" ], "maxLength": 50, "type": "string" } }, "required": [ "created_time", "modified_time", "display_label", "portal_user_types", "module", "name", "modified_by", "profiles", "active", "containers", "id", "created_by" ], "type": "object" }, "maxItems": 25, "type": "array" } }, "required": [ "wizards" ], "type": "object", "x-zs-$id": "WizardsGetResponse" } } }, "description": "Returns the list of wizards configured in the Zoho CRM organization, including their basic details such as associated module, assigned profiles, and portal types." }, "204": { "description": "Returns no content when no wizards match the specified criteria or no wizards have been configured in the Zoho CRM organization." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "description": "Represents a 400 error response returned when the module API name supplied in the request is not recognized by Zoho CRM. The response body contains the INVALID_MODULE error code indicating the source of the failure.", "summary": "400 error returned when an unrecognized module API name is provided", "value": { "code": "INVALID_MODULE", "details": {}, "message": "The module name seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error returned when the specified module name is not recognized or is invalid.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values:\nINVALID_MODULE - Indicates the specified module is invalid.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional information about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the request failed.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the request status.\nPossible values:\nerror - Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidModuleResponse" } ], "description": "Represents the error response returned when the request contains an invalid module name or query parameters.", "x-zs-$id": "WizardsGetErrorResponses" } } }, "description": "The module API name provided in the request is not recognized.\n**Resolution:** The module API name in the request URL must be valid." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Represents a 401 error response returned when the access token provided is invalid or has expired. The request cannot be authenticated until a valid token is supplied.", "summary": "Access token is invalid or expired", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "invalid oauth token", "status": "error" } }, "OauthScopeMismatch": { "description": "Represents a 401 error response returned when the access token does not include the required OAuth scope for this operation. The token must be regenerated with the appropriate scope before retrying.", "summary": "Access token lacks the required OAuth scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error returned when the provided OAuth token does not have the required scope to access this resource.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values:\nOAUTH_SCOPE_MISMATCH - Indicates the OAuth token does not have the required scope to access this resource.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the request failed.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the request status.\nPossible values:\nerror - Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetAllWizardsOauthScopeMismatchError" }, { "additionalProperties": false, "description": "Represents the error returned when the provided OAuth token is invalid or has expired.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values:\nINVALID_TOKEN - Indicates the provided authentication token is invalid.", "enum": [ "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the error.", "type": "object" }, "message": { "description": "Represents the error message describing why the request failed.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the request status.\nPossible values:\nerror - Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetAllWizardsInvalidTokenError" } ], "description": "Represents the error response returned when the request cannot be authenticated due to missing, invalid, or insufficient credentials.", "x-zs-$id": "GetAllWizardsUnauthorizedErrorResponse" } } }, "description": "Authentication credentials are missing or invalid.\n**Resolution:** A new access token must be generated with the correct scope and valid credentials for this API." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Represents a 403 error response returned when the authenticated user's profile does not have sufficient permission to read wizard configurations. An administrator must grant the required profile permission before the request can succeed.", "summary": "User profile lacks permission to read wizards", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Zoho CRM: Settings Permission" ] }, "message": "Permission denied to read wizards", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the authenticated user does not have permission to retrieve wizards.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values:\nNO_PERMISSION - Indicates the user does not have the required permissions to access this resource.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the permission requirements that caused the request to be rejected.", "properties": { "permissions": { "description": "Contains the list of permissions required to perform this operation.", "items": { "description": "Represents the name of a profile permission that is required to access this resource but was not granted to the authenticated user.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing why the request failed.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the request status.\nPossible values:\nerror - Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetAllWizardsForbiddenError" } } }, "description": "The authenticated user's profile does not have permission to retrieve wizard configurations.\n**Resolution:** The CRM administrator must grant the required permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Represents a 404 error response returned when the request URL does not match a recognized API endpoint pattern. Verify that the URL is correctly formed and resubmit the request.", "summary": "Request URL does not match a valid endpoint pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error returned when the request URL does not conform to a valid URL pattern.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values:\nINVALID_URL_PATTERN - Indicates the requested URL does not match a recognized pattern.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the error, if available.", "type": "object" }, "message": { "description": "Represents the error message describing why the resource could not be found.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the request status.\nPossible values:\nerror - Indicates the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidUrlPatternResponse" } ], "description": "Represents the error response returned when the requested URL does not match a recognized pattern.", "x-zs-$id": "ErrorResponses404" } } }, "description": "The request URL does not match a recognized API endpoint pattern.\n**Resolution:** The request URL must match a valid API endpoint pattern." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.wizards.READ" ] } ], "summary": "Get all wizard configurations", "tags": [ "wizards" ], "x-zoho-document": "wizards" } }, "/crm/v8/settings/wizards/{id}": { "get": { "description": "To retrieve the complete configuration of a single wizard in your Zoho CRM organization, including its containers, screens, segments, buttons, and conditional rules.", "operationId": "getWizardDetails", "parameters": [ { "$ref": "#/components/parameters/WizardsId" }, { "$ref": "#/components/parameters/WizardsLayoutId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "WizardDetailsForLayout": { "description": "Shows the full wizard configuration including containers, screens, segments, buttons, and chart flow data for the specified layout.", "summary": "Detailed wizard definition for a specific layout.", "value": { "wizards": [ { "active": true, "containers": [ { "chart_data": { "color_palette": { "button_background": [ "#ADD9FF", "#C4F0B3", "#FFD6BC", "#F8E199", "#FFC6C6" ] }, "connections": [ { "id": "111113000000106411", "source_screen": { "display_label": "Screen 2", "id": "111113000000106225" }, "target_screen": { "display_label": "Screen 3", "id": "111113000000106227" } }, { "id": "111113000000106413", "source_screen": { "display_label": "Screen 1", "id": "111113000000106223" }, "target_screen": { "display_label": "Screen 2", "id": "111113000000106225" } } ], "nodes": [ { "pos_x": 637, "pos_y": 108, "screen": { "display_label": "Screen 1", "id": "111113000000106223" }, "start_node": true }, { "pos_x": 957, "pos_y": 218, "screen": { "display_label": "Screen 2", "id": "111113000000106225" }, "start_node": false }, { "pos_x": 637, "pos_y": 328, "screen": { "display_label": "Screen 3", "id": "111113000000106227" }, "start_node": false } ] }, "id": "111113000000003656", "layout": { "display_label": "Standard", "id": "111113000000003656", "name": "Standard" }, "screens": [ { "api_name": "Screen_1", "conditional_rules": [ { "actions": [ { "field": { "api_name": "Twitter", "id": "111113000000004632" }, "id": "111113000000106351", "type": "set_mandatory" } ], "criteria": { "comparator": "not_equal", "field": { "api_name": "Skype_ID", "id": "111113000000004606" }, "type": "value", "value": "${EMPTY}" }, "execute_on": "create_edit", "query_id": "111113000000106338" } ], "display_label": "Screen 1", "id": "111113000000106223", "segments": [ { "column_count": 2, "content": "Hi ${!Contacts.Last_Name} \nWelcome to Screen 1", "display_label": "Title of Screen 1", "id": "111113000000106234", "name": "Text_1", "sequence_number": 1, "type": "text_label" }, { "column_count": 2, "display_label": "Contact Information", "elements": [ { "resource": { "id": "111113000000004622", "name": "Salutation" }, "sequence_number": 0, "type": "field" }, { "resource": { "id": "111113000000004564", "name": "Owner" }, "sequence_number": 1, "type": "field" }, { "resource": { "id": "111113000000004566", "name": "Lead_Source" }, "sequence_number": 2, "type": "field" }, { "resource": { "id": "111113000000004568", "name": "First_Name" }, "sequence_number": 3, "type": "field" }, { "resource": { "id": "111113000000004570", "name": "Last_Name" }, "sequence_number": 4, "type": "field" }, { "resource": { "id": "111113000000004574", "name": "Account_Name" }, "sequence_number": 5, "type": "field" }, { "resource": { "id": "111113000000004576", "name": "Vendor_Name" }, "sequence_number": 6, "type": "field" }, { "resource": { "id": "111113000000004578", "name": "Email" }, "sequence_number": 7, "type": "field" }, { "resource": { "id": "111113000000004582", "name": "Title" }, "sequence_number": 8, "type": "field" }, { "resource": { "id": "111113000000004584", "name": "Department" }, "sequence_number": 9, "type": "field" }, { "resource": { "id": "111113000000004586", "name": "Phone" }, "sequence_number": 10, "type": "field" }, { "resource": { "id": "111113000000004588", "name": "Home_Phone" }, "sequence_number": 11, "type": "field" }, { "resource": { "id": "111113000000004590", "name": "Other_Phone" }, "sequence_number": 12, "type": "field" }, { "resource": { "id": "111113000000004592", "name": "Fax" }, "sequence_number": 13, "type": "field" }, { "resource": { "id": "111113000000004594", "name": "Mobile" }, "sequence_number": 14, "type": "field" }, { "resource": { "id": "111113000000004596", "name": "Date_of_Birth" }, "sequence_number": 15, "type": "field" }, { "resource": { "id": "111113000000004598", "name": "Assistant" }, "sequence_number": 16, "type": "field" }, { "resource": { "id": "111113000000004600", "name": "Asst_Phone" }, "sequence_number": 17, "type": "field" }, { "resource": { "id": "111113000000004602", "name": "Reporting_To" }, "sequence_number": 18, "type": "field" }, { "resource": { "id": "111113000000004604", "name": "Email_Opt_Out" }, "sequence_number": 19, "type": "field" }, { "resource": { "id": "111113000000004606", "name": "Skype_ID" }, "sequence_number": 20, "type": "field" }, { "resource": { "id": "111113000000004624", "name": "Secondary_Email" }, "sequence_number": 21, "type": "field" }, { "resource": { "id": "111113000000004632", "name": "Twitter" }, "sequence_number": 22, "type": "field" } ], "id": "111113000000106232", "sequence_number": 2, "type": "composite" }, { "buttons": [ { "background_color": "#00A3F3", "category": "wizard_button", "color": "#fff", "display_label": "Next", "id": "111113000000106258", "name": "WB_Next", "sequence_number": 1, "shape": "capsule", "target_screen": { "id": "111113000000106225", "name": "Screen 2" }, "type": "transition", "visibility": "show" } ], "column_count": 2, "display_label": "Dummy", "id": "111113000000106236", "sequence_number": 3, "type": "buttons" } ] }, { "api_name": "Screen_3", "display_label": "Screen 3", "id": "111113000000106227", "segments": [ { "column_count": 2, "display_label": "Description Information", "elements": [ { "resource": { "id": "111113000000004686", "name": "Description" }, "sequence_number": 1, "type": "field" } ], "id": "111113000000106242", "sequence_number": 1, "type": "composite" }, { "buttons": [ { "background_color": "#00A3F3", "category": "wizard_button", "color": "#fff", "display_label": "Save", "id": "111113000000106399", "name": "WB_Save", "sequence_number": 1, "shape": "capsule", "type": "save", "visibility": "show" } ], "column_count": 2, "display_label": "Dummy", "id": "111113000000106244", "sequence_number": 2, "type": "buttons" } ] }, { "api_name": "Screen_2", "display_label": "Screen 2", "id": "111113000000106225", "segments": [ { "column_count": 2, "display_label": "Address Information", "elements": [ { "resource": { "id": "111113000000004666", "name": "Mailing_Street" }, "sequence_number": 1, "type": "field" }, { "resource": { "id": "111113000000004668", "name": "Other_Street" }, "sequence_number": 2, "type": "field" }, { "resource": { "id": "111113000000004670", "name": "Mailing_City" }, "sequence_number": 3, "type": "field" }, { "resource": { "id": "111113000000004672", "name": "Other_City" }, "sequence_number": 4, "type": "field" }, { "resource": { "id": "111113000000004674", "name": "Mailing_State" }, "sequence_number": 5, "type": "field" }, { "resource": { "id": "111113000000004676", "name": "Other_State" }, "sequence_number": 6, "type": "field" }, { "resource": { "id": "111113000000004678", "name": "Mailing_Zip" }, "sequence_number": 7, "type": "field" }, { "resource": { "id": "111113000000004680", "name": "Other_Zip" }, "sequence_number": 8, "type": "field" }, { "resource": { "id": "111113000000004682", "name": "Mailing_Country" }, "sequence_number": 9, "type": "field" }, { "resource": { "id": "111113000000004684", "name": "Other_Country" }, "sequence_number": 10, "type": "field" } ], "id": "111113000000106238", "sequence_number": 1, "type": "composite" }, { "buttons": [ { "background_color": "#00A3F3", "category": "wizard_button", "color": "#fff", "display_label": "Next", "id": "111113000000106358", "name": "WB_Next_1", "sequence_number": 1, "shape": "capsule", "target_screen": { "id": "111113000000106227", "name": "Screen 3" }, "type": "transition", "visibility": "show" } ], "column_count": 2, "display_label": "Dummy", "id": "111113000000106240", "sequence_number": 2, "type": "buttons" } ] } ] } ], "created_by": { "id": "111113000000057672", "name": "Drogon Nine" }, "created_time": "2025-11-28T12:15:16+05:30", "display_label": "Harry Potter", "id": "111113000000106221", "modified_by": { "id": "111113000000057672", "name": "Drogon Nine" }, "modified_time": "2025-11-28T12:15:16+05:30", "module": { "api_name": "Contacts", "id": "111113000000002652" }, "name": "Harry Potter", "portal_user_types": null, "profiles": [ { "display_label": "Administrator", "id": "111113000000000501", "name": "Administrator" } ], "source": "crm" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body containing the wizard configuration for the requested identifier.", "properties": { "wizards": { "description": "Represents the list of wizards in the response. For this operation, the array contains exactly one wizard object corresponding to the requested identifier.", "items": { "additionalProperties": false, "description": "Represents a wizard object containing its complete configuration, including its associated module, active status, and the containers that define the multi-step screen flow.", "properties": { "active": { "description": "Indicates whether the wizard is currently active.\n\nPossible values:\ntrue - The wizard is active and available for use in the CRM module.\nfalse - The wizard is inactive and not available for use.", "type": "boolean" }, "containers": { "description": "Represents the list of containers associated with the wizard. Each container links a specific layout to the screens and segments that define the wizard flow for that layout.", "items": { "additionalProperties": false, "description": "Represents a container that associates a CRM layout with its corresponding screens and chart definition, establishing the navigation structure for one segment of the wizard flow.", "properties": { "chart_data": { "additionalProperties": false, "description": "Represents the metadata that describes the visual flow between screens in the wizard canvas, including the color palette applied to the canvas and the connections between screens.", "properties": { "color_palette": { "additionalProperties": false, "description": "Represents the color palette applied to the wizard canvas, defining the colors used for visual elements such as button backgrounds.", "properties": { "button_background": { "description": "Represents the list of hex color values applied to button backgrounds in the wizard canvas.", "items": { "description": "Represents a hex color code that defines a button background color in the wizard canvas (for example, '#FFFFFF').", "maxLength": 7, "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "connections": { "description": "Represents the list of connections between source and target screens that define the navigation flow within the wizard.", "items": { "additionalProperties": false, "description": "Represents a single directed connection in the wizard flow, linking a source screen to a target screen to define the transition path between them.", "properties": { "id": { "description": "Represents the unique identifier of the connection between the source screen and the target screen in the wizard flow.", "format": "int64", "maxLength": 19, "type": "string" }, "source_screen": { "additionalProperties": false, "description": "Represents the screen from which the connection originates in the wizard flow, identifying the starting point of the transition.", "properties": { "display_label": { "description": "Represents the display label of the source screen as it appears in the wizard canvas.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the source screen from which the connection originates.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "display_label", "id" ], "type": "object" }, "target_screen": { "additionalProperties": false, "description": "Represents the screen to which the connection points in the wizard flow, identifying the destination of the transition.", "properties": { "display_label": { "description": "Represents the display label of the target screen as it appears in the wizard canvas.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the target screen to which the connection points.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "display_label", "id" ], "type": "object" } }, "required": [ "source_screen", "target_screen", "id" ], "type": "object" }, "maxItems": 75, "type": [ "array", "null" ] }, "nodes": { "description": "Represents the list of visual nodes on the wizard canvas, where each node corresponds to a screen in the wizard flow.", "items": { "additionalProperties": false, "description": "Represents a single visual node on the wizard canvas, corresponding to a screen in the wizard flow and capturing its position and identity within the chart layout.", "properties": { "pos_x": { "description": "Represents the X-coordinate position, in pixels, of the node on the wizard canvas.", "format": "int32", "type": "integer" }, "pos_y": { "description": "Represents the Y-coordinate position, in pixels, of the node on the wizard canvas.", "format": "int32", "type": "integer" }, "screen": { "additionalProperties": false, "description": "Represents the wizard screen associated with this node in the flow chart.", "properties": { "display_label": { "description": "Represents the display label of the screen associated with the node.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the screen associated with the node.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "display_label", "id" ], "type": "object" }, "start_node": { "description": "Indicates whether this node is the starting screen in the wizard flow.\nPossible values:\ntrue - The node is the starting screen of the wizard flow.\nfalse - The node is not the starting screen of the wizard flow.", "type": "boolean" } }, "required": [ "pos_x", "pos_y", "start_node", "screen" ], "type": "object" }, "maxItems": 75, "type": "array" } }, "required": [ "nodes", "connections" ], "type": "object" }, "id": { "description": "Represents the unique identifier of the container layout.", "format": "int64", "maxLength": 19, "type": "string" }, "layout": { "additionalProperties": false, "description": "Represents the layout from which wizard fields are sourced for this container.", "properties": { "display_label": { "description": "Represents the display label of the layout, translated into the user's locale where available.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the layout. Refer to the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) endpoint for details.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the layout associated with the wizard container.", "maxLength": 50, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" }, "screens": { "description": "Represents the list of screens included in the wizard container. Each screen groups one or more segments presented to the user during the wizard flow.", "items": { "additionalProperties": false, "description": "Represents a screen definition within the wizard container that organizes segments and governs the data-entry step presented to the user.", "properties": { "api_name": { "description": "Represents the API name of the screen within the wizard container.", "maxLength": 255, "type": "string" }, "conditional_rules": { "description": "Represents the list of conditional rules evaluated on the screen. Returns null when no conditional rules are configured for the screen.", "items": { "additionalProperties": false, "description": "Represents a conditional rule configured for the screen, defining the criteria and the corresponding actions to execute when the criteria are satisfied.", "properties": { "actions": { "description": "Represents the list of actions executed when the conditional rule criteria are satisfied on the screen.", "items": { "additionalProperties": false, "description": "Represents an action configuration that is executed when the associated conditional rule criteria are met on the screen.", "properties": { "exempted_portal_user_types": { "description": "Represents the list of client portal user types that are exempted from the conditional rule action on the screen.", "items": { "additionalProperties": false, "description": "Represents a client portal user type that is exempted from the conditional rule action on the screen.", "properties": { "id": { "description": "Represents the unique numeric identifier of the portal user type that is exempted from the conditional rule action.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the portal user type that is exempted from the conditional rule action.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 500, "type": "array" }, "exempted_profiles": { "description": "Represents the list of CRM profiles that are exempted from the conditional rule action and will not have the action applied to them.", "items": { "additionalProperties": false, "description": "Represents a CRM profile that is exempted from the conditional rule action and will not have the action applied to it.", "properties": { "id": { "description": "Represents the unique numeric identifier of the CRM profile that is exempted from the conditional rule action.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the display name of the CRM profile that is exempted from the conditional rule action.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 500, "type": "array" }, "field": { "additionalProperties": false, "description": "Represents the wizard screen field to which the conditional rule action is applied. This object is present only for field-targeting action types.", "properties": { "api_name": { "description": "Represents the API name of the wizard screen field on which the conditional rule action is executed.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique numeric identifier of the wizard screen field on which the conditional rule action is executed.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "id": { "description": "Represents the unique numeric identifier of the conditional rule action.", "format": "int64", "maxLength": 19, "type": "string" }, "segment": { "additionalProperties": false, "description": "Represents the segment on which the action is applied. Present only for segment-targeting actions.", "properties": { "display_label": { "description": "Represents the display label of the segment on which the action is executed.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the segment on which the action is executed.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "type": { "description": "Indicates the type of action to perform on the targeted field or segment. Possible values include set_mandatory, make_read_only, hide, and show.", "maxLength": 50, "type": "string" }, "value": { "description": "Represents the value applied to the field by the action. Present only for field-value actions.", "maxLength": 2000, "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "maxItems": 50, "type": "array" }, "criteria": { "additionalProperties": false, "description": "Represents the criteria expression evaluated to determine whether the conditional rule actions are triggered.", "properties": { "comparator": { "description": "Indicates the comparator used to evaluate the criteria expression. Possible values include not_equal, equal, is_empty, and is_not_empty.", "maxLength": 50, "type": "string" }, "field": { "additionalProperties": false, "description": "Represents the field against which the criteria expression is evaluated.", "properties": { "api_name": { "description": "Represents the API name of the field used in the criteria expression.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the field used in the criteria expression.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "type": { "description": "Represents the type of the criteria applied in the conditional rule evaluation, for example 'value'.", "maxLength": 50, "type": "string" }, "value": { "description": "Represents the value used in the criteria comparison during conditional rule evaluation, for example ''.", "maxLength": 255, "type": "string" } }, "required": [ "comparator", "field", "type", "value" ], "type": [ "object", "null" ] }, "execute_on": { "description": "Represents the event on which the conditional rule executes, for example 'create_edit'.", "enum": [ "create_edit", "create", "edit" ], "maxLength": 50, "type": "string" }, "query_id": { "description": "Represents the unique numeric identifier of the conditional rule.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "query_id", "execute_on", "actions" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "display_label": { "description": "Display label of the screen.", "maxLength": 255, "type": "string" }, "id": { "description": "Numeric unique identifier of the screen.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$id": "ScreenId" }, "segments": { "description": "Represents the segments that group fields, buttons, and other elements displayed on the screen.", "items": { "additionalProperties": false, "description": "Represents a segment contained within a screen, grouping related fields, buttons, and other interface elements.", "properties": { "buttons": { "description": "Represents the buttons displayed inside this segment. Present for segments of the buttons type.", "items": { "additionalProperties": false, "description": "Represents a button configuration entry within the segment, defining the button behavior and presentation.", "properties": { "background_color": { "description": "Represents the background color of the button, typically expressed as a hexadecimal color value.", "maxLength": 7, "type": "string" }, "category": { "description": "Represents the category of the button, used to classify or group the button by its functional purpose.", "enum": [ "wizard_button", "custom_button" ], "type": "string" }, "color": { "description": "Represents the text color of the button, typically expressed as a hexadecimal color value.", "maxLength": 7, "type": "string" }, "criteria": { "additionalProperties": false, "description": "Represents the criteria controlling the visibility or behavior of the button, defining the conditions under which the button is active or displayed.", "properties": { "comparator": { "description": "Represents the comparator used in the criteria to evaluate the relationship between the field and the value.", "maxLength": 50, "type": "string" }, "field": { "additionalProperties": true, "description": "Represents the field against which the criteria is evaluated when determining the visibility or behavior of the button.", "type": "object" }, "type": { "description": "Represents the type of criteria applied to the button, indicating the nature of the condition being evaluated.", "maxLength": 50, "type": "string" }, "value": { "description": "Represents the value used in the comparison when evaluating the criteria associated with the button.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "display_label": { "description": "Represents the display label of the button, shown to the user as the visible text or title of the button.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the button.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$id": "ButtonId" }, "message": { "additionalProperties": false, "description": "Represents the message configuration used when this button performs a save or summary action.", "properties": { "content": { "description": "Body content of the acknowledgement message.", "maxLength": 2000, "type": "string" }, "title": { "description": "Title of the acknowledgement message.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "name": { "description": "Represents the name of the button.", "maxLength": 255, "type": "string" }, "profiles": { "description": "Represents the profiles for which this button is available.", "items": { "additionalProperties": false, "description": "Profile associated with this button", "properties": { "display_label": { "description": "Display label of the profile.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the profile.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Internal name of the profile.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 40, "type": [ "array", "null" ] }, "resource": { "additionalProperties": false, "description": "Resource associated with the button, if any.", "properties": { "id": { "description": "Represents the unique numeric identifier of the resource associated with the button.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the resource associated with the button.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "sequence_number": { "description": "Represents the sequential position of the button within its parent segment, determining the display order.", "format": "int32", "type": "integer" }, "shape": { "description": "Represents the visual shape of the button as rendered in the wizard interface.", "enum": [ "square", "capsule", "round" ], "type": "string" }, "show_summary_on": { "description": "Indicates the condition or event upon which a summary screen is displayed, when a summary screen is configured for the button.", "enum": [ "create", "edit", "create_and_edit", null ], "maxLength": 50, "type": [ "string", "null" ] }, "target_screen": { "additionalProperties": false, "description": "Represents the screen to which the wizard navigates when this button is activated. Returns null for buttons that perform a save operation without navigation.", "properties": { "id": { "description": "Represents the unique numeric identifier of the target screen to which the button navigates.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the target screen to which the button navigates.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "transition": { "additionalProperties": false, "description": "Represents the automation transition configuration applied when this button is activated. Returns null when no transition is configured.", "properties": { "id": { "description": "Represents the unique numeric identifier of the automation transition associated with the button.", "format": "int64", "maxLength": 19, "type": "string" } }, "type": [ "object", "null" ] }, "type": { "description": "Represents the type of action performed by the button within the wizard segment.", "enum": [ "save", "transition" ], "type": [ "string", "null" ] }, "visibility": { "description": "Indicates the visibility behavior of the button, controlling whether the button is displayed or hidden within the wizard segment.", "enum": [ "hide", "disable", "show" ], "type": "string" } }, "required": [ "color", "shape", "visibility", "type", "sequence_number", "display_label", "background_color", "name", "id", "category" ], "type": "object" }, "maxItems": 50, "minItems": 1, "type": "array" }, "column_count": { "description": "Represents the number of columns used to arrange elements within the segment layout.", "format": "int32", "type": "integer" }, "content": { "description": "Represents the static content of the segment, applicable to segments of the text_label type.", "maxLength": 2000, "type": "string" }, "display_label": { "description": "Display label of the segment.", "maxLength": 255, "type": "string" }, "elements": { "description": "Represents the collection of field elements contained within the segment, present when the segment is of a composite type.", "items": { "additionalProperties": false, "description": "Represents an individual field element contained within a segment.", "properties": { "resource": { "additionalProperties": false, "description": "Represents the field resource referenced by this element, linking the element to its associated data field definition.", "properties": { "id": { "description": "Represents the unique identifier of the field resource associated with this element.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the API name of the field resource associated with this element.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "sequence_number": { "description": "Represents the position of the element within the segment, determining the display order.", "format": "int32", "type": "integer" }, "type": { "description": "Represents the type of element within the segment, for example 'field'.", "enum": [ "field", "query_component" ], "maxLength": 50, "type": "string" } }, "required": [ "sequence_number", "type", "resource" ], "type": "object" }, "maxItems": 200, "type": "array" }, "id": { "description": "Represents the unique identifier of the segment.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$id": "SegmentId" }, "name": { "description": "Represents the name of the segment. Present for text_label and buttons segments.", "maxLength": 255, "type": "string" }, "sequence_number": { "description": "Represents the sequential position of the segment within the screen, determining its display order.", "format": "int32", "type": "integer" }, "tab_traversal": { "description": "Represents the traversal order for elements within the segment, used for keyboard navigation.", "enum": [ "left_to_right", "top_to_bottom" ], "type": "string" }, "type": { "description": "Represents the type of the segment, for example 'composite', 'text_label', or 'buttons'.", "enum": [ "composite", "fields", "subforms", "text_label", "widget", "buttons" ], "maxLength": 50, "type": "string" }, "widget": { "additionalProperties": false, "description": "Represents the widget resource linked to this segment. Required when the segment type is 'widget'.", "properties": { "id": { "description": "Represents the unique identifier of the widget linked to the segment.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the widget linked to the segment.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "sequence_number", "display_label", "column_count", "id", "type" ], "type": "object" }, "maxItems": 75, "type": "array" } }, "required": [ "display_label", "api_name", "id", "segments" ], "type": "object" }, "maxItems": 75, "type": "array" } }, "required": [ "layout", "chart_data", "screens", "id" ], "type": "object" }, "maxItems": 7, "type": "array" }, "created_by": { "additionalProperties": false, "description": "Represents the user who created the wizard.", "properties": { "id": { "description": "Represents the unique identifier of the user who created the wizard.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the user who created the wizard.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "created_time": { "description": "Represents the timestamp when Zoho CRM created the wizard.", "format": "date-time", "type": "string" }, "display_label": { "description": "Represents the display label of the wizard, translated into the available locale where applicable.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the wizard.", "format": "int64", "maxLength": 19, "type": "string", "x-zs-$id": "WizardDetailId" }, "modified_by": { "additionalProperties": false, "description": "Represents the user who last modified the wizard.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified the wizard.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the user who last modified the wizard.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "modified_time": { "description": "Represents the timestamp when Zoho CRM last modified the wizard.", "format": "date-time", "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the Zoho CRM module associated with the wizard.", "properties": { "api_name": { "description": "Represents the API name of the Zoho CRM module associated with the wizard.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the Zoho CRM module associated with the wizard.", "format": "int64", "maxLength": 19, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Represents the API name of the wizard.", "maxLength": 30, "type": "string" }, "portal_user_types": { "description": "Represents the client portal user types for which the wizard is available.", "items": { "additionalProperties": false, "description": "Portal user type associated with this wizard.", "properties": { "display_label": { "description": "Represents the display label of the portal user type.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the portal user type.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the portal user type.", "maxLength": 255, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "profiles": { "description": "Represents the Zoho CRM profiles for which the wizard is available.", "items": { "additionalProperties": false, "description": "Represents a CRM profile associated with the wizard.", "properties": { "display_label": { "description": "Represents the display label of the profile, translated into the available locale where applicable.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the profile.", "format": "int64", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the profile.", "maxLength": 255, "type": "string" } }, "required": [ "display_label", "name", "id" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "source": { "description": "Indicates the source that originated the wizard.", "enum": [ "crm", "platform_plugin", "marketplace_plugin" ], "maxLength": 50, "type": "string" } }, "required": [ "created_time", "modified_time", "display_label", "portal_user_types", "module", "name", "modified_by", "profiles", "active", "containers", "id", "created_by" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "wizards" ], "type": "object", "x-zs-$id": "GetWizardDetailResponse" } } }, "description": "Returns the detailed configuration of the specified wizard, including its containers, screens, segments, buttons, conditional rules, and associated metadata." }, "204": { "description": "The request succeeded. No content returns in the response body." }, "400": { "content": { "application/json": { "examples": { "ExpectedParameterMissing": { "description": "Shows a 400 error response when one of the expected layout parameters is missing from the request.", "summary": "One of the expected layout parameters is missing.", "value": { "code": "EXPECTED_PARAM_MISSING", "details": { "param_names": [ "layout_rid", "layout_id" ] }, "message": "One of the expected parameter is missing", "status": "error" } }, "InvalidModule": { "description": "Shows a 400 error response when the module name provided is not valid.", "summary": "The module specified is invalid.", "value": { "code": "INVALID_MODULE", "details": {}, "message": "The module name seems to be invalid", "status": "error" } }, "MissingParameter": { "description": "Shows a 400 error response when the required module parameter is missing from the request.", "summary": "The required module parameter was not found.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "api_name": "module" }, "message": "The parameter 'module' is required.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when a required parameter is missing in the request.", "properties": { "code": { "description": "Represents the error code returned when a required parameter is missing.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the missing parameter that caused the error.", "properties": { "api_name": { "description": "Represents the API name of the missing parameter that caused the validation error.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Represents the error message returned when a required parameter is missing.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "WizardsDetailRequiredParamMissingError" }, { "additionalProperties": false, "description": "Represents the error response returned when one of the expected layout parameters is missing from the request.", "properties": { "code": { "description": "Represents the error code returned when a required query parameter is missing.", "enum": [ "EXPECTED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the missing expected parameters.", "properties": { "param_names": { "description": "Represents the list of expected parameter names that are missing from the request.", "items": { "description": "Represents the name of an expected query parameter that is missing from the request.", "maxLength": 255, "type": "string" }, "maxItems": 50, "minItems": 1, "type": "array" } }, "required": [ "param_names" ], "type": "object" }, "message": { "description": "Represents the error message returned when expected parameters are missing from the request.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "WizardsDetailExpectedParamMissingError" }, { "additionalProperties": false, "description": "Represents the error response returned when the module name or query parameters are invalid.", "properties": { "code": { "description": "Represents the error code returned when the module specified in the request is invalid.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error. Returns an empty object when no additional details are available.", "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "WizardsDetailInvalidModuleError" }, { "additionalProperties": false, "description": "Represents the error response returned when the wizard identifier is invalid.", "properties": { "code": { "description": "Represents the error code returned when the wizard identifier in the request is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid field that caused the validation error.", "properties": { "api_name": { "description": "Represents the API name of the invalid field that caused the validation error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path pointing to the invalid field in the request.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "WizardsDetailInvalidDataError" } ], "description": "Represents the error response returned when the request contains invalid or missing parameters.", "x-zs-$id": "WizardsDetailGetErrorResponses" } } }, "description": "The request was malformed or contained invalid parameters.\n**Resolution:** The request URL and parameters must use valid values. Refer to the API documentation for the required format." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows a 401 error response when the access token provided is invalid or has expired.", "summary": "OAuth token is invalid or expired.", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "invalid oauth token", "status": "error" } }, "OauthScopeMismatch": { "description": "Shows a 401 error response when the access token does not include the ZohoCRM.settings.wizards.READ scope.", "summary": "OAuth token lacks ZohoCRM.settings.wizards.READ scope.", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "invalid oauth scope to access this URL", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when the OAuth access token does not include the required scope.", "properties": { "code": { "description": "Represents the error code returned when the OAuth access token does not include the required scope.", "enum": [ "OAUTH_SCOPE_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the authentication error. Returns an empty object when no additional details are available.", "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetWizardOauthScopeMismatchError" }, { "additionalProperties": false, "description": "Represents the error response returned when the OAuth access token is invalid or has expired.", "properties": { "code": { "description": "Represents the error code returned when the OAuth access token is invalid or has expired.", "enum": [ "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the authentication error. Returns an empty object when no additional details are available.", "type": "object" }, "message": { "description": "Represents the error message describing the authentication failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetWizardInvalidTokenError" } ], "description": "Represents the error response returned when authentication credentials are missing or invalid.", "x-zs-$id": "GetWizardUnauthorizedErrorResponse" } } }, "description": "Authentication credentials are missing or invalid.\n**Resolution:** A new access token must be generated with the required scope for this API." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows a 403 error response when the user's profile does not have permission to read wizard details.", "summary": "User lacks permission to read wizards.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Zoho CRM: Settings Permission" ] }, "message": "Permission denied to read wizards", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user lacks the required permission to perform the operation.", "properties": { "code": { "description": "Represents the error code returned when the user does not have permission to perform the operation.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the permissions required to perform the operation.", "properties": { "permissions": { "description": "Represents the list of permissions required to access this resource.", "items": { "description": "Represents the name of a permission required to access this resource.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission denial.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetWizardForbiddenError" } } }, "description": "Permission denied to retrieve wizard details.\n**Resolution:** The Zoho CRM administrator must grant the required permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows a 404 error response when the request URL does not match a valid endpoint pattern.", "summary": "Invalid URL pattern or wizard identifier.", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when the URL pattern is invalid or the wizard identifier does not exist.", "properties": { "code": { "description": "Represents the error code returned when the URL pattern is invalid or the requested resource does not exist.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional information about the error, if available.", "type": "object" }, "message": { "description": "Represents the error message explaining why the requested resource was not found.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the request, indicating that the request has failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "GetWizardErrorResponse404" } ], "description": "Represents the error response returned when the requested wizard resource is not found.", "x-zs-$id": "GetWizardErrorResponses404" } } }, "description": "The requested wizard resource was not found.\n**Resolution:** The wizard ID and layout ID in the request must correspond to existing resources in the Zoho CRM organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.wizards.READ" ] } ], "summary": "Get wizard details", "tags": [ "wizards" ], "x-zoho-document": "wizards" } }, "/crm/v8/settings/zia/data_enrichment": { "get": { "description": "Use this API to get the details of configuration for data enrichment. This API gives you the mapping of the enrich fields with their corresponding CRM fields for enriching data. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names for filtering or reference.", "operationId": "getZiaEnrichmentConfiguration", "responses": { "200": { "content": { "application/json": { "examples": { "Example": { "description": "Returns an array of data enrichment configurations for Contacts, Accounts, and Leads modules with both personal and organization enrichment types. Each configuration includes field mappings between Zia enrichment fields and CRM fields, along with status and metadata.", "summary": "Successful retrieval of data enrichment configurations", "value": { "data_enrichment": [ { "created_by": { "id": "111113000000053889", "name": "Krishna Prakash" }, "created_time": "2024-04-15T10:01:22+05:30", "id": "111113000000063801", "input_data_field_mapping": [ { "crm_field": { "api_name": "Email", "id": "111113000000004139", "name": "Email" }, "enrich_field": { "display_label": "Email", "name": "email" } }, { "crm_field": null, "enrich_field": { "display_label": "Website", "name": "org_website" } }, { "crm_field": null, "enrich_field": { "display_label": "Organization Name", "name": "org_name" } }, { "crm_field": null, "enrich_field": { "display_label": "facebook", "name": "facebook" } }, { "crm_field": null, "enrich_field": { "display_label": "X", "name": "twitter" } }, { "crm_field": null, "enrich_field": { "display_label": "LinkedIn", "name": "linkedin" } } ], "modified_by": { "id": "111113000000053889", "name": "Krishna Prakash" }, "modified_time": "2024-04-15T10:01:22+05:30", "module": { "api_name": "Contacts", "id": "111113000000002411" }, "status": true, "type": "personal" }, { "created_by": { "id": "111113000000053889", "name": "Krishna Prakash" }, "created_time": "2024-04-15T10:01:38+05:30", "id": "111113000000063807", "input_data_field_mapping": [ { "crm_field": null, "enrich_field": { "display_label": "Email", "name": "email" } }, { "crm_field": { "api_name": "Website", "id": "111113000000004033", "name": "Website" }, "enrich_field": { "display_label": "Website", "name": "org_website" } }, { "crm_field": null, "enrich_field": { "display_label": "Organization Name", "name": "org_name" } }, { "crm_field": null, "enrich_field": { "display_label": "facebook", "name": "facebook" } }, { "crm_field": null, "enrich_field": { "display_label": "X", "name": "twitter" } }, { "crm_field": null, "enrich_field": { "display_label": "LinkedIn", "name": "linkedin" } } ], "modified_by": { "id": "111113000000053889", "name": "Krishna Prakash" }, "modified_time": "2024-04-15T10:01:38+05:30", "module": { "api_name": "Accounts", "id": "111113000000002413" }, "status": true, "type": "personal" }, { "created_by": { "id": "111113000000053889", "name": "Krishna Prakash" }, "created_time": "2024-04-15T13:07:01+05:30", "id": "111113000000072003", "input_data_field_mapping": [ { "crm_field": { "api_name": "Company", "id": "111113000000004369", "name": "Company" }, "enrich_field": { "display_label": "Organization Name", "name": "org_name" } }, { "crm_field": { "api_name": "Email", "id": "111113000000004379", "name": "Email" }, "enrich_field": { "display_label": "Email", "name": "email" } }, { "crm_field": { "api_name": "Website", "id": "111113000000004387", "name": "Website" }, "enrich_field": { "display_label": "Website", "name": "org_website" } } ], "modified_by": { "id": "111113000000053889", "name": "Krishna Prakash" }, "modified_time": "2024-04-15T13:07:01+05:30", "module": { "api_name": "Leads", "id": "111113000000002409" }, "status": true, "type": "organization" } ] } } }, "schema": { "additionalProperties": false, "description": "Data enrichment configurations fetched successfully.", "properties": { "data_enrichment": { "description": "Array of data enrichment configurations.", "items": { "additionalProperties": false, "description": "Enrichment configuration item for a single module.", "properties": { "created_by": { "additionalProperties": false, "description": "User who created the enrichment configuration.", "properties": { "id": { "description": "Unique identifier of the user who created the configuration.", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the user who created the configuration.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "created_time": { "description": "Timestamp when the configuration was created.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the enrichment configuration.", "maxLength": 19, "type": "string" }, "input_data_field_mapping": { "$ref": "#/components/schemas/FieldMappingForRead" }, "modified_by": { "additionalProperties": false, "description": "User who last modified the enrichment configuration.", "properties": { "id": { "description": "Unique identifier of the user who last modified the configuration.", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the user who last modified the configuration.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "modified_time": { "description": "Timestamp when the configuration was last modified.", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/Module" }, "status": { "description": "Whether the enrichment configuration is active.", "type": "boolean" }, "type": { "description": "Type of enrichment — 'personal' or 'organization'.", "maxLength": 255, "type": "string" } }, "required": [ "id", "type", "module", "status", "input_data_field_mapping", "created_time", "created_by", "modified_time", "modified_by" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "GetZiaEnrichmentConfigurationsSuccessResponse" } } }, "description": "Enrichment configurations fetched successfully." }, "204": { "description": "No Content — No enrichment configurations found." }, "400": { "content": { "application/json": { "examples": { "Example": { "description": "Returned when the Data Enrichment feature is not enabled in the organization. Enable the feature in Zoho CRM settings before using this API.", "summary": "Feature not enabled error", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Data Enrichment feature not enabled", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the feature is not enabled or not supported.", "properties": { "code": { "description": "Error code indicating the feature is not enabled or not supported.", "enum": [ "FEATURE_NOT_ENABLED", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details — empty for this error type.", "properties": {}, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetZiaEnrichmentConfigurationsFeatureNotEnabledorNotSupported" } } }, "description": "Bad Request. Returned when the feature is not enabled or not supported." }, "403": { "content": { "application/json": { "examples": { "Example": { "description": "Returned when the user lacks the required permissions to access Data Enrichment configurations. The required permissions are listed in the details.permissions array.", "summary": "No permission to access feature", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Data_Enrichment", "Crm_Implied_View_Data_Enrichment" ] }, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the user lacks permission to access this feature.", "properties": { "code": { "description": "Error code — 'NO_PERMISSION'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing permissions.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "Permission required to access this feature.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetZiaEnrichmentConfigurationsNoPermission" } } }, "description": "Permission error. Returned when the user lacks the necessary permissions to view enrichment configurations." } }, "security": [ { "OAuth2": [ "ZohoCRM.zia.enrichment.READ" ] } ], "summary": "Data Enrichment", "tags": [ "zia_enrichment" ], "x-zoho-document": "zia_enrichment" }, "post": { "description": "Creates Zia Enrichment Configurations for a specific module. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names, and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names.", "operationId": "createZiaEnrichmentConfigurations", "requestBody": { "content": { "application/json": { "examples": { "Example": { "value": { "data_enrichment": [ { "input_data_field_mapping": [ { "crm_field": { "api_name": "Email", "id": "917992000000000449" }, "enrich_field": { "name": "email" } } ], "module": { "api_name": "Contacts", "id": "917992000000000129" }, "output_data_field_mapping": [ { "crm_field": { "api_name": "Last_Name", "id": "917992000000000443" }, "enrich_field": { "name": "last_name" } }, { "crm_field": { "api_name": "Email", "id": "917992000000000449" }, "enrich_field": { "name": "primary_email" } }, { "crm_field": { "api_name": "Secondary_Email", "id": "917992000000026001" }, "enrich_field": { "name": "secondary_email" } }, { "crm_field": { "api_name": "Phone", "id": "917992000000000457" }, "enrich_field": { "name": "primary_contact" } }, { "crm_field": { "api_name": "Twitter", "id": "917992000000035003" }, "enrich_field": { "name": "social_media_twitter" } }, { "crm_field": { "api_name": "Other_State", "id": "917992000000000503" }, "enrich_field": { "name": "primary_address_info_state" } }, { "crm_field": { "api_name": "Other_City", "id": "917992000000000499" }, "enrich_field": { "name": "primary_address_info_city" } }, { "crm_field": { "api_name": "Other_Country", "id": "917992000000000511" }, "enrich_field": { "name": "primary_address_info_country" } }, { "crm_field": { "api_name": "First_Name", "id": "917992000000000441" }, "enrich_field": { "name": "first_name" } } ], "type": "personal" } ] } } }, "schema": { "additionalProperties": false, "description": "Request body schema for creating Zia Enrichment configurations.", "properties": { "data_enrichment": { "description": "Array of data enrichment configurations.", "items": { "additionalProperties": false, "description": "Configuration item for a single module's enrichment settings.", "properties": { "input_data_field_mapping": { "$ref": "#/components/schemas/FieldMappingForWrite" }, "module": { "$ref": "#/components/schemas/Module" }, "output_data_field_mapping": { "$ref": "#/components/schemas/FieldMappingForWrite" }, "type": { "description": "Type of enrichment — either 'personal' or 'organization'.", "maxLength": 255, "type": "string" } }, "required": [ "type", "module", "input_data_field_mapping", "output_data_field_mapping" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Example": { "value": { "data_enrichment": [ { "code": "SUCCESS", "details": { "created_by": { "id": "917992000000417001", "name": "Brendon Caster" }, "created_time": "2025-11-13T12:25:39+05:30", "id": "917992000008626025" }, "message": "Enrichment created successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Enrichment created successfully.", "properties": { "data_enrichment": { "description": "Array of creation results for each configuration.", "items": { "additionalProperties": false, "description": "Result item for a single enrichment configuration creation.", "properties": { "code": { "description": "Result code indicating the operation status.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the created enrichment configuration.", "properties": { "created_by": { "additionalProperties": false, "description": "User who created the enrichment configuration.", "properties": { "id": { "description": "Unique identifier of the user who created the configuration.", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the user who created the configuration.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "created_time": { "description": "Timestamp when the enrichment configuration was created.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the created enrichment configuration.", "maxLength": 19, "type": "string" } }, "required": [ "created_time", "id", "created_by" ], "type": "object" }, "message": { "description": "Human-readable message describing the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Overall status of the operation — 'success' or 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsSuccessResponse" } } }, "description": "Enrichment configuration created successfully." }, "400": { "content": { "application/json": { "examples": { "Example1": { "value": { "data_enrichment": [ { "code": "INVALID_DATA", "details": { "api_name": "output_data_field_mapping || input_data_field_mapping", "expected_data_type": "jsonarray", "json_path": "$.data_enrichment[0].(output_data_field_mapping || input_data_field_mapping)" }, "message": "Invalid data", "status": "error" } ] } }, "Example2": { "value": { "data_enrichment": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.data_enrichment[0].type", "supported_values": [ "organization", "personal" ] }, "message": "the given type seems to be invalid", "status": "error" } ] } }, "Example3": { "value": { "data_enrichment": [ { "code": "LIMIT_EXCEEDED", "details": { "limit": 50, "limit_due_to": [ { "api_name": "data_enrichment", "json_path": "$.data_enrichment" } ] }, "message": "data enrichment configurations limit exceeded", "status": "error" } ] } }, "Example4": { "value": { "data_enrichment": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.data_enrichment[0].input_data_field_mapping[0].crm_field.id" }, { "api_name": "api_name", "json_path": "$.data_enrichment[0].output_data_field_mapping[0].crm_field.api_name" } ] }, "message": "Crm field cannot be empty", "status": "error" } ] } }, "Example5": { "value": { "data_enrichment": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "api_name", "json_path": "$.data_enrichment[0].module.api_name" }, { "api_name": "id", "json_path": "$.data_enrichment[0].module.id" } ] }, "message": "Ambiguity while processing", "status": "error" } ] } }, "Example6": { "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Data Enrichment feature not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response when invalid data is provided.", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code identifying the type of validation failure.", "enum": [ "INVALID_DATA", "MANDATORY_NOT_FOUND", "NOT_ALLOWED", "NOT_SUPPORTED", "INVALID_MAPPING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the validation failure.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field in the request body.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsProvideInvalidData" }, { "additionalProperties": false, "description": "Error response when unsupported values are provided.", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code — 'INVALID_DATA'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the unsupported value.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field in the request body.", "maxLength": 255, "type": "string" }, "supported_values": { "description": "List of supported values for the field.", "items": { "description": "Supported value for the field.", "enum": [ "organization", "personal" ], "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsUnSupportedValues" }, { "additionalProperties": false, "description": "Error response when the maximum limit is exceeded.", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code — 'LIMIT_EXCEEDED'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the exceeded limit.", "properties": { "limit": { "description": "Maximum allowed limit.", "format": "int32", "type": "integer" }, "limit_due_to": { "description": "Fields that caused the limit to be exceeded.", "items": { "additionalProperties": false, "description": "Item indicating the limit cause.", "properties": { "api_name": { "description": "API name of the field that caused the limit.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field that caused the limit.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "limit", "limit_due_to" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsLimitExceeded" }, { "additionalProperties": false, "description": "Error response when expected fields are missing.", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code — 'EXPECTED_FIELD_MISSING'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing expected fields.", "properties": { "expected_fields": { "description": "List of expected fields that are missing.", "items": { "additionalProperties": false, "description": "Expected field item.", "properties": { "api_name": { "description": "API name of the expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the expected field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsExpectedFieldMissing" }, { "additionalProperties": false, "description": "Error response when ambiguity occurs during processing (e.g., mismatched module ID and API name).", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code — 'AMBIGUITY_DURING_PROCESSING'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the ambiguity.", "properties": { "ambiguity_due_to": { "description": "Fields that caused the ambiguity.", "items": { "additionalProperties": false, "description": "Item indicating the ambiguity cause.", "properties": { "api_name": { "description": "API name of the field causing ambiguity.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the field causing ambiguity.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsAmbiguityDuringProcessing" }, { "additionalProperties": false, "description": "Error response when the feature is not enabled or not supported.", "properties": { "code": { "description": "Error code indicating the feature is not enabled or not supported.", "enum": [ "FEATURE_NOT_ENABLED", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details — empty for this error type.", "properties": {}, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsFeatureNotEnabledOrNotSupported" } ], "description": "400 responses", "x-zs-$id": "CreateZiaEnrichmentConfigurationsBadResponses" } } }, "description": "Validation error. Returned when the request contains invalid data, missing mandatory fields, unsupported values, or exceeds limits." }, "403": { "content": { "application/json": { "examples": { "Example": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Data_Enrichment" ] }, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the user lacks permission to access this feature.", "properties": { "code": { "description": "Error code — 'NO_PERMISSION'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing permissions.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "Permission required to access this feature.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CreateZiaEnrichmentConfigurationsNoPermission" } } }, "description": "Permission error. Returned when the user lacks the necessary permissions to create enrichment configurations." } }, "security": [ { "OAuth2": [ "ZohoCRM.zia.enrichment.CREATE" ] } ], "summary": "Zia Data Enrichment Configuration", "tags": [ "zia_enrichment" ], "x-zoho-document": "zia_enrichment" } }, "/crm/v8/settings/zia/data_enrichment/{id}": { "delete": { "description": "Deletes a Zia Enrichment Configuration for a specific module by ID. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module ID.", "operationId": "deleteZiaEnrichmentConfiguration", "parameters": [ { "description": "Data Enrichment configuration ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the Data Enrichment configuration to delete.", "maxLength": 19, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Example": { "value": { "data_enrichment": [ { "code": "SUCCESS", "details": { "id": "5667964000001485102" }, "message": "enrichment deleted Successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Data enrichment deleted successfully.", "properties": { "data_enrichment": { "description": "Array of deletion results for each configuration.", "items": { "additionalProperties": false, "description": "Result item for a single enrichment configuration deletion.", "properties": { "code": { "description": "Result code — 'SUCCESS' for successful deletion.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the deleted configuration.", "properties": { "id": { "description": "Unique identifier of the deleted enrichment configuration.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Human-readable message describing the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Overall status of the operation — 'success' or 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "DeleteZiaEnrichmentConfigurationSuccessresponse" } } }, "description": "Enrichment configuration deleted successfully." }, "400": { "content": { "application/json": { "examples": { "Example1": { "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the enrichment id given seems to be invalid.", "status": "error" } }, "Example2": { "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Data Enrichment feature not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response when the path parameter is invalid.", "properties": { "code": { "description": "Error code — 'INVALID_DATA'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the invalid path parameter.", "properties": { "resource_path_index": { "description": "Index of the invalid resource path segment.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteZiaEnrichmentConfigurationPathParamAreInvalid" }, { "additionalProperties": false, "description": "Error response when the feature is not enabled or not supported.", "properties": { "code": { "description": "Error code indicating the feature is not enabled or not supported.", "enum": [ "FEATURE_NOT_ENABLED", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details — empty for this error type.", "properties": {}, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteZiaEnrichmentConfigurationFeatureNotEnabledOrNotSupported" } ], "description": "400 responses", "x-zs-$id": "DeleteZiaEnrichmentConfigurationBadresponses" } } }, "description": "Bad Request. Returned when the enrichment ID is invalid or the feature is not enabled." }, "403": { "content": { "application/json": { "examples": { "Example": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Data_Enrichment" ] }, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the user lacks permission to access this feature.", "properties": { "code": { "description": "Error code — 'NO_PERMISSION'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing permissions.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "Permission required to access this feature.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteZiaEnrichmentConfigurationNoPermission" } } }, "description": "Permission error. Returned when the user lacks the necessary permissions to delete enrichment configurations." } }, "security": [ { "OAuth2": [ "ZohoCRM.zia.enrichment.DELETE" ] } ], "summary": "Delete Zia Enrichment Configuration for a specific module", "tags": [ "zia_enrichment" ], "x-zoho-document": "zia_enrichment" }, "get": { "description": "Retrieves a specific Zia Enrichment Configuration by ID. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names, and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names for reference.", "operationId": "getSpecificZiaEnrichmentConfiguration", "parameters": [ { "description": "Data Enrichment configuration ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the Data Enrichment configuration to retrieve.", "maxLength": 19, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Example": { "value": { "data_enrichment": [ { "id": "917992000008626019", "input_data_field_mapping": [ { "crm_field": { "api_name": "Company", "id": "917992000000000555", "name": "Company" }, "enrich_field": { "display_label": "Organization Name", "name": "org_name" } }, { "crm_field": { "api_name": "Email", "id": "917992000000000563", "name": "Email" }, "enrich_field": { "display_label": "Email", "name": "email" } }, { "crm_field": { "api_name": "Website", "id": "917992000000000571", "name": "Website" }, "enrich_field": { "display_label": "Website", "name": "org_website" } } ], "modified_by": { "id": "917992000000417001", "name": "Brendon Caster" }, "modified_time": "2025-11-13T13:16:04+05:30", "module": { "api_name": "Leads", "id": "917992000000000125" }, "output_data_field_mapping": [ { "crm_field": { "api_name": "Company", "id": "917992000000000555", "name": "Company" }, "enrich_field": { "display_label": "Organization Name", "name": "name" } }, { "crm_field": { "api_name": "Email", "id": "917992000000000563", "name": "Email" }, "enrich_field": { "display_label": "Primary Email", "name": "primary_email" } }, { "crm_field": { "api_name": "Secondary_Email", "id": "917992000000026003", "name": "Secondary Email" }, "enrich_field": { "display_label": "Secondary Email", "name": "secondary_email" } }, { "crm_field": { "api_name": "Phone", "id": "917992000000000565", "name": "Phone" }, "enrich_field": { "display_label": "Primary Contact Number", "name": "primary_contact" } }, { "crm_field": null, "enrich_field": { "display_label": "Secondary Contact Number", "name": "secondary_contact" } }, { "crm_field": { "api_name": "Industry", "id": "917992000000000577", "name": "Industry" }, "enrich_field": { "display_label": "Industries", "name": "industries" } }, { "crm_field": { "api_name": "Skype_ID", "id": "917992000000000587", "name": "Skype ID" }, "enrich_field": { "display_label": "Skype", "name": "social_media_skype" } }, { "crm_field": null, "enrich_field": { "display_label": "Facebook", "name": "social_media_facebook" } }, { "crm_field": { "api_name": "Twitter", "id": "917992000000035001", "name": "Twitter" }, "enrich_field": { "display_label": "X", "name": "social_media_twitter" } }, { "crm_field": null, "enrich_field": { "display_label": "Other social media link", "name": "social_media_other" } }, { "crm_field": { "api_name": "Website", "id": "917992000000000571", "name": "Website" }, "enrich_field": { "display_label": "Website", "name": "website" } }, { "crm_field": { "api_name": "Description", "id": "917992000000000613", "name": "Description" }, "enrich_field": { "display_label": "About the company", "name": "description" } }, { "crm_field": { "api_name": "No_of_Employees", "id": "917992000000000579", "name": "No. of Employees" }, "enrich_field": { "display_label": "Employee count", "name": "no_of_employees" } }, { "crm_field": { "api_name": "Annual_Revenue", "id": "917992000000000581", "name": "Annual Revenue" }, "enrich_field": { "display_label": "Annual Revenue", "name": "revenue" } }, { "crm_field": { "api_name": "Lead_Source", "id": "917992000000000573", "name": "Lead Source" }, "enrich_field": { "display_label": "Business Type", "name": "org_type" } }, { "crm_field": null, "enrich_field": { "display_label": "Business Size", "name": "org_status" } }, { "crm_field": null, "enrich_field": { "display_label": "Year in business", "name": "years_in_industry" } }, { "crm_field": null, "enrich_field": { "display_label": "Business Locations", "name": "territory_list" } }, { "crm_field": { "api_name": "Record_Image", "id": "917992000000179001", "name": "Lead Image" }, "enrich_field": { "display_label": "LOGO", "name": "logo" } }, { "crm_field": null, "enrich_field": { "display_label": "Business Model", "name": "business_model" } }, { "crm_field": null, "enrich_field": { "display_label": "Headquarters - Country", "name": "head_quarters_country" } }, { "crm_field": { "api_name": "Street", "id": "917992000000000603", "name": "Street" }, "enrich_field": { "display_label": "Address - Street", "name": "address_street" } }, { "crm_field": { "api_name": "State", "id": "917992000000000607", "name": "State" }, "enrich_field": { "display_label": "Address - State", "name": "address_state" } }, { "crm_field": { "api_name": "City", "id": "917992000000000605", "name": "City" }, "enrich_field": { "display_label": "Address - City", "name": "address_city" } }, { "crm_field": { "api_name": "Zip_Code", "id": "917992000000000609", "name": "Zip Code" }, "enrich_field": { "display_label": "Address - Zip Code", "name": "address_zip_code" } }, { "crm_field": { "api_name": "Country", "id": "917992000000000611", "name": "Country" }, "enrich_field": { "display_label": "Address - Country", "name": "address_country" } } ], "status": true, "type": "organization" } ] } } }, "schema": { "additionalProperties": false, "description": "Data enrichment configuration fetched successfully.", "properties": { "data_enrichment": { "description": "Array containing the requested enrichment configuration.", "items": { "additionalProperties": false, "description": "Enrichment configuration item for a specific module.", "properties": { "created_by": { "additionalProperties": false, "description": "User who created the enrichment configuration.", "properties": { "id": { "description": "Unique identifier of the user who created the configuration.", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the user who created the configuration.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "created_time": { "description": "Timestamp when the configuration was created.", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the enrichment configuration.", "maxLength": 19, "type": "string" }, "input_data_field_mapping": { "$ref": "#/components/schemas/FieldMappingForRead" }, "modified_by": { "additionalProperties": false, "description": "User who last modified the enrichment configuration.", "properties": { "id": { "description": "Unique identifier of the user who last modified the configuration.", "maxLength": 19, "type": "string" }, "name": { "description": "Name of the user who last modified the configuration.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "modified_time": { "description": "Timestamp when the configuration was last modified.", "maxLength": 255, "type": "string" }, "module": { "$ref": "#/components/schemas/Module" }, "output_data_field_mapping": { "$ref": "#/components/schemas/FieldMappingForRead" }, "status": { "description": "Whether the enrichment configuration is active.", "type": "boolean" }, "type": { "description": "Type of enrichment — 'personal' or 'organization'.", "maxLength": 255, "type": "string" } }, "required": [ "id", "type", "module", "status", "input_data_field_mapping", "output_data_field_mapping", "modified_time", "modified_by" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "GetZiaEnrichmentConfigurationSuccessResponse" } } }, "description": "Enrichment configuration fetched successfully." }, "204": { "description": "No Content — No enrichment configuration found for the given ID." }, "400": { "content": { "application/json": { "examples": { "Example": { "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Data Enrichment feature not enabled", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the feature is not enabled or not supported.", "properties": { "code": { "description": "Error code indicating the feature is not enabled or not supported.", "enum": [ "FEATURE_NOT_ENABLED", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details — empty for this error type.", "properties": {}, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetZiaEnrichmentConfigurationFeatureNotEnabledorNotSupported" } } }, "description": "Bad Request. Returned when the feature is not enabled or not supported." }, "403": { "content": { "application/json": { "examples": { "Example": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Data_Enrichment", "Crm_Implied_View_Data_Enrichment" ] }, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the user lacks permission to access this feature.", "properties": { "code": { "description": "Error code — 'NO_PERMISSION'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing permissions.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "Permission required to access this feature.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetZiaEnrichmentConfigurationNoPermission" } } }, "description": "Permission error. Returned when the user lacks the necessary permissions to view enrichment configurations." } }, "security": [ { "OAuth2": [ "ZohoCRM.zia.enrichment.READ" ] } ], "summary": "Get Zia Enrichment Configuration for a specific module", "tags": [ "zia_enrichment" ], "x-zoho-document": "zia_enrichment" }, "put": { "description": "Updates Zia Enrichment Configurations for a specific module by ID. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names, and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names.", "operationId": "updateZiaEnrichmentConfigurations", "parameters": [ { "description": "Data Enrichment configuration ID", "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the Data Enrichment configuration to update.", "maxLength": 19, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Example": { "value": { "data_enrichment": [ { "input_data_field_mapping": [ { "crm_field": { "api_name": "Company", "id": "917992000000000555" }, "enrich_field": { "name": "org_name" } }, { "crm_field": { "api_name": "Email", "id": "917992000000000563" }, "enrich_field": { "name": "email" } }, { "crm_field": { "api_name": "Website", "id": "917992000000000571" }, "enrich_field": { "name": "org_website" } } ], "output_data_field_mapping": [ { "crm_field": { "api_name": "Company", "id": "917992000000000555" }, "enrich_field": { "name": "name" } }, { "crm_field": { "api_name": "Email", "id": "917992000000000563" }, "enrich_field": { "name": "primary_email" } }, { "crm_field": { "api_name": "Secondary_Email", "id": "917992000000026003" }, "enrich_field": { "name": "secondary_email" } }, { "crm_field": { "api_name": "Phone", "id": "917992000000000565" }, "enrich_field": { "name": "primary_contact" } }, { "crm_field": { "api_name": "Industry", "id": "917992000000000577" }, "enrich_field": { "name": "industries" } }, { "crm_field": { "api_name": "Skype_ID", "id": "917992000000000587" }, "enrich_field": { "name": "social_media_skype" } }, { "crm_field": { "api_name": "Twitter", "id": "917992000000035001" }, "enrich_field": { "name": "social_media_twitter" } }, { "crm_field": { "api_name": "Website", "id": "917992000000000571" }, "enrich_field": { "name": "website" } }, { "crm_field": { "api_name": "Description", "id": "917992000000000613" }, "enrich_field": { "name": "description" } }, { "crm_field": { "api_name": "No_of_Employees", "id": "917992000000000579" }, "enrich_field": { "name": "no_of_employees" } }, { "crm_field": { "api_name": "Annual_Revenue", "id": "917992000000000581" }, "enrich_field": { "name": "revenue" } }, { "crm_field": { "api_name": "Record_Image", "id": "917992000000179001" }, "enrich_field": { "name": "logo" } }, { "crm_field": { "api_name": "Street", "id": "917992000000000603" }, "enrich_field": { "name": "address_street" } }, { "crm_field": { "api_name": "State", "id": "917992000000000607" }, "enrich_field": { "name": "address_state" } }, { "crm_field": { "api_name": "City", "id": "917992000000000605" }, "enrich_field": { "name": "address_city" } }, { "crm_field": { "api_name": "Zip_Code", "id": "917992000000000609" }, "enrich_field": { "name": "address_zip_code" } }, { "crm_field": { "api_name": "Country", "id": "917992000000000611" }, "enrich_field": { "name": "address_country" } }, { "crm_field": { "api_name": "Lead_Source", "id": "917992000000000573" }, "enrich_field": { "name": "org_type" } } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body schema for updating Zia Enrichment configurations.", "properties": { "data_enrichment": { "description": "Array of updated data enrichment configurations.", "items": { "additionalProperties": false, "description": "Updated configuration item for a single module.", "properties": { "input_data_field_mapping": { "$ref": "#/components/schemas/FieldMappingForWrite" }, "output_data_field_mapping": { "$ref": "#/components/schemas/FieldMappingForWrite" }, "status": { "description": "Whether the enrichment configuration should be active.", "type": "boolean" } }, "required": [ "output_data_field_mapping", "input_data_field_mapping" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "UpdateZiaEnrichmentConfigurationsPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Example": { "value": { "data_enrichment": [ { "code": "SUCCESS", "details": { "id": "{id}", "modified_by": { "id": "{id}", "name": "Krishna Prakash B" }, "modified_time": "2023-08-10T15:12:10+05:30" }, "message": "enrichment updated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Enrichment updated successfully.", "properties": { "data_enrichment": { "description": "Array of update results for each configuration.", "items": { "additionalProperties": false, "description": "Result item for a single enrichment configuration update.", "properties": { "code": { "description": "Result code — 'SUCCESS' for successful update.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the updated enrichment configuration.", "properties": { "id": { "description": "Unique identifier of the updated enrichment configuration.", "maxLength": 19, "type": "string" }, "modified_by": { "additionalProperties": false, "description": "User who last modified the enrichment configuration.", "properties": { "id": { "description": "Unique identifier of the user who modified the configuration.", "maxLength": 255, "type": "string" }, "name": { "description": "Name of the user who modified the configuration.", "maxLength": 255, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "modified_time": { "description": "Timestamp when the configuration was last modified.", "maxLength": 255, "type": "string" } }, "required": [ "id", "modified_time", "modified_by" ], "type": "object" }, "message": { "description": "Human-readable message describing the operation result.", "maxLength": 255, "type": "string" }, "status": { "description": "Overall status of the operation — 'success' or 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "UpdateZiaEnrichmentConfigurationsSuccessResponse" } } }, "description": "Enrichment configuration updated successfully." }, "400": { "content": { "application/json": { "examples": { "Example1": { "value": { "data_enrichment": [ { "code": "INVALID_DATA", "details": { "api_name": "output_data_field_mapping || input_data_field_mapping", "expected_data_type": "jsonarray", "json_path": "$.data_enrichment[0].(output_data_field_mapping || input_data_field_mapping)" }, "message": "Invalid data", "status": "error" } ] } }, "Example2": { "value": { "data_enrichment": [ { "code": "INVALID_DATA", "details": { "api_name": "type", "json_path": "$.data_enrichment[0].type", "supported_values": [ "organization", "personal" ] }, "message": "the given type seems to be invalid", "status": "error" } ] } }, "Example4": { "value": { "data_enrichment": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "id", "json_path": "$.data_enrichment[0].input_data_field_mapping[0].crm_field.id" }, { "api_name": "api_name", "json_path": "$.data_enrichment[0].output_data_field_mapping[0].crm_field.api_name" } ] }, "message": "Crm field cannot be empty", "status": "error" } ] } }, "Example6": { "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Data Enrichment feature not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response when invalid data is provided.", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code identifying the type of validation failure.", "enum": [ "INVALID_DATA", "MANDATORY_NOT_FOUND", "NOT_ALLOWED", "NOT_SUPPORTED", "INVALID_MAPPING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the validation failure.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field in the request body.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "UpdateZiaEnrichmentConfigurationsProvideInvalidData" }, { "additionalProperties": false, "description": "Error response when unsupported values are provided.", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code — 'INVALID_DATA'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the unsupported value.", "properties": { "api_name": { "description": "API name of the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the invalid field in the request body.", "maxLength": 255, "type": "string" }, "supported_values": { "description": "List of supported values for the field.", "items": { "description": "Supported value for the field.", "enum": [ "organization", "personal" ], "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "api_name", "json_path", "supported_values" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "UpdateZiaEnrichmentConfigurationsUnSupportedValues" }, { "additionalProperties": false, "description": "Error response when expected fields are missing.", "properties": { "data_enrichment": { "description": "Array of error items.", "items": { "additionalProperties": false, "description": "Error item for a single configuration.", "properties": { "code": { "description": "Error code — 'EXPECTED_FIELD_MISSING'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing expected fields.", "properties": { "expected_fields": { "description": "List of expected fields that are missing.", "items": { "additionalProperties": false, "description": "Expected field item.", "properties": { "api_name": { "description": "API name of the expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "JSON path to the expected field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 50, "type": "array" } }, "required": [ "data_enrichment" ], "type": "object", "x-zs-$id": "UpdateZiaEnrichmentConfigurationsExpectedFieldMissing" }, { "additionalProperties": false, "description": "Error response when the feature is not enabled or not supported.", "properties": { "code": { "description": "Error code indicating the feature is not enabled or not supported.", "enum": [ "FEATURE_NOT_ENABLED", "FEATURE_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details — empty for this error type.", "properties": {}, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateZiaEnrichmentConfigurationsFeatureNotEnabledOrNotSupported" } ], "description": "400 responses", "x-zs-$id": "UpdateZiaEnrichmentConfigurationsBadResponses" } } }, "description": "Validation error. Returned when the request contains invalid data, missing mandatory fields, or unsupported values." }, "403": { "content": { "application/json": { "examples": { "Example": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Data_Enrichment" ] }, "message": "No permission to access this feature", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response when the user lacks permission to access this feature.", "properties": { "code": { "description": "Error code — 'NO_PERMISSION'.", "maxLength": 255, "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the missing permissions.", "properties": { "permissions": { "description": "List of required permissions.", "items": { "description": "Permission required to access this feature.", "maxLength": 255, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 255, "type": "string" }, "status": { "description": "Error status — always 'error'.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateZiaEnrichmentConfigurationNoPermission" } } }, "description": "Permission error. Returned when the user lacks the necessary permissions to update enrichment configurations." } }, "security": [ { "OAuth2": [ "ZohoCRM.zia.enrichment.UPDATE" ] } ], "summary": "Update Zia Enrichment Configurations for a specific module", "tags": [ "zia_enrichment" ], "x-zoho-document": "zia_enrichment" } }, "/crm/v8/users": { "get": { "description": "To retrieve all users in your Zoho CRM organization based on the specified filter parameters, including type, role, query criteria, and field selection.", "operationId": "getUsers", "parameters": [ { "$ref": "#/components/parameters/UsersType" }, { "$ref": "#/components/parameters/UsersPage" }, { "$ref": "#/components/parameters/UsersPerPage" }, { "$ref": "#/components/parameters/UsersIncludeLiteUsers" }, { "$ref": "#/components/parameters/UsersRoleId" }, { "$ref": "#/components/parameters/QueryId" }, { "$ref": "#/components/parameters/ChildData" }, { "$ref": "#/components/parameters/UsersIds" }, { "$ref": "#/components/parameters/UsersFields" }, { "description": "Filter users by their account type.\nPossible values:\n**Regular User** - Standard CRM user with full access to the organization.\n**Sandbox Developer User** - User with access to the sandbox environment for development and testing.\n**Team User** - User operating as part of a team account.\n**Digital Employee** - Automated or bot-type user representing a digital workforce entity.\n**Support User** - User with access granted for support purposes.\n**Client Portal User** - User with limited access via the client-facing portal.", "explode": false, "in": "query", "name": "type__s", "required": false, "schema": { "enum": [ "Regular User", "Sandbox Developer User", "Team User", "Digital Employee", "Support User", "Client Portal User" ], "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "examples": { "UsersGetResponse": { "description": "A successful response contains a paginated list of Zoho CRM users, each with identity, role, profile, locale, and preference details.", "summary": "Successful retrieval of a paginated list of users", "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 }, "users": [ { "$current_shift": { "id": "111133000000012345", "name": "Morning Shift" }, "$next_shift": { "id": "111133000000023456", "name": "Evening Shift" }, "$shift_effective_from": null, "Modified_By": { "id": "111133000000057662", "name": "Thuvassshhhh test test" }, "Modified_Time": "2025-12-08T16:53:16+05:30", "Reporting_To": null, "alias": "aaaa", "confirm": true, "created_by": { "id": "111133000000057662", "name": "Thuvassshhhh test test" }, "created_time": "2025-11-12T11:20:12+05:30", "date_format": "MM/dd/yyyy", "decimal_separator": "Period", "email": "user@example.com", "first_name": "Thuvassshhhh", "full_name": "Thuvassshhhh test test", "id": "111133000000057662", "image_link": "https://profile.csez.zohocorpin.com/file?ID=43318041&fs=thumb", "last_name": "test test", "locale": "en_US", "microsoft": false, "phone": null, "profile": { "id": "111133000000000497", "name": "Administrator" }, "role": { "id": "111133000000000861", "name": "CEO" }, "sandboxDeveloper": false, "status": "disabled", "status_reason__s": null, "type__s": "Regular User", "zuid": "43318041" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the paginated response for the getUsers operation. Includes a list of user objects and an info object.", "properties": { "info": { "$ref": "#/components/schemas/UsersInfo" }, "users": { "description": "List of user objects, each representing an individual Zoho CRM user returned by the query.", "items": { "$ref": "#/components/schemas/GetUserDetails" }, "maxItems": 200, "type": "array" } }, "type": "object", "x-zs-$id": "UsersGetResponse" } } }, "description": "Returns user records matching the specified filter parameters. The response body contains a list of user objects and an info object." }, "204": { "description": "Returns no content when no users match the specified filter criteria." }, "400": { "content": { "application/json": { "examples": { "DependentFieldMissingErrorResponse": { "description": "Shows a 400 error when a required dependent parameter is missing. This example demonstrates the response when query_id is provided but the required child_data dependent parameter is absent.", "summary": "Missing required dependent parameter triggers a 400 error", "value": { "code": "DEPENDENT_PARAM_MISSING", "details": { "dependee": { "param_name": "child_data" }, "param_name": "query_id" }, "message": "Dependent Param missing", "status": "error" } }, "InvalidDataErrorResponse": { "description": "Shows a 400 error when the query_id parameter contains an invalid value.", "summary": "400 error for an invalid query_id parameter value", "value": { "code": "INVALID_DATA", "details": { "param_name": "query_id" }, "message": "Invalid queryId", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/UsersGetInvalidParamResponse" }, { "$ref": "#/components/schemas/UsersGetDependentFieldMissingResponse" } ], "description": "The request contains an invalid or missing parameter. The INVALID_DATA error occurs when the query_id parameter has an invalid value. The DEPENDENT_PARAM_MISSING error occurs when query_id is provided but the required child_data dependent parameter is absent.", "x-zs-$id": "UsersGetBadRequestResponse" } } }, "description": "Invalid query parameter or missing required dependent parameter. **Resolution:** The query_id parameter must contain a valid identifier, and the child_data dependent parameter must be provided alongside it." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.READ" ] } ], "summary": "Get users", "tags": [ "users" ], "x-zoho-document": "users" }, "post": { "description": "To create a new user record in your Zoho CRM organization. The request body must contain a `users` array with one user object including the required fields such as email, role, profile, and first name.", "operationId": "createUser", "requestBody": { "content": { "application/json": { "examples": { "UserAdded": { "description": "Demonstrates a sample request body for creating a new user with the required fields including first name, email, role, profile, last name, name format, and sort order preference.", "summary": "Create User Request", "value": { "users": [ { "$invitation_details": { "COMPANYLOGOURL": "https://static.zohocdn.com/crm/CRMClient/images/crm_logonew_18ad4a6d3fca927f423b0a15f6dbc241_.svg", "COMPANYNAME": "ZohoCRM", "DISPLAYNAME": "User 1" }, "email": "user@example.com", "first_name": "rfdc2", "profile": { "id": "2922942000000015972", "name": "Administrator" }, "role": { "id": "2922942000000015966", "name": "CEO" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload schema for creating a user in Zoho CRM. Contains the `users` array with user detail objects.", "properties": { "users": { "description": "The request body must contain a `users` array. You can include a maximum of one object per request.", "items": { "$ref": "#/components/schemas/UserDetails" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object" } } }, "description": "The request body must contain a `users` array with one object." }, "responses": { "201": { "content": { "application/json": { "examples": { "UserCreatedSuccessfully": { "description": "Shows the response returned after a user is successfully added to the CRM organization, including the unique ID of the new user record.", "summary": "Successful user creation response", "value": { "users": [ { "code": "SUCCESS", "details": { "id": "111113000000071587" }, "message": "User added", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload schema returned upon successful user creation. Contains the `users` array with the result objects.", "properties": { "users": { "description": "Contains the result of the user creation request, including the status, response code, confirmation message, and the unique ID of the newly created user.", "items": { "additionalProperties": false, "description": "Represents the outcome of the user creation request. Each object contains a status indicating success, a response code, a confirmation message, and a object that holds the unique ID of the newly created user.", "properties": { "code": { "description": "Indicates the result code for the user creation request. Possible values: `SUCCESS`.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional information about the created user, including the unique ID assigned to the user record in Zoho CRM.", "properties": { "id": { "description": "Represents the unique ID of the user record created in Zoho CRM.", "maxLength": 19, "type": "string", "x-zs-$id": "UserResultId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Indicates the confirmation message returned upon successful user creation. Possible values: `User added`.", "enum": [ "User added" ], "type": "string" }, "status": { "description": "Indicates the overall status of the user creation request. Possible values: `success`.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "CreateUserSuccessResponse" } } }, "description": "Returns the result of the user creation request, including the unique ID of the newly created user." }, "400": { "content": { "application/json": { "examples": { "AddingCreatedByOrModifiedByField": { "description": "Shows the error returned when the request body includes the Created By or Modified By field, which are read-only and cannot be set through the API.", "summary": "Attempt to set read-only Created By or Modified By field", "value": { "users": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "created_by", "json_path": "$.users[0].created_by" }, "message": "Created by & Modified by fields cannot be updated by api", "status": "error" } ] } }, "AddingUserInCrmPlus": { "description": "Shows the error returned when attempting to add a user through the CRM API for a CRM Plus account, which is not supported via the API.", "summary": "Attempt to add user in a CRM Plus account", "value": { "users": [ { "code": "UNAPPROVABLE", "details": {}, "message": "Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus", "status": "error" } ] } }, "AddingUserInZohoOne": { "description": "Shows the error returned when attempting to add a user through the CRM API for a Zoho One account, which must be done through the Zoho One portal.", "summary": "Attempt to add user in a Zoho One account", "value": { "users": [ { "code": "UNAPPROVABLE", "details": {}, "message": "Cannot add user for ZohoOne account from CRM. Kindly add user through ZohoOne", "status": "error" } ] } }, "CreatingDigitalEmployee": { "description": "Shows the error returned when attempting to create a Digital Employee type user through the API, which is not supported.", "summary": "Attempt to create a Digital Employee user via API", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "type__s", "json_path": "$.users[0].type__s" }, "message": "The specified user type is not allowed", "status": "error" } ] } }, "CreatingSupportUser": { "description": "Shows the error returned when attempting to create a Support User type through the API, which is not allowed.", "summary": "Attempt to create a Support User via API", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profile" }, "message": "Support user cannot be added", "status": "error" } ] } }, "CreatingSystemUser": { "description": "Shows the error returned when attempting to create a System User type through the API, which is not permitted.", "summary": "Attempt to create a System User via API", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profile" }, "message": "System user cannot be added", "status": "error" } ] } }, "DuplicateEmailInUserCreation": { "description": "Shows the error returned when the email address provided in the request is already associated with an existing user in the CRM organization.", "summary": "Duplicate email address in user creation request", "value": { "users": [ { "code": "DUPLICATE_DATA", "details": {}, "message": "Failed to add user since same email id is already present", "status": "error" } ] } }, "EmailAlradyRegisteredInAnotherDC": { "description": "Shows the error returned when the provided email address is registered with a user in a different data center and cannot be added to this organization.", "summary": "Email address registered in another data center", "value": { "users": [ { "code": "INVALID_DATA", "details": {}, "message": "This email address is already registered with another datacenter and cannot be registered with this account's data centre US", "status": "error" } ] } }, "InvalidCurrenntShiftId": { "description": "Shows the error returned when the current shift ID specified in the request is not valid.", "summary": "Invalid current shift ID in request", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "$current_shift", "json_path": "$.users[0].$current_shift.id" }, "message": "Invalid current shift id", "status": "error" } ] } }, "InvalidDataErrorResponse": { "description": "Shows the error returned when one or more fields in the request contain values that do not conform to the expected format or constraints.", "summary": "Invalid data in one or more request fields", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "time_zone", "json_path": "$.users[0].time_zone" }, "message": "Give a proper time zone value", "status": "error" } ] } }, "InvalidDataInResponse2": { "description": "Shows an alternate invalid data error scenario where an invalid reporting to user ID or role ID is provided in the request.", "summary": "Invalid reporting to user ID or role ID", "value": { "users": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "Valid userid should be given" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDecimalSeparator": { "description": "Shows the error returned when an invalid decimal separator value is provided in the request.", "summary": "Invalid decimal separator value in request", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.users[0].decimal_separator" }, "message": "Invalid data. Valid values are Comma/Period (Not case-sensitive)", "status": "error" } ] } }, "InvalidEmailId": { "description": "Shows the error returned when the email address provided in the request does not conform to the expected email format.", "summary": "Invalid email address format in request", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "email" }, "message": "Invalid Email Id. Please choose a different email id", "status": "error" } ] } }, "InvalidNextShiftId": { "description": "Shows the error returned when the next shift ID specified in the request is not valid.", "summary": "Invalid next shift ID in request", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "$next_shift", "json_path": "$.users[0].$next_shift.id" }, "message": "Invalid next shift id", "status": "error" } ] } }, "InvalidNumberSeparator": { "description": "Shows the error returned when an invalid number separator value is provided in the request.", "summary": "Invalid number separator value in request", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "number_separator", "json_path": "$.users[0].number_separator" }, "message": "Invalid data. Valid values are Comma/Period/Space (Not case-sensitive)", "status": "error" } ] } }, "InvalidProfieIdOrRoleIdOrLocale": { "description": "Shows the error returned when an invalid profile ID, role ID, or locale value is provided in the request.", "summary": "Invalid profile ID, role ID, or locale value", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "profile", "json_path": "$.users[0].profile" }, "message": "INVALID_DATA", "status": "error" } ] } }, "InvalidReportingToUser": { "description": "Shows the error returned when the Reporting To user ID specified in the request does not correspond to a valid user.", "summary": "Invalid Reporting To user ID in request", "value": { "users": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "Invalid Reporting Manager" }, "message": "invalid data", "status": "error" } ] } }, "InvalidShiftEffectiveFromDate": { "description": "Shows the error returned when the shift effective-from date provided in the request is not valid.", "summary": "Invalid shift effective-from date in request", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "$shift_effective_from", "json_path": "$.users[0].$shift_effective_from" }, "message": "Shift effective from date should be greater than Current Shift date", "status": "error" } ] } }, "MoreThanOneUserCreationAttempt": { "description": "Shows the error returned when the request includes more than one user object in the `users` array, which exceeds the per-request limit of one user.", "summary": "More than one user object in the request", "value": { "code": "INVALID_DATA", "details": { "api_name": "users", "json_path": "$.users", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "NextShiftWithDateWithMoretimePeriod": { "description": "Shows the error returned when the shift effective-from date is set too far in the future, exceeding the maximum allowed time period.", "summary": "Shift effective-from date too far in the future", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "$shift_effective_from", "expected_data_type": "Maximum time period is six months to move shift", "json_path": "$.users[0].$shift_effective_from" }, "message": "invalid data", "status": "error" } ] } }, "NumberAndDecimalSeparatorMismatch": { "value": { "description": "Shows the error returned when the number separator and decimal separator values submitted in the request are identical.", "summary": "Number separator and decimal separator values are identical", "users": [ { "code": "MAPPING_MISMATCH", "details": { "api_name": "decimal_separator", "json_path": "$.users[0].decimal_separator", "mapped_field": { "api_name": "number_separator", "json_path": "$.users[0].number_separator" } }, "message": "the number separator and decimal separator values should not be same", "status": "error" } ] } }, "PatternMismatchInField": { "description": "Shows the error returned when the value provided for a field does not match the expected format or pattern, such as for the time format, distance preference, or status fields.", "value": { "summary": "Field value does not match the expected pattern", "users": [ { "code": "INVALID_DATA", "details": { "api_name": "time_format", "json_path": "$.users[0].time_format" }, "message": "Pattern not matched", "status": "error" } ] } }, "ReportingToUserIdDeleted": { "description": "Shows the error returned when the user ID specified in the Reporting To field has been deleted and is no longer active.", "summary": "Reporting To user ID refers to a deleted user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "Reporting_To", "json_path": "$.users[0].Reporting_To.id" }, "message": "the id given seems to be already deleted", "status": "error" } ] } }, "SameCurrentAndNextShiftId": { "description": "Shows the error returned when the current shift ID and the next shift ID submitted in the request are identical.", "summary": "Current shift and next shift IDs are identical", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "$next_shift.id", "json_path": "$.users[0].$next_shift.id" }, "message": "current shift and next shift should not be same", "status": "error" } ] } }, "ShiftEffectiveFromDateMissing": { "description": "Shows the error returned when a next shift is specified but the effective-from date is not provided in the request.", "summary": "Next shift specified without an effective-from date", "value": { "users": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "$shift_effective_from", "dependee": { "api_name": "$next_shift", "json_path": "$.users[0].$next_shift" }, "json_path": "$.users[0].$shift_effective_from" }, "message": "Dependent Field value should not be null", "status": "error" } ] } }, "SpecialCharacterInField": { "description": "Shows the error returned when a field value contains a special character that is not permitted for that field.", "summary": "Impermissible special character in a field value", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "first_name", "json_path": "$.users[0].first_name" }, "message": "Special Characters Found", "status": "error" } ] } }, "TeamUserLimitExceeded": { "description": "Shows the error returned when the maximum number of team users permitted under the current license has been reached.", "summary": "Team user limit reached under current license", "value": { "users": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "Request exceeds your license limit. Need to upgrade in order to add a team user", "status": "error" } ] } }, "UpdatingReportingToFieldWithoutEnablingReportingToFeature": { "description": "Shows the error returned when the Reporting To field is included in the request but the Reporting To feature has not been enabled in the CRM organization.", "summary": "Reporting To field set without enabling the Reporting To feature", "value": { "users": [ { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "ReportingTo Feature is not enabled", "status": "error" } ] } }, "Updatingtypefields": { "description": "Shows the error returned when attempting to set a field that cannot be updated through the API, such as the user type or the Created By and Modified By fields.", "summary": "Attempt to set a read-only or API-restricted field", "value": { "users": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "type__s", "json_path": "$.users[0].type__s" }, "message": "type__s is cannot be updated by api", "status": "error" } ] } }, "UserCreationInSandBoxOrg": { "description": "Shows the error returned when attempting to create a user in a sandbox organization.", "summary": "Attempt to create user in a sandbox organization", "value": { "users": [ { "code": "NOT_ALLOWED", "details": {}, "message": "You cannot create user in a sandbox org", "status": "error" } ] } }, "UserCreationWithoutUpdatingCompanyDetails": { "description": "Shows the error returned when creating a user without first updating the required company details for the CRM organization.", "summary": "User creation attempted without required company details", "value": { "users": [ { "code": "MANDATORY_NOT_FOUND", "details": {}, "message": "Company Name is required", "status": "error" } ] } }, "UserInvitationLimitExceeded": { "description": "Shows the error returned when the organization has reached the maximum number of pending user invitations allowed.", "summary": "Maximum pending user invitations reached", "value": { "users": [ { "code": "INVALID_REQUEST", "details": {}, "message": "User cannot be added as the user has already reached the maximum invitation limit", "status": "error" } ] } }, "UserLimitExceeded": { "description": "Shows the error returned when the organization has reached the maximum number of licensed users allowed under the current plan.", "summary": "Licensed user limit reached under current plan", "value": { "users": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "Request exceeds your license limit. Need to upgrade in order to add a user", "status": "error" } ] } }, "ZohoEmailId": { "description": "Shows the error returned when attempting to create a user with a Zoho-domain email address, which is not permitted.", "summary": "Attempt to create user with a Zoho-domain email address", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "email" }, "message": "Email Id should not contain @zoho.com. Please choose a different email id", "status": "error" } ] } } }, "schema": { "additionalProperties": true, "description": "Represents the response payload schema returned when a user creation request fails. Contains the `users` array with error result objects.", "properties": { "users": { "description": "Contains one or more error objects returned when the user creation request fails validation or cannot be processed.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error result returned when the user creation request contains invalid data (code: `INVALID_DATA`).", "properties": { "code": { "description": "Represents the error classification code returned when a user creation request contains invalid data.\nPossible values: INVALID_DATA.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the validation error, including the affected field API name, JSON path, maximum permitted length, expected data type, and applicable date range constraints.", "properties": { "api_name": { "description": "Represents the API name of the request field that triggered the validation error.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the data type that was expected for the field that triggered the validation error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the request field that triggered the validation error.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum number of characters permitted for the field that triggered the validation error.", "format": "int32", "type": "integer" }, "range": { "additionalProperties": false, "description": "Contains the acceptable date range for the field that triggered the validation error, expressed as a start date and an end date.", "properties": { "from": { "description": "Represents the start date of the acceptable date range for the field that triggered the validation error.", "format": "date", "type": "string" }, "to": { "description": "Represents the end date of the acceptable date range for the field that triggered the validation error.", "format": "date", "type": "string" } }, "type": "object" } }, "type": "object" }, "message": { "description": "Represents the message describing the nature of the validation error encountered during user creation.", "enum": [ "invalid data", "INVALID_DATA", "Give a proper time zone value", "This email address is already registered with another datacenter and cannot be registered with this account's data centre US", "Invalid Email Id. Please choose a different email id", "Email Id should not contain @zoho.com. Please choose a different email id", "Special Characters Found", "Pattern not matched", "Effective from should be greater than current date", "Effective from should be less than 6 months", "Invalid data. Valid values are Comma/Period/Space (Not case-sensitive)", "Invalid data. Valid values are Comma/Period (Not case-sensitive)", "Valid date format should be given", "Shift effective from date should be greater than Current Shift date" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserInvalidDataError" }, { "additionalProperties": false, "description": "Represents an error result returned when a dependent field value is null or missing (code: `DEPENDENT_MISMATCH`).", "properties": { "code": { "description": "Indicates the error code identifying a dependent field value mismatch condition. Possible values: `DEPENDENT_MISMATCH`.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the dependent field mismatch error, including the API name and JSON path of the offending field and information about the field it depends on.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the dependent field mismatch error.", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Contains the API name and JSON path of the field upon which the erroring field depends.", "properties": { "api_name": { "description": "Represents the API name of the field upon which the erroring field depends.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field upon which the erroring field depends.", "maxLength": 200, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path of the field associated with the dependent field mismatch error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message returned when a dependent field value is missing. Possible values: `Dependent Field value should not be null`.", "enum": [ "Dependent Field value should not be null" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserDependentFieldMissingError" }, { "additionalProperties": false, "description": "Represents an error result returned when a user cannot be created due to an unapproved account type or external account restriction (code: `UNAPPROVABLE`).", "properties": { "code": { "description": "Indicates the error code returned when the user type cannot be approved for creation. Possible values: `UNAPPROVABLE`.", "enum": [ "UNAPPROVABLE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the unapprovable user creation error.", "type": "object" }, "message": { "description": "Indicates the error message returned when a user cannot be added from the CRM interface for certain account types. Possible values: `Cannot add user for ZohoOne account from CRM. Kindly add user through ZohoOne`, `Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus`.", "enum": [ "Cannot add user for ZohoOne account from CRM. Kindly add user through ZohoOne", "Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserUnapprovableError" }, { "additionalProperties": false, "description": "Represents an error result returned when the user creation operation is not allowed for the specified context or user type (code: `NOT_ALLOWED`).", "properties": { "code": { "description": "Indicates the error code identifying an operation that is not permitted. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the not-allowed error, including the API name and JSON path of the field that triggered the restriction.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the not-allowed error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that triggered the not-allowed error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message returned when a user creation attempt is not allowed for the specified user type or organization context. Possible values: `You cannot create user in a sandbox org`, `Support user cannot be added`, `System user cannot be added`, `the id given seems to be already deleted`, `current shift and next shift should not be same`.", "enum": [ "You cannot create user in a sandbox org", "Support user cannot be added", "System user cannot be added", "the id given seems to be already deleted", "current shift and next shift should not be same" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserNotAllowedError" }, { "additionalProperties": false, "description": "Represents an error result returned when a field or operation is not supported for the user type being created (code: `NOT_SUPPORTED`).", "properties": { "code": { "description": "Indicates the error code returned when the requested operation is not supported for the user type. Possible values: `NOT_SUPPORTED`.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the not-supported error, including the API name and JSON path of the field that triggered the restriction.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the not-supported error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that triggered the not-supported error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message returned when an update to a restricted field is attempted through the API. Possible values: `type__s is cannot be updated by api`, `Created by & Modified by fields cannot be updated by api`.", "enum": [ "type__s is cannot be updated by api", "Created by & Modified by fields cannot be updated by api" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserNotSupportedError" }, { "additionalProperties": false, "description": "Represents an error result returned when a required field is missing from the request (code: `MANDATORY_NOT_FOUND`).", "properties": { "code": { "description": "Indicates the error code returned when a required field is missing in the request. Possible values: `MANDATORY_NOT_FOUND`.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the mandatory field missing error.", "type": "object" }, "message": { "description": "Indicates the error message returned when a required company detail is missing from the request. Possible values: `Company Name is required`.", "enum": [ "Company Name is required" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserMandatoryNotFoundError" }, { "additionalProperties": false, "description": "Represents an error result returned when the request exceeds the account license limit for users (code: `LICENSE_LIMIT_EXCEEDED`).", "properties": { "code": { "description": "Indicates the error code returned when the request exceeds the account license limit for users. Possible values: `LICENSE_LIMIT_EXCEEDED`.", "enum": [ "LICENSE_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the license limit exceeded error.", "type": "object" }, "message": { "description": "Indicates the error message returned when the license limit for users is exceeded. Possible values: `Request exceeds your license limit. Need to upgrade in order to add a user`, `Request exceeds your license limit. Need to upgrade in order to add a team user`.", "enum": [ "Request exceeds your license limit. Need to upgrade in order to add a user", "Request exceeds your license limit. Need to upgrade in order to add a team user" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserLicenseLimitExceededError" }, { "additionalProperties": false, "description": "Represents an error result returned when the email address submitted is already associated with an existing user (code: `DUPLICATE_DATA`).", "properties": { "code": { "description": "Indicates the error code returned when a duplicate user email address is detected. Possible values: `DUPLICATE_DATA`.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the duplicate data error.", "type": "object" }, "message": { "description": "Indicates the error message returned when a user with the same email address already exists. Possible values: `Failed to add user since same email id is already present`.", "enum": [ "Failed to add user since same email id is already present" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserDuplicateDataError" }, { "additionalProperties": false, "description": "Represents an error result returned when the user creation request itself is malformed or cannot be processed (code: `INVALID_REQUEST`).", "properties": { "code": { "description": "Indicates the error code returned when the request itself is invalid or cannot be processed. Possible values: `INVALID_REQUEST`.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the invalid request error, including the API name and JSON path of the offending field.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the invalid request error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with the invalid request error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message returned for an invalid user creation request. Possible values: `User cannot be added as the user has already reached the maximum invitation limit`, `Invalid current shift id`, `Invalid next shift id`.", "enum": [ "User cannot be added as the user has already reached the maximum invitation limit", "Invalid current shift id", "Invalid next shift id" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserInvalidRequestError" }, { "additionalProperties": false, "description": "Represents an error result returned when a required CRM feature is not enabled for the organization (code: `FEATURE_NOT_ENABLED`).", "properties": { "code": { "description": "Indicates the error code returned when a required CRM feature is not enabled for the organization. Possible values: `FEATURE_NOT_ENABLED`.", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the feature not enabled error.", "type": "object" }, "message": { "description": "Indicates the error message returned when the Reporting To feature is not enabled in the CRM organization. Possible values: `ReportingTo Feature is not enabled`.", "enum": [ "ReportingTo Feature is not enabled" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserFeatureNotEnabledError" }, { "additionalProperties": false, "description": "Represents an error result returned when the number separator and decimal separator values conflict (code: `MAPPING_MISMATCH`).", "properties": { "code": { "description": "Indicates the error code identifying a mapping mismatch condition. Possible values: `MAPPING_MISMATCH`.", "enum": [ "MAPPING_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the mapping mismatch error, including the API name and JSON path of the offending field and the corresponding mapped field information.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the mapping mismatch error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with the mapping mismatch error.", "maxLength": 200, "type": "string" }, "mapped_field": { "additionalProperties": false, "description": "Contains the API name and JSON path of the field that is mapped to the conflicting field in the mapping mismatch error.", "properties": { "api_name": { "description": "Represents the API name of the mapped field involved in the mapping mismatch error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the mapped field involved in the mapping mismatch error.", "maxLength": 200, "type": "string" } }, "type": "object" } }, "type": "object" }, "message": { "description": "Indicates the error message returned when a mapping mismatch is detected. Possible values: `the number separator and decimal separator values should not be same`.", "enum": [ "the number separator and decimal separator values should not be same" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserMappingMismatchError" }, { "additionalProperties": false, "description": "Represents an error result returned when a value that has already been used is submitted again (code: `ALREADY_USED`).", "properties": { "code": { "description": "Indicates the error code identifying a value that has already been used. Possible values: `ALREADY_USED`.", "enum": [ "ALREADY_USED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the already-used value error, including the API name and JSON path of the offending field and the location where the value already exists.", "properties": { "api_name": { "description": "Represents the API name of the field associated with the already-used value error.", "maxLength": 100, "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Contains the API name and JSON path identifying the location where the conflicting value already exists.", "properties": { "api_name": { "description": "Represents the API name of the field where the conflicting value already exists.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field where the conflicting value already exists.", "maxLength": 200, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path of the field associated with the already-used value error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message returned when a duplicate shift assignment is detected. Possible values: `current shift and next shift id cannot be the same`.", "enum": [ "current shift and next shift id cannot be the same" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserAlreadyUsedError" }, { "additionalProperties": false, "description": "Represents an error result returned when the specified user type is not permitted (code: `NOT_ALLOWED`).", "properties": { "code": { "description": "Indicates the error code identifying an operation that is not permitted. Possible values: `NOT_ALLOWED`.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the not-allowed error, including the API name and JSON path of the field that triggered the restriction.", "properties": { "api_name": { "description": "Represents the API name of the field that triggered the not-allowed error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that triggered the not-allowed error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message returned when a disallowed user type is specified. Possible values: `The specified user type is not allowed`.", "enum": [ "The specified user type is not allowed" ], "type": "string" }, "status": { "description": "Indicates the status of the user creation request. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "CreateUserTypeNotAllowedError" } ], "description": "Represents an error result for the user creation request. Each object contains an error code, a descriptive message, and a `details` object with additional context about the failure." }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "CreateUserBadRequestResponse" } } }, "description": "The request contains invalid, missing, or unsupported field values.\n**Resolution:** The invalid field details are available in the `users[].details` object. The request must be corrected and resubmitted." }, "403": { "content": { "application/json": { "examples": { "NoPermissionToCreateUser": { "description": "Shows the 403 error response returned when the requesting user does not have the Manage Users permission required to create a user.", "summary": "Insufficient permission to create a user", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Users" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload schema returned when the requesting user does not have permission to create a user.", "properties": { "code": { "description": "Indicates the error code returned when the requesting user lacks permission to create a user. Possible values: `NO_PERMISSION`, `PERMISSION_DENIED`.", "enum": [ "NO_PERMISSION", "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the permission denied error, including the list of required permissions that are missing.", "properties": { "permissions": { "description": "Contains the list of Zoho CRM permission identifiers required for this operation that are absent from the requesting user profile.", "items": { "description": "Represents a missing Zoho CRM permission identifier. Possible values: .", "enum": [ "Crm_Implied_Manage_Users" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "type": "object" }, "message": { "description": "Indicates the error message returned when permission to create a user is denied. Possible values: `permission denied`.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Indicates the overall response status when access is denied. Possible values: `error`.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "PermissionDeniedResponse" } } }, "description": "Permission denied to create a user.\n**Resolution:** The Zoho CRM administrator must grant the Manage Users permission to the requesting user profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.CREATE" ] } ], "summary": "Create User", "tags": [ "users" ], "x-zoho-document": "users" }, "put": { "description": "To update the details of one or more users in your Zoho CRM organization. The request must include a users array with up to 10 user records, each identified by a unique user ID. You can update user profile settings, role assignments, locale preferences, and other account details.", "operationId": "updateUser", "requestBody": { "content": { "application/json": { "examples": { "UserAdded": { "description": "Shows a sample request body for updating a user, including the user ID and changed field values.", "summary": "Update user request", "value": { "users": [ { "email": "user@example.com", "first_name": "rfdc2", "profile": { "id": "2922942000000015972", "name": "Administrator" }, "role": { "id": "2922942000000015966", "name": "CEO" } } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the list of user objects to update in this request.", "properties": { "users": { "description": "Specify the list of user records to update. Each object in the array represents a single user whose details you want to modify.", "items": { "$ref": "#/components/schemas/UserDetails" }, "maxItems": 10, "type": "array" } }, "required": [ "users" ], "type": "object" } } }, "description": "The request body must contain a users array. You can include a maximum of 10 objects per request." }, "responses": { "200": { "content": { "application/json": { "examples": { "UserUpdatedSuccessfully": { "description": "Shows a successful response confirming the user record update, including the user IDs and success status.", "summary": "User updated successfully", "value": { "users": [ { "code": "SUCCESS", "details": { "id": "111113000000071587" }, "message": "User updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the list of user update result objects returned in the 200 response.", "properties": { "users": { "description": "Represents the list of user update result objects returned after a successful request.", "items": { "additionalProperties": false, "description": "Represents the result of a single user update operation, including the status, response code, message, and details of the updated user record.", "properties": { "code": { "description": "Represents the response code indicating a successful update. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the updated user record.", "properties": { "id": { "description": "Represents the unique ID of the updated user.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the response message confirming the outcome of the update operation. Possible values: **User updated**.", "enum": [ "User updated" ], "type": "string" }, "status": { "description": "Represents the response status indicating success. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateUserSuccessResponse" } } }, "description": "Returns the update result for the user records processed in the request." }, "400": { "content": { "application/json": { "examples": { "ActivatingSupportUser": { "description": "Shows the error response when attempting to activate a support user, which is not permitted.", "summary": "Activating a support user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Support user cannot be activated", "status": "error" } ] } }, "ActivatingSystemUser": { "description": "Shows the error response when attempting to activate a system user, which is not permitted.", "summary": "Activating a system user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "System user cannot be activated", "status": "error" } ] } }, "AlreadyActiveUserActivation": { "description": "Shows the error response when attempting to activate a user that is already in the active state.", "summary": "Activating an already active user", "value": { "users": [ { "code": "ID_ALREADY_ACTIVE", "details": { "id": "0987654321", "json_path": "$.users[0].id" }, "message": "User is already active", "status": "error" } ] } }, "AssigningSystemProfileToUser": { "description": "Shows the error response when attempting to assign a system profile to a regular user, which is not allowed.", "summary": "Assigning system profile to a user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profile", "json_path": "$.users[0].profile" }, "message": "System Profile cannot be assigned to other users", "status": "error" } ] } }, "CreatingSupportOrSystemUser": { "description": "Shows the error response when attempting to change a user type to a support or system user type via the API, which is not permitted.", "summary": "Changing a user to support or system type", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profile" }, "message": "Support user cannot be added", "status": "error" } ] } }, "CrmPlusUserEmailUpdate": { "description": "Shows the error response when attempting to update the email address of a Zoho CRM Plus user, which is not permitted.", "summary": "Email update for a CRM Plus user", "value": { "users": [ { "code": "EMAIL_UPDATE_NOT_ALOWED", "details": { "api_name": "email" }, "message": "Crm Plus account is not allowed to edit the email while updating the user info", "status": "error" } ] } }, "DeactivatingAlreadyDeactivatedUser": { "description": "Shows the error response when attempting to deactivate a user that is already in the inactive state.", "summary": "Deactivating an already deactivated user", "value": { "users": [ { "code": "ID_ALREADY_DEACTIVATED", "details": { "api_name": "id", "id": "$.users[0].id" }, "message": "User is already deactivated", "status": "error" } ] } }, "DeactivatingPrimaryUser": { "description": "Shows the error response when attempting to deactivate the primary contact user of the organization.", "summary": "Deactivating the primary user", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "id": "0987654321", "json_path": "$.users[0].id" }, "message": "Primary Contact cannot be deactivated", "status": "error" } ] } }, "DeactivatingSupportUser": { "description": "Shows the error response when attempting to deactivate a support user, which is not permitted.", "summary": "Deactivating a support user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Support user cannot be deactivated", "status": "error" } ] } }, "DeactivatingSystemUser": { "description": "Shows the error response when attempting to deactivate a system user, which is not permitted.", "summary": "Deactivating a system user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "System user cannot be deactivated", "status": "error" } ] } }, "DeletedUserUpdate": { "description": "Shows the error response when attempting to update a user that has been deleted.", "summary": "Updating a deleted user", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "the id given seems to be invalid", "status": "error" } }, "DigitalUserStatusUpdate": { "description": "Shows the error response when attempting to change the status of a digital employee user, which is not permitted.", "summary": "Digital employee user status change", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "id": "0987654321" }, "message": "You are not allowed to perform this operation.", "status": "error" } ] } }, "DuplicateEmailId": { "description": "Shows the error response when attempting to update a user with an email address that is already registered in the organization.", "summary": "Duplicate email address in user update", "value": { "users": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "email", "json_path": "$.users[0].email" }, "message": "Email already exists", "status": "error" } ] } }, "InSufficientPrivilegesToUpdateUser": { "description": "Shows the error response when the requesting user does not have sufficient privileges to update the target user.", "summary": "Insufficient privileges to update a user", "value": { "users": [ { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "Either trial is expired or user does not have sufficiet previlege to perform this action", "status": "error" } ] } }, "InValidUserIdResponse": { "description": "Shows the error response when the specified user ID is invalid or does not correspond to an existing user.", "summary": "Invalid user ID in update request", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the id given seems to be invalid", "status": "error" } }, "InsufficientPrevilidgesToUpdateUser": { "description": "Shows the error response when the caller lacks the required authorization level to update another user.", "summary": "Insufficient authorization to update a user", "value": { "users": [ { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "Either trial is expired or user does not have sufficient previlege to perform this action", "status": "error" } ] } }, "InvalidCurrenntShiftId": { "description": "Shows the error response when the specified current shift ID does not correspond to an existing shift.", "summary": "Invalid current shift ID", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "$current_shift", "json_path": "$.users[0].$current_shift.id" }, "message": "Invalid current shift id", "status": "error" } ] } }, "InvalidDataErrorResponse": { "description": "Shows the error response when one or more fields in the request body contain invalid data.", "summary": "Invalid data in update request", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "time_zone", "json_path": "$.users[0].time_zone" }, "message": "Give a proper time zone value", "status": "error" } ] } }, "InvalidDataInResponse2": { "description": "Shows the error response when an invalid reporting manager ID or role ID is provided in the request.", "summary": "Invalid reporting manager or role ID", "value": { "users": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "Valid userid should be given" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDecimalSeparator": { "description": "Shows the error response when an invalid decimal separator value is specified during user update.", "summary": "Invalid decimal separator", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.users[0].decimal_separator" }, "message": "Invalid data. Valid values are Comma/Period (Not case-sensitive)", "status": "error" } ] } }, "InvalidLanguageCode": { "description": "Shows the error response when an unsupported or invalid language code is specified for the user.", "summary": "Invalid language code", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "language", "json_path": "$.users[0].language" }, "message": "Give a proper language code", "status": "error" } ] } }, "InvalidNameFormat": { "description": "Shows the error response when an unsupported name format is specified for the user.", "summary": "Invalid name format", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "name_format__s", "json_path": "$.users[0].name_format__s" }, "message": "Valid name format should be given", "status": "error" } ] } }, "InvalidNextShiftId": { "description": "Shows the error response when the specified next shift ID does not correspond to an existing shift.", "summary": "Invalid next shift ID", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "$next_shift", "json_path": "$.users[0].$next_shift.id" }, "message": "Invalid next shift id", "status": "error" } ] } }, "InvalidNumberSeparator": { "description": "Shows the error response when an invalid number separator value is specified during user update.", "summary": "Invalid number separator", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "number_separator", "json_path": "$.users[0].number_separator" }, "message": "Invalid data. Valid values are Comma/Period/Space (Not case-sensitive)", "status": "error" } ] } }, "InvalidProfieIdOrRoleIdOrLocale": { "description": "Shows the error response when an invalid profile ID, role ID, or locale value is provided in the update request.", "summary": "Invalid profile ID, role ID, or locale", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "profile", "json_path": "$.users[0].profile" }, "message": "INVALID_DATA", "status": "error" } ] } }, "InvalidReportingManager": { "description": "Shows the error response when the specified Reporting To user ID is invalid or does not correspond to an eligible reporting manager.", "summary": "Invalid reporting manager", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.users[0].Reporting_To.id" }, "message": "the reporting manager must be superior in reporting hierarchy", "status": "error" } ] } }, "InvalidShiftEffectiveFromDate": { "description": "Shows the error response when the shift effective-from date is outside the valid date range for assignment.", "summary": "Invalid shift effective-from date", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "$shift_effective_from", "json_path": "$.users[0].$shift_effective_from" }, "message": "Shift effective from date should be greater than Current Shift date", "status": "error" } ] } }, "InvalidSortPreference": { "description": "Shows the error response when an unsupported sort order preference is specified for the user.", "summary": "Invalid sort order preference", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "sort_order_preference__s", "json_path": "$.users[0].sort_order_preference__s" }, "message": "Valid sort order preference should be given", "status": "error" } ] } }, "LicenseLimitExceededWhileActivatingUser": { "description": "Shows the error response when activating a user fails because the organization has reached its license limit.", "summary": "License limit exceeded while activating a user", "value": { "users": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "License Limit is Exceeded", "status": "error" } ] } }, "LoggedInUserStatusUpdate": { "description": "Shows the error response when the currently logged-in user attempts to deactivate their own account.", "summary": "Deactivating the currently logged-in user", "value": { "users": [ { "code": "FEATURE_NOT_AVAILABLE", "details": {}, "message": "Share among Subordinates Feature is not available", "status": "error" } ] } }, "MoreThanOneUserUpdationAttempt": { "description": "Shows the error response when more than the maximum allowed number of users are included in a single update request.", "summary": "Updating more than the maximum allowed users", "value": { "code": "INVALID_DATA", "details": { "api_name": "users", "json_path": "$.users", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "NextShiftWithDateWithMoretimePeriod": { "description": "Shows the error response when the next shift effective-from date is set too far in the future beyond the allowed time period.", "summary": "Shift effective-from date exceeds maximum period", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "$shift_effective_from", "expected_data_type": "Maximum time period is six months to move shift", "json_path": "$.users[0].$shift_effective_from" }, "message": "invalid data", "status": "error" } ] } }, "NotUpdatingFortheSameUser": { "description": "Shows the error response when attempting to update restricted fields such as name format or sort preference for another user.", "summary": "Not allowed to update restricted fields for another user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "name_format__s" }, "message": "Cannot update the name_format__s of another User", "status": "error" } ] } }, "NumberAndDecimalSeparatorMismatch": { "description": "Shows the error response when the number separator and decimal separator values are set to the same character during update.", "summary": "Number and decimal separator cannot be the same", "value": { "users": [ { "code": "MAPPING_MISMATCH", "details": { "api_name": "decimal_separator", "json_path": "$.users[0].decimal_separator", "mapped_field": { "api_name": "number_separator", "json_path": "$.users[0].number_separator" } }, "message": "the number separator and decimal separator values should not be same", "status": "error" } ] } }, "PatternMismatchInField": { "description": "Shows the error response when a field value does not match the expected pattern, such as an invalid time format or distance preference.", "summary": "Pattern mismatch in field value", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "time_format", "json_path": "$.users[0].time_format" }, "message": "Pattern not matched", "status": "error" } ] } }, "ReinvitingConfirmedUser": { "description": "Shows the error response when attempting to re-send an invitation to a user who has already confirmed their account.", "summary": "Re-inviting an already confirmed user", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "reinvite" }, "message": "Reinvite is not allowed for a confirmed user", "status": "error" } ] } }, "SameCurrentAndNextShiftId": { "description": "Shows the error response when the current shift and next shift IDs are set to the same value during update.", "summary": "Current and next shift IDs cannot be the same", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "$next_shift.id", "json_path": "$.users[0].$next_shift.id" }, "message": "current shift and next shift should not be same", "status": "error" } ] } }, "ShareAmongFeatureNotEnabled": { "description": "Shows the error response when the share-among-subordinates feature is not enabled in the organization.", "summary": "Share among subordinates feature not enabled", "value": { "users": [ { "code": "INVALID_REQUEST", "details": {}, "message": "You can't perform this action over logged in user", "status": "error" } ] } }, "ShiftEffectiveFromDateMissing": { "description": "Shows the error response when a next shift is specified but the required shift effective-from date is missing from the request.", "summary": "Missing shift effective-from date", "value": { "users": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "$shift_effective_from", "dependee": { "api_name": "$next_shift", "json_path": "$.users[0].$next_shift" }, "json_path": "$.users[0].$shift_effective_from" }, "message": "Dependent Field value should not be null", "status": "error" } ] } }, "SpecialCharacterInField": { "description": "Shows the error response when a field value contains special characters that are not accepted.", "summary": "Special character in a field value", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "first_name", "json_path": "$.users[0].first_name" }, "message": "Special Characters Found", "status": "error" } ] } }, "UpdatingClosedOrDeletedUser": { "description": "Shows the error response when attempting to update a user in a closed or deleted organization.", "summary": "Updating a user in a closed or deleted organization", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "You can't perform this action over a closed/deleted user", "status": "error" } ] } }, "UpdatingCreatedByOrModifiedByField": { "description": "Shows the error response when attempting to update the Created By or Modified By read-only fields on a user record.", "summary": "Updating read-only Created By or Modified By field", "value": { "users": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "created_by", "json_path": "$.users[0].created_by" }, "message": "Created by & Modified by fields cannot be updated by api", "status": "error" } ] } }, "UpdatingDeletedUser": { "description": "Shows the error response when attempting to update a user record that has already been deleted.", "summary": "Updating a deleted user", "value": { "users": [ { "code": "CANNOT_UPDATE_DELETED_USER", "details": {}, "message": "Deleted user cannot be updated", "status": "error" } ] } }, "UpdatingDigitalUserStatus": { "description": "Shows the error response when attempting to change the status of a digital employee user, which is not permitted.", "summary": "Updating digital employee user status", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "type__s", "json_path": "$.users[0].type__s" }, "message": "Digital Employee cannot be Deleted / Deactivated / Activated", "status": "error" } ] } }, "UpdatingEmailForAConfirmedUser": { "description": "Shows the error response when attempting to update the email address of a confirmed user, which is not permitted.", "summary": "Updating email for a confirmed user", "value": { "users": [ { "code": "EMAIL_UPDATE_NOT_ALOWED", "details": { "api_name": "email" }, "message": "Cannot update email of a confirmed CRM User", "status": "error" } ] } }, "UpdatingMoreThanTenUsers": { "description": "Shows the error response when more than 10 users are included in a single update request.", "summary": "Updating more than 10 users at once", "value": { "code": "INVALID_DATA", "details": { "api_name": "users", "json_path": "$.users", "maximum_length": 10 }, "message": "invalid data", "status": "error" } }, "UpdatingNonSubordinateUser": { "description": "Shows the error response when a manager attempts to update a user who is not their subordinate.", "summary": "Updating a non-subordinate user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Non subordinate users cannot be updated", "status": "error" } ] } }, "UpdatingReportingToFieldWithoutEnablingReportingToFeature": { "description": "Shows the error response when the Reporting To field update requires the Reporting To feature to be enabled in the organization.", "summary": "Setting Reporting To without enabling the feature", "value": { "users": [ { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "ReportingTo Feature is not enabled", "status": "error" } ] } }, "UpdatingSameUserIdAsReportingTo": { "description": "Shows the error response when a user attempts to set themselves as their own Reporting To manager.", "summary": "Setting self as Reporting To manager", "value": { "users": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "ReportingTo Id should not be the same as userId" }, "message": "invalid data", "status": "error" } ] } }, "UpdatingSupportUserDetails": { "description": "Shows the error response when attempting to update support user details, which is not permitted.", "summary": "Updating support user details", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Cannot update the user details of support user", "status": "error" } ] } }, "UpdatingUserWithReportingToWithNotSupportedRoles": { "description": "Shows the error response when the Reporting To feature is not supported for the role assigned to the user.", "summary": "Reporting To not supported for the user role", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "Reporting_To" }, "message": "Reporting manager should be from parent roles or from the same role to which the current user belongs", "status": "error" } ] } }, "UpdatingWithoutUserId": { "description": "Shows the error response when a user object in the request body is missing the required user ID field.", "summary": "User ID missing in update request", "value": { "users": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "required field not found", "status": "error" } ] } }, "Updatingtypesfields": { "description": "Shows the error response when attempting to update a read-only user type field during a user update.", "summary": "Updating read-only type field", "value": { "users": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "type__s", "json_path": "$.users[0].type__s" }, "message": "type__s is cannot be updated by api", "status": "error" } ] } }, "UserAlreadyExistsInCRMplus": { "description": "Shows the error response when attempting to create or update a user with an email already registered in the Zoho CRM Plus organization.", "summary": "User already exists in CRM Plus", "value": { "users": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "email", "id": "0987654321" }, "message": "User with same email id is already in CRM Plus", "status": "error" } ] } }, "UserLimitExceeded": { "description": "Shows the error response when activating a user fails because the organization has reached its maximum user count.", "summary": "User limit exceeded", "value": { "users": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "You are trying to activate more mail addon which exceeds your license limit. If you want to activate mail addon for additional users, please upgrade your license", "status": "error" } ] } }, "UserUpdatingWithNotEligibleReportingTo": { "description": "Shows the error response when the specified Reporting To user is not eligible to manage the target user based on their role hierarchy.", "summary": "Reporting To user not eligible", "value": { "users": [ { "code": "CONFLICTING_DATA_FOUND", "details": { "api_name": "Reporting_To", "json_path": "$.users[0].Reporting_To" }, "message": "the user must be updated with new eligible reporting manager because of changing user role", "status": "error" } ] } }, "UserUpdatingWithNotEligibleSubordinates": { "description": "Shows the error response when a role change would result in invalid subordinate relationships in the user hierarchy.", "summary": "Role change creates invalid subordinate relationships", "value": { "users": [ { "code": "CONFLICTING_DATA_FOUND", "details": { "api_name": "Reporting_To", "json_path": "$.users[0].Reporting_To" }, "message": "the user must be updated with new eligible reporting manager and the subordinates who are going to report to a user in a role below them, because of new role change are need to transfer to new eligible reporting manager", "status": "error" } ] } } }, "schema": { "additionalProperties": true, "description": "Contains the list of error result objects returned in the 400 response when user update fails.", "properties": { "users": { "description": "Represents the error result object returned when the user update request fails validation or cannot be processed.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error details for the INVALID_DATA error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum character length allowed for the field.", "format": "int32", "type": "integer" }, "range": { "additionalProperties": false, "description": "Contains the valid date range.", "properties": { "from": { "description": "Represents the start date of the valid date range.", "format": "date", "type": "string" }, "to": { "description": "Represents the end date of the valid date range.", "format": "date", "type": "string" } }, "type": "object" }, "resource_path_index": { "description": "Represents the index position of the resource path in the array for the field that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the invalid data condition. Possible values: **invalid data**, **INVALID_DATA**, **the id given seems to be invalid**,\n**Special Characters Found**, \n**Pattern not matched**, \n**invalid id in reporting to or roles provided**, \n**the number separator and decimal separator values should not be same**, \n**Invalid data. Valid values are Comma/Period/Space (Not case-sensitive)**, \n**Invalid data. Valid values are Comma/Period (Not case-sensitive)**, \n**Give a proper time zone value**, \n**Reporting manager should be from parent roles or from the same role to which the current user belongs**, \n**Valid name format should be given**, \n**Valid sort order preference should be given**, **Give a proper language code**, \n**the reporting manager must be superior in reporting hierarchy**,\n **Effective from should be greater than current date**, \n**Effective from should be less than 6 months**, **Shift effective from date should be greater than Current Shift date**, \n**User is not confirmed so customization information cannot be updated**.", "enum": [ "invalid data", "INVALID_DATA", "the id given seems to be invalid", "Special Characters Found", "Pattern not matched", "invalid id in reporting to or roles provided", "the number separator and decimal separator values should not be same", "Invalid data. Valid values are Comma/Period/Space (Not case-sensitive)", "Invalid data. Valid values are Comma/Period (Not case-sensitive)", "Give a proper time zone value", "Reporting manager should be from parent roles or from the same role to which the current user belongs", "Valid name format should be given", "Valid sort order preference should be given", "Give a proper language code", "the reporting manager must be superior in reporting hierarchy", "Effective from should be greater than current date", "Effective from should be less than 6 months", "Shift effective from date should be greater than Current Shift date", "User is not confirmed so customization info can't be updated" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserInvalidDataError" }, { "additionalProperties": false, "description": "Represents the error schema for the DEPENDENT_MISMATCH error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **DEPENDENT_MISMATCH**.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name, JSON path, and dependee field information.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Contains details about the dependee field that caused the mismatch.", "properties": { "api_name": { "description": "Represents the API name of the dependee field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the dependee field.", "maxLength": 200, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message. Possible values: **Dependent Field value should not be null**.", "enum": [ "Dependent Field value should not be null" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserDependentFieldMissingError" }, { "additionalProperties": false, "description": "Represents the error schema for the NOT_ALLOWED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name, JSON path, user ID, and resource path index.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique ID of the user associated with this error.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" }, "resource_path_index": { "description": "Represents the index position of the resource path in the array for the field that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message when an operation is not allowed. Possible values: **the id given seems to be invalid**, **Support user cannot be activated**, **System user cannot be activated**, **Support user cannot be deactivated**, **System user cannot be deactivated**, **Cannot update the user details of support user**, **System Profile cannot be assigned to other users**, **You are not allowed to perform this operation.**, **Cannot update the name_format__s of another User**, **Non subordinate users cannot be updated**, **You cannot perform this action over a closed/deleted user**, **Support user cannot be added**, **Cannot update the sort_order_preference__s of another User**, **Cannot update the user details of System User**, **current shift and next shift should not be same**.", "enum": [ "the id given seems to be invalid", "Support user cannot be activated", "System user cannot be activated", "Support user cannot be deactivated", "System user cannot be deactivated", "Cannot update the user details of support user", "System Profile cannot be assigned to other users", "You are not allowed to perform this operation.", "Cannot update the name_format__s of another User", "Non subordinate users cannot be updated", "You can't perform this action over a closed/deleted user", "Support user cannot be added", "Cannot update the sort_order_preference__s of another User", "Cannot update the user details of System User", "current shift and next shift should not be same" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserNotAllowedError" }, { "additionalProperties": false, "description": "Represents the error schema for the MANDATORY_NOT_FOUND error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **MANDATORY_NOT_FOUND**.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message when a required field is not found. Possible values: **required field not found**, **Company Name is required**.", "enum": [ "required field not found", "Company Name is required" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserMandatoryNotFoundError" }, { "additionalProperties": false, "description": "Represents the error schema for the CANNOT_UPDATE_DELETED_USER error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **CANNOT_UPDATE_DELETED_USER**.", "enum": [ "CANNOT_UPDATE_DELETED_USER" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message. Possible values: **Deleted user cannot be updated**.", "enum": [ "Deleted user cannot be updated" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserCannotUpdateDeletedUserError" }, { "additionalProperties": false, "description": "Represents the error schema for the EMAIL_UPDATE_NOT_ALOWED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **EMAIL_UPDATE_NOT_ALOWED**.", "enum": [ "EMAIL_UPDATE_NOT_ALOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message when an email update is not allowed. Possible values: **Crm Plus account is not allowed to edit the email while updating the user info**, **Cannot update email of a confirmed CRM User**.", "enum": [ "Crm Plus account is not allowed to edit the email while updating the user info", "Cannot update email of a confirmed CRM User" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserEmailUpdateNotAllowedError" }, { "additionalProperties": false, "description": "Represents the error schema for the INVALID_REQUEST error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **INVALID_REQUEST**.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name, user ID, and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique ID of the user associated with this error.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message for an invalid request. Possible values: **You cannot perform this action over logged in user**, **invalid request**, **Reinvite is not allowed for a confirmed user**, **Primary Contact cannot be deactivated**, **Invalid current shift id**, **Invalid next shift id**.", "enum": [ "You can't perform this action over logged in user", "invalid request", "Reinvite is not allowed for a confirmed user", "Primary Contact cannot be deactivated", "Invalid current shift id", "Invalid next shift id" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserInvalidRequestError" }, { "additionalProperties": false, "description": "Represents the error schema for the DUPLICATE_DATA error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **DUPLICATE_DATA**.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name, the duplicate user ID, and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique ID of the duplicate user.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message when duplicate data is found. Possible values: **User with same email id is already in CRM Plus**, **Email already exists**.", "enum": [ "User with same email id is already in CRM Plus", "Email already exists" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserDuplicateDataError" }, { "additionalProperties": false, "description": "Represents the error schema for the ID_ALREADY_DEACTIVATED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **ID_ALREADY_DEACTIVATED**.", "enum": [ "ID_ALREADY_DEACTIVATED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name and user ID.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique ID of the user.", "maxLength": 19, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message. Possible values: **User is already deactivated**.", "enum": [ "User is already deactivated" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserIdAlreadyDeactivatedError" }, { "additionalProperties": false, "description": "Represents the error schema for the NOT_SUPPORTED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **NOT_SUPPORTED**.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message when the operation is not supported. Possible values: **type__s is cannot be updated by api**, **Created by & Modified by fields cannot be updated by api**.", "enum": [ "type__s is cannot be updated by api", "Created by & Modified by fields cannot be updated by api" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserNotSupportedError" }, { "additionalProperties": false, "description": "Represents the error details for the UNAPPROVABLE error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **UNAPPROVABLE**.", "enum": [ "UNAPPROVABLE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message. Possible values: **You cannot update user in a sandbox org**.", "enum": [ "You cannot update user in a sandbox org" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserUnapprovableError" }, { "additionalProperties": false, "description": "Represents the error details for the LICENSE_LIMIT_EXCEEDED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **LICENSE_LIMIT_EXCEEDED**.", "enum": [ "LICENSE_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Indicates the error message when the license limit is exceeded. Possible values: **You are trying to activate more mail addon which exceeds your license limit. If you want to activate mail addon for additional users, please upgrade your license**, **License Limit is Exceeded**.", "enum": [ "You are trying to activate more mail addon which exceeds your license limit. If you want to activate mail addon for additional users, please upgrade your license", "License Limit is Exceeded" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserLicenseLimitExceededError" }, { "additionalProperties": false, "description": "Represents the error details for the AUTHORIZATION_FAILED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **AUTHORIZATION_FAILED**.", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Indicates the error message when the user lacks authorization. Possible values: **Either trial is expired or user does not have sufficient privilege to perform this action**, **Either trial is expired or user does not have sufficient privilege to perform this action**.", "enum": [ "Either trial is expired or user does not have sufficient previlege to perform this action", "Either trial is expired or user does not have sufficiet previlege to perform this action" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserAuthorizationFailedError" }, { "additionalProperties": false, "description": "Represents the error details for the FEATURE_NOT_AVAILABLE error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **FEATURE_NOT_AVAILABLE**.", "enum": [ "FEATURE_NOT_AVAILABLE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message. Possible values: **Share among Subordinates Feature is not available**.", "enum": [ "Share among Subordinates Feature is not available" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserFeatureNotAvailableError" }, { "additionalProperties": false, "description": "Represents the error schema for the CONFLICTING_DATA_FOUND error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **CONFLICTING_DATA_FOUND**.", "enum": [ "CONFLICTING_DATA_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message when conflicting reporting manager data is found. Possible values: **the user must be updated with new eligible reporting manager because of changing user role**, **the user must be updated with new eligible reporting manager and the subordinates who are going to report to a user in a role below them, because of new role change are need to transfer to new eligible reporting manager**.", "enum": [ "the user must be updated with new eligible reporting manager because of changing user role", "the user must be updated with new eligible reporting manager and the subordinates who are going to report to a user in a role below them, because of new role change are need to transfer to new eligible reporting manager" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserConflictingDataFoundError" }, { "additionalProperties": false, "description": "Represents the error schema for the ID_ALREADY_ACTIVE error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **ID_ALREADY_ACTIVE**.", "enum": [ "ID_ALREADY_ACTIVE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the user ID and JSON path.", "properties": { "id": { "description": "Represents the unique ID of the user.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message. Possible values: **User is already active**.", "enum": [ "User is already active" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserIdAlreadyActiveError" }, { "additionalProperties": false, "description": "Represents the error schema for the MAPPING_MISMATCH error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **MAPPING_MISMATCH**.", "enum": [ "MAPPING_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name, JSON path, and mapped field information.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" }, "mapped_field": { "additionalProperties": false, "description": "Contains information about the mapped field associated with this error.", "properties": { "api_name": { "description": "Represents the API name of the mapped field.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the mapped field.", "maxLength": 200, "type": "string" } }, "type": "object" } }, "type": "object" }, "message": { "description": "Represents the error message. Possible values: **the number separator and decimal separator values should not be same**.", "enum": [ "the number separator and decimal separator values should not be same" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserMappingMismatchError" }, { "additionalProperties": false, "description": "Represents the error schema for the FEATURE_NOT_ENABLED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **FEATURE_NOT_ENABLED**.", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error.", "type": "object" }, "message": { "description": "Indicates the error message when a required feature is not enabled. Possible values: **ReportingTo Feature is not enabled**, **User is not confirmed so customization information cannot be updated**.", "enum": [ "ReportingTo Feature is not enabled", "User is not confirmed so customization info can't be updated" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserFeatureNotEnabledError" }, { "additionalProperties": false, "description": "Represents the error schema for the ALREADY_USED error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **ALREADY_USED**.", "enum": [ "ALREADY_USED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including field identifiers and information about where the value already exists.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Contains information about the location where the value already exists.", "properties": { "api_name": { "description": "Represents the API name of the field where the value already exists.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field where the value already exists.", "maxLength": 200, "type": "string" } }, "type": "object" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message. Possible values: **Current shift and next shift id cannot be the same**.", "enum": [ "Current shift and next shift id cannot be the same" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserAlreadyUsedError" }, { "additionalProperties": false, "description": "Represents the error schema for the NOT_ALLOWED (digital employee) error variant.", "properties": { "code": { "description": "Represents the error code for this error variant. Possible values: **NOT_ALLOWED**.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the error, including the field API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field associated with this error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with this error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message. Possible values: **Digital Employee cannot be Deleted / Deactivated / Activated**.", "enum": [ "Digital Employee cannot be Deleted / Deactivated / Activated" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateUserDigitalEmployeeNotAllowedError" } ], "description": "Represents an individual error result object describing the failure reason for a user update request, including the error code, status, message, and any additional details." }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateUserBadRequestResponse" } } }, "description": "Indicates that the request could not be processed due to validation errors or constraint violations in the input data." }, "403": { "content": { "application/json": { "examples": { "NoPermissionToCreateUser": { "description": "Shows the 403 error response when the caller does not have the required CRM permission to update users.", "summary": "No permission to update a user", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Users" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the permission denied response schema returned when the user lacks the required CRM permissions to update a user.", "properties": { "code": { "description": "Represents the error code for the permission denied response. Possible values: **NO_PERMISSION**, **PERMISSION_DENIED**.", "enum": [ "NO_PERMISSION", "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the permission error, including the list of missing permissions.", "properties": { "permissions": { "description": "Represents the list of permissions that are missing for the requested action.", "items": { "description": "Represents a missing permission required to perform the action. Possible values: **Crm_Implied_Manage_Users**.", "enum": [ "Crm_Implied_Manage_Users" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message. Possible values: **permission denied**.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the response status. Possible values: **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "PermissionDeniedUpdateUserResponse" } } }, "description": "Indicates that the requesting user does not have the required Zoho CRM profile permissions to update users." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.UPDATE" ] } ], "summary": "Update users", "tags": [ "users" ], "x-zoho-document": "users" } }, "/crm/v8/users/actions/transfer": { "get": { "description": "Retrieves the current status of a user transfer operation using the job ID returned by the transfer request. The response indicates whether the transfer job is scheduled, in progress, completed, or failed.", "operationId": "getTransferAPIStatus", "parameters": [ { "$ref": "#/components/parameters/UsersTransferJobId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "TransferStatusResponse": { "description": "Shows a successful response where the transfer operation status is completed.", "summary": "An example response of completed transfer status.", "value": { "transfer": [ { "status": "completed" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the transfer status request, containing the current status of the scheduled transfer job.", "properties": { "transfer": { "description": "Represents the list of transfer operation status details. The array contains a maximum of one object.", "items": { "additionalProperties": false, "description": "Each object represents the status details of a single transfer operation.", "properties": { "reason": { "description": "Represents the failure reason of the job when `status` is `failed`. Not always present.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the current status of the transfer\noperation. \n\n\n**Possible values**: \n\n- in_progress\n\n- completed\n\n- failed\n\n- scheduled\n", "enum": [ "in_progress", "completed", "failed", "scheduled" ], "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer" ], "type": "object", "x-zs-$id": "TransferAPIStatusResponse" } } }, "description": "The transfer status was retrieved successfully." }, "204": { "description": "Shows the response when no transfer job was found for the provided job ID." }, "400": { "content": { "application/json": { "examples": { "MissingJobIdError": { "description": "Shows an error response returned when the **job_id** query parameter is not provided in the request.", "summary": "An example error response of missing job_id parameter.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "job_id" }, "message": "mandatory param missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when a required parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code for the failed request. ", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the name of the missing parameter.", "properties": { "param_name": { "description": "Represents the name of the missing required parameter. ", "enum": [ "job_id" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing parameter. ", "enum": [ "mandatory param missing" ], "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "TransferAPIMissingParamError" } } }, "description": "The request failed due to an invalid or missing required parameter." } }, "security": [ { "OAuth2": [ "ZohoCRM.change_owner.READ" ] } ], "summary": "Get user transfer status", "tags": [ "users_transfer" ], "x-zoho-document": "users_transfer" } }, "/crm/v8/users/actions/transfer_and_delete": { "get": { "description": "Retrieves the current status of a transfer and delete operation using the job ID returned by the POST request. The response indicates whether the job is scheduled, in progress, completed, or failed.", "operationId": "getTransferStatus", "parameters": [ { "$ref": "#/components/parameters/UsersTransferJobId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "TransferStatusResponse": { "description": "Shows a successful response where the transfer and delete operation status is completed.", "summary": "An example of success response of a completed transfer and delete status.", "value": { "transfer_and_delete": [ { "status": "completed" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the transfer and delete status request, containing the current status of the scheduled job.", "properties": { "transfer_and_delete": { "description": "Represents the list of transfer and delete operation status details. The array contains a maximum of one object.", "items": { "additionalProperties": false, "description": "Each object represents the status details of a single transfer and delete operation.", "properties": { "reason": { "description": "Represents the failure reason of the job when `status` is `failed`. The key is not always present.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the current status of the transfer and\ndelete operation. \n\n\n**Possible values**: \n\n- in_progress\n\n- completed\n\n- failed\n\n- scheduled\n", "enum": [ "in_progress", "completed", "failed", "scheduled" ], "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer_and_delete" ], "type": "object", "x-zs-$id": "TransferStatusResponse" } } }, "description": "Shows the success response of the retrieved transfer and delete status." }, "204": { "description": "Shows that no transfer and delete job was found for the provided job ID." }, "400": { "content": { "application/json": { "examples": { "MissingJobIdError": { "description": "Shows an error response returned when the job_id query parameter is not provided in the request.", "summary": "An example response of a missing job_id parameter.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "job_id" }, "message": "mandatory param missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when a required parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code for the failed request. ", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the name of the missing parameter.", "properties": { "param_name": { "description": "Represents the name of the missing required parameter. ", "enum": [ "job_id" ], "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing parameter. ", "enum": [ "mandatory param missing" ], "type": "string" }, "status": { "description": "Represents the status of the API request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "TransferStatusMissingParamError" } } }, "description": "The request failed due to an invalid or missing required parameter." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.DELETE", "ZohoCRM.users.READ" ] } ], "summary": "Get transfer and delete status", "tags": [ "users_transfer" ], "x-zoho-document": "users_transfer" }, "post": { "description": "Transfer user records, assignments, and criteria to another user", "operationId": "userTransferWithoutId", "requestBody": { "content": { "application/json": { "examples": { "TransferAndDeleteExample": { "description": "Shows a request to transfer records and assignments of a user to one target and move subordinates to another, with criteria transfer disabled.", "summary": "An example response for transfer and delete request with user ID in body.", "value": { "transfer_and_delete": [ { "id": "5725767000000411001", "move_subordinate": { "id": "5725767000000411003" }, "transfer": { "assignment": true, "criteria": false, "id": "5725767000000411002", "records": true } } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for transferring and deleting user data", "properties": { "transfer_and_delete": { "description": "Specify the list of user transfer and delete operations to perform. The array accepts a maximum of one entry.", "items": { "additionalProperties": false, "description": "Each object specifies the details of the user transfer and delete operation.", "properties": { "id": { "description": "Specify the unique identifier of the user whose data is to be transferred and who is to be deleted.", "maxLength": 19, "type": "string" }, "move_subordinate": { "additionalProperties": false, "description": "Provides the details of the user to whom subordinates will be moved.", "properties": { "id": { "description": "Specify the unique identifier of the user to whom the subordinates of the deleted user are moved. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "transfer": { "additionalProperties": false, "description": "Provides the transfer settings for records, assignments, and criteria.", "properties": { "assignment": { "description": "Specify whether to transfer the assignments of the deleted user to the target user.", "type": "boolean" }, "criteria": { "description": "Specify whether to transfer the criteria of the deleted user to the target user.", "type": "boolean" }, "id": { "description": "Specify the unique identifier of the user to whom the data of the deleted user is transferred. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values.", "maxLength": 19, "type": "string" }, "records": { "description": "Specify whether to transfer the records of the deleted user to the target user.", "type": "boolean" } }, "required": [ "id" ], "type": "object" } }, "required": [ "id", "move_subordinate", "transfer" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer_and_delete" ], "type": "object" } } }, "description": "The request body contains the data required to perform the operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful response where the system deletes the user and returns a job ID along with the user ID for tracking.", "summary": "An example success response for transfer and delete request. ", "value": { "transfer_and_delete": [ { "code": "SUCCESS", "details": { "id": "5725767000000411001", "job_id": "5725767000000498001" }, "message": "User is deleted successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Provides the response body for successful user transfer and delete operation.", "properties": { "transfer_and_delete": { "description": "Represents an array containing transfer and delete operation results.", "items": { "additionalProperties": false, "description": "Each object represents the result of the user transfer and delete operation.", "properties": { "code": { "description": "Represents the rsponse code indicating operation scheduled.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the scheduled operation.", "properties": { "id": { "description": "Represents the unique identifier of the user involved in the transfer and delete operation.", "maxLength": 19, "type": "string" }, "job_id": { "description": "Represents the unique identifier of the scheduled job created for the transfer and delete operation.", "maxLength": 50, "type": "string" } }, "required": [ "job_id", "id" ], "type": "object" }, "message": { "description": "Represents the message describing the result.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the transfer and delete operation.", "maxLength": 100, "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer_and_delete" ], "type": "object", "x-zs-$id": "UserTransferScheduledResponse" } } }, "description": "Shows the success response of user transfer and delete operation is scheduled." }, "400": { "content": { "application/json": { "examples": { "ExpectedFieldMissingError": { "description": "Shows an error response returned when the required transfer and move_subordinate fields are not provided in the request.", "summary": "An example error response for missing required fields.", "value": { "transfer_and_delete": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_data": [ { "api_name": "transfer", "json_path": "$.transfer_and_delete.transfer" }, { "api_name": "move_subordinate", "json_path": "$.transfer_and_delete.move_subordinate" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidDataError1": { "description": "Shows an error response returned when the transfer_and_delete array exceeds the maximum allowed length of one entry.", "summary": "An example error response for a maximum length exceeded request.", "value": { "code": "INVALID_DATA", "details": { "api_name": "transfer_and_delete", "json_path": "$.transfer_and_delete", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataError2": { "description": "Shows an error response returned when the transfer target user has a deleted owner status.", "summary": "An example error response for deleted transfer target user request.", "value": { "transfer_and_delete": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.transfer_and_delete.transfer.id", "owner_status": "deleted" }, "message": "The user to whom you are trying to transfer is deleted.", "status": "error" } ] } }, "MandatoryFieldMissingError": { "description": "Shows an error response returned when the transfer object is present but its required id field is missing.", "summary": "An example of a missing id field inside the transfer object.", "value": { "transfer_and_delete": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.transfer_and_delete.transfer.id", "parent_api_name": "transfer" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowedSelfDeleteError": { "description": "Shows an error response returned when the id in the request body refers to the user's own account, which cannot be deleted.", "summary": "An example error response for attempting to delete your own account.", "value": { "transfer_and_delete": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.transfer_and_delete.id" }, "message": "Super Admin cannot be Deleted.", "status": "error" } ] } }, "SchedulerLimitExceededError": { "description": "Shows an error response returned when the maximum number of concurrently scheduled transfer and delete jobs has been reached.", "summary": "An example error response for exceeding the concurrent scheduler job limit.", "value": { "code": "CONCURRENT_JOB_LIMIT_EXCEEDED", "details": { "limit": "10" }, "message": "Transfer and delete user scheduler limit reached", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error scenario where the response contains validation errors wrapped inside the transfer_and_delete array.", "properties": { "transfer_and_delete": { "description": "Represents the list of errors encountered during the transfer and delete operation.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents a validation error indicating that the request contains invalid data or a disallowed operation.", "properties": { "code": { "description": "Represents the error code for the validation failure. ", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents error details returned when the provided user ID is invalid or does not exist in the system.", "properties": { "id": { "description": "Represents the identifier value that failed validation in the request.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "UserTransferInvalidIdValue" }, { "additionalProperties": false, "description": "Represents error details returned when a specified field name or JSON path is invalid in the transfer request.", "properties": { "api_name": { "description": "Represents the API name of the field that failed validation.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that failed validation in the request body.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "UserTransferInvalidFieldDetails2" }, { "additionalProperties": false, "description": "Represents error details returned when a field value does not match the expected data type in the transfer request.", "properties": { "api_name": { "description": "Represents the API name of the field that contains an incorrect data type.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the data type that the field expects for a valid request.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains an incorrect data type.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "UserTransferInvalidArrayElementDetails" }, { "additionalProperties": false, "description": "Represents error details returned when the target user has an invalid owner status such as not being a CRM user, deleted, or inactive.", "properties": { "api_name": { "description": "Represents the API name of the field associated with an invalid owner status.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with an invalid owner status.", "maxLength": 200, "type": "string" }, "owner_status": { "description": "Represents the current status of the\nuser that prevents the transfer. \n\n\n**Possible values**: \n\n- no_crm_user\n\n- deleted\n\n- inactive\n", "enum": [ "no_crm_user", "deleted", "inactive" ], "type": "string" } }, "required": [ "api_name", "json_path", "owner_status" ], "type": "object", "x-zs-$id": "UserTransferInvalidOwnerStatusDetails" }, { "additionalProperties": false, "description": "Represents error details returned when an array element contains invalid data or does not match the expected data type.", "properties": { "expected_data_type": { "description": "Represents the data type that the array element expects for a valid request.", "maxLength": 50, "type": "string" }, "index": { "description": "Represents the zero-based index of the array element that contains invalid data.", "format": "int32", "type": "integer" }, "json_path": { "description": "Represents the JSON path of the array element that contains invalid data.", "maxLength": 200, "type": "string" } }, "required": [ "index", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "UserTransferInvalidArrayElement" } ], "description": "Represents the contextual details of the validation error, varying based on the type of invalid data encountered." }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ValidationErrors" }, { "additionalProperties": false, "description": "Represents the error response for expected field missing.\n", "properties": { "code": { "description": "Represents the error code when required fields are missing.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required fields in the request.", "properties": { "expected_data": { "description": "Represents the list of required fields that are missing from the request body.", "items": { "additionalProperties": false, "description": "Each object represents the details of a single required field that is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the required field that is missing from the request.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the required field that is missing from the request.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing required fields.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferExpectedFieldMissing" }, { "additionalProperties": false, "description": "Represents the error response returned when the transfer or move_subordinate object is present but its required id field is missing or null.", "properties": { "code": { "description": "Represents the error code when a required nested field is missing. ", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required id field.", "properties": { "api_name": { "description": "Represents the API name of the missing field.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing field.", "maxLength": 200, "type": "string" }, "parent_api_name": { "description": "Represents the parent field under which the id field is missing.", "enum": [ "transfer", "move_subordinate" ], "type": "string" } }, "required": [ "api_name", "json_path", "parent_api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferMissingTransferIdError" } ], "description": "Each object represents an error entry returned when validation fails or required fields are missing during the transfer and delete operation." }, "maxItems": 1, "type": "array" } }, "required": [ "transfer_and_delete" ], "type": "object", "x-zs-$id": "UserTransferInvalidDataError" }, { "additionalProperties": false, "description": "Represents a top-level error returned when the request data exceeds constraints or contains invalid values.", "properties": { "code": { "description": "Represents the error code for the invalid data. ", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the data constraint violation, including the field that exceeds the maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeds the maximum allowed length.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that exceeds the maximum allowed length.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum number of elements allowed in the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "UserTransferMaxLengthExceededDetails" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferInvalidUserOrDataError" }, { "additionalProperties": false, "description": "Represents the error returned when the maximum number of concurrently scheduled transfer and delete jobs has been reached.", "properties": { "code": { "description": "Represents the error code returned when the scheduler job limit is reached. ", "enum": [ "CONCURRENT_JOB_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the exceeded scheduler limit.", "properties": { "limit": { "description": "Represents the maximum number of transfer and delete jobs that can be scheduled concurrently.", "maxLength": 10, "type": "string" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the scheduler limit.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferSchedulerLimitExceededError" } ], "description": "Represents the error response returned when the transfer and delete operation request contains invalid data, constraint violations, or is missing required fields.", "x-zs-$id": "UserTransferInvalidOrMissingRequiredFieldsResponse" } } }, "description": "Provides the error response body for an invalid data or missing required fields." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows an error response returned when the caller lacks the Crm_Implied_Change_Owner_Leads permission.", "summary": "An example of no permission to transfer issue.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Change_Owner_Leads" ] }, "message": "You do not have permission to perform this operation", "status": "error" } }, "SuperAdminPermissionError": { "description": "Shows an error response returned when a non-super-admin user attempts to transfer and delete a user. The **details** object is not returned for this check.", "summary": "An example error response when the caller is not a super admin.", "value": { "code": "NO_PERMISSION", "message": "Only super admin has permission to delete users", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have the required permissions to perform the transfer and delete operation.", "properties": { "code": { "description": "Represents the error code returned when the user lacks the required permission. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Provides the additional details about missing permissions.", "properties": { "permissions": { "description": "Provides the list of required permissions that are missing.", "items": { "description": "Each string represents the specific CRM permission that the user lacks to perform the transfer and delete operation.", "maxLength": 200, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Provides the message describing the issue in the request.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the error response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "UserTransferPermissionDeniedResponse" } } }, "description": "Provides the error response for a request where user does not have permission to perform this operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.UPDATE" ] } ], "summary": "Transfer and delete a user", "tags": [ "users_transfer" ], "x-zoho-document": "users_transfer" } }, "/crm/v8/users/{userId}/actions/transfer": { "post": { "description": "Transfer user records, assignments, and criteria to another user", "operationId": "userTransferAPI", "parameters": [ { "$ref": "#/components/parameters/UsersTransferUserId" } ], "requestBody": { "content": { "application/json": { "examples": { "TransferExample": { "description": "Shows a request to transfer records and assignments to one user and move subordinates to another user, with criteria transfer disabled.", "summary": "An example of transfer records and assignments.", "value": { "transfer": [ { "move_subordinate": { "id": "5725767000000411001" }, "transfer": { "assignment": true, "criteria": false, "id": "5725767000000411002", "records": true } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body to transfer a user's records, assignments, criteria, and subordinates to another user.", "properties": { "transfer": { "description": "Specify the list of transfer operations to perform for the user. Only one transfer operation is allowed per request.", "items": { "additionalProperties": false, "description": "Each object specifies the details of the transfer operation including subordinate reassignment and data transfer preferences.", "properties": { "move_subordinate": { "additionalProperties": false, "description": "The details of the new user you want to transfer the subordinates of the old user to.", "properties": { "id": { "description": "Specify the unique identifier of the user to whom the subordinates are reassigned. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "transfer": { "additionalProperties": false, "description": "The details of the new user you want to transfer the records of the old user to.", "properties": { "assignment": { "description": "Specify whether to transfer the record assignments to the target user.", "type": "boolean" }, "criteria": { "description": "Specify whether to transfer the criteria-based data to the target user.", "type": "boolean" }, "id": { "description": "Specify the unique identifier of the user to whom the data is transferred. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values.", "maxLength": 19, "type": "string" }, "records": { "description": "Specify whether to transfer the records to the target user.", "type": "boolean" } }, "required": [ "id" ], "type": "object" } }, "required": [ "move_subordinate", "transfer" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer" ], "type": "object" } } }, "description": "The request body contains the data required to perform the operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful response where the system schedules the transfer job and returns a job ID for tracking the progress.", "summary": "An example success response for the scheduled transfer job.", "value": { "transfer": [ { "code": "SCHEDULED", "details": { "job_id": "4243020004133788" }, "message": "transfer of data is successfully scheduled", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Provides the response body for successful user transfer operation\n", "properties": { "transfer": { "description": "Represents an array containing transfer operation results.", "items": { "additionalProperties": false, "description": "Each object represents the result of the user transfer operation.", "properties": { "code": { "description": "Represents the response code indicating operation scheduled.\n", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the scheduled operation.\n", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled job created for the transfer operation.", "maxLength": 19, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the message describing the result.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the transfer operation.", "maxLength": 100, "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer" ], "type": "object", "x-zs-$id": "UserTransferAPIResponse" } } }, "description": "Shows the success response of a user transfer operation is scheduled." }, "400": { "content": { "application/json": { "examples": { "ExpectedFieldMissingError": { "description": "Shows an error response returned when the required transfer and move_subordinate fields are not provided in the request.", "summary": "An example error response of a missing required fields.", "value": { "transfer": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_data": [ { "api_name": "transfer", "json_path": "$.transfer.transfer" }, { "api_name": "move_subordinate", "json_path": "$.transfer.move_subordinate" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidDataError1": { "description": "Shows an error response returned when the user ID in the request path refers to a deleted user.", "summary": "An example error response for a deleted user in path.", "value": { "code": "INVALID_DATA", "details": { "owner_status": "deleted", "resource_path_index": 1 }, "message": "the user id provided is already deleted.", "status": "error" } }, "InvalidDataError2": { "description": "Shows an error response returned when the transfer target user has a deleted owner status.", "summary": "An example error response of a deleted transfer target user.", "value": { "transfer": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.transfer.transfer.id", "owner_status": "deleted" }, "message": "The user to whom you are trying to transfer is deleted.", "status": "error" } ] } }, "MandatoryFieldMissingError": { "description": "Shows an error response returned when the transfer object is present but its required id field is missing.", "summary": "An example of a missing id field inside the transfer object.", "value": { "transfer": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.transfer.transfer.id", "parent_api_name": "transfer" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowedResponse1": { "summary": "An example of error response where Transfer is allowed only for subordinate users of current user.", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Transfer is allowed only for subordinate users of current user.", "status": "error" } }, "SchedulerLimitExceededError": { "description": "Shows an error response returned when the maximum number of concurrently scheduled transfer and delete jobs has been reached.", "summary": "An example error response for exceeding the concurrent scheduler job limit.", "value": { "code": "CONCURRENT_JOB_LIMIT_EXCEEDED", "details": { "limit": "10" }, "message": "Transfer and delete user scheduler limit reached", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error scenario where the response contains validation errors wrapped inside the transfer array.", "properties": { "transfer": { "description": "Represents the list of errors encountered during the transfer operation.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents a validation error indicating that the request contains invalid data or a disallowed operation.", "properties": { "code": { "description": "Represents the error code for the validation failure. ", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents error details returned when a specified field name or JSON path is invalid in the transfer request.", "properties": { "api_name": { "description": "Represents the API name of the field that failed validation in the transfer request.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that failed validation in the transfer request.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "UserTransferAPIInvalidFieldDetails" }, { "additionalProperties": false, "description": "Represents error details returned when the target user has an invalid owner status such as not being a CRM user, deleted, or inactive.", "properties": { "api_name": { "description": "Represents the API name of the field associated with an invalid owner status.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with an invalid owner status.", "maxLength": 200, "type": "string" }, "owner_status": { "description": "Represents the current status of the\nuser that prevents the transfer. \n\n\n**Possible values**: \n\n- not_crm_user\n\n- deleted\n\n- inactive\n", "enum": [ "not_crm_user", "deleted", "inactive" ], "type": "string" } }, "required": [ "api_name", "json_path", "owner_status" ], "type": "object", "x-zs-$id": "UserTransferAPIInvalidOwnerStatusDetails" } ], "description": "Represents the additional details about the validation error." }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferAPIValidationError" }, { "additionalProperties": false, "description": "Provides the error response for expected field missing.\n", "properties": { "code": { "description": "Represents the error code when required fields are missing. ", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required fields in the request.", "properties": { "expected_data": { "description": "Represents the list of required fields that are missing from the request body.", "items": { "additionalProperties": false, "description": "Each object represents the details of a single required field that is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the required field that is missing from the request.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the required field that is missing from the request.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing required fields.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferAPIExpectedFieldMissingError" }, { "additionalProperties": false, "description": "Represents the error response returned when the transfer or move_subordinate object is present but its required id field is missing or null.", "properties": { "code": { "description": "Represents the error code when a required nested field is missing. ", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required id field.", "properties": { "api_name": { "description": "Represents the API name of the missing field.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing field.", "maxLength": 200, "type": "string" }, "parent_api_name": { "description": "Represents the parent field under which the id field is missing.", "enum": [ "transfer", "move_subordinate" ], "type": "string" } }, "required": [ "api_name", "json_path", "parent_api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferAPIMissingTransferIdError" } ], "description": "Each object represents the details of a transfer validation error." }, "maxItems": 1, "type": "array" } }, "required": [ "transfer" ], "type": "object", "x-zs-$id": "UserTransferAPIErrorWithArray" }, { "additionalProperties": false, "description": "Represents a top-level error returned when the user ID in the request path is invalid, refers to a deleted user, or is not allowed to be transferred (e.g. not a subordinate of the caller).", "properties": { "code": { "description": "Represents the error code for the invalid user or not allowed error. ", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the invalid user in the request path. owner_status is not returned for the NOT_ALLOWED case where the target user is not a subordinate of the caller.", "properties": { "owner_status": { "description": "Represents the current status of the user specified in the request path.", "enum": [ "not_crm_user", "deleted" ], "type": "string" }, "resource_path_index": { "description": "Represents the position index of the invalid user ID in the resource path.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "UserTransferAPIInvalidUserInPathDetails" }, "message": { "description": "Represents the error message describing the invalid user in the request path.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferAPIInvalidUserDataError" }, { "additionalProperties": false, "description": "Represents the error returned when the maximum number of concurrently scheduled transfer and delete jobs has been reached.", "properties": { "code": { "description": "Represents the error code returned when the scheduler job limit is reached. ", "enum": [ "CONCURRENT_JOB_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the exceeded scheduler limit.", "properties": { "limit": { "description": "Represents the maximum number of transfer and delete jobs that can be scheduled concurrently.", "maxLength": 10, "type": "string" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the scheduler limit.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferAPISchedulerLimitExceededError" } ], "description": "Represents the error response returned when the transfer request contains invalid data or is missing required fields.", "x-zs-$id": "UserTransferAPIInvalidDataResponse" } } }, "description": "Provides the error response for invalid data or missing required fields." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows an error response returned when the caller lacks the Crm_Implied_Change_Owner_Leads permission.", "summary": "An example error response for no permission to transfer.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Change_Owner_Leads" ] }, "message": "You do not have permission to perform this operation", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have the required permissions to perform the transfer operation.", "properties": { "code": { "description": "Represents the error code returned when the user lacks the required permission. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about missing permissions.\n", "properties": { "permissions": { "description": "Represents the list of required permissions that are missing.", "items": { "description": "Each object represents the specific CRM permission that the user lacks to perform the transfer operation.", "maxLength": 200, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission issue.\n", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the error response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferAPIPermissionDeniedError" } } }, "description": "Provides the error response body where the user does not have permission to perform this operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.change_owner.CREATE" ] } ], "summary": "Transfer a user", "tags": [ "users_transfer" ], "x-zoho-document": "users_transfer" } }, "/crm/v8/users/{userId}/actions/transfer_and_delete": { "post": { "description": "Transfer user records, assignments, and criteria to another user", "operationId": "userTransfer", "parameters": [ { "$ref": "#/components/parameters/UsersTransferUserId" } ], "requestBody": { "content": { "application/json": { "examples": { "TransferAndDeleteExample": { "description": "Shows a request to transfer records and assignments to one user and move subordinates to another user, with criteria transfer disabled.", "summary": "An example response of Transfer and delete request with records and assignments.", "value": { "transfer_and_delete": [ { "move_subordinate": { "id": "5725767000000411001" }, "transfer": { "assignment": true, "criteria": false, "id": "5725767000000411002", "records": true } } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for transferring and deleting user data", "properties": { "transfer_and_delete": { "description": "Specify the list of transfer and delete operations. The array accepts a maximum of one object.", "items": { "additionalProperties": false, "description": "Each object specifies the details for the transfer and delete operation.", "properties": { "move_subordinate": { "additionalProperties": false, "description": "Specify the details of the user to whom the subordinates of the deleted user are moved.", "properties": { "id": { "description": "Specify the unique identifier of the user to whom the subordinates are moved. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "transfer": { "additionalProperties": false, "description": "Specify the transfer settings for records, assignments, and criteria of the deleted user.", "properties": { "assignment": { "description": "Specify whether to replace the user in assignment rules, escalation rules, field updates, and automation actions. ", "type": "boolean" }, "criteria": { "description": "Specify whether to replace the user in criteria for custom views, automation, and reports. ", "type": "boolean" }, "id": { "description": "Specify the unique identifier of the user to whom the records are transferred. Use the [Get Users API](users.yaml#$.paths./users.get) API to get the valid values.", "maxLength": 19, "type": "string" }, "records": { "description": "Specify whether to transfer the open records of the deleted user to the new user. ", "type": "boolean" } }, "required": [ "id" ], "type": "object" } }, "required": [ "move_subordinate", "transfer" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer_and_delete" ], "type": "object" } } }, "description": "The request body to transfer the records, assignments, criteria, and subordinates of the specified user before deletion.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful response where the system deletes the user and returns a job ID for tracking the transfer progress.", "summary": "An example of successful transfer and delete operation.", "value": { "transfer_and_delete": [ { "code": "SUCCESS", "details": { "job_id": "5725767000000498001" }, "message": "User is deleted successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Provides the response body for successful user transfer and delete operation.\n", "properties": { "transfer_and_delete": { "description": "Represents the list of transfer and delete operation results. The array contains a maximum of one object.", "items": { "additionalProperties": false, "description": "Represents the result of a single transfer and delete operation.", "properties": { "code": { "description": "Represents the response code of the operation. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduled transfer and delete operation, including the job ID.", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled transfer and delete job. Use this ID with the [status](users_transfer.yaml#$.paths./users/actions/transfer_and_delete.get) endpoint to track the progress of the job.", "maxLength": 50, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the message describing the result of the operation.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the operation.", "maxLength": 100, "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "transfer_and_delete" ], "type": "object", "x-zs-$id": "UserTransferResponse" } } }, "description": "Shows the user transfer and delete operation is scheduled successfully." }, "400": { "content": { "application/json": { "examples": { "ExpectedFieldMissingError": { "description": "Shows an error response returned when the required transfer and move_subordinate fields are not provided in the request.", "summary": "An example of missing required fields in the request.", "value": { "transfer_and_delete": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_data": [ { "api_name": "transfer", "json_path": "$.transfer_and_delete.transfer" }, { "api_name": "move_subordinate", "json_path": "$.transfer_and_delete.move_subordinate" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "InvalidDataError1": { "description": "Shows an error response returned when the user ID in the request path refers to a deleted user.", "summary": "An example response of deleted user provided in the path.", "value": { "code": "INVALID_DATA", "details": { "owner_status": "deleted", "resource_path_index": 1 }, "message": "the user id provided is already deleted.", "status": "error" } }, "InvalidDataError2": { "description": "Shows an error response returned when the transfer target user has a deleted owner status.", "summary": "An example error response of deleted transfer target user request.", "value": { "transfer_and_delete": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.transfer_and_delete.transfer.id", "owner_status": "deleted" }, "message": "The user to whom you are trying to transfer is deleted.", "status": "error" } ] } }, "JobLimitExceededError": { "description": "Shows an error response returned when the maximum number of concurrently scheduled transfer and delete jobs has been reached.", "summary": "An example error response for exceeding the concurrent scheduler job limit.", "value": { "code": "CONCURRENT_JOB_LIMIT_EXCEEDED", "details": { "limit": "10" }, "message": "Transfer and delete user scheduler limit reached", "status": "error" } }, "MandatoryFieldMissingError": { "description": "Shows an error response returned when the transfer object is present but its required id field is missing.", "summary": "An example of a missing id field inside the transfer object.", "value": { "transfer_and_delete": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.transfer_and_delete.transfer.id", "parent_api_name": "transfer" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowedError": { "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Super Admin cannot be Deleted.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error scenario where the response contains validation errors wrapped inside the transfer_and_delete array.", "properties": { "transfer_and_delete": { "description": "Represents the array of error results from the user transfer and delete operation.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents a validation error indicating that the request contains invalid data or a disallowed operation.", "properties": { "code": { "description": "Represents the error code for the validation failure. ", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents error details returned when the user is not allowed to transfer (e.g. Super Admin cannot be deleted).", "properties": { "resource_path_index": { "description": "Represents the index of the resource path that caused the validation error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "UserTransferNotAllowedPathDetails" }, { "additionalProperties": false, "description": "Represents error details returned when the provided user ID is invalid or does not exist in the system.", "properties": { "id": { "description": "Represents the identifier value that failed validation in the request.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "UserTransferInvalidIdDetails" }, { "additionalProperties": false, "description": "Represents error details returned when a specified field name or JSON path is invalid in the transfer request.", "properties": { "api_name": { "description": "Represents the API name of the field that failed validation.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that failed validation in the request body.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object", "x-zs-$id": "UserTransferInvalidFieldDetails" }, { "additionalProperties": false, "description": "Represents error details returned when a field value does not match the expected data type in the transfer request.", "properties": { "api_name": { "description": "Represents the API name of the field that contains an incorrect data type.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Represents the data type that the field expects for a valid request.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that contains an incorrect data type.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidDataTypeDetails" }, { "additionalProperties": false, "description": "Represents error details returned when the target user has an invalid owner status such as not being a CRM user, deleted, or inactive.", "properties": { "api_name": { "description": "Represents the API name of the field associated with an invalid owner status.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field associated with an invalid owner status.", "maxLength": 200, "type": "string" }, "owner_status": { "description": "Represents the current status of the\nuser that prevents the transfer. \n\n**Possible values**: \n\n- no_crm_user\n\n- deleted\n\n- inactive\n", "enum": [ "no_crm_user", "deleted", "inactive" ], "type": "string" } }, "required": [ "api_name", "json_path", "owner_status" ], "type": "object", "x-zs-$id": "InvalidOwnerStatusDetails" }, { "additionalProperties": false, "description": "Represents error details returned when an array element contains invalid data or does not match the expected data type.", "properties": { "expected_data_type": { "description": "Represents the data type that the array element expects for a valid request.", "maxLength": 50, "type": "string" }, "index": { "description": "Represents the zero-based index of the array element that contains invalid data.", "format": "int32", "type": "integer" }, "json_path": { "description": "Represents the JSON path of the array element that contains invalid data.", "maxLength": 200, "type": "string" } }, "required": [ "index", "json_path", "expected_data_type" ], "type": "object", "x-zs-$id": "InvalidArrayElementDetails" } ], "description": "Represents the contextual details of the validation error, varying based on the type of invalid data encountered." }, "message": { "description": "Represents the error message describing the validation failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferValidationError" }, { "additionalProperties": false, "description": "Represents the error response body for a request where required fields are missing. ", "properties": { "code": { "description": "Represents the error code when required fields are missing. ", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required fields in the request.", "properties": { "expected_data": { "description": "Represents the list of required fields that are missing from the request body.", "items": { "additionalProperties": false, "description": "Each object represents the details of a single required field that is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the required field that is missing from the request.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the required field that is missing from the request.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing required fields.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferExpectedFieldMissingError" }, { "additionalProperties": false, "description": "Represents the error response returned when the transfer or move_subordinate object is present but its required id field is missing or null.", "properties": { "code": { "description": "Represents the error code when a required nested field is missing. ", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the missing required id field.", "properties": { "api_name": { "description": "Represents the API name of the missing field.", "enum": [ "id" ], "type": "string" }, "json_path": { "description": "Represents the JSON path of the missing field.", "maxLength": 200, "type": "string" }, "parent_api_name": { "description": "Represents the parent field under which the id field is missing.", "enum": [ "transfer", "move_subordinate" ], "type": "string" } }, "required": [ "api_name", "json_path", "parent_api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferMandatoryFieldMissingError" } ], "description": "Each object represents an error entry returned when validation fails or required fields are missing during the transfer and delete operation." }, "maxItems": 1, "type": "array" } }, "required": [ "transfer_and_delete" ], "type": "object", "x-zs-$id": "UserTransferErrorWithArray" }, { "additionalProperties": false, "description": "Represents a top-level error returned when the user ID in the request path is invalid or a data constraint is violated.", "properties": { "code": { "description": "Represents the error code for the invalid data or user error. ", "enum": [ "INVALID_DATA", "NOT_ALLOWED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents error details returned when the user ID in the request path is not allowed to be deleted (e.g. own account), or refers to a non-CRM or deleted user.", "properties": { "owner_status": { "description": "Represents the current status of the user specified in the request path. Not returned for the NOT_ALLOWED case where the user tries to delete their own account. ", "enum": [ "not_crm_user", "deleted" ], "type": "string" }, "resource_path_index": { "description": "Represents the position index of the invalid user ID in the resource path.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "UserTransferInvalidUserInPathDetails" }, { "additionalProperties": false, "description": "Represents error details returned when a field value exceeds the maximum allowed length.", "properties": { "api_name": { "description": "Represents the API name of the field that exceeds the maximum allowed length.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that exceeds the maximum allowed length.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum number of elements allowed in the field.", "format": "int32", "type": "integer" } }, "required": [ "api_name", "json_path", "maximum_length" ], "type": "object", "x-zs-$id": "UserTransferMaximumLengthExceededDetails" } ], "description": "Represents the contextual details about the invalid user." }, "message": { "description": "Represents the error message describing the invalid user.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferInvalidUserDataError" }, { "additionalProperties": false, "description": "Represents the error returned when the maximum number of concurrently scheduled transfer and delete jobs has been reached.", "properties": { "code": { "description": "Represents the error code returned when the scheduler job limit is reached. ", "enum": [ "CONCURRENT_JOB_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the exceeded scheduler limit.", "properties": { "limit": { "description": "Represents the maximum number of transfer and delete jobs that can be scheduled concurrently.", "maxLength": 10, "type": "string" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the scheduler limit.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UserTransferJobLimitExceededError" } ], "description": "Represents the error response returned when the transfer and delete operation request contains invalid data or is missing required fields.", "x-zs-$id": "UserTransferInvalidDataResponse" } } }, "description": "Represents the error response when the request has invalid data or any missing required fields." }, "403": { "content": { "application/json": { "examples": { "NoPermissionError": { "description": "Shows an error response returned when the caller lacks the Crm_Implied_Change_Owner_Leads permission.", "summary": "An example error response for no permission to transfer.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Change_Owner_Leads" ] }, "message": "You do not have permission to perform this operation", "status": "error" } }, "SuperAdminPermissionError": { "description": "Shows an error response returned when a non-super-admin user attempts to transfer and delete a user. The **details** object is not returned for this case.", "summary": "An example error response when the caller is not a super admin.", "value": { "code": "NO_PERMISSION", "message": "Only super admin has permission to delete users", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user does not have the required permissions to perform the transfer and delete operation.", "properties": { "code": { "description": "Represents the error code returned when the user lacks the required permission. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about missing permissions.\n\n\n", "properties": { "permissions": { "description": "Provides the list of required permissions that are missing.\n", "items": { "description": "Each string epresents the specific CRM permission that the user lacks to perform the transfer operation, such as `Crm_Implied_Change_Owner_Leads`.", "maxLength": 200, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission issue. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the error response. ", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "UserPermissionDeniedError" } } }, "description": "Shows the error response body of a request when the user does not have enough permission to perform the operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.UPDATE" ] } ], "summary": "Transfer and delete a user", "tags": [ "users_transfer" ], "x-zoho-document": "users_transfer" } }, "/crm/v8/users/{userId}/actions/validate_before_transfer": { "get": { "description": "Validates whether the specified user has open records, assignments, criteria configurations, subordinates, or alerts before transferring the user's data. Use this operation to check the user's dependencies before initiating a transfer.", "operationId": "getValidateBeforeTransferStatus", "parameters": [ { "$ref": "#/components/parameters/UsersTransferUserId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "TransferStatusResponse": { "description": "Shows a successful response with the validation details for a user who has assignments and subordinates but no criteria or alerts.", "summary": "An example successful response for pre-transfer validation.", "value": { "validate_before_transfer": [ { "alert": false, "assignment": true, "criteria": false, "id": "5725767000000411001", "name": "John Doe", "subordinates": true } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the pre-transfer validation request, containing details about the user's records, assignments, criteria, subordinates, and alerts.", "properties": { "validate_before_transfer": { "description": "Represents the list of pre-transfer validation results for the specified user. The array contains a maximum of one object.", "items": { "additionalProperties": false, "description": "Represents the validation details for a single user before transfer.", "properties": { "alert": { "description": "Indicates whether alerts exist for the user. ", "type": "boolean" }, "assignment": { "description": "Indicates whether assignments exist for the user. ", "type": "boolean" }, "criteria": { "description": "Indicates whether criteria configurations exist for the user. ", "type": "boolean" }, "id": { "description": "Represents the unique identifier of the user being validated.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the user being validated.", "maxLength": 250, "type": "string" }, "subordinates": { "description": "Indicates whether subordinates exist for the user. ", "type": "boolean" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "validate_before_transfer" ], "type": "object", "x-zs-$id": "ValidateBeforeTransferStatusResponse" } } }, "description": "The pre-transfer validation details were retrieved successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows an error response returned when the user ID provided in the request path is invalid.", "summary": "An example error response for an invalid user ID.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the id given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the provided user ID is invalid.", "properties": { "code": { "description": "Represents the error code for the failed request. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the index of the resource path that caused the failure.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path that contains the invalid value.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ValidateBeforeTransferErrorResponse" } } }, "description": "The request failed due to an invalid user ID or request parameters." }, "403": { "content": { "application/json": { "examples": { "SelfValidationNotAllowed": { "description": "Shows an error response returned when the user attempts to validate their own account before transfer.", "summary": "An example error response when validating your own account.", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Super Admin cannot be validated.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the user attempts to validate their own account before transfer.", "properties": { "code": { "description": "Represents the error code for the disallowed self-check.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the index of the resource path that caused the failure.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path that contains the invalid value.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "ValidateBeforeTransferSelfCheckError" } } }, "description": "Shows the error response body of a request when the user attempts to validate their own account before transfer." } }, "security": [ { "OAuth2": [ "ZohoCRM.change_owner.READ" ] } ], "summary": "Validate user before transfer", "tags": [ "users_transfer" ], "x-zoho-document": "users_transfer" } }, "/crm/v8/users/{user}": { "delete": { "description": "To delete a specific user from your Zoho CRM organization, submit a DELETE request with the target user ID. Only one user can be removed per request, and certain protected user types — including support, system, Digital Employee, and primary contact users — cannot be deleted.", "operationId": "deleteUser", "parameters": [ { "$ref": "#/components/parameters/UsersUser" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUserDeletion": { "description": "Shows the success response returned when a user is successfully removed from a Zoho CRM organization. The response confirms the operation with a SUCCESS status code and a corresponding message.", "summary": "User deleted successfully from the organization", "value": { "users": [ { "code": "SUCCESS", "details": { "id": "111113000000071587" }, "message": "User deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned after a user has been deleted from the Zoho CRM organization.", "properties": { "users": { "description": "Represents the list of deletion results for the requested user.", "items": { "additionalProperties": false, "description": "Represents the status and details of the user deletion operation.", "properties": { "code": { "description": "Indicates the result of the deletion request.\nPossible values:\nSUCCESS - The API successfully deleted the user.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the deleted user record.", "properties": { "id": { "description": "Represents the unique ID of the deleted user.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Indicates the outcome of the deletion request.\nPossible values:\nUser deleted - The user was removed from the organization successfully.", "enum": [ "User deleted" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nsuccess - The deletion request was processed successfully.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "DeleteUserSuccessResponse" } } }, "description": "Returns a success response confirming that the specified user has been deleted from the Zoho CRM organization." }, "400": { "content": { "application/json": { "examples": { "DeletingAlreadyDeletedUser": { "description": "Shows the error response returned when a DELETE request targets a user that has already been removed from the Zoho CRM organization. The response includes the ID_ALREADY_DELETED error code.", "summary": "Delete request targeting a previously deleted user", "value": { "users": [ { "code": "ID_ALREADY_DELETED", "details": { "id": "2922942000003738152", "json_path": "$.users[0].id" }, "message": "User is already deleted", "status": "error" } ] } }, "DeletingWithoutSufficientPrivileges": { "description": "Shows the AUTHORIZATION_FAILED error response returned when the authenticated user has the Manage Subordinates restriction enabled or attempts to delete a user outside their reporting hierarchy.", "summary": "Delete attempt by a user without sufficient privileges", "value": { "users": [ { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient previlege to delete users", "status": "error" } ] } }, "DigitalUserDeletion": { "description": "Shows the NOT_ALLOWED error response returned when the targeted user is a Digital Employee, a protected type that cannot be deleted, deactivated, or activated in a Zoho CRM organization.", "summary": "Delete attempt on a Digital Employee user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Digital Employee cannot be deleted/deactivated/activated", "status": "error" } ] } }, "InValidUserIdResponse": { "description": "Shows the INVALID_DATA error response returned when the user ID supplied in the request path does not correspond to any user in the Zoho CRM organization.", "summary": "Delete request with an invalid user ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the id given seems to be invalid", "status": "error" } }, "SupportUserDeletionResponse": { "description": "Shows the NOT_ALLOWED error response returned when the targeted user is a support user, a protected type that cannot be deleted from a Zoho CRM organization.", "summary": "Delete attempt on a support user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Support user cannot be deleted", "status": "error" } ] } }, "SystemUserDeletionResponse": { "description": "Shows the NOT_ALLOWED error response returned when the targeted user is a system user, a protected type that cannot be deleted from a Zoho CRM organization.", "summary": "Delete attempt on a system user", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "System user cannot be deleted", "status": "error" } ] } }, "UserDeletionInSandBox": { "description": "Shows the NOT_ALLOWED error response returned when a DELETE request is issued against a user in a sandbox Zoho CRM organization, where user deletion is not permitted.", "summary": "Delete attempt within a sandbox organization", "value": { "users": [ { "code": "NOT_ALLOWED", "details": {}, "message": "You cannot delete user in a sandbox org", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when the provided user ID is invalid.\n**Resolution:** Verify that the user ID supplied in the request path corresponds to an existing user in the Zoho CRM organization.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nINVALID_DATA - The provided user ID is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the INVALID_DATA error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path that caused the INVALID_DATA error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message describing why the request failed.\nPossible values:\nthe id given seems to be invalid - The supplied user ID does not correspond to a valid user.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "DeleteUserInvalidDataError" }, { "additionalProperties": false, "description": "Represents the error response returned when an attempt is made to delete a user from a sandbox organization.\n**Resolution:** Perform the user deletion operation against a production Zoho CRM organization rather than a sandbox environment.", "properties": { "users": { "description": "Represents the list of error results for the deletion request.", "items": { "additionalProperties": false, "description": "Represents the error details for the failed deletion attempt.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nNOT_ALLOWED - The requested operation is not permitted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the NOT_ALLOWED error.", "properties": {}, "type": "object" }, "message": { "description": "Indicates the error message describing why the operation was not permitted.\nPossible values:\nYou cannot delete user in a sandbox org - The user cannot be deleted because the organization is a sandbox.", "enum": [ "You cannot delete user in a sandbox org" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeleteUserSandboxNotAllowedError" }, { "additionalProperties": false, "description": "Represents the error response returned when an attempt is made to DELETE a support user, which is a protected user type.\n**Resolution:** Confirm the target user type before issuing the DELETE request, as support users cannot be deleted from a Zoho CRM organization.", "properties": { "users": { "description": "Represents the list of error results for the deletion request.", "items": { "additionalProperties": false, "description": "Represents the error details for the failed deletion attempt.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nNOT_ALLOWED - The requested operation is not permitted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the NOT_ALLOWED error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path that caused the NOT_ALLOWED error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message describing why the operation was not permitted.\nPossible values:\nSupport user cannot be deleted - A support user account cannot be removed from the organization.", "enum": [ "Support user cannot be deleted" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeleteUserSupportUserError" }, { "additionalProperties": false, "description": "Represents the error response returned when an attempt is made to DELETE a system user, which is a protected user type.\n**Resolution:** Confirm the target user type before issuing the DELETE request, as system users cannot be deleted from a Zoho CRM organization.", "properties": { "users": { "description": "Represents the list of error results for the deletion request.", "items": { "additionalProperties": false, "description": "Represents the error details for the failed deletion attempt.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nNOT_ALLOWED - The requested operation is not permitted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the NOT_ALLOWED error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path that caused the NOT_ALLOWED error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message describing why the operation was not permitted.\nPossible values:\nSystem user cannot be deleted - A system user account cannot be removed from the organization.", "enum": [ "System user cannot be deleted" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeleteUserSystemUserError" }, { "additionalProperties": false, "description": "Represents the error response returned when the authenticated user lacks sufficient privileges to delete other users.\n**Resolution:** Ensure the authenticated user profile includes the necessary user management privileges in the Zoho CRM organization.", "properties": { "users": { "description": "Represents the list of error results for the deletion request.", "items": { "additionalProperties": false, "description": "Represents the error details for the failed deletion attempt.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nAUTHORIZATION_FAILED - The user does not have sufficient privileges to perform this operation.", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the AUTHORIZATION_FAILED error.", "properties": {}, "type": "object" }, "message": { "description": "Indicates the error message when the user lacks the necessary privileges to delete users.\nPossible values:\nUser does not have sufficient previlege to delete users - The requesting user does not have permission to delete users.", "enum": [ "User does not have sufficient previlege to delete users" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeleteUserAuthorizationFailedError" }, { "additionalProperties": false, "description": "Represents the error response returned when the specified user has already been deleted from the Zoho CRM organization.\n**Resolution:** Verify the current status of the user before attempting deletion to avoid issuing a duplicate DELETE request.", "properties": { "users": { "description": "Represents the list of error results for the deletion request.", "items": { "additionalProperties": false, "description": "Represents the error details for the failed deletion attempt.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nID_ALREADY_DELETED - The specified user has already been deleted.", "enum": [ "ID_ALREADY_DELETED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the ID_ALREADY_DELETED error.", "properties": { "id": { "description": "Represents the unique ID of the user that caused the ID_ALREADY_DELETED error.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the ID_ALREADY_DELETED error.\nPossible values:\n$.users[0].ID - Identifies the user ID field in the request.", "enum": [ "$.users[0].id" ], "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message when the user account has already been deleted.\nPossible values:\nUser is already deleted - The specified user was previously removed from the organization.", "enum": [ "User is already deleted" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeleteUserAlreadyDeletedError" }, { "additionalProperties": false, "description": "Represents the error response returned when an attempt is made to DELETE a Digital Employee user, which cannot be deleted, deactivated, or activated.\n**Resolution:** Confirm the target user type before issuing the DELETE request, as Digital Employee users are not eligible for deletion in a Zoho CRM organization.", "properties": { "users": { "description": "Represents the list of error results for the deletion request.", "items": { "additionalProperties": false, "description": "Represents the error details for the failed deletion attempt.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nNOT_ALLOWED - The requested operation is not permitted.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the NOT_ALLOWED error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path that caused the NOT_ALLOWED error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message when the user type cannot be deleted.\nPossible values:\nDigital Employee cannot be deleted/deactivated/activated - A Digital Employee user account cannot be deleted, deactivated, or activated.", "enum": [ "Digital Employee cannot be deleted/deactivated/activated" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeleteUserDigitalEmployeeError" }, { "additionalProperties": false, "description": "Represents the error response returned when an attempt is made to delete the primary contact of the Zoho CRM organization.\n**Resolution:** Reassign the primary contact role to another user before attempting to delete the current primary contact.", "properties": { "users": { "description": "Represents the list of error results for the deletion request.", "items": { "additionalProperties": false, "description": "Represents the error details for the failed deletion attempt.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nINVALID_REQUEST - The request contains invalid data or violates a business rule.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the INVALID_REQUEST error.", "properties": { "id": { "description": "Represents the unique ID of the user that caused the INVALID_REQUEST error.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Represents the JSON path of the field that caused the INVALID_REQUEST error.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message when the primary contact cannot be deleted.\nPossible values:\nPrimary contact cannot be deleted - The primary contact of the organization cannot be removed.", "enum": [ "Primary contact cannot be deleted" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object", "x-zs-$id": "DeleteUserPrimaryContactError" } ], "description": "Represents one of several 400 error responses returned when the user deletion request is invalid or cannot be completed.", "x-zs-$id": "DeleteUserErrorResponse" } } }, "description": "Returns an error response when the user deletion request cannot be processed due to invalid data, a protected user type, insufficient privileges, a duplicate deletion, or an invalid request." }, "403": { "content": { "application/json": { "examples": { "DeletingClosedOrDeletedUser": { "description": "Shows the 403 error response returned when the DELETE request targets a user belonging to a closed or deleted Zoho CRM organization, rendering the operation forbidden.", "summary": "Delete attempt targeting a closed or deleted organization", "value": { "code": "PERMISSION_DENIED", "details": {}, "message": "You can't perform this action over a closed/deleted user", "status": "error" } }, "DeletionLimitExceededForOrg": { "description": "Shows the 403 error response returned when the Zoho CRM organization has reached the maximum allowable number of user deletions, preventing further delete operations.", "summary": "Delete request rejected because the organization deletion limit is exceeded", "value": { "code": "PERMISSION_DENIED", "details": {}, "message": "User deletion is not allowed for the org because of CrmKeyValue entry RESTRICT_USER_DELETION_FOR_THE_ORG & deleted users count exceeded 10", "status": "error" } }, "PermissionDeniedResponse": { "description": "Shows the PERMISSION_DENIED error response returned when the authenticated caller profile does not include the permission required to delete users in the Zoho CRM organization.", "summary": "Delete request denied due to insufficient profile permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Users" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the caller does not have permission to delete the specified user or when the operation is forbidden for the target organization.", "properties": { "code": { "description": "Indicates the error code for this error condition.\nPossible values:\nNO_PERMISSION - The user lacks the required CRM profile permission.\nPERMISSION_DENIED - The user does not have permission to perform this action.", "enum": [ "NO_PERMISSION", "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional information about the permission error.", "properties": { "permissions": { "description": "Represents the list of missing CRM profile permissions that caused the error.", "items": { "description": "Represents a missing CRM profile permission required to perform this operation.\nPossible values:\nCrm_Implied_Manage_Users - Permission to manage users in the Zoho CRM organization.", "enum": [ "Crm_Implied_Manage_Users" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the permission error.\nPossible values:\npermission denied - The user does not have the required permission to delete users.\nYou can't perform this action over a closed/deleted user - The target user account is closed or already deleted.\nUser deletion is not allowed for the org because of CrmKeyValue entry RESTRICT_USER_DELETION_FOR_THE_ORG & deleted users count exceeded 10 - The organization has reached the maximum limit for user deletions.", "enum": [ "permission denied", "You can't perform this action over a closed/deleted user", "User deletion is not allowed for the org because of CrmKeyValue entry RESTRICT_USER_DELETION_FOR_THE_ORG & deleted users count exceeded 10" ], "type": "string" }, "status": { "description": "Indicates the status of the API request.\nPossible values:\nerror - The request failed.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "PermissionDeniedDeleteResponse" } } }, "description": "Returns an error response when the caller does not have permission to delete users.\n**Resolution:** The CRM administrator must grant the required user management permission to the caller profile in the Zoho CRM organization." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.DELETE" ] } ], "summary": "Delete a user from the organization", "tags": [ "users" ], "x-zoho-document": "users" }, "get": { "description": "To retrieve the details of a specific user in Zoho CRM, use the unique user ID as the path parameter.", "operationId": "getSingleUser", "parameters": [ { "$ref": "#/components/parameters/UsersUser" }, { "$ref": "#/components/parameters/UsersFields" }, { "$ref": "#/components/parameters/TypeS" } ], "responses": { "200": { "content": { "application/json": { "examples": { "UsersGetResponse": { "description": "Shows the user record for a specified user ID, including profile, role, and status details.", "summary": "Retrieve a single user by ID", "value": { "users": [ { "$current_shift": null, "$next_shift": { "id": "111133000000023456", "name": "Evening Shift" }, "$shift_effective_from": null, "Modified_By": { "id": "111133000000057662", "name": "Thuvassshhhh test test" }, "Modified_Time": "2025-12-08T16:53:16+05:30", "Reporting_To": null, "alias": "aaaa", "confirm": true, "created_by": { "id": "111133000000057662", "name": "Thuvassshhhh test test" }, "created_time": "2025-11-12T11:20:12+05:30", "customize_info": { "bc_view": null, "notes_desc": false, "show_detail_view": true, "show_home": false, "show_left_panel": true, "show_right_panel": null, "unpin_recent_item": null }, "date_format": "MM/dd/yyyy", "decimal_separator": "Period", "email": "user@example.com", "first_name": "Thuvassshhhh", "full_name": "Thuvassshhhh test test", "id": "111133000000057662", "image_link": "https://profile.csez.zohocorpin.com/file?ID=43318041&fs=thumb", "last_name": "test test", "locale": "en_US", "microsoft": false, "personal_account": false, "phone": null, "profile": { "id": "111133000000000497", "name": "Administrator" }, "role": { "id": "111133000000000861", "name": "CEO" }, "sandboxDeveloper": false, "status": "disabled", "status_reason__s": null, "theme": { "background": "#F3F0EB", "new_background": null, "normal_tab": { "background": "#222222", "font_color": "#FFFFFF" }, "screen": "fixed", "selected_tab": { "background": "#222222", "font_color": "#FFFFFF" }, "type": "default" }, "type__s": "Regular User", "zuid": "43318041" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the user record returned for the specified user ID.\n", "properties": { "users": { "description": "Represents the list of user records returned for the specified user ID.", "items": { "$ref": "#/components/schemas/GetUserDetails" }, "maxItems": 200, "type": "array" } }, "type": "object", "x-zs-$id": "UsersSingleGetResponse" } } }, "description": "Returns the details of the specified user." }, "204": { "description": "No content returned. No user record exists for the specified user ID." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.READ" ] } ], "summary": "Get a specific user", "tags": [ "users" ], "x-zoho-document": "users" }, "put": { "description": "To update the details of a specific user in your Zoho CRM organization by user ID.", "operationId": "updateSingleUser", "parameters": [ { "$ref": "#/components/parameters/UsersUser" } ], "requestBody": { "content": { "application/json": { "examples": { "UserAdded": { "description": "Shows a sample request body for updating an individual user with their ID and the fields to modify.", "summary": "Update Single User Request", "value": { "users": [ { "email": "user@example.com", "first_name": "rfdc2", "profile": { "id": "2922942000000015972", "name": "Administrator" }, "role": { "id": "2922942000000015966", "name": "CEO" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the structure of the user update request body. Contains a users array with the details of the user to update.", "properties": { "users": { "description": "Specify the user details to update. Only one user record can be submitted per request.", "items": { "$ref": "#/components/schemas/UserDetails" }, "maxItems": 1, "type": "array" } }, "required": [ "users" ], "type": "object" } } }, "description": "The request body must contain a users array with one object." }, "responses": { "200": { "content": { "application/json": { "examples": { "UserUpdatedSuccessfully": { "description": "Shows a successful single user update response including the updated user ID and confirmation of the update.", "summary": "Single User Updated Successfully", "value": { "users": [ { "code": "SUCCESS", "details": { "id": "111113000000071587" }, "message": "User updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the structure of the user update success response. Contains a users array with the outcome of the update operation.", "properties": { "users": { "description": "Represents the list of outcome objects returned after processing the user update request. Each element reports the result status for the updated user record.", "items": { "additionalProperties": false, "description": "Represents the outcome of a single user update operation. Contains the status code, a message, the unique identifier of the updated user, and the overall request status.", "properties": { "code": { "description": "Indicates the API-level result code for the user update operation.\n\nPossible values:\nSUCCESS - The user record updates successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents an object containing identifying information about the updated user. Includes the unique ID of the user.", "properties": { "id": { "description": "Represents the unique system-generated identifier of the updated user.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Indicates the message describing the outcome of the user update operation.\n\nPossible values:\nUser updated - The user record updates successfully.", "enum": [ "User updated" ], "type": "string" }, "status": { "description": "Indicates the overall processing status of the user update request.\n\nPossible values:\nsuccess - The request processes and the user record updates without errors.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "maxItems": 10, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateSingleUserSuccessResponse" } } }, "description": "Returns the result of the user update operation, including the status and unique ID of the updated user." }, "400": { "content": { "application/json": { "examples": { "ActivatingSupportUser": { "description": "Shows the error response when attempting to activate a support user, which is not permitted in Zoho CRM.", "summary": "Activating a Support User", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Support user cannot be activated", "status": "error" } ] } }, "ActivatingSystemUser": { "description": "Shows the error response when attempting to activate a system user, which is not permitted in Zoho CRM.", "summary": "Activating a System User", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "System user cannot be activated", "status": "error" } ] } }, "AlreadyActiveUserActivation": { "description": "Shows demonstrates the error response when attempting to activate a user that is already in the active state.", "summary": "Activating an Already Active User", "value": { "users": [ { "code": "ID_ALREADY_ACTIVE", "details": { "id": "0987654321", "json_path": "$.users[0].id" }, "message": "User is already active", "status": "error" } ] } }, "AssigningSystemProfileToUser": { "description": "Shows demonstrates the error response when attempting to assign a system profile to a user, which is not allowed.", "summary": "Assigning System Profile to User", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profile", "json_path": "$.users[0].profile" }, "message": "System Profile cannot be assigned to other users", "status": "error" } ] } }, "CreatingSupportOrSystemUser": { "description": "Shows demonstrates the error response when attempting to change a user type to a support or system user type, which is not permitted via the API.", "summary": "Changing User to Support or System Type", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "profile" }, "message": "Support user cannot be added", "status": "error" } ] } }, "CrmPlusUserEmailUpdate": { "description": "Shows demonstrates the error response when attempting to update the email address of a crm plus user, which is not permitted.", "summary": "Email Update for CRM Plus User", "value": { "users": [ { "code": "EMAIL_UPDATE_NOT_ALOWED", "details": { "api_name": "email" }, "message": "Crm Plus account is not allowed to edit the email while updating the user info", "status": "error" } ] } }, "DeactivatingAlreadyDeactivatedUser": { "description": "Shows demonstrates the error response when attempting to deactivate a user that is already in the inactive state.", "summary": "Deactivating an Already Deactivated User", "value": { "users": [ { "code": "ID_ALREADY_DEACTIVATED", "details": { "api_name": "id", "id": "$.users[0].id" }, "message": "User is already deactivated", "status": "error" } ] } }, "DeactivatingPrimaryUser": { "description": "Shows demonstrates the error response when attempting to deactivate the primary (super admin) user of the organization.", "summary": "Deactivating the Primary User", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "id": "0987654321", "json_path": "$.users[0].id" }, "message": "Primary Contact cannot be deactivated", "status": "error" } ] } }, "DeactivatingSupportUser": { "description": "Shows demonstrates the error response when attempting to deactivate a support user, which is not permitted.", "summary": "Deactivating a Support User", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Support user cannot be deactivated", "status": "error" } ] } }, "DeactivatingSystemUser": { "description": "Shows demonstrates the error response when attempting to deactivate a system user, which is not permitted.", "summary": "Deactivating a System User", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "System user cannot be deactivated", "status": "error" } ] } }, "DeletedUserUpdate": { "description": "Shows demonstrates the error response when attempting to update a user that has been deleted.", "summary": "Updating a Deleted User", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "the id given seems to be invalid", "status": "error" } }, "DigitalUserStatusUpdate": { "description": "Shows demonstrates the error response when attempting to change the status of a digital employee user, which is not permitted.", "summary": "Digital Employee User Status Change", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "id": "0987654321" }, "message": "You are not allowed to perform this operation.", "status": "error" } ] } }, "DuplicateEmailId": { "description": "Shows demonstrates the error response when attempting to update a user with an email address that is already registered in the organization.", "summary": "Duplicate Email Address in User Update", "value": { "users": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "email", "json_path": "$.users[0].email" }, "message": "Email already exists", "status": "error" } ] } }, "InSufficientPrivilegesToUpdateUser": { "description": "Shows demonstrates the error response when the caller does not have sufficient privileges to update the target user.", "summary": "Insufficient Privileges to Update User", "value": { "users": [ { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "Either trial is expired or user does not have sufficiet previlege to perform this action", "status": "error" } ] } }, "InValidUserIdResponse": { "description": "Shows demonstrates the error response when the specified user ID is invalid or does not correspond to a valid user.", "summary": "Invalid User ID in Update Request", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the id given seems to be invalid", "status": "error" } }, "InsufficientPrevilidgesToUpdateUser": { "description": "Shows demonstrates the error response when the caller lacks the required authorization level to update another user.", "summary": "Insufficient Authorization to Update User", "value": { "users": [ { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "Either trial is expired or user does not have sufficient previlege to perform this action", "status": "error" } ] } }, "InvalidCurrenntShiftId": { "description": "Shows demonstrates the error response when the specified current shift ID does not correspond to an existing shift.", "summary": "Invalid Current Shift ID", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "$current_shift", "json_path": "$.users[0].$current_shift.id" }, "message": "Invalid current shift id", "status": "error" } ] } }, "InvalidDataErrorResponse": { "description": "Shows demonstrates the error response when one or more fields in the request body contain invalid data.", "summary": "Invalid Data in Update Request", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "time_zone", "json_path": "$.users[0].time_zone" }, "message": "Give a proper time zone value", "status": "error" } ] } }, "InvalidDataInResponse2": { "description": "Shows invalid ID in reporting to or roles provided.", "summary": "Invalid Data - Alternate Scenario", "value": { "users": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "Valid userid should be given" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDecimalSeparator": { "description": "Shows demonstrates the error response when an invalid decimal separator value is specified during user update.", "summary": "Invalid Decimal Separator", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "decimal_separator", "json_path": "$.users[0].decimal_separator" }, "message": "Invalid data. Valid values are Comma/Period (Not case-sensitive)", "status": "error" } ] } }, "InvalidLanguageCode": { "description": "Shows demonstrates the error response when an unsupported or invalid language code is specified for the user.", "summary": "Invalid Language Code", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "language", "json_path": "$.users[0].language" }, "message": "Give a proper language code", "status": "error" } ] } }, "InvalidNameFormat": { "description": "Shows demonstrates the error response when an unsupported name format is specified for the user.", "summary": "Invalid Name Format", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "name_format__s", "json_path": "$.users[0].name_format__s" }, "message": "Valid name format should be given", "status": "error" } ] } }, "InvalidNextShiftId": { "description": "Shows demonstrates the error response when the specified next shift ID does not correspond to an existing shift.", "summary": "Invalid Next Shift ID", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "$next_shift", "json_path": "$.users[0].$next_shift.id" }, "message": "Invalid next shift id", "status": "error" } ] } }, "InvalidNumberSeparator": { "description": "Shows demonstrates the error response when an invalid number separator value is specified during user update.", "summary": "Invalid Number Separator", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "number_separator", "json_path": "$.users[0].number_separator" }, "message": "Invalid data. Valid values are Comma/Period/Space (Not case-sensitive)", "status": "error" } ] } }, "InvalidProfieIdOrRoleIdOrLocale": { "description": "Shows invalid profile ID or role ID or locale value provided. api_name and json_path will have the field name(profile/role/locale) accordingly.", "summary": "Invalid Profile ID, Role ID, or Locale", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "profile", "json_path": "$.users[0].profile" }, "message": "INVALID_DATA", "status": "error" } ] } }, "InvalidReportingManager": { "description": "Shows demonstrates the error response when the specified reporting to user ID is invalid or does not correspond to an eligible manager.", "summary": "Invalid Reporting Manager", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.users[0].Reporting_To.id" }, "message": "the reporting manager must be superior in reporting hierarchy", "status": "error" } ] } }, "InvalidShiftEffectiveFromDate": { "description": "Shows demonstrates the error response when the shift effective-from date is outside the valid date range for assignment.", "summary": "Invalid Shift Effective From Date", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "$shift_effective_from", "json_path": "$.users[0].$shift_effective_from" }, "message": "current shift and next shift should not be same", "status": "error" } ] } }, "InvalidSortPreference": { "description": "Shows demonstrates the error response when an unsupported sort order preference is specified for the user.", "summary": "Invalid Sort Order Preference", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "sort_order_preference__s", "json_path": "$.users[0].sort_order_preference__s" }, "message": "Valid sort order preference should be given", "status": "error" } ] } }, "LicenseLimitExceededWhileActivatingUser": { "description": "Shows demonstrates the error response when activating a user fails because the organization has reached its license limit.", "summary": "License Limit Exceeded While Activating User", "value": { "users": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "License Limit is Exceeded", "status": "error" } ] } }, "LoggedInUserStatusUpdate": { "description": "Shows demonstrates the error response when the currently logged-in user attempts to deactivate their own account.", "summary": "Deactivating the Currently Logged-In User", "value": { "users": [ { "code": "FEATURE_NOT_AVAILABLE", "details": {}, "message": "Share among Subordinates Feature is not available", "status": "error" } ] } }, "MoreThanOneUserUpdationAttempt": { "description": "Shows demonstrates the error response when more than one user object is included in a single update request for a specific user endpoint.", "summary": "More Than One User in Single User Update Request", "value": { "code": "INVALID_DATA", "details": { "api_name": "users", "json_path": "$.users", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "NextShiftWithDateWithMoretimePeriod": { "description": "Shows demonstrates the error response when the next shift effective-from date is set too far in the future beyond the allowed time period.", "summary": "Shift Effective From Date Exceeds Maximum Period", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "$shift_effective_from", "expected_data_type": "Maximum time period is six months to move shift", "json_path": "$.users[0].$shift_effective_from" }, "message": "invalid data", "status": "error" } ] } }, "NotUpdatingFortheSameUser": { "description": "Shows demonstrates the error response when name_format__s, sort_order_preference__s, language, time_zone fields cannot be updated for another user.", "summary": "Not Allowed to Update Another User", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "name_format__s" }, "message": "Cannot update the name_format__s of another User", "status": "error" } ] } }, "NumberAndDecimalSeparatorMismatch": { "description": "Shows demonstrates the error response when the number separator and decimal separator values are set to the same character during update.", "summary": "Number and Decimal Separator Cannot Be the Same", "value": { "users": [ { "code": "MAPPING_MISMATCH", "details": { "api_name": "decimal_separator", "json_path": "$.users[0].decimal_separator", "mapped_field": { "api_name": "number_separator", "json_path": "$.users[0].number_separator" } }, "message": "the number separator and decimal separator values should not be same", "status": "error" } ] } }, "PatternMismatchInField": { "description": "Shows time_format,distance_preference__s,status fields have pattern restrictions.", "summary": "Pattern Mismatch in Field Value", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "time_format", "json_path": "$.users[0].time_format" }, "message": "Pattern not matched", "status": "error" } ] } }, "ReinvitingConfirmedUser": { "description": "Shows demonstrates the error response when attempting to re-send an invitation to a user that has already confirmed their account.", "summary": "Re-inviting an Already Confirmed User", "value": { "users": [ { "code": "INVALID_REQUEST", "details": { "api_name": "reinvite" }, "message": "Reinvite is not allowed for a confirmed user", "status": "error" } ] } }, "SameCurrentAndNextShiftId": { "description": "Shows demonstrates the error response when the current shift and next shift ids are set to the same value during update.", "summary": "Current and Next Shift Cannot Be the Same", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "$next_shift.id", "json_path": "$.users[0].$next_shift.id" }, "message": "current shift and next shift should not be same", "status": "error" } ] } }, "ShareAmongFeatureNotEnabled": { "description": "Shows demonstrates the error response when the share-among-subordinates feature is not enabled in the organization.", "summary": "Share Among Feature Not Enabled", "value": { "users": [ { "code": "INVALID_REQUEST", "details": {}, "message": "You can't perform this action over logged in user", "status": "error" } ] } }, "ShiftEffectiveFromDateMissing": { "description": "Shows demonstrates the error response when a next shift is specified but the required shift effective-from date is missing from the request.", "summary": "Missing Shift Effective From Date", "value": { "users": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "$shift_effective_from", "dependee": { "api_name": "$next_shift", "json_path": "$.users[0].$next_shift" }, "json_path": "$.users[0].$shift_effective_from" }, "message": "Dependent Field value should not be null", "status": "error" } ] } }, "SpecialCharacterInField": { "description": "Shows first_name,last_name,city,country,state,street, alias, zip fields do not accept special characters.", "summary": "Special Character in Field Value", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "first_name", "json_path": "$.users[0].first_name" }, "message": "Special Characters Found", "status": "error" } ] } }, "UpdatingClosedOrDeletedUser": { "description": "Shows demonstrates the error response when attempting to update a user in a closed or deleted organization.", "summary": "Updating User in Closed or Deleted Organization", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "You can't perform this action over a closed/deleted user", "status": "error" } ] } }, "UpdatingCreatedByOrModifiedByField": { "description": "Shows created by and modified by fields cannot be updated.", "summary": "Updating Read-Only Created By or Modified By Field", "value": { "users": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "created_by", "json_path": "$.users[0].created_by" }, "message": "Created by & Modified by fields cannot be updated by api", "status": "error" } ] } }, "UpdatingDeletedUser": { "description": "Shows demonstrates the error response when attempting to update a user that has already been deleted.", "summary": "Updating a Deleted User", "value": { "users": [ { "code": "CANNOT_UPDATE_DELETED_USER", "details": {}, "message": "Deleted user cannot be updated", "status": "error" } ] } }, "UpdatingDigitalUserStatus": { "description": "Illustrates a sample request for this operation.", "summary": "Example request", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "type__s", "json_path": "$.users[0].type__s" }, "message": "Digital Employee cannot be Deleted / Deactivated / Activated", "status": "error" } ] } }, "UpdatingEmailForAConfirmedUser": { "description": "Shows demonstrates the error response when attempting to update the email address of a confirmed user, which is restricted.", "summary": "Updating Email for a Confirmed User", "value": { "users": [ { "code": "EMAIL_UPDATE_NOT_ALOWED", "details": { "api_name": "email" }, "message": "Cannot update email of a confirmed CRM User", "status": "error" } ] } }, "UpdatingNonSubordinateUser": { "description": "Shows demonstrates the error response when a manager attempts to update a user who is not their subordinate.", "summary": "Updating a Non-Subordinate User", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Non subordinate users cannot be updated", "status": "error" } ] } }, "UpdatingReportingToFieldWithoutEnablingReportingToFeature": { "description": "Shows reporting to feature should be enabled to set reporting to field.", "summary": "Setting Reporting To Without Enabling the Feature", "value": { "users": [ { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "ReportingTo Feature is not enabled", "status": "error" } ] } }, "UpdatingSameUserIdAsReportingTo": { "description": "Shows demonstrates the error response when a user attempts to set themselves as their own reporting to manager.", "summary": "Setting Self as Reporting To Manager", "value": { "users": [ { "code": "INVALID_DATA", "details": { "expected_data_type": "ReportingTo Id should not be the same as userId" }, "message": "invalid data", "status": "error" } ] } }, "UpdatingSupportUserDetails": { "description": "Shows similarly system user details cannot be updated.", "summary": "Updating Support User Details", "value": { "users": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.users[0].id" }, "message": "Cannot update the user details of support user", "status": "error" } ] } }, "UpdatingUserWithReportingToWithNotSupportedRoles": { "description": "Shows demonstrates the error response when the reporting to feature is not supported for the role assigned to the user.", "summary": "Reporting To Not Supported for User Role", "value": { "users": [ { "code": "INVALID_DATA", "details": { "api_name": "Reporting_To" }, "message": "Reporting manager should be from parent roles or from the same role to which the current user belongs", "status": "error" } ] } }, "Updatingtypesfields": { "description": "Shows demonstrates the error response when attempting to update a read-only user type field during a user update.", "summary": "Updating Read-Only Type Field", "value": { "users": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "type__s", "json_path": "$.users[0].type__s" }, "message": "type__s is cannot be updated by api", "status": "error" } ] } }, "UserAlreadyExistsInCRMplus": { "description": "Shows demonstrates the error response when attempting to update a user with an email that is already registered in the crm plus organization.", "summary": "User Already Exists in CRM Plus", "value": { "users": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "email", "id": "0987654321" }, "message": "User with same email id is already in CRM Plus", "status": "error" } ] } }, "UserLimitExceeded": { "description": "Shows demonstrates the error response when activating a user fails because the organization has reached its maximum user count.", "summary": "User Limit Exceeded", "value": { "users": [ { "code": "LICENSE_LIMIT_EXCEEDED", "details": {}, "message": "You are trying to activate more mail addon which exceeds your license limit. If you want to activate mail addon for additional users, please upgrade your license", "status": "error" } ] } }, "UserUpdatingWithNotEligibleReportingTo": { "description": "Shows demonstrates the error response when the specified reporting to user is not eligible to manage the target user based on their role hierarchy.", "summary": "Reporting To User Not Eligible", "value": { "users": [ { "code": "CONFLICTING_DATA_FOUND", "details": { "api_name": "Reporting_To", "json_path": "$.users[0].Reporting_To" }, "message": "the user must be updated with new eligible reporting manager because of changing user role", "status": "error" } ] } }, "UserUpdatingWithNotEligibleSubordinates": { "description": "Shows demonstrates the error response when a role change would result in invalid subordinate relationships in the user hierarchy.", "summary": "Role Change Creates Invalid Subordinate Relationships", "value": { "users": [ { "code": "CONFLICTING_DATA_FOUND", "details": { "api_name": "Reporting_To", "json_path": "$.users[0].Reporting_To" }, "message": "the user must be updated with new eligible reporting manager and the subordinates who are going to report to a user in a role below them, because of new role change are need to transfer to new eligible reporting manager", "status": "error" } ] } } }, "schema": { "additionalProperties": true, "description": "Represents the structure of the user update error response. Contains a users array with details of the validation or processing failure.", "properties": { "users": { "description": "Represents the list of error objects returned when the user update request could not be processed. Each element describes the specific error encountered.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Indicates that one or more fields in the request payload failed data validation.", "properties": { "code": { "description": "Indicates the specific error classification returned when the request payload fails validation.\n\nPossible values:\nINVALID_DATA - The submitted field value does not match the expected type or format.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains structured diagnostic information about the validation failure, including the affected field API name, JSON path, data type expectations, length constraints, resource path index, and applicable date range.", "properties": { "api_name": { "description": "Indicates the API name of the user field that triggered the INVALID_DATA error, enabling callers to identify and correct the offending field in the request payload.", "maxLength": 100, "type": "string" }, "expected_data_type": { "description": "Indicates the data type that the API expected to receive for the failing field, allowing callers to supply a correctly typed value in a corrected request.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the validation failure, useful for pinpointing errors in nested or array structures.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Indicates the maximum number of characters or digits permitted for the field that failed validation, giving callers the upper bound needed to correct the submitted value.", "format": "int32", "type": "integer" }, "range": { "additionalProperties": false, "description": "Contains the permissible date interval for a date-type field that failed validation, expressed as a start date and an end date defining the inclusive bounds that the submitted value must fall within.", "properties": { "from": { "description": "Represents the earliest permissible date of the valid range for the field that triggered the validation error.", "format": "date", "type": "string" }, "to": { "description": "Represents the latest permissible date of the valid range for the field that triggered the validation error.", "format": "date", "type": "string" } }, "type": "object" }, "resource_path_index": { "description": "Indicates the zero-based index position within an array in the request body that identifies which element caused the validation failure.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "invalid data", "INVALID_DATA", "the id given seems to be invalid", "Special Characters Found", "Pattern not matched", "invalid id in reporting to or roles provided", "Invalid data. Valid values are Comma/Period/Space (Not case-sensitive)", "Invalid data. Valid values are Comma/Period (Not case-sensitive)", "Give a proper time zone value", "Reporting manager should be from parent roles or from the same role to which the current user belongs", "Valid name format should be given", "Valid sort order preference should be given", "Give a proper language code", "the reporting manager must be superior in reporting hierarchy", "Effective from should be greater than current date", "Effective from should be less than 6 months", "Valid date format should be given" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserInvalidDataError" }, { "additionalProperties": false, "description": "Indicates that the requested operation is not permitted for this user or field type.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the user associated with this error condition.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" }, "resource_path_index": { "description": "Indicates the zero-based index position within an array in the request body that identifies which element caused the validation failure.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "the id given seems to be invalid", "Support user cannot be activated", "System user cannot be activated", "Support user cannot be deactivated", "System user cannot be deactivated", "Cannot update the user details of support user", "System Profile cannot be assigned to other users", "You are not allowed to perform this operation.", "Cannot update the name_format__s of another User", "Non subordinate users cannot be updated", "You can't perform this action over a closed/deleted user", "Support user cannot be added", "Cannot update the sort_order_preference__s of another User", "Cannot update the time_zone of another User", "current shift and next shift should not be same" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserNotAllowedError" }, { "additionalProperties": false, "description": "Indicates that the user record cannot be updated because the user has been deleted.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "CANNOT_UPDATE_DELETED_USER" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Deleted user cannot be updated" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserCannotUpdateDeletedUserError" }, { "additionalProperties": false, "description": "Indicates that updating the email address is not allowed for a confirmed CRM user.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "EMAIL_UPDATE_NOT_ALOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Crm Plus account is not allowed to edit the email while updating the user info", "Cannot update email of a confirmed CRM User" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserEmailUpdateNotAllowedError" }, { "additionalProperties": false, "description": "Indicates that the request contains an invalid action or configuration.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the user associated with this error condition.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "You can't perform this action over logged in user", "invalid request", "Reinvite is not allowed for a confirmed user", "Primary Contact cannot be deactivated", "Invalid current shift id", "Invalid next shift id" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserInvalidRequestError" }, { "additionalProperties": false, "description": "Indicates that a unique field in the request contains a value that already exists in the organization.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the user associated with this error condition.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "User with same email id is already in CRM Plus", "Email already exists" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserDuplicateDataError" }, { "additionalProperties": false, "description": "Indicates that the requested status change failed because the user is already deactivated.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "ID_ALREADY_DEACTIVATED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the unique identifier of the user associated with this error condition.", "maxLength": 19, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "User is already deactivated" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserIdAlreadyDeactivatedError" }, { "additionalProperties": false, "description": "Indicates that the field or operation in the request is not supported.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "type__s is cannot be updated by api", "Created by & Modified by fields cannot be updated by api" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserNotSupportedError" }, { "additionalProperties": false, "description": "Indicates that the user cannot be approved due to an unmet condition.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "UNAPPROVABLE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Cannot add user for ZohoOne account from CRM. Kindly add user through ZohoOne", "Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus", "You cannot update user in a sandbox org" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserUnapprovableError" }, { "additionalProperties": false, "description": "Indicates that the requested change cannot be completed because the organization has reached its license or user limit.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "LICENSE_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "You are trying to activate more mail addon which exceeds your license limit. If you want to activate mail addon for additional users, please upgrade your license", "License Limit is Exceeded" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserLicenseLimitExceededError" }, { "additionalProperties": false, "description": "Indicates that the requesting user does not have sufficient privileges to perform this operation.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nAUTHORIZATION_FAILED - The error code returned when this specific validation failure occurs.", "enum": [ "AUTHORIZATION_FAILED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Either trial is expired or user does not have sufficient previlege to perform this action", "Either trial is expired or user does not have sufficiet previlege to perform this action" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserAuthorizationFailedError" }, { "additionalProperties": false, "description": "Indicates that the requested feature is not available in the organization.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nFEATURE_NOT_AVAILABLE - The error code returned when this specific validation failure occurs.", "enum": [ "FEATURE_NOT_AVAILABLE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Share among Subordinates Feature is not available" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserFeatureNotAvailableError" }, { "additionalProperties": false, "description": "Indicates that the submitted value conflicts with an existing field configuration in the organization.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nCONFLICTING_DATA_FOUND - The error code returned when this specific validation failure occurs.", "enum": [ "CONFLICTING_DATA_FOUND" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "the user must be updated with new eligible reporting manager because of changing user role", "the user must be updated with new eligible reporting manager and the subordinates who are going to report to a user in a role below them, because of new role change are need to transfer to new eligible reporting manager" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserConflictingDataFoundError" }, { "additionalProperties": false, "description": "Indicates that the requested status change failed because the user is already active.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nID_ALREADY_ACTIVE - The error code returned when this specific validation failure occurs.", "enum": [ "ID_ALREADY_ACTIVE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "id": { "description": "Represents the unique identifier of the user associated with this error condition.", "maxLength": 19, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "User is already active" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserIdAlreadyActiveError" }, { "additionalProperties": false, "description": "Indicates that a separator field configuration in the request conflicts with an existing separator field.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nMAPPING_MISMATCH - The error code returned when this specific validation failure occurs.", "enum": [ "MAPPING_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" }, "mapped_field": { "additionalProperties": false, "description": "Contains the API name and JSON path of the field whose configuration conflicts with the submitted separator value.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body of the conflicting separator field.", "maxLength": 200, "type": "string" } }, "type": "object" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "the number separator and decimal separator values should not be same" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserMappingMismatchError" }, { "additionalProperties": false, "description": "Indicates that the feature required to process the request is not enabled for the organization.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nFEATURE_NOT_ENABLED - The error code returned when this specific validation failure occurs.", "enum": [ "FEATURE_NOT_ENABLED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "ReportingTo Feature is not enabled" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserFeatureNotEnabledError" }, { "additionalProperties": false, "description": "Indicates that the submitted value is already in use by another field in the organization.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nALREADY_USED - The error code returned when this specific validation failure occurs.", "enum": [ "ALREADY_USED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "exists_in": { "additionalProperties": false, "description": "Contains the location of the existing record that already uses the submitted value, identifying the source of the duplicate conflict.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body of the field where the conflicting value already exists.", "maxLength": 200, "type": "string" } }, "type": "object" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Current shift and next shift id cannot be the same" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserAlreadyUsedError" }, { "additionalProperties": false, "description": "Indicates that a dependent field value in the request is invalid given the current value of its parent field.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\nDEPENDENT_MISMATCH - The error code returned when this specific validation failure occurs.", "enum": [ "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Contains the API name and JSON path of the parent field on which the failing field depends.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body of the parent (dependee) field.", "maxLength": 200, "type": "string" } }, "type": "object" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Dependent Field value should not be null" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserDependentFieldMissingError" }, { "additionalProperties": false, "description": "Indicates that the requested operation is not permitted for this user or field type.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains diagnostic information about the error, identifying the specific field or condition that caused the failure.", "properties": { "api_name": { "description": "Indicates the API name of the user field that caused the error, enabling callers to identify the offending field in the request payload.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Indicates the path within the request body that locates the field responsible for the error.", "maxLength": 200, "type": "string" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "Digital Employee cannot be Deleted / Deactivated / Activated" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "UpdateSingleUserDigitalEmployeeNotAllowedError" } ], "description": "Represents a single error object describing the reason a user update request was rejected. The structure varies depending on the specific validation or business rule violation that occurred." }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateSingleUserBadRequestResponse" } } }, "description": "The request could not be processed due to a validation or business-rule failure.\n**Resolution:** Review the error details in the response to identify and correct the invalid field values before resubmitting the request." }, "403": { "content": { "application/json": { "examples": { "NoPermissionToCreateUser": { "description": "Shows demonstrates the 403 error response when the caller does not have the required permission to update this user.", "summary": "No Permission to Update User", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Users" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when the user update request is denied due to insufficient permissions.", "properties": { "code": { "description": "Indicates the error code for this failure type.\n\nPossible values:\n[error-specific code] - The error code returned when this specific validation failure occurs.", "enum": [ "NO_PERMISSION", "PERMISSION_DENIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional information about the permission denial, including the list of missing permissions.", "properties": { "permissions": { "description": "Indicates the list of CRM permissions that the requesting user's profile lacks for this operation.", "items": { "description": "Represents a CRM permission identifier that the requesting user's profile lacks.", "enum": [ "Crm_Implied_Manage_Users" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "type": "object" }, "message": { "description": "Indicates the error message describing the specific validation or processing failure that occurred.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Indicates the processing status when this error occurs.\n\nPossible values:\nerror - The request could not be processed due to a validation or business-rule failure.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "PermissionDeniedUpdateSingleUserResponse" } } }, "description": "Permission denied to update the user.\n**Resolution:** The CRM administrator must grant the Manage Users permission to the requesting user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.users.UPDATE" ] } ], "summary": "Update a single user by user ID", "tags": [ "users" ], "x-zoho-document": "users" } }, "/crm/v8/users/{user}/actions/associated_groups": { "get": { "description": "To retrieve the paginated list of user groups associated with a specific user in your Zoho CRM organization, with optional inclusion of member sources and source counts.", "operationId": "getAssociatedGroupsForUser", "parameters": [ { "description": "\n\nSpecifies the unique ID of the user whose associated groups you want to retrieve. Use the [Get Users](users#$.paths./users.get) API to obtain user IDs. From API v9 onwards, UUID format is also accepted.", "in": "path", "name": "user", "required": true, "schema": { "enum": [ "3652397000000186017" ], "type": "string" } }, { "$ref": "#/components/parameters/UserGroupsInclude" }, { "$ref": "#/components/parameters/UserGroupsPage" }, { "$ref": "#/components/parameters/UserGroupsPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a paginated list of user groups associated with a specific user, including group metadata and optional source counts.", "summary": "Successful response with associated user groups", "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 }, "user_groups": [ { "created_by": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "created_time": "2022-11-21T12:33:12+05:30", "description": "groups API", "id": "3652397000009949005", "modified_by": { "id": "3652397000000186017", "name": "Patricia Boyle" }, "modified_time": "2022-11-21T13:21:46+05:30", "name": "group 1" } ] } } }, "schema": { "additionalProperties": false, "description": "Response schema containing the paginated list of user groups associated with the specified user.", "properties": { "info": { "additionalProperties": false, "description": "Represents pagination information for the response. ", "properties": { "count": { "description": "Represents the total number of user groups returned in the current response. ", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional user group records are available beyond the current page. ", "type": "boolean" }, "page": { "description": "Represents the current page number in the paginated response. ", "format": "int32", "type": "integer" }, "per_page": { "description": "Represents the maximum number of user group records returned per page. ", "format": "int32", "type": "integer" } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" }, "user_groups": { "description": "Represents the array of user groups associated with the specified user. ", "items": { "additionalProperties": false, "description": "Represents the details of a user group associated with the user, including metadata and optional sources and source counts.", "properties": { "created_by": { "additionalProperties": false, "description": "Represents the user who created this user group. ", "properties": { "id": { "description": "Represents the unique ID of the user who created this group. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the user who created this group. ", "maxLength": 512, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "created_time": { "description": "Represents the date and time of user group creation, in ISO 8601 format. ", "format": "date-time", "type": "string" }, "description": { "anyOf": [ { "description": "Represents the text description of the user group.", "maxLength": 250, "type": "string", "x-zs-$id": "GroupDescriptionForSpecifiedUser" }, { "description": "Indicates that no description was provided for the user group.", "type": "null", "x-zs-$id": "NoDescriptionForSpecifiedUser" } ], "description": "Represents the text description of the user group. Present in the response when a description was provided during group creation." }, "id": { "description": "Represents the unique identifier of the user group. ", "maxLength": 19, "type": "string" }, "modified_by": { "anyOf": [ { "additionalProperties": false, "description": "Represents the user who last modified this group, with their ID and name.", "properties": { "id": { "description": "Represents the unique ID of the user who last modified this group. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the user who last modified this group. ", "maxLength": 512, "type": "string" } }, "required": [ "name", "id" ], "type": "object", "x-zs-$id": "ModifierUserInformationSpecifiedUser" }, { "description": "Indicates that this group has not been modified since creation.", "type": "null", "x-zs-$id": "NoModifierInfoForGetSpecifiedUser" } ], "description": "Represents the user who last modified this user group. " }, "modified_time": { "anyOf": [ { "description": "Represents the timestamp of the last modification in ISO 8601 format.", "format": "date-time", "type": "string", "x-zs-$id": "TimeStampInISO8601FormatForSpecifiedUser" }, { "description": "Indicates that the group has not been modified since creation.", "type": "null", "x-zs-$id": "NoModificationTimeForSpecifiedUser" } ], "description": "Represents the date and time when the user group was last modified. " }, "name": { "description": "Represents the name of the user group. ", "maxLength": 250, "type": "string" }, "sources": { "description": "Represents the array of member sources configured for this user group. Present when the **include** query parameter includes **sources**.", "items": { "additionalProperties": false, "description": "Represents one member source entry for this user group.", "properties": { "source": { "additionalProperties": false, "description": "Represents the identifier and name of the source. ", "properties": { "id": { "description": "Represents the unique ID of the source configured as a member. ", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the source configured as a member. ", "maxLength": 250, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "sub_territories": { "description": "Indicates whether members from sub-territories are included for territory-type sources. Present when configured.", "type": "boolean" }, "subordinates": { "description": "Indicates whether users in subordinate roles are included for role-type sources. Present when configured.", "type": "boolean" }, "type": { "description": "Represents the type of this member source. \nPossible values:\n**users** - Individual CRM users.\n**roles** - CRM roles.\n**territories** - CRM territories.\n**groups** - CRM user groups.", "enum": [ "users", "roles", "territories", "groups" ], "type": "string" } }, "required": [ "source", "type" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "created_by", "modified_by", "modified_time", "created_time", "description", "id", "name" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "user_groups", "info" ], "type": "object", "x-zs-$id": "AssociatedUserGroupForSpecifiedUser" } } }, "description": "Returns a paginated list of user groups associated with the specified user." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the user ID in the URL does not match an existing CRM user.", "summary": "Invalid user ID in request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid user ID error.", "properties": { "code": { "description": "Represents the error code for the request failure. \nPossible values:\n**INVALID_DATA** - The user ID in the URL is invalid.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the request error. ", "properties": { "resource_path_index": { "description": "Represents the index of the path segment where the invalid resource ID was found. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the request failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request failed because the user ID is invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidDataAssoGrps" } } }, "description": "The user ID in the URL is invalid. **Resolution:** Provide a valid numeric CRM user ID in the **user** path parameter." }, "404": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the request URL does not match any configured API endpoint pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The provided group ID is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Response schema for an invalid URL pattern error.", "properties": { "code": { "description": "Represents the error code for the URL pattern failure. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL does not match any configured API endpoint.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the URL pattern error. ", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message describing the URL pattern failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the request. \nPossible values:\n**error** - The request URL pattern was invalid.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GroupInvalidURLPatternAssoGrps" } } }, "description": "The request URL does not match any configured endpoint pattern. **Resolution:** Verify the URL follows the pattern /users/{user}/actions/associated_groups." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.user_groups.READ" ] } ], "summary": "Get associated groups for a user", "tags": [ "user_groups" ], "x-zoho-document": "user_groups" } }, "/crm/v8/users/{user}/territories": { "delete": { "description": "To remove one or more territories from a user in your Zoho CRM organization.", "operationId": "removeTerritoriesfromUser", "parameters": [ { "$ref": "#/components/parameters/UsersTerritoriesUser" }, { "$ref": "#/components/parameters/UsersTerritoriesIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "RemoveTerritoriesExample": { "description": "Shows a successful removal response for a territory with the territory ID confirmed.", "summary": "Successful territories removal response", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "111121000000088044" }, "message": "Territory removed from the user successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UsersTerritoriesSuccessResponse" } } }, "description": "Returns a **territories** array containing the removal result for each specified territory." }, "400": { "content": { "application/json": { "examples": { "InvalidTerritoryId": { "description": "Shows an invalid territory ID error when one or more specified territory IDs are not assigned to the user.", "summary": "Invalid territory ID error", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.territories[0].id" }, "message": "Invalid Territory Id", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/CommonErrorResponse" } } }, "description": "One or more territory IDs in the request are invalid. Resolution: Valid territory IDs must be specified in the **ids** parameter. Valid territory IDs can be retrieved using the [Get Territories](user_territories.json#$.paths./{users}/{user}/territories.get) API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.DELETE", "ZohoCRM.users.DELETE" ] } ], "summary": "Remove territories from a user", "tags": [ "users_territories" ], "x-zoho-document": "users_territories" }, "get": { "description": "To retrieve all territories assigned to a specific user in your Zoho CRM organization.", "operationId": "getTerritoriesOfUser", "parameters": [ { "$ref": "#/components/parameters/UsersTerritoriesUser" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetTerritoriesOfUser": { "description": "Shows the territories assigned to a user, including territory names and their reporting hierarchy.", "summary": "Get territories of a user", "value": { "info": { "count": 2, "more_records": false, "page": 1, "per_page": 200 }, "territories": [ { "Manager": { "id": "111121000000076087" }, "Name": "T3", "Reporting_To": { "Name": "zoho crm", "id": "111121000000076087" }, "id": "111121000000078023" }, { "Manager": { "id": "111121000000076087" }, "Name": "T4", "Reporting_To": { "Name": "T3", "id": "111121000000078023" }, "id": "111121000000086015" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryGetResponse" } } }, "description": "Returns a **territories** array with the territories assigned to the user and pagination **info**." }, "204": { "description": "No territories are assigned to the specified user." }, "400": { "content": { "application/json": { "examples": { "InvalidUserId": { "description": "Shows an invalid user ID error when the specified user does not exist in the organization.", "summary": "Invalid user ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/CommonUrlErrorResponse" } } }, "description": "The user ID in the request URL is invalid. Resolution: A valid user ID must be specified. Valid user IDs can be retrieved using the [Get Users](users.json#$.paths./{users}.get) API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.READ", "ZohoCRM.users.READ" ] } ], "summary": "Get territories of a user", "tags": [ "users_territories" ], "x-zoho-document": "users_territories" }, "put": { "description": "To associate one or more territories with a specific user in your Zoho CRM organization.", "operationId": "associateTerritoriesToUser", "parameters": [ { "$ref": "#/components/parameters/UsersTerritoriesUser" } ], "requestBody": { "content": { "application/json": { "examples": { "AssociateTerritoriesExample": { "description": "Shows an association request for a single territory using its unique ID.", "summary": "Associate territories with a user", "value": { "territories": [ { "id": "111121000000076093" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the data required to associate territories with a user.", "properties": { "territories": { "description": "JSON array specifying the territories to associate with the user.", "items": { "additionalProperties": false, "description": "Specify one territory to associate with the user.", "properties": { "id": { "description": "Specify the unique ID of the territory. Valid territory IDs can be retrieved using the [Get Territories](user_territories.json#$.paths./{users}/{user}/territories.get) API.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "territories" ], "type": "object" } } }, "description": "The request body must contain a **territories** array with the territory IDs to associate with the user.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AssociateTerritoriesExample": { "description": "Shows a successful association response with the territory ID confirmed.", "summary": "Successful territory association response", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "111121000000076093" }, "message": "Territory associated to the user successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UsersTerritoriesSuccessResponse" } } }, "description": "Returns a **territories** array containing the association result for each requested territory." }, "400": { "content": { "application/json": { "examples": { "AlreadyAssociatedTerritoryErrorResponse": { "description": "Shows a duplicate association error when the territory is already assigned to the user.", "summary": "Duplicate territory association error", "value": { "territories": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "id", "json_path": "$.territories[0].id" }, "message": "Territory already associated with the user", "status": "error" } ] } }, "InvalidTerritoryIdErrorResponse": { "description": "Shows an invalid territory ID error when the specified territory does not exist.", "summary": "Invalid territory ID error", "value": { "territories": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.territories[0].id" }, "message": "Invalid Territory Id", "status": "error" } ] } }, "PermissionDeniedError": { "description": "Shows a permission denied error when the user lacks update or delete permission for the territory.", "summary": "Permission denied error for territory", "value": { "territories": [ { "code": "PERMISSION_DENIED", "details": { "api_name": "id", "json_path": "$.territories[0].id" }, "message": "User does not have update/delete permission for the territory", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/CommonErrorResponse" } } }, "description": "One or more territories in the request have validation errors. Resolution: Check the **code** field in each **territories** item for the specific error type and resolve accordingly." }, "403": { "content": { "application/json": { "examples": { "LoggedInUserCannotUpdateTerritories": { "description": "Shows a not-allowed error when the logged-in user attempts to update their own territory associations.", "summary": "Logged-in user cannot update their own territories", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Logged in user can't update their territories", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/CommonUrlErrorResponse" } } }, "description": "The logged-in user cannot update their own territory associations. Resolution: Territory associations for the currently logged-in user must be managed by a different user with the required permissions." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.UPDATE", "ZohoCRM.users.UPDATE" ] } ], "summary": "Add territories to a user", "tags": [ "users_territories" ], "x-zoho-document": "users_territories" } }, "/crm/v8/users/{user}/territories/{territory}": { "delete": { "description": "To remove a specific territory from a user in your Zoho CRM organization.", "operationId": "removeSpecificTerritoriesfromUser", "parameters": [ { "$ref": "#/components/parameters/UsersTerritoriesUser" }, { "$ref": "#/components/parameters/UsersTerritoriesTerritory" } ], "responses": { "200": { "content": { "application/json": { "examples": { "RemoveTerritoriesExample": { "description": "Shows a successful territory removal response with the territory ID confirmed.", "summary": "Successful territory removal response", "value": { "territories": [ { "code": "SUCCESS", "details": { "id": "111121000000088044" }, "message": "Territory removed from the user successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/UsersTerritoriesSuccessResponse" } } }, "description": "Returns the removal result for the territory in a **territories** array." }, "400": { "content": { "application/json": { "examples": { "InvalidTerritoryId": { "description": "Shows an invalid territory ID error when the specified territory is not assigned to the user.", "summary": "Invalid territory ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "Invalid Territory Id", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/CommonUrlErrorResponse" } } }, "description": "The territory ID in the request URL is invalid. Resolution: A valid territory ID must be specified. Valid territory IDs can be retrieved using the[Get Territories](user_territories.json#$.paths./{users}/{user}/territories/.get) API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.DELETE", "ZohoCRM.users.DELETE" ] } ], "summary": "Remove territory from a user", "tags": [ "users_territories" ], "x-zoho-document": "users_territories" }, "get": { "description": "To retrieve a specific territory assigned to a user in your Zoho CRM organization.", "operationId": "getSpecificTerritoryOfUser", "parameters": [ { "$ref": "#/components/parameters/UsersTerritoriesUser" }, { "$ref": "#/components/parameters/UsersTerritoriesTerritory" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetTerritoryOfUser": { "description": "Shows the details of a specific territory assigned to the user.", "summary": "Get specific territory of a user", "value": { "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 }, "territories": [ { "Manager": { "id": "111121000000076087" }, "Name": "T3", "Reporting_To": { "Name": "zoho crm", "id": "111121000000076087" }, "id": "111121000000078023" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryGetResponse" } } }, "description": "Returns the details of a specific territory assigned to the user in a **territories** array." }, "204": { "description": "The specified territory is not assigned to the user." }, "400": { "content": { "application/json": { "examples": { "InvalidUserId": { "description": "Shows an invalid user ID error when the specified user does not exist in the organization.", "summary": "Invalid user ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/CommonUrlErrorResponse" } } }, "description": "The user ID in the request URL is invalid. Resolution: A valid user ID must be specified. Valid user IDs can be retrieved using the [Get Users](users.json#$.paths./{users}.get) API." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.territories.READ", "ZohoCRM.users.READ" ] } ], "summary": "Specific territory of a user", "tags": [ "users_territories" ], "x-zoho-document": "users_territories" } }, "/crm/v8/workflow_configurations": { "get": { "description": "Retrieves the available triggers, actions, and related trigger details for a specific module. Use this endpoint before creating or updating workflow rules to discover which triggers and actions are supported, their per-type limits, scheduling compatibility, and related module triggers. The response includes three sections: triggers (events that fire the rule), actions (operations executed when the rule fires), and related_triggers_details (child/related modules like Notes or Calls that can also trigger rules on the parent module).", "operationId": "getWorkflowConfigurations", "parameters": [ { "$ref": "#/components/parameters/WorkflowConfigurationsParamQueryModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows the workflow configuration metadata for the Leads module, including available trigger types with their supported actions and related module trigger details for Notes.", "summary": "Workflow configurations for the Leads module", "value": { "workflow_configurations": { "actions": [ { "api_name": "remove_tags", "associate_action": false, "is_clickable": true, "limit": 1, "limit_per_action": 10, "name": "RemoveTags", "supported_in_scheduled_action": true }, { "api_name": "convert", "associate_action": false, "is_clickable": true, "limit": 1, "limit_per_action": null, "name": "Convert", "supported_in_scheduled_action": false }, { "api_name": "functions", "associate_action": true, "is_clickable": true, "limit": 1, "limit_per_action": null, "name": "Deluge", "supported_in_scheduled_action": true }, { "api_name": "assign_owner", "associate_action": false, "is_clickable": true, "limit": 3, "limit_per_action": null, "name": "AssignOwner", "supported_in_scheduled_action": true }, { "api_name": "field_updates", "associate_action": true, "is_clickable": true, "limit": 5, "limit_per_action": null, "name": "Fieldupdate", "supported_in_scheduled_action": true }, { "api_name": "add_tags", "associate_action": false, "is_clickable": true, "limit": 1, "limit_per_action": 10, "name": "AddTags", "supported_in_scheduled_action": true }, { "api_name": "email_notifications", "associate_action": true, "is_clickable": true, "limit": 5, "limit_per_action": null, "name": "Alert", "supported_in_scheduled_action": true }, { "api_name": "webhooks", "associate_action": true, "is_clickable": true, "limit": 1, "limit_per_action": null, "name": "Webhook", "supported_in_scheduled_action": true }, { "api_name": "create_record", "associate_action": false, "is_clickable": true, "limit": 1, "limit_per_action": null, "name": "CreateRecord", "supported_in_scheduled_action": true }, { "api_name": "schedule_call", "associate_action": false, "is_clickable": true, "limit": 1, "limit_per_action": null, "name": "ScheduleCall", "supported_in_scheduled_action": true }, { "api_name": "add_meeting", "associate_action": false, "is_clickable": true, "limit": 1, "limit_per_action": null, "name": "AddMeeting", "supported_in_scheduled_action": true }, { "api_name": "flow", "associate_action": false, "is_clickable": true, "limit": 1, "limit_per_action": null, "name": "Flow", "supported_in_scheduled_action": true } ], "related_triggers_details": [ { "api_name": "Notes", "module": { "api_name": "Notes", "id": "3361265000000000147", "name": "Notes", "plural_label": "Notes", "singular_label": "Note" }, "name": "Notes", "triggers": [ { "actions": [ "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "webhooks", "functions", "flow" ], "api_name": "create", "deprecated": false, "name": "Create", "scheduled_actions_supported": true }, { "actions": [ "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "webhooks", "functions", "flow" ], "api_name": "create_or_edit", "deprecated": false, "name": "CreateorEdit", "scheduled_actions_supported": true }, { "actions": [ "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "webhooks", "functions", "flow" ], "api_name": "edit", "deprecated": false, "name": "Edit", "scheduled_actions_supported": true }, { "actions": [ "email_notifications", "webhooks", "functions" ], "api_name": "delete", "deprecated": false, "name": "Delete", "scheduled_actions_supported": false } ] } ], "triggers": [ { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "convert", "webhooks", "functions", "flow" ], "api_name": "create", "deprecated": false, "name": "Create", "scheduled_actions_supported": true }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "convert", "webhooks", "functions", "flow" ], "api_name": "create_or_edit", "deprecated": false, "name": "CreateorEdit", "scheduled_actions_supported": true }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "convert", "webhooks", "functions", "flow" ], "api_name": "edit", "deprecated": false, "name": "Edit", "scheduled_actions_supported": true }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "convert", "webhooks", "functions", "flow" ], "api_name": "field_update", "deprecated": false, "name": "FieldUpdate", "scheduled_actions_supported": true }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "convert", "webhooks", "functions", "flow" ], "api_name": "section_update", "deprecated": false, "name": "SectionUpdate", "scheduled_actions_supported": true }, { "actions": [ "email_notifications", "webhooks", "functions" ], "api_name": "delete", "deprecated": false, "name": "Delete", "scheduled_actions_supported": false }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "create_record", "add_meeting", "schedule_call", "webhooks", "functions", "flow" ], "api_name": "date_or_datetime", "deprecated": false, "name": "DateBased", "scheduled_actions_supported": true }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "webhooks", "functions", "flow" ], "api_name": "score_increase", "deprecated": false, "name": "ScoreIncrease", "scheduled_actions_supported": false }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "webhooks", "functions", "flow" ], "api_name": "score_decrease", "deprecated": false, "name": "ScoreDecrease", "scheduled_actions_supported": false }, { "actions": [ "field_updates", "assign_owner", "add_tags", "remove_tags", "email_notifications", "webhooks", "functions", "flow" ], "api_name": "score_update", "deprecated": false, "name": "ScoreUpdate", "scheduled_actions_supported": false } ] } } } }, "schema": { "$ref": "#/components/schemas/GetworkflowconfigurationsResponse200" } } }, "description": "Returns the workflow configuration metadata for the specified module, including the available trigger types, action types with their per-type limits and scheduling support, and related module trigger details." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleResponse": { "description": "Shows the 400 error response when the module query parameter value does not correspond to a valid or workflow-supported CRM module.", "summary": "INVALID_MODULE error when the module API name is not valid", "value": { "code": "INVALID_MODULE", "details": { "param_name": "module" }, "message": "The value provided to the param is Invalid", "status": "error" } }, "RequiredParamMissingResponse": { "description": "Shows the 400 error response when the required module query parameter is omitted from the request.", "summary": "REQUIRED_PARAM_MISSING error when the module parameter is omitted", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "required param not found", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowConfigurationsRequiredParamMissingError" }, { "$ref": "#/components/schemas/InvalidModuleResponse" } ], "description": "Represents the error response for a missing or invalid module query parameter.", "x-zs-$id": "WorkflowConfigurationsError400" } } }, "description": "The module query parameter is missing from the request, or the specified module API name is not valid. Resolution: The module query parameter must be included in the request with a valid workflow-supported module API name." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse": { "description": "Shows the 403 error response when the requesting user's profile lacks the Crm_Implied_Manage_Workflow permission.", "summary": "NO_PERMISSION error when workflow management privilege is absent", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_Workflow" ] }, "message": "feature not available in this edition", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/WorkflowConfigurationsNoPermissionError" } } }, "description": "The requesting user lacks the Manage Automation Actions privilege, or the workflow feature is unavailable in the current CRM edition. Resolution: The CRM administrator must grant the Crm_Implied_Manage_Workflow permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.workflow_rules.READ" ] } ], "summary": "Workflow Configuration", "tags": [ "workflow_configurations" ], "x-zoho-document": "workflow_configurations", "x-zs-llm-description": "Use this API to discover the workflow triggers, supported actions, action limits, scheduling support, and related module trigger metadata for a module before creating or updating workflow rules." } }, "/crm/v8/{moduleApiName}/actions/count": { "get": { "description": "To retrieve the total number of records in a specified Zoho CRM module, optionally filtered by a Custom View or search criteria. The count can be filtered using `cvid` (Custom View ID) or search parameters (`criteria`, `email`, `phone`, or `word`). These two filter groups are mutually exclusive - they cannot be combined in the same request. The `converted` and `approved` parameters apply only to the Leads module. The `type` parameter applies only to the Users module. Note: The record count may take 1-10 minutes to reflect the latest changes in Zoho CRM.\n\nThe count can be filtered using `cvid` (Custom View ID) or one of the search parameters (`criteria`, `phone`, `email`, `word`).\n\n**Important Constraint (Zoho Documentation):**\n\nYou can only include **either** `cvid` **or** one of the search parameters (`criteria`, `phone`, `email`, `word`) in a single request. Combining `cvid` with any search parameter will result in an `AMBIGUITY_DURING_PROCESSING` error (HTTP 400).", "operationId": "getRecordCount", "parameters": [ { "$ref": "#/components/parameters/RecordCountModuleApiName" }, { "$ref": "#/components/parameters/Email" }, { "$ref": "#/components/parameters/Phone" }, { "$ref": "#/components/parameters/Word" }, { "$ref": "#/components/parameters/RecordCountCvid" }, { "$ref": "#/components/parameters/RecordCountCriteria" }, { "$ref": "#/components/parameters/RecordCountFilters" }, { "$ref": "#/components/parameters/IncludeFilters" }, { "$ref": "#/components/parameters/RecordCountCrossFilters" }, { "$ref": "#/components/parameters/RecordCountConverted" }, { "$ref": "#/components/parameters/RecordCountApproved" }, { "$ref": "#/components/parameters/RecordCountPage" }, { "$ref": "#/components/parameters/RecordCountPerPage" }, { "$ref": "#/components/parameters/RecordCountType" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "summary": "Successful record count response", "value": { "count": 42 } } }, "schema": { "additionalProperties": false, "description": "Represents the response body containing the total number of records matching the specified filter criteria.", "properties": { "count": { "description": "Represents the total number of records matching the specified filter criteria. Always returned in the response.", "format": "int32", "type": "integer" } }, "required": [ "count" ], "type": "object", "x-zs-$id": "GetRecordCountResponse" } } }, "description": "Successful response containing the total record count.", "x-zs-llm-description": "This tool is used to get the number of records for the given CRM module by using either cvid or criteria" }, "400": { "content": { "application/json": { "examples": { "AmbiguityError": { "summary": "Ambiguous parameters - cvid with criteria", "value": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "param_name": "cvid" }, { "param_name": "criteria" } ] }, "message": "Please use either Cvid or Search Params. Combination of both the params is not allowed", "status": "error" } }, "CriteriaLimitExceeded": { "description": "Illustrates the error returned when the request includes more than 10 criteria in the `criteria` parameter.", "summary": "More than 10 criteria specified", "value": { "code": "CRITERIA_LIMIT_EXCEEDED", "details": {}, "message": "no of criterium that can be given exceed the limit 15", "status": "error" } }, "ExpectedParamMissing": { "summary": "Missing required search parameter", "value": { "code": "EXPECTED_PARAM_MISSING", "details": { "param_names": [ "criteria", "email", "phone", "word" ] }, "message": "one of the expected parameter is missing", "status": "error" } }, "FieldTypeUnavailable": { "description": "Illustrates the error returned when the specified field type is not found in the module.", "summary": "Field type not found in module", "value": { "code": "FIELD_TYPE_UNAVAILABLE", "details": {}, "message": "this data type is not found in this module", "status": "error" } }, "InvalidDataInvalidOperator": { "description": "Illustrates the error returned when the request uses an invalid operator for a field in the `criteria` parameter.", "summary": "Invalid data - operator error", "value": { "code": "INVALID_DATA", "details": { "api_name": "Picklist_Field", "operator": "between", "reason": "The operator is not valid for the field type" }, "message": "invalid operator found", "status": "error" } }, "InvalidDataInvalidParam": { "description": "Illustrates the error returned when an invalid parameter name is provided in the `criteria` parameter.", "summary": "Invalid data - parameter error", "value": { "code": "INVALID_DATA", "details": { "param_name": "word" }, "message": "invalid data", "status": "error" } }, "InvalidDataMinimumLength": { "description": "Illustrates the error returned when the search term in the criteria is shorter than the minimum required length of 2 characters.", "summary": "Search term below minimum length", "value": { "code": "INVALID_DATA", "details": { "param_name": "word" }, "message": "provide atleast 2 letters for search", "status": "error" } }, "InvalidDataMultipleWildcards": { "description": "Illustrates the error returned when the criteria value contains more than one wildcard character.", "summary": "Multiple wildcards not allowed in criteria", "value": { "code": "INVALID_DATA", "details": { "api_name": "Company", "reason": "More than one wildcard(*) not allowed in a searchword" }, "message": "More than one wildcard(*) not allowed in a searchword", "status": "error" } }, "InvalidDataRestrictedField": { "description": "Illustrates the error returned when the criteria includes a field that is restricted from search operations.", "summary": "Restricted field used in criteria", "value": { "code": "INVALID_DATA", "details": { "api_name": "System_Field", "reason": "Cannot use the restricted field." }, "message": "Cannot use the restricted field.", "status": "error" } }, "InvalidDataSpecialCharacters": { "description": "Illustrates the error returned when the criteria value contains unsupported special characters.", "summary": "Special characters in criteria value", "value": { "code": "INVALID_DATA", "details": { "api_name": "Name", "reason": "special characters are not allowed" }, "message": "special characters are not allowed", "status": "error" } }, "InvalidDataTimeInvalidValue": { "description": "Illustrates the error returned when a date or time value in the criteria does not match the expected format.", "summary": "Invalid date/time value in criteria", "value": { "code": "INVALID_DATA", "details": { "api_name": "Created_Time", "reason": "Please check the value of the field", "value": "invalid-date" }, "message": "invalid value for search", "status": "error" } }, "InvalidDataTypeMismatch": { "description": "Illustrates the error returned when the value provided in the criteria does not match the expected data type of the field.", "summary": "Data type mismatch in criteria", "value": { "code": "INVALID_DATA", "details": { "api_name": "Modified_Time", "expected_data_type": "datetime", "reason": "invalid value for search" }, "message": "invalid data", "status": "error" } }, "InvalidDateValue": { "description": "Illustrates the error returned when an invalid date value is provided in the criteria.", "summary": "Invalid date value in criteria", "value": { "code": "INVALID_QUERY", "details": { "api_name": "NonDate", "expected_data_type": "date", "reason": "invalid value for search", "value": "asadsa" }, "message": "Invalid query formed", "status": "error" } }, "InvalidModule": { "description": "Illustrates the error returned when the specified module name does not correspond to a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 1 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidQueryDataTypeMismatch": { "description": "Illustrates the error returned when a data type mismatch is detected in the search criteria query.", "summary": "Data type mismatch in search criteria", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Age", "expected_data_type": "Integer", "reason": "invalid value for search" }, "message": "invalid value for search", "status": "error" } }, "InvalidQueryFieldNotAvailable": { "description": "Illustrates the error returned when the specified field is not available for search in the module.", "summary": "Field not available for search", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Encrypted_Field", "reason": "the field is not available for search" }, "message": "the field is not available for search", "status": "error" } }, "InvalidQueryInOperatorLimit": { "description": "Illustrates the error returned when the number of values provided for the `in` operator exceeds the allowed limit.", "summary": "IN operator value limit exceeded", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Lead_Status" }, "message": "Only 100 values are allowed in \"IN\" criteria", "status": "error" } }, "InvalidQueryInvalidOperator": { "description": "Illustrates the error returned when the operator specified in the criteria is not valid for the field type.", "summary": "Invalid operator for field type", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Email", "operator": "greater_than", "reason": "The operator is not valid for the field type" }, "message": "invalid operator found", "status": "error" } }, "InvalidQueryInvalidOperatorForDataType": { "description": "Illustrates the error returned when the operator is not supported for the field's data type.", "summary": "Operator not supported for data type", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Annual_Revenue", "operator": "starts_with" }, "message": "invalid operator found", "status": "error" } }, "InvalidQueryInvalidParam": { "description": "Illustrates the error returned when the request includes an invalid parameter in the search criteria query.", "summary": "Invalid parameter in search criteria", "value": { "code": "INVALID_QUERY", "details": { "param_name": "email" }, "message": "Invalid query formed", "status": "error" } }, "InvalidQueryInvalidValue": { "description": "Illustrates the error returned when an invalid value is provided in the search criteria query.", "summary": "Invalid value in search criteria", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Phone", "reason": "Please check the value of the field", "value": "ABC123" }, "message": "invalid value for search", "status": "error" } }, "InvalidQueryMultipleWildcards": { "description": "Illustrates the error returned when multiple wildcard characters are used in the search criteria.", "summary": "Multiple wildcards in criteria not allowed", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Search_Field", "reason": "More than one wildcard(*) not allowed in a searchword" }, "message": "More than one wildcard(*) not allowed in a searchword", "status": "error" } }, "InvalidQueryNoMaskingPermission": { "description": "Illustrates the error returned when the requesting user does not have permission to search masked fields.", "summary": "No masking permission for searched field", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Masked_Field", "reason": "no_masking_permission" }, "message": "no_masking_permission", "status": "error" } }, "InvalidQueryRestrictedField": { "description": "Illustrates the error returned when the request includes a restricted field in the search criteria.", "summary": "Restricted field in search criteria", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Custom_Field_1", "reason": "Cannot use the restricted field." }, "message": "Cannot use the restricted field.", "status": "error" } }, "InvalidQuerySpecialCharacters": { "description": "Illustrates the error returned when unsupported special characters are used in the search criteria.", "summary": "Special characters in search criteria", "value": { "code": "INVALID_QUERY", "details": { "api_name": "Search_Field", "reason": "special characters are not allowed" }, "message": "special characters are not allowed", "status": "error" } }, "InvalidRequest": { "description": "Illustrates the error returned when the request is invalid due to malformed or unsupported input.", "summary": "Invalid request error", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.", "status": "error" } }, "LimitReached": { "summary": "Maximum record iteration limit reached", "value": { "code": "LIMIT_REACHED", "details": { "limit": "2000" }, "message": "maximum response iteration limit reached", "status": "error" } }, "ModuleNotSupportedForSearch": { "description": "Illustrates the error returned when the specified module does not support search-based record count operations.", "summary": "Module not supported for search", "value": { "code": "NOT_SUPPORTED", "details": { "module": "Activities" }, "message": "module not suppoted for search", "status": "error" } }, "NotSupported": { "description": "Illustrates the error returned when the specified module does not support the record count operation.", "summary": "Module not supported for count", "value": { "code": "NOT_SUPPORTED", "details": { "module": "Module_Name" }, "message": "the given module is not supported for count", "status": "error" } }, "NotSupportedVersion": { "summary": "Operation not supported in this API version", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_version": "v2.1" }, "message": "api not supported in this version", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Invalid request error response", "properties": { "code": { "description": "Error code indicating invalid request", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "type": "object" }, "message": { "const": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.", "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "PostInvalidRequestErrorResponse" }, { "additionalProperties": false, "description": "Invalid request error response", "properties": { "code": { "description": "Error code indicating invalid request", "enum": [ "FIELD_TYPE_UNAVAILABLE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "type": "object" }, "message": { "description": "Human-readable error message", "enum": [ "this data type is not found in this module" ], "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "PostFieldTypeUnavailableErrorResponse" }, { "additionalProperties": false, "description": "Operation not supported error response", "properties": { "code": { "const": "NOT_SUPPORTED", "description": "Error code indicating unsupported operation", "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including module information", "properties": { "module": { "description": "The module that does not support this operation", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message", "enum": [ "The module does not support this operation", "module not suppoted for search", "the given module is not supported for count" ], "maxLength": 1000, "type": "string" }, "status": { "const": "error", "description": "Error status indicator", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostNotSupportedErrorResponse" }, { "additionalProperties": false, "description": "Missing required parameter error response", "properties": { "code": { "description": "Error code indicating missing parameters", "enum": [ "EXPECTED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including missing parameter names", "properties": { "param_names": { "description": "List of missing parameter names", "items": { "description": "Parameter name", "enum": [ "criteria", "email", "phone", "word" ], "maxLength": 100, "type": "string" }, "maxItems": 50, "type": "array" } }, "required": [ "param_names" ], "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostExpectedParamMissingErrorResponse" }, { "additionalProperties": false, "description": "Invalid module error response", "properties": { "code": { "description": "Error code indicating invalid module", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including resource path information", "properties": { "resource_path_index": { "description": "Index of the invalid resource path segment", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 1000, "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostInvalidModuleErrorResponse" }, { "additionalProperties": false, "description": "Invalid query error response with various detail formats", "properties": { "code": { "description": "Error code indicating invalid query", "enum": [ "INVALID_QUERY" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Invalid Operator passed for datatype", "properties": { "operator": { "description": "The invalid operator used in the query", "maxLength": 50, "type": "string" } }, "required": [ "operator", "api_name" ], "type": "object", "x-zs-$id": "PostInvalidOperatorForDataTypeDetails" }, { "additionalProperties": false, "description": "Data type mismatch error details", "properties": { "expected_data_type": { "description": "The expected data type for the field", "maxLength": 100, "type": "string" }, "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" } }, "required": [ "expected_data_type", "reason", "api_name" ], "type": "object", "x-zs-$id": "PostInvalidQueryDataTypeMismatchDetails" }, { "additionalProperties": false, "description": "Data type mismatch error details", "properties": { "expected_data_type": { "description": "The expected data type for the field", "maxLength": 100, "type": "string" }, "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" }, "value": { "description": "The invalid value provided in the query", "maxLength": 500, "type": "string" } }, "required": [ "expected_data_type", "reason", "api_name", "value" ], "type": "object", "x-zs-$id": "PostInvalidQueryDataTypeMismatchDetailsWithValue" }, { "additionalProperties": false, "description": "Invalid operator error details", "properties": { "operator": { "description": "The invalid operator used in the query", "maxLength": 50, "type": "string" }, "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" } }, "required": [ "operator", "reason", "api_name" ], "type": "object", "x-zs-$id": "PostInvalidQueryInvalidOperatorDetails" }, { "additionalProperties": false, "description": "General query error details", "properties": { "details": { "description": "Additional details about the error, only Zoho Search team", "maxLength": 1000, "type": "string" }, "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" } }, "required": [ "reason", "api_name" ], "type": "object", "x-zs-$id": "PostInvalidQueryGeneralDetails" }, { "additionalProperties": false, "description": "Invalid value error details", "properties": { "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" }, "value": { "description": "The invalid value provided in the query", "maxLength": 500, "type": "string" } }, "required": [ "reason", "api_name", "value" ], "type": "object", "x-zs-$id": "PostInvalidQueryInvalidValueDetails" }, { "additionalProperties": false, "description": "Invalid value error details", "properties": { "param_name": { "description": "Name of the parameter causing the error", "enum": [ "email", "phone", "word" ], "maxLength": 500, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "PostInvalidQueryInvalidParamDetails" }, { "additionalProperties": false, "description": "Invalid value error details", "type": "object", "x-zs-$id": "PostInvalidQueryEmptyDetails" } ] }, "message": { "description": "Human-readable error message describing the query issue", "enum": [ "Cannot use the restricted field.", "Invalid query formed", "invalid value for search", "the field is not available for search", "Please check the value of the field", "special characters are not allowed", "invalid operator found", "no_masking_permission", "More than one wildcard(*) not allowed in a searchword" ], "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostInvalidQueryVariantsErrorResponse" }, { "additionalProperties": false, "description": "Invalid query error response with various detail formats", "properties": { "code": { "description": "Error code indicating invalid query", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Data type mismatch error details", "properties": { "expected_data_type": { "description": "The expected data type for the field", "maxLength": 100, "type": "string" }, "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" } }, "required": [ "expected_data_type", "reason", "api_name" ], "type": "object", "x-zs-$id": "PostInvalidDataDataTypeMismatchDetails" }, { "additionalProperties": false, "description": "Invalid operator error details", "properties": { "operator": { "description": "The invalid operator used in the query", "maxLength": 50, "type": "string" }, "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" } }, "required": [ "operator", "reason", "api_name" ], "type": "object", "x-zs-$id": "PostInvalidDataInvalidOperatorDetails" }, { "additionalProperties": false, "description": "General query error details", "properties": { "details": { "description": "Additional details about the error, only Zoho Search team", "maxLength": 1000, "type": "string" }, "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" } }, "required": [ "reason", "api_name" ], "type": "object", "x-zs-$id": "PostInvalidDataGeneralDetails" }, { "additionalProperties": false, "description": "Invalid value error details", "properties": { "reason": { "description": "Detailed reason for the error", "maxLength": 500, "type": "string" }, "value": { "description": "The invalid value provided in the query", "maxLength": 500, "type": "string" } }, "required": [ "reason", "api_name", "value" ], "type": "object", "x-zs-$id": "PostInvalidDataInvalidValueDetails" }, { "additionalProperties": false, "description": "Invalid value error details", "properties": { "param_name": { "description": "Name of the parameter causing the error", "maxLength": 500, "type": "string" } }, "required": [ "param_name" ], "type": "object", "x-zs-$id": "PostInvalidParamValueDetails" }, { "additionalProperties": false, "description": "Invalid value error details", "type": "object", "x-zs-$id": "PostInvalidDataEmptyDetails" } ] }, "message": { "description": "Human-readable error message describing the query issue", "enum": [ "Cannot use the restricted field.", "Invalid query formed", "invalid value for search", "the field is not available for search", "Please check the value of the field", "special characters are not allowed", "invalid operator found", "no_masking_permission", "invalid data", "More than one wildcard(*) not allowed in a searchword", "provide atleast 2 letters for search" ], "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostInvalidDataVariantsErrorResponse" }, { "additionalProperties": false, "description": "Invalid query error response for IN operator violations", "properties": { "code": { "description": "Error code indicating invalid query", "enum": [ "INVALID_QUERY" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including field information", "properties": { "param_name": { "description": "Name of the parameter causing the error", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Human-readable error message describing the query issue", "enum": [ "Only 100 values are allowed in \"IN\" criteria", "Invalid query formed" ], "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostInvalidQueryInOperatorErrorResponse" }, { "additionalProperties": false, "description": "Limit reached error response when maximum record iteration exceeded", "properties": { "code": { "description": "Error code indicating limit reached", "enum": [ "LIMIT_REACHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details including the limit value", "properties": { "limit": { "description": "Maximum number of records allowed", "enum": [ "2000" ], "type": "string" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Human-readable error message", "enum": [ "maximum response iteration limit reached" ], "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostLimitReachedErrorResponse" }, { "additionalProperties": false, "description": "Criteria limit exceeded error response", "properties": { "code": { "description": "Error code indicating criteria limit exceeded", "enum": [ "CRITERIA_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional error details", "type": "object" }, "message": { "description": "Human-readable error message", "enum": [ "no of criterium that can be given exceed the limit 15" ], "type": "string" }, "status": { "description": "Error status indicator", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "PostCriteriaLimitExceededErrorResponse" }, { "additionalProperties": false, "description": "Ambiguity during processing error response", "properties": { "code": { "description": "Error code representing ambiguity during request processing.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the ambiguity.", "properties": { "ambiguity_due_to": { "description": "List of parameters causing ambiguity.", "items": { "additionalProperties": false, "description": "Parameter causing ambiguity.", "properties": { "param_name": { "description": "Name of the parameter causing ambiguity.", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "maxItems": 2, "type": "array" } }, "type": "object" }, "message": { "description": "Detailed message describing the ambiguity in the request.", "enum": [ "Please use either Cvid or Search Params. Combination of both the params is not allowed" ], "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the response is an error.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "AmbiguityDuringProcessingError" }, { "additionalProperties": false, "description": "Error response when the requested operation or module is not supported.", "properties": { "code": { "description": "Error code representing unsupported operation or module.", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details including the unsupported module name.", "properties": { "supported_version": { "description": "The API version that supports this operation.", "enum": [ "v2.1" ], "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Detailed message describing why the request is not supported.", "enum": [ "api not supported in this version" ], "maxLength": 512, "type": "string" }, "status": { "description": "Indicates the response is an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "NotSupportedVersionError" } ], "description": "Represents the union of possible error response bodies returned for a 400 Bad Request.", "x-zs-$id": "GetCount400ErrorResponses" } } }, "description": "Bad Request - invalid module name, unsupported module, or ambiguous use of parameters." }, "401": { "content": { "application/json": { "examples": { "ScopeMismatch": { "summary": "OAuth scope mismatch error", "value": { "code": "OAUTH_SCOPE_MISMATCH", "message": "You do not have the scope required to use this API." } } }, "schema": { "$ref": "#/components/schemas/RecordCountErrorResponse" } } }, "description": "Unauthorized (e.g., OAUTH_SCOPE_MISMATCH)." }, "500": { "content": { "application/json": { "examples": { "INTERNALERROR": { "description": "Illustrates the error returned when an unexpected server-side failure occurs during processing.", "summary": "Internal server error", "value": { "code": "INTERNAL_ERROR", "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordCountErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Leads.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.pricebooks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.READ" ] } ], "summary": "Module Record Count", "tags": [ "record_count" ], "x-zoho-document": "record_count" } }, "/crm/v8/{moduleApiName}/actions/fetch_full_data": { "get": { "description": "Retrieves the full content of rich text multi-line fields for multiple records in a single request. Both the 'ids' and 'fields' query parameters are mandatory. You can specify up to 200 record IDs in the 'ids' parameter and up to 8 rich text field API names in the 'fields' parameter. This API exclusively fetches rich text fields - other field types are not supported. Only data from rich text multi-line fields can be retrieved; multi-line fields of other types (small, large) are not supported.", "operationId": "fetchFullDataForMultipleRecords", "parameters": [ { "$ref": "#/components/parameters/FetchFullDataModuleApiName" }, { "$ref": "#/components/parameters/FetchFullDataFields", "required": true }, { "$ref": "#/components/parameters/FetchFullDataIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "MultipleRecords": { "value": { "data": [ { "Rich_Text_1": "Bold Content", "Rich_Text_2": "Italic Content", "id": "1043386000018763408" }, { "Rich_Text_1": "

Specifications: Tonnage: 300

", "Rich_Text_2": "

Controller: V22 Control

", "id": "1043386000018763409" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapper object for the response. Contains a 'data' array of record objects, each holding the record ID and the rich text field values.", "properties": { "data": { "description": "An array of record objects, each containing the record ID and the values of the requested rich text fields. Returns up to 200 records matching the specified IDs.", "items": { "additionalProperties": { "description": "The full HTML-formatted content of a rich text field. The property name corresponds to the API name of the rich text field in the module. The value is null if the field has no content. Each rich text field supports up to 50,000 characters.", "maxLength": 50000, "type": "string" }, "description": "A record object containing the record's unique ID and the full content of each requested rich text field. The rich text field property names correspond to the API names of the fields in the module.", "properties": { "id": { "description": "The unique identifier of the record whose rich text field data is being returned.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "FetchFullDataMultipleRecordsResponse" } } }, "description": "Successful response containing the full HTML-formatted content of the requested rich text fields for the specified records. Each record object includes the record ID and the values of the requested rich text fields." }, "204": { "$ref": "#/components/responses/FetchFullDataNoContentResponse" }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "summary": "Invalid Module", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequest": { "summary": "Invalid Request", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.", "status": "error" } }, "RequiredParamMissing": { "summary": "Required Parameter Missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the module API name specified in the path is not a valid CRM module. Verify the module API name and retry the request.", "properties": { "code": { "description": "Error code indicating that the module API name specified in the request path is not recognized as a valid CRM module.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with resource path index", "properties": { "resource_path_index": { "description": "Index of the resource path that caused the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleErrorResponse" }, { "additionalProperties": false, "description": "Returned when the 'fields' or 'ids' parameter is missing. Both parameters are mandatory when retrieving rich text fields for multiple records. The 'param_name' in the details object identifies which parameter is missing.", "properties": { "code": { "description": "Error code indicating that a required query parameter ('fields' or 'ids') is missing from the request.", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with parameter name", "properties": { "param_name": { "description": "The name of the missing parameter.", "maxLength": 100, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParamMissingErrorResponse" }, { "additionalProperties": false, "description": "Returned when the request cannot be processed. This occurs when more than 200 record IDs are passed in the 'ids' parameter, or more than 8 field API names are passed in the 'fields' parameter. Reduce the number of IDs or fields and retry.", "properties": { "code": { "description": "Error code indicating the request is invalid. Triggered when the number of record IDs exceeds 200 or the number of field API names exceeds 8.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidRequestErrorResponse" } ], "description": "Error response for the multiple-records fetch full data operation. Includes INVALID_MODULE, REQUIRED_PARAM_MISSING, and INVALID_REQUEST error variants.", "x-zs-$id": "FetchFullDataMultipleRecordsErrorResponse" } } }, "description": "Bad Request. Returned when a required parameter is missing, the module API name is invalid, or the request exceeds parameter limits (more than 200 record IDs or more than 8 field API names)." }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "500": { "$ref": "#/components/responses/FetchFullDataInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Rich text field content for multiple records", "tags": [ "fetch_full_data" ], "x-zoho-document": "fetch_full_data", "x-zs-llm-description": "Use this endpoint to fetch full rich-text values for multiple records in one call. Provide moduleApiName, ids, and explicit fields to avoid oversized payloads and to stay within field count limits." } }, "/crm/v8/{moduleApiName}/actions/share_emails": { "post": { "description": "To share email threads linked to multiple CRM records with colleagues in the same organization. Accepts up to 100 record IDs per request. Supports partial success - each record in the response is processed independently, and individual results indicate success or failure.", "operationId": "shareBulkEmails", "parameters": [ { "description": "Specify the API name of the module that contains the records whose emails you want to share. Refer to [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve available module API names.", "example": "Leads", "in": "path", "name": "moduleApiName", "required": true, "schema": { "enum": [ "Leads", "Contacts", "Accounts", "Deals", "CustomModule1" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "BulkShare": { "description": "Shows a sample request body for sharing emails of multiple records, containing an array of record IDs.", "summary": "Sample bulk email share request", "value": { "ids": [ "1234567890", "0987654321" ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body schema for sharing emails in bulk, containing an array of record IDs.", "properties": { "ids": { "description": "Specify the list of record IDs whose emails you want to share. Accepts up to 100 record IDs per request.", "items": { "description": "Represents the unique identifier of a CRM record.", "format": "string", "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "description": "The request body must contain an **ids** array with up to 100 record IDs whose emails you want to share.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the response when all email sharing operations in the bulk request complete successfully.", "summary": "Successful bulk email sharing", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "1234567890" }, "message": "Successfully shared", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 200 response schema for the shareBulkEmails operation, containing an array of per-record email sharing results.", "properties": { "data": { "description": "Represents the list of per-record email sharing results. Always present in the response.", "items": { "additionalProperties": false, "description": "Represents the result for a single record in the bulk email sharing response.", "properties": { "code": { "description": "Represents the result code for the email sharing operation.\nPossible values: **SUCCESS** - the email sharing completed successfully. Always present in the response.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the record that was shared. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the shared record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for the email sharing operation. Always present in the response.", "enum": [ "Successfully shared" ], "type": "string" }, "status": { "description": "Represents the overall operation status.\nPossible values: **success** - the email sharing completed successfully. Always present in the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "BulkShareEmailsResponse" } } }, "description": "Returns the list of per-record results when all email sharing operations in the bulk request complete successfully." }, "207": { "content": { "application/json": { "examples": { "MultiStatus": { "description": "Shows the partial success response when some records succeed and others fail in a single bulk email share request.", "summary": "Partial success - mixed sharing results", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "1234567890" }, "message": "Successfully shared", "status": "success" }, { "code": "ALREADY_SHARED", "details": { "id": "0987654321" }, "message": "Emails are already shared to the colleagues already", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 207 partial success response schema for the shareBulkEmails operation, where each item indicates an individual record's outcome.", "properties": { "data": { "description": "Represents the list of per-record results for the partial success response. Always present in the response.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents a per-record result where the email threads are already shared with colleagues.", "properties": { "code": { "description": "Represents the result code for a record whose emails are already shared.\nPossible values: **ALREADY_SHARED** - the emails for this record are already shared with colleagues.", "enum": [ "ALREADY_SHARED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the already-shared record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the already-shared record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the already-shared status. Always present in the response.", "enum": [ "Emails are already shared to the colleagues already" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - the emails are already shared. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "AlreadySharedResponse" }, { "additionalProperties": false, "description": "Represents a per-record result where email sharing completed successfully.", "properties": { "code": { "description": "Represents the result code for a successfully shared record.\nPossible values: **SUCCESS** - the email sharing completed successfully for this record.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the successfully shared record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the successfully shared record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for the successfully shared record. Always present in the response.", "enum": [ "Successfully shared" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **success** - the email sharing completed for this record. Always present in the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SuccessResponse" }, { "additionalProperties": false, "description": "Represents a per-record result where the record ID failed validation.", "properties": { "code": { "description": "Represents the result code for a record that failed validation.\nPossible values: **INVALID_DATA** - the record ID is invalid or not found.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the invalid record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message for the invalid data result. Always present in the response.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - the record ID is invalid. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataResponse" }, { "additionalProperties": false, "description": "Represents a per-record result where the email sharing operation was not permitted for the record.", "properties": { "code": { "description": "Represents the result code for a record where the operation is not allowed.\nPossible values: **NOT_ALLOWED** - the operation is not permitted for this record.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context for the not-allowed result. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element associated with this error. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message for the not-allowed result. Always present in the response.", "format": "string", "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - the operation is not allowed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowed" }, { "additionalProperties": false, "description": "Represents a per-record result where the record ID was submitted more than once in the request.", "properties": { "code": { "description": "Represents the result code for a duplicate record ID.\nPossible values: **DUPLICATE_DATA** - this record ID appears more than once in the request.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the duplicate record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the duplicate record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message for the duplicate data result. Always present in the response.", "enum": [ "Duplicate Data" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - a duplicate record ID was found. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateDataError" } ], "description": "Represents the outcome for a single record in the partial success response. Each item contains a result code, record details, and status." }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "BulkShareEmailsMultiStatusResponse" } } }, "description": "Returns a mix of success and failure results when some email sharing operations succeed and others fail. Inspect each item in the `data` array for the individual outcome." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when one or more record IDs in the bulk request fail validation.", "summary": "INVALID_DATA - invalid record ID", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "3249415000000548012" }, "message": "the related id given seems to be invalid", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the INVALID_DATA error response when one or more record IDs in the bulk request are invalid.", "properties": { "data": { "description": "Represents the list of per-record INVALID_DATA results returned when record IDs fail validation.", "items": { "additionalProperties": false, "description": "Represents a per-record INVALID_DATA result in the bulk email sharing error response.", "properties": { "code": { "description": "Represents the result code for a record that failed validation.\nPossible values: **INVALID_DATA** - the record ID is invalid or not found.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the invalid record. Always present in the response.", "format": "string", "type": "string" } }, "required": [], "type": "object" }, "message": { "description": "Represents the error message for the invalid data result. Always present in the response.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status for this error result.\nPossible values: **error** - the record ID is invalid. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "InvalidDataErrorResponse" }, { "additionalProperties": false, "description": "Represents the NOT_ALLOWED error response when the bulk email sharing operation is not permitted.", "properties": { "data": { "description": "Represents the list of per-record NOT_ALLOWED results returned when the operation is not permitted.", "items": { "additionalProperties": false, "description": "Represents a per-record NOT_ALLOWED result in the bulk email sharing error response.", "properties": { "code": { "description": "Represents the result code for a record where the operation is not permitted.\nPossible values: **NOT_ALLOWED** - the operation is not allowed for this record.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context for the not-allowed result. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message for the not-allowed result. Always present in the response.", "format": "string", "type": "string" }, "status": { "description": "Represents the status for this error result.\nPossible values: **error** - the operation is not allowed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "NotAllowedErrorResponse" }, { "additionalProperties": false, "description": "Represents the DUPLICATE_DATA error response when duplicate record IDs are present in the bulk request.", "properties": { "data": { "description": "Represents the list of per-record DUPLICATE_DATA results returned when duplicate record IDs are submitted.", "items": { "additionalProperties": false, "description": "Represents a per-record DUPLICATE_DATA result in the bulk email sharing error response.", "properties": { "code": { "description": "Represents the result code for a duplicate record ID.\nPossible values: **DUPLICATE_DATA** - this record ID appears more than once in the request.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the duplicate record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the duplicate record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message for the duplicate data result. Always present in the response.", "enum": [ "Duplicate Data" ], "type": "string" }, "status": { "description": "Represents the status for this error result.\nPossible values: **error** - a duplicate record ID was found. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "DuplicateDataErrorResponse" } ], "description": "Represents the 400 error response schema for the shareBulkEmails operation, returned when per-record or request-level validation fails.", "x-zs-$id": "BulkShareEmailsError400Response" } } }, "description": "The request failed for all records. Possible causes include invalid record IDs, duplicate IDs, or a NOT_ALLOWED condition. Resolution: Review the error details and correct the request before retrying." }, "403": { "content": { "application/json": { "examples": { "PermissionDenied": { "description": "Shows the error response when the authenticated user lacks the required permission to share emails.", "summary": "NO_PERMISSION - permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "ZohoCRM.modules.Leads.DELETE" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error response when the authenticated user lacks the required module CREATE permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required module CREATE permission. Always present in the response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission. Always present in the response.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "format": "string", "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission. Always present in the response.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PermissionDeniedErrorResponse" } } }, "description": "The authenticated user lacks the required module CREATE permission. Resolution: Ensure the access token includes the correct `ZohoCRM.modules.{moduleName}.CREATE` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Invoices.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Forecasts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Activities.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Attachments.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.CREATE" ] } ], "summary": "Share Record Emails", "tags": [ "record_share_email" ], "x-zoho-document": "record_share_email" } }, "/crm/v8/{moduleApiName}/actions/unshare_emails": { "post": { "description": "To revoke email sharing for multiple CRM records in a single request. Accepts up to 100 record IDs per request. The `data` array in the 207 response contains an item for each record, indicating success or failure.", "operationId": "unshareBulkEmails", "parameters": [ { "description": "Specify the API name of the module that contains the records whose email sharing you want to revoke. Refer to [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve available module API names.", "example": "Leads", "in": "path", "name": "moduleApiName", "required": true, "schema": { "enum": [ "Leads", "Contacts", "Accounts", "Deals", "CustomModule1" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "BulkUnshare": { "description": "Shows a sample request body for revoking email sharing for multiple records, containing an array of record IDs.", "summary": "Sample bulk email unshare request", "value": { "ids": [ "1234567890", "0987654321" ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body schema for unsharing emails in bulk, containing an array of record IDs.", "properties": { "ids": { "description": "Specify the list of record IDs whose email sharing you want to revoke. Accepts up to 100 record IDs per request.", "items": { "description": "Represents the unique identifier of a CRM record.", "format": "string", "type": "string" }, "maxItems": 100, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "description": "The request body must contain an **ids** array with up to 100 record IDs whose email sharing you want to revoke.", "required": true }, "responses": { "207": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the partial success response when some records fail validation during a bulk email unsharing request.", "summary": "INVALID_DATA - invalid record ID", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "3249415000000548012" }, "message": "the related id given seems to be invalid", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 207 partial success response schema for the unshareBulkEmails operation, where each item indicates an individual record's outcome.", "properties": { "data": { "description": "Represents the list of per-record results for the bulk email unsharing operation. Always present in the response.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents a per-record result where the emails are not currently shared for the specified record.", "properties": { "code": { "description": "Represents the result code for a record whose emails are not currently shared.\nPossible values: **NOT_SHARED** - the emails for this record are not shared with colleagues.", "enum": [ "NOT_SHARED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the not-shared status. Always present in the response.", "enum": [ "Emails are not shared to the colleagues already" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - the emails are not currently shared. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotSharedError" }, { "additionalProperties": false, "description": "Represents a per-record result where email sharing was successfully revoked.", "properties": { "code": { "description": "Represents the result code for a successfully unshared record.\nPossible values: **SUCCESS** - the email sharing was successfully revoked for this record.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the record whose email sharing was revoked. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the successfully unshared record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for the successfully unshared record. Always present in the response.", "enum": [ "Sharing revoked successfully" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **success** - the email sharing was revoked for this record. Always present in the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SuccessResponseBulkUnshare" }, { "additionalProperties": false, "description": "Represents a per-record result where the record ID failed validation.", "properties": { "code": { "description": "Represents the result code for a record that failed validation.\nPossible values: **INVALID_DATA** - the record ID is invalid or not found.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the invalid record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message for the invalid data result. Always present in the response.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - the record ID is invalid. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataErrorResponseBulk" }, { "additionalProperties": false, "description": "Represents a per-record result where the unsharing operation was not permitted for the record.", "properties": { "code": { "description": "Represents the result code for a record where the operation is not allowed.\nPossible values: **NOT_ALLOWED** - the unsharing operation is not permitted for this record.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context for the not-allowed result. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element associated with this error. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message for the not-allowed result. Always present in the response.", "format": "string", "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - the operation is not allowed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedErrorResponseSharing" }, { "additionalProperties": false, "description": "Represents a per-record result where the record ID was submitted more than once in the request.", "properties": { "code": { "description": "Represents the result code for a duplicate record ID.\nPossible values: **DUPLICATE_DATA** - this record ID appears more than once in the request.", "enum": [ "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the duplicate record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the duplicate record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message for the duplicate data result. Always present in the response.", "enum": [ "Duplicate Data" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - a duplicate record ID was found. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DuplicateDataErrorResponseSharing" } ], "description": "Represents the outcome for a single record in the partial success response. Each item contains a result code, record details, and status." }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "BulkUnshareEmailsMultiStatusResponse" } } }, "description": "Returns a mix of success and failure results when some email unsharing operations succeed and others fail. Inspect each item in the `data` array for the individual outcome." }, "403": { "content": { "application/json": { "examples": { "PermissionDenied": { "description": "Shows the error response when the authenticated user lacks the required permission to unshare emails.", "summary": "NO_PERMISSION - permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "ZohoCRM.modules.Leads.DELETE" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error response when the authenticated user lacks the required module DELETE permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required module DELETE permission. Always present in the response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission. Always present in the response.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "format": "string", "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission. Always present in the response.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PermissionDeniedErrorResponseSharing" } } }, "description": "The authenticated user lacks the required module DELETE permission. Resolution: Ensure the access token includes the correct `ZohoCRM.modules.{moduleName}.DELETE` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Invoices.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Forecasts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Activities.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Attachments.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.DELETE" ] } ], "summary": "Unshare emails in bulk", "tags": [ "record_share_email" ], "x-zoho-document": "record_share_email" } }, "/crm/v8/{moduleApiName}/{id}/__emails_sharing_details": { "get": { "description": "To retrieve the email sharing details for a specific record in your Zoho CRM organization, including the users whose email accounts are accessible and the available email filter options for the record's email view.", "operationId": "getEmailSharingDetail", "parameters": [ { "description": "Specifies the **API name** of the module for which you want to retrieve the email sharing details. \nPossible values: **Leads**, **Contacts**, **Accounts**, **Deals**, **CustomModule1**. \nRefer to the [Retrieve CRM module metadata](modules.json#$.paths./settings/modules.get) resource for valid values.", "example": "Leads", "in": "path", "name": "moduleApiName", "required": true, "schema": { "enum": [ "Leads", "Contacts", "Accounts", "Deals", "CustomModule1" ], "type": "string" } }, { "description": "Specify the **ID** of the **record** for which you want to retrieve the email sharing details.", "example": "412463000000867017", "in": "path", "name": "id", "required": true, "schema": { "description": "Record ID", "maxLength": 100, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "EmailsSharingDetailsResponseExample": { "description": "Shows a successful response with two users in the **shared_from_users** list and four available email filter categories.", "summary": "Successful response with email sharing details for a record", "value": { "__emails_sharing_details": [ { "available_types": [ "emails_sent_from_crm", "all_contacts_emails", "all_imap_shared_users", "all_emails" ], "shared_from_users": [ { "_type": "pop", "id": "412463000001213019", "name": "Will Grandon" }, { "_type": "imap", "id": "412463000000867017", "name": "boyle" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for the **Get Email Shared Details** operation, containing the email sharing configuration for the requested record.", "properties": { "__emails_sharing_details": { "description": "A JSON array representing the list of email sharing configurations for the record, including the users whose emails can be shared and the available email filter options.", "items": { "additionalProperties": false, "description": "Represents the email sharing configuration for the record, containing the list of users whose **emails are accessible** and the available **email filter** options.", "properties": { "available_types": { "description": "Represents the available email filter options for the record's email view. Always returned in the response.", "items": { "description": "Represents an email filter option. \nPossible values: **emails_sent_from_crm**, **all_contacts_emails**, **all_imap_shared_users**, **all_pop_shared_users**, **all_emails**.", "enum": [ "emails_sent_from_crm", "all_contacts_emails", "all_imap_shared_users", "all_pop_shared_users", "all_emails" ], "type": "string" }, "maxItems": 5, "minItems": 1, "type": "array" }, "shared_from_users": { "description": "Specifies the list of users whose email accounts are accessible when viewing the record's emails. Always returned in the response.", "items": { "additionalProperties": false, "description": "Represents a user whose email account is accessible for the record's email view, including the user's name, unique ID, and email account type.", "properties": { "_type": { "description": "Represents the type of email account used by the user. Possible values: **imap**, **pop**, **api**. Always returned in the response.", "enum": [ "imap", "pop", "api" ], "type": "string" }, "id": { "description": "Represents the unique ID of the user. Always returned in the response.", "maxLength": 100, "type": "string" }, "name": { "description": "Represents the name of the user with email access.", "maxLength": 250, "type": "string" } }, "required": [ "name", "_type", "id" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] } }, "required": [ "shared_from_users", "available_types" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "EmailsSharingDetailsResponse" } } }, "description": "Returns the email sharing configuration for the requested record, including the users with accessible email accounts and the available email filter options." }, "400": { "content": { "application/json": { "examples": { "InvalidDataExample": { "description": "Shows a 400 error response when the request contains invalid data, with the INVALID_DATA error code.", "summary": "400 error response for invalid request data", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "The given data is invalid.", "status": "error" } }, "InvalidModuleExample": { "description": "Shows a 400 error response when the module API name in the request URL is unrecognized, with the INVALID_MODULE error code.", "summary": "400 error response for an unrecognized module API name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 3 }, "message": "The module API name is invalid.", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response body returned when the request fails due to invalid input or an unrecognized module.", "properties": { "code": { "description": "Represents the error code that identifies the type of error. Possible values: **INVALID_DATA**, **INVALID_MODULE**. Always returned in the response.", "enum": [ "INVALID_DATA", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents an object containing additional context about the error, such as the path segment where the issue occurred. Always returned in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the path segment in the request URL where the error occurred.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message that describes the cause of the error. Possible values: **The given data is invalid.**, **The module API name is invalid.**. Always returned in the response.", "enum": [ "The given data is invalid.", "The module API name is invalid.", "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**. Always returned in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "ErrorResponse" } } }, "description": "The request contains invalid data or an unrecognized module API name. \n**Resolution:** The module API name in the request URL must match one of the supported modules, and the record ID must be valid." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.ALL", "ZohoCRM.modules.emails.READ" ] } ], "summary": "Get email sharing details for a record", "tags": [ "emails_sharing_details" ], "x-zoho-document": "emails_sharing_details" } }, "/crm/v8/{moduleApiName}/{id}/actions/convert": { "post": { "description": "To convert an inventory record in your Zoho CRM organization from one module to another. Supported conversion paths are: Quotes to Sales Orders or Invoices, and Sales Orders to Invoices.", "operationId": "convertInventory", "parameters": [ { "$ref": "#/components/parameters/InventoryConvertModuleApiName" }, { "$ref": "#/components/parameters/InventoryConvertId" } ], "requestBody": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a request to convert a Quotes record to a Sales Order, specifying the target module API name and unique ID.", "summary": "Convert a Quotes record to a Sales Order", "value": { "data": [ { "convert_to": [ { "module": { "api_name": "Sales_Orders", "id": "111111000000002469" } } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload for the inventory record conversion.", "properties": { "data": { "description": "Specify the inventory record conversion details.", "items": { "additionalProperties": false, "description": "Specify the details for the inventory record to convert.", "properties": { "convert_to": { "description": "Specify the target module details for the conversion.", "items": { "additionalProperties": false, "description": "Specify the target module name and ID for the converted record.", "properties": { "carry_over_tags": { "description": "Specifies whether the tags from the source record are carried over to the converted target record. Must be set to true or omitted; setting this to false returns a NOT_ALLOWED error.", "type": "boolean" }, "module": { "additionalProperties": false, "description": "Specify the target inventory module to which the record is to be converted.", "properties": { "api_name": { "description": "Specify the API name of the target inventory module. Possible values: **Invoices**, **Sales_Orders**. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs and API names.", "maxLength": 50, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesApiName" } ], "resource": "modules" } }, "id": { "description": "Unique ID of the target module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module ID.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getModules", "propertyId": "ModulesId" } ], "resource": "modules" } } }, "required": [ "api_name", "id" ], "type": "object" } }, "required": [ "module" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "convert_to" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object" } } }, "description": "The request body must contain a data array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful conversion response with the converted Sales Order record ID and display name.", "summary": "Successful conversion of a Quotes record to a Sales Order", "value": { "data": [ { "code": "SUCCESS", "details": { "Sales_Orders": { "id": "111111000000072039", "name": "TestQ4" } }, "message": "The record has been converted successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response returned when the inventory record is converted.", "properties": { "data": { "description": "Represents the list of conversion results returned by the operation.", "items": { "additionalProperties": false, "description": "Represents the conversion result for the inventory record.", "properties": { "code": { "description": "Represents the result code of the conversion operation. Possible values: **SUCCESS**.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the converted record, organized by the target module API name.", "properties": { "Invoices": { "additionalProperties": false, "description": "Represents the details of the converted Invoice record.", "properties": { "id": { "description": "Represents the unique ID of the converted Invoice record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the converted Invoice record.", "maxLength": 50, "type": "string" } }, "type": "object" }, "Sales_Orders": { "additionalProperties": false, "description": "Represents the details of the converted Sales Order record.", "properties": { "id": { "description": "Represents the unique ID of the converted Sales Order record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the converted Sales Order record.", "maxLength": 50, "type": "string" } }, "type": "object" } }, "type": "object" }, "message": { "description": "Represents the message describing the result of the conversion operation.", "enum": [ "The record has been converted successfully" ], "type": "string" }, "status": { "description": "Represents the status of the conversion operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "InventoryConvertSuccessResponse" } } }, "description": "Returns the conversion result, including the unique ID and display name of the converted record in the target module." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "description": "Shows an AMBIGUITY_DURING_PROCESSING error returned when the provided module API name and ID refer to different modules.", "summary": "API name and ID do not match", "value": { "data": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "api_name", "json_path": "$.data[0].convert_to[0].module.api_name" }, { "api_name": "id", "json_path": "$.data[0].convert_to[0].module.id" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "DuplicateData": { "description": "Shows a DUPLICATE_DATA error returned when the converted record's unique field value already exists in the target module.", "summary": "Duplicate unique field value in the target module", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Billing_Street", "duplicate_record": { "Owner": { "id": "111111000000058229", "name": "Poovi MBUser2", "zuid": "44653171" }, "id": "111111000000536282", "module": { "api_name": "Sales_Orders", "id": "111111000000002766" } }, "json_path": "$.data[0].Billing_Street", "more_records": false }, "message": "duplicate data", "status": "error" } ] } }, "ExpectedFieldMissing": { "description": "Shows an EXPECTED_FIELD_MISSING error returned when neither the module API name nor the ID is provided in the request body.", "summary": "Required field missing from convert_to array", "value": { "data": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.data[0].convert_to[0].module.api_name" }, { "api_name": "id", "json_path": "$.data[0].convert_to[0].module.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "IdAlreadyConverted": { "description": "Shows an ID_ALREADY_CONVERTED error returned when the specified source record has already been converted to another module.", "summary": "Source record has already been converted", "value": { "code": "ID_ALREADY_CONVERTED", "details": { "resource_path_index": 1 }, "message": "id already converted", "status": "error" } }, "InvalidParentId": { "description": "Shows an INVALID_DATA error returned when the source record ID does not belong to the specified source module.", "summary": "Invalid or mismatched source record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "invalid data", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an INVALID_REQUEST_METHOD error returned when the request specifies an unsupported HTTP method for the conversion endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryIdsMissing": { "description": "Shows a MANDATORY_NOT_FOUND error returned when the required convert_to field is absent from the request body.", "summary": "Missing mandatory convert_to field", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "convert_to", "json_path": "$.data[0].convert_to" }, "message": "required field not found", "status": "error" } }, "NoPermission": { "description": "Shows a NO_PERMISSION error returned when the caller lacks access to the source inventory module.", "summary": "Permission denied to access the source module", "value": { "code": "NO_PERMISSION", "details": { "resource_path_index": 0 }, "message": "permission denied to access the module", "status": "error" } }, "NotAllowed": { "description": "Shows a NOT_ALLOWED error returned when the carry_over_tags field is explicitly set to false, as tags are always carried over during conversion.", "summary": "carry_over_tags must be set to true", "value": { "data": [ { "code": "NOT_ALLOWED", "details": { "api_name": "carry_over_tags", "json_path": "$.data[0].convert_to[0].carry_over_tags", "reason": "Carry over tags will be automatically converted" }, "message": "carry over tags must be given as true", "status": "error" } ] } }, "NotApproved": { "description": "Shows a NOT_APPROVED error returned when the source record has not been approved and cannot be converted.", "summary": "Source record is pending approval", "value": { "code": "NOT_APPROVED", "details": { "resource_path_index": 1 }, "message": "record not approved", "status": "error" } }, "NotReviewed": { "description": "Shows a NOT_REVIEWED error returned when the source record is still under review and cannot be converted.", "summary": "Source record is pending review", "value": { "code": "NOT_REVIEWED", "details": { "resource_path_index": 1 }, "message": "record in review", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents a flat error response returned when a single validation failure occurs at the request or record level.", "properties": { "code": { "description": "Represents the error code returned for the validation failure. Possible values: **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**. Always returned in the response.", "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, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error, such as the field name, JSON path, or expected data type. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message describing the issue. Always returned in the response.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**. Always returned in the response.", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "InventoryConvertValidationErrorResponse" }, { "additionalProperties": false, "description": "Represents an error response containing a data array returned when validation failures are associated with specific request fields.", "properties": { "data": { "description": "Represents the list of validation error details returned for the failed conversion.", "items": { "additionalProperties": false, "description": "Represents the error detail for a single validation failure in the conversion request.", "properties": { "code": { "description": "Represents the error code for the validation failure. Possible values: **AMBIGUITY_DURING_PROCESSING**, **EXPECTED_FIELD_MISSING**, **NOT_ALLOWED**, **INVALID_DATA**, **DUPLICATE_DATA**. Always returned in the response.", "enum": [ "AMBIGUITY_DURING_PROCESSING", "EXPECTED_FIELD_MISSING", "NOT_ALLOWED", "INVALID_DATA", "DUPLICATE_DATA" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the validation error, such as the field name, JSON path, or expected data type. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message describing the validation issue. Always returned in the response.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**. Always returned in the response.", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 4, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "InventoryConvertValidationErrorResponsewithRoot" } ], "description": "Represents the possible error response shapes returned for validation failures in the conversion request.", "x-zs-$id": "InventoryConvert400ErrorResponse" } } }, "description": "Returns a validation error when the request data is invalid or a required field is missing." }, "403": { "content": { "application/json": { "examples": { "NoPermissionForSourceModule": { "description": "Shows a NO_PERMISSION error returned when the caller lacks permission to convert records from the source module.", "summary": "Permission denied for source module", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Quotes", "Crm_Implied_Convert_Quotes" ] }, "message": "permission denied", "status": "error" } }, "PermissionDeniedForTargetModule": { "description": "Shows a NO_PERMISSION error returned when the caller lacks permission to create records in the target module.", "summary": "Permission denied for target module", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "api_name": "module", "json_path": "$.data[0].convert_to[0].module", "permissions": [ "Crm_Implied_Create_Invoices", "Crm_Implied_View_Invoices" ] }, "message": "permission denied", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents a permission denied response containing a data array, returned when access to the target module is denied.", "properties": { "data": { "description": "Represents the list of permission error details returned by the operation.", "items": { "additionalProperties": false, "description": "Represents a single permission error detail for the conversion operation.", "properties": { "code": { "description": "Represents the error code for the permission failure. Possible values: **NO_PERMISSION**. Always returned in the response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the permission error, such as the required permissions or the resource path index. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message describing the permission denial. Always returned in the response.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**. Always returned in the response.", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 4, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PermissionDeniedForSourceModule" }, { "additionalProperties": false, "description": "Represents a flat permission denied response returned when access to the source module is denied.", "properties": { "code": { "description": "Represents the error code for the permission failure. Possible values: **NO_PERMISSION**. Always returned in the response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the permission denial, such as the required permissions. Always returned in the response.", "type": "object" }, "message": { "description": "Represents the error message describing the permission denial. Always returned in the response.", "maxLength": 512, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error**. Always returned in the response.", "enum": [ "error" ], "maxLength": 50, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PermissionDeniedForTargetModule" } ], "description": "Represents the permission denied response returned when the caller lacks access to the source or target inventory module.", "x-zs-$id": "PermissionDeniedErrorResponse" } } }, "description": "Returns a permission denied error when the caller lacks access to the source or target inventory module." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Quotes.CREATE", "ZohoCRM.modules.SalesOrders.CREATE" ] } ], "summary": "Convert Inventory Record", "tags": [ "inventory_convert" ], "x-zoho-document": "inventory_convert" } }, "/crm/v8/{moduleApiName}/{id}/actions/fetch_full_data": { "get": { "description": "Retrieves the full content of rich text multi-line fields for a specific record identified by its record ID in the path. The 'fields' query parameter is optional for this endpoint - if omitted, all rich text fields of the record are returned. When specified, only the listed rich text fields are fetched. This API exclusively fetches rich text fields - other field types are not supported. Only data from rich text multi-line fields can be retrieved; multi-line fields of other types (small, large) are not supported.", "operationId": "fetchFullDataForSingleRecord", "parameters": [ { "$ref": "#/components/parameters/FetchFullDataModuleApiName" }, { "$ref": "#/components/parameters/FetchFullDataFields" }, { "$ref": "#/components/parameters/FetchFullDataId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SingleRecord": { "value": { "data": [ { "Rich_Text_1": "Bold Content", "Rich_Text_2": "Italic Content", "id": "1043386000018763408" } ] } } }, "schema": { "additionalProperties": false, "description": "Wrapper object for the response. Contains a 'data' array with a single record object holding the record ID and its rich text field values.", "properties": { "data": { "description": "An array containing a single record object with the record ID and the values of the requested rich text fields.", "items": { "additionalProperties": { "description": "The full HTML-formatted content of a rich text field. The property name corresponds to the API name of the rich text field in the module. The value is null if the field has no content. Each rich text field supports up to 50,000 characters.", "maxLength": 50000, "type": "string" }, "description": "A record object containing the record's unique ID and the full content of each requested rich text field. The rich text field property names correspond to the API names of the fields in the module.", "properties": { "id": { "description": "The unique identifier of the record whose rich text field data is being returned.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "FetchFullDataSingleRecordResponse" } } }, "description": "Successful response containing the full HTML-formatted content of the rich text fields for the specified record. If the 'fields' parameter was omitted, all rich text fields of the record are included." }, "204": { "$ref": "#/components/responses/FetchFullDataNoContentResponse" }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "summary": "Invalid Module", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequest": { "summary": "Invalid Request", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the module API name specified in the path is not a valid CRM module. Verify the module API name and retry the request.", "properties": { "code": { "description": "Error code indicating that the module API name specified in the request path is not recognized as a valid CRM module.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Error details with resource path index", "properties": { "resource_path_index": { "description": "Index of the resource path that caused the error.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModule400ErrorResponse" }, { "additionalProperties": false, "description": "Returned when the request cannot be processed due to an incorrect method name, parameter, or parameter value. Verify the request URL and parameters and retry.", "properties": { "code": { "description": "Error code indicating the request is invalid due to incorrect method name, parameter, or parameter values.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional details about the error.", "type": "object" }, "message": { "description": "Human-readable error message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RequiredParam400MissingErrorResponse" } ], "description": "Error response for the single-record fetch full data operation. Includes INVALID_MODULE and INVALID_REQUEST error variants.", "x-zs-$id": "FetchFullDataSingleRecordErrorResponse" } } }, "description": "Bad Request. Returned when the module API name is invalid or the request cannot be processed due to incorrect method name, parameter, or parameter values." }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "500": { "$ref": "#/components/responses/FetchFullDataInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Rich text field content for a specific record", "tags": [ "fetch_full_data" ], "x-zoho-document": "fetch_full_data", "x-zs-llm-description": "Use this endpoint to fetch full rich-text field content for one record. Prefer passing fields explicitly when only selected rich-text columns are needed; omit fields only when complete rich-text retrieval is required." } }, "/crm/v8/{moduleApiName}/{id}/actions/share_emails": { "post": { "description": "To share email threads linked to a specific CRM record with colleagues in the same organization. Requires custom email sharing to be enabled in the organization and a valid email configuration for the user.", "operationId": "shareEmails", "parameters": [ { "description": "Specify the API name of the module that contains the record whose emails you want to share. Refer to [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve available module API names.", "example": "Leads", "in": "path", "name": "moduleApiName", "required": true, "schema": { "enum": [ "Leads", "Contacts", "Accounts", "Deals", "CustomModule1" ], "type": "string" } }, { "$ref": "#/components/parameters/RecordShareEmailId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the response when the email sharing operation for the specified record completes successfully.", "summary": "Successful email sharing", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "1234567890" }, "message": "Successfully shared", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 200 response schema for the shareEmails operation, containing an array of per-record email sharing results.", "properties": { "data": { "description": "Represents the list of per-record email sharing results. Always present in the response.", "items": { "additionalProperties": false, "description": "Represents the result for a single record in the email sharing response.", "properties": { "code": { "description": "Represents the result code for the email sharing operation.\nPossible values: **SUCCESS** - the email sharing completed successfully. Always present in the response.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the record that was shared. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the shared record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for the email sharing operation. Always present in the response.", "enum": [ "Successfully shared" ], "type": "string" }, "status": { "description": "Represents the overall operation status.\nPossible values: **success** - the email sharing completed successfully. Always present in the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "ShareEmailsResponse" } } }, "description": "Returns the per-record email sharing result after the operation completes successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the specified record ID fails validation.", "summary": "INVALID_DATA - invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the related id given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the INVALID_DATA error response when the provided record ID is invalid.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **INVALID_DATA** - a field value failed validation. Always present in the response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the validation error. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. Always present in the response.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataError" }, { "additionalProperties": false, "description": "Represents the INVALID_MODULE error response when the specified module name is invalid.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **INVALID_MODULE** - the specified module name is not valid. Always present in the response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the invalid module error. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid module. Always present in the response.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, { "additionalProperties": false, "description": "Represents the NOT_SUPPORTED error response when the specified module does not support email sharing.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NOT_SUPPORTED** - the specified module does not support email sharing. Always present in the response.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the unsupported module error. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported module. Always present in the response.", "enum": [ "the given module is not supported in api" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotSupportedModuleError" }, { "additionalProperties": false, "description": "Represents the NOT_ALLOWED error response when custom email sharing is not enabled for the organization.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NOT_ALLOWED** - the organization has not enabled custom email sharing. Always present in the response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context. Always present in the response.", "type": "object" }, "message": { "description": "Represents the error message when custom email sharing is not enabled. Always present in the response.", "enum": [ "User did not enable custom sharing" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CustomSharingNotEnabledError" }, { "additionalProperties": false, "description": "Represents the NOT_ALLOWED error response when no email configuration exists for the user.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NOT_ALLOWED** - no email configuration exists for this user. Always present in the response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context. Always present in the response.", "type": "object" }, "message": { "description": "Represents the error message when no email configuration exists. Always present in the response.", "enum": [ "Email Configuration does not exist" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "EmailConfigMissingError" }, { "additionalProperties": false, "description": "Represents the ALREADY_SHARED error response when the emails are already shared for the specified record.", "properties": { "data": { "description": "Represents the list of per-record already-shared results. Always present in the response.", "items": { "additionalProperties": false, "description": "Represents a per-record result where the emails are already shared.", "properties": { "code": { "description": "Represents the result code.\nPossible values: **ALREADY_SHARED** - the emails for this record are already shared with colleagues.", "enum": [ "ALREADY_SHARED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the already-shared record. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the already-shared record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the message describing the already-shared status. Always present in the response.", "enum": [ "Emails are already shared to the colleagues already" ], "type": "string" }, "status": { "description": "Represents the status for this result item.\nPossible values: **error** - the emails are already shared. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "AlreadySharedError" }, { "additionalProperties": false, "description": "Represents the INVALID_DATA error response when a field value has an incorrect data type.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **INVALID_DATA** - a field value has an incorrect data type. Always present in the response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the data type error. Always present in the response.", "properties": { "api_name": { "description": "Represents the API name of the field that has an incorrect data type. Always present in the response.", "format": "string", "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "expected_data_type", "api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the data type mismatch. Always present in the response.", "format": "string", "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataTypeError" }, { "additionalProperties": false, "description": "Represents the NOT_ALLOWED error response when the operation is not permitted for the specified record.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NOT_ALLOWED** - the operation is not permitted. Always present in the response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation is not allowed. Always present in the response.", "format": "string", "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedError" } ], "description": "Represents the 400 error response schema for the shareEmails operation, returned when input validation fails.", "x-zs-$id": "ShareEmailsError400Response" } } }, "description": "The request failed. Possible causes include an invalid record ID, an invalid or unsupported module, emails already being shared, a missing email configuration, or custom email sharing not being enabled. Resolution: Review the error code and details to correct the request before retrying." }, "403": { "content": { "application/json": { "examples": { "PermissionDenied": { "description": "Shows the error response when the authenticated user lacks the required permission to share emails for the record.", "summary": "NO_PERMISSION - permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "ZohoCRM.modules.Leads.PUT" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error response when the authenticated user lacks the required module CREATE permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required module CREATE permission. Always present in the response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission. Always present in the response.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "format": "string", "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission. Always present in the response.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PermissionDeniedError" } } }, "description": "The authenticated user lacks the required module CREATE permission. Resolution: Ensure the access token includes the correct `ZohoCRM.modules.{moduleName}.CREATE` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Invoices.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Forecasts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Activities.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Attachments.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.CREATE" ] } ], "summary": "Share Record Emails", "tags": [ "record_share_email" ], "x-zoho-document": "record_share_email" } }, "/crm/v8/{moduleApiName}/{id}/actions/unshare_emails": { "post": { "description": "To revoke email sharing for a specific CRM record, making the linked email threads no longer visible to colleagues. Requires custom email sharing to be enabled in the organization and a valid email configuration for the user.", "operationId": "unshareEmails", "parameters": [ { "description": "Specify the API name of the module that contains the record whose email sharing you want to revoke. Refer to [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve available module API names.", "example": "Leads", "in": "path", "name": "moduleApiName", "required": true, "schema": { "enum": [ "Leads", "Contacts", "Accounts", "Deals", "CustomModule1" ], "type": "string" } }, { "$ref": "#/components/parameters/RecordShareEmailId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the response when the email sharing revocation for the specified record completes successfully.", "summary": "Successful email sharing revocation", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "1234567890" }, "message": "Sharing revoked successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the 200 response schema for the unshareEmails operation, containing an array of per-record email unsharing results.", "properties": { "data": { "description": "Represents the list of per-record email unsharing results. Always present in the response.", "items": { "additionalProperties": false, "description": "Represents the result for a single record in the email unsharing response.", "properties": { "code": { "description": "Represents the result code for the email unsharing operation.\nPossible values: **SUCCESS** - the email sharing was successfully revoked. Always present in the response.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the record whose email sharing was revoked. Always present in the response.", "properties": { "id": { "description": "Represents the unique identifier of the unshared record. Always present in the response.", "format": "string", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for the email unsharing operation. Always present in the response.", "enum": [ "Sharing revoked successfully" ], "type": "string" }, "status": { "description": "Represents the overall operation status.\nPossible values: **success** - the email sharing was successfully revoked. Always present in the response.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "UnshareEmailsResponse" } } }, "description": "Returns the per-record email unsharing result after the operation completes successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the error response when the specified record ID fails validation during email unsharing.", "summary": "INVALID_DATA - invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "the related id given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the INVALID_DATA error response when the provided record ID is invalid.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **INVALID_DATA** - a field value failed validation. Always present in the response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the validation error. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the validation failure. Always present in the response.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidData" }, { "additionalProperties": false, "description": "Represents the INVALID_MODULE error response when the specified module name is invalid.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **INVALID_MODULE** - the specified module name is not valid. Always present in the response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the invalid module error. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid module. Always present in the response.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModule" }, { "additionalProperties": false, "description": "Represents the NOT_SUPPORTED error response when the specified module does not support this operation.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NOT_SUPPORTED** - the specified module does not support email sharing. Always present in the response.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the unsupported module error. Always present in the response.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element where the error occurred. Always present in the response.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported module. Always present in the response.", "enum": [ "the given module is not supported in api" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotSupportedModule" }, { "additionalProperties": false, "description": "Represents the NOT_ALLOWED error response when custom email sharing is not enabled for the organization.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NOT_ALLOWED** - the organization has not enabled custom email sharing. Always present in the response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context. Always present in the response.", "type": "object" }, "message": { "description": "Represents the error message when custom email sharing is not enabled. Always present in the response.", "enum": [ "User did not enable custom sharing" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "CustomSharingNotEnabled" }, { "additionalProperties": false, "description": "Represents the NOT_ALLOWED error response when no email configuration exists for the user.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NOT_ALLOWED** - no email configuration exists for this user. Always present in the response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional error context. Always present in the response.", "type": "object" }, "message": { "description": "Represents the error message when no email configuration exists. Always present in the response.", "enum": [ "Email Configuration does not exist" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "EmailConfigMissing" } ], "description": "Represents the 400 error response schema for the unshareEmails operation, returned when input validation fails.", "x-zs-$id": "UnshareEmailsError400Response" } } }, "description": "The request failed. Possible causes include an invalid record ID, an invalid or unsupported module, a missing email configuration, or custom email sharing not being enabled. Resolution: Review the error code and details to correct the request before retrying." }, "403": { "content": { "application/json": { "examples": { "PermissionDenied": { "description": "Shows the error response when the authenticated user lacks the required permission to unshare emails for the record.", "summary": "NO_PERMISSION - permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "ZohoCRM.modules.Leads.PUT" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the NO_PERMISSION error response when the authenticated user lacks the required module DELETE permission.", "properties": { "code": { "description": "Represents the error code for this response.\nPossible values: **NO_PERMISSION** - the authenticated user lacks the required module DELETE permission. Always present in the response.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the missing permission. Always present in the response.", "properties": { "permissions": { "description": "Represents the list of required permission identifiers that the user lacks.", "items": { "description": "Represents a required permission identifier.", "format": "string", "type": "string" }, "maxItems": 10, "type": "array" } }, "type": "object" }, "message": { "description": "Represents the error message describing the missing permission. Always present in the response.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the overall response status.\nPossible values: **error** - the request failed. Always present in the response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PermissionDenied" } } }, "description": "The authenticated user lacks the required module DELETE permission. Resolution: Ensure the access token includes the correct `ZohoCRM.modules.{moduleName}.DELETE` scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Invoices.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Forecasts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Activities.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Attachments.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.DELETE" ] } ], "summary": "Unshare Record Emails", "tags": [ "record_share_email" ], "x-zoho-document": "record_share_email" } }, "/crm/v8/{moduleApiName}/{recordId}/Attachments": { "get": { "description": "Retrieves all attachments associated with a specific record in a module.", "operationId": "getAttachments", "parameters": [ { "$ref": "#/components/parameters/AttachmentsRecordId" }, { "$ref": "#/components/parameters/AttachmentsModuleApiName" }, { "$ref": "#/components/parameters/AttachmentsFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "EmptyList": { "description": "Response when no attachments are associated with the record.", "summary": "No attachments found", "value": { "data": [], "info": { "count": 0, "more_records": false, "next_page_token": null, "page": 1, "page_token_expiry": null, "per_page": 200, "previous_page_token": null } } }, "MultipleAttachments": { "description": "Response showing both file and link type attachments.", "summary": "Multiple attachments including file and link types", "value": { "data": [ { "$editable": true, "$field_states": null, "$file_id": "file123", "$se_module": "Leads", "$state": "save", "$type": "File", "Created_By": { "email": "test@zohocorp.com", "id": "2876819000000511001", "name": "John CRM" }, "Created_Time": "2025-12-11T11:34:53+05:30", "File_Name": "Q4_Report.pdf", "Modified_By": { "email": "test@zohocorp.com", "id": "2876819000000511001", "name": "John CRM" }, "Modified_Time": "2025-12-11T11:34:53+05:30", "Owner": { "email": "test@zohocorp.com", "id": "2876819000000511001", "name": "John CRM" }, "Parent_Id": { "id": "2876819000001234567", "name": "John Doe" }, "Size": "1048576", "id": "2876819000001935002" }, { "$editable": true, "$field_states": null, "$file_id": null, "$link_url": "https://www.google.com", "$se_module": "Contacts", "$state": "save", "$type": "Link URL", "Created_By": { "email": "admin@zohocorp.com", "id": "2876819000000511002", "name": "Admin User" }, "Created_Time": "2025-12-10T09:20:15+05:30", "File_Name": "Google", "Modified_By": { "email": "admin@zohocorp.com", "id": "2876819000000511002", "name": "Admin User" }, "Modified_Time": "2025-12-10T09:20:15+05:30", "Owner": { "email": "admin@zohocorp.com", "id": "2876819000000511002", "name": "Admin User" }, "Parent_Id": { "id": "2876819000001234568", "name": "Jane Smith" }, "Size": "0", "id": "2876819000001935003" } ], "info": { "count": 2, "more_records": false, "next_page_token": null, "page": 1, "page_token_expiry": null, "per_page": 200, "previous_page_token": null } } } }, "schema": { "$ref": "#/components/schemas/AttachmentListResponse" } } }, "description": "Successfully retrieved list of attachments" }, "400": { "$ref": "#/components/responses/AttachmentsBadRequest" }, "401": { "$ref": "#/components/responses/AttachmentsUnauthorized" }, "403": { "$ref": "#/components/responses/AttachmentsForbidden" }, "404": { "$ref": "#/components/responses/AttachmentsNotFound" }, "429": { "$ref": "#/components/responses/AttachmentsTooManyRequests" }, "500": { "$ref": "#/components/responses/AttachmentsInternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.attachments.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.attachments.ALL" ] } ], "summary": "Retrieve All Attachments", "tags": [ "attachments" ], "x-zoho-document": "attachments" }, "post": { "description": "Uploads an attachment by providing either a file or a valid URL. Maximum request body size: 100MB.", "operationId": "uploadAttachment", "parameters": [ { "$ref": "#/components/parameters/AttachmentsRecordId" }, { "$ref": "#/components/parameters/AttachmentsModuleApiName" } ], "requestBody": { "content": { "multipart/form-data": { "examples": { "BasicUpload": { "description": "Upload request with an optional title provided.", "summary": "Upload with title", "value": { "attachmentUrl": "https://example.com/document.pdf", "title": "Q4 Financial Report" } }, "MaxLengthUrl": { "description": "Upload request with a URL approaching the maximum allowed length.", "summary": "Maximum length URL", "value": { "attachmentUrl": "https://example.com/very/long/path/that/could/reach/maximum/allowed/length/of/2000/characters/...", "title": "Document with long URL" } }, "MinimalUpload": { "description": "Upload request with only the required attachment URL.", "summary": "Upload without title", "value": { "attachmentUrl": "https://example.com/document.pdf" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Upload attachment by file", "properties": { "file": { "description": "The file to upload as an attachment", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object", "x-zs-$id": "UploadAttachmentByFile" }, { "additionalProperties": false, "description": "Upload attachment by URL", "properties": { "attachmentUrl": { "description": "The URL of the attachment to be linked", "maxLength": 3000, "type": "string" }, "title": { "description": "Optional title for the attachment", "maxLength": 255, "minLength": 1, "type": [ "string", "null" ] } }, "required": [ "attachmentUrl" ], "type": "object", "x-zs-$id": "UploadAttachmentByUrl" } ], "description": "Schema used by uploadAttachment." } } }, "description": "Request payload for uploadAttachment. Provide multipart form-data fields as documented for this operation.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpload": { "description": "Successful attachment upload response with details and timestamps.", "summary": "Successful attachment upload", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "2876819000000511001", "name": "John Doe" }, "Created_Time": "2025-12-22T13:14:47+05:30", "Modified_By": { "id": "2876819000000511001", "name": "John Doe" }, "Modified_Time": "2025-12-22T13:14:47+05:30", "id": "2876819000002738705" }, "message": "attachment uploaded successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/AttachmentSuccessResponse" } } }, "description": "Attachment uploaded successfully" }, "400": { "$ref": "#/components/responses/AttachmentsBadRequest" }, "401": { "$ref": "#/components/responses/AttachmentsUnauthorized" }, "403": { "$ref": "#/components/responses/AttachmentsForbidden" }, "404": { "$ref": "#/components/responses/AttachmentsNotFound" }, "413": { "$ref": "#/components/responses/PayloadTooLarge" }, "429": { "$ref": "#/components/responses/AttachmentsTooManyRequests" }, "500": { "$ref": "#/components/responses/AttachmentsInternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.attachments.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.attachments.ALL" ] } ], "summary": "Upload an Attachment", "tags": [ "attachments" ], "x-zoho-document": "attachments" } }, "/crm/v8/{moduleApiName}/{recordId}/Attachments/{id}": { "delete": { "description": "Deletes a link attachment associated with a specific record in a module. Note that only link attachments can be deleted using this endpoint; file attachments cannot be deleted through this API.", "operationId": "deleteAttachment", "parameters": [ { "$ref": "#/components/parameters/AttachmentsRecordId" }, { "$ref": "#/components/parameters/AttachmentsModuleApiName" }, { "$ref": "#/components/parameters/AttachmentsId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDeletion": { "description": "Successful deletion response with attachment ID.", "summary": "Successful attachment deletion", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "2876819000001935002" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful deletion response", "properties": { "data": { "description": "Array of deletion results", "items": { "additionalProperties": false, "description": "Deletion status details", "properties": { "code": { "description": "Represents the response code indicating success", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the deleted attachment", "properties": { "id": { "description": "ID of the deleted attachment. Use the [Get Attachments](attachments.yaml#$.paths./{moduleApiName}/{recordId}/Attachments.get) resource to retrieve attachment IDs.\n", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message", "enum": [ "record deleted" ], "type": "string" }, "status": { "description": "Represents the operation status", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteAttachmentSuccessResponseData" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteAttachmentSuccessResponse" } } }, "description": "Successful deletion response" }, "400": { "content": { "application/json": { "examples": { "AlreadyDeleted": { "description": "Error response returned when the attachment has already been deleted.", "summary": "Attachment already deleted", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "record not deleted", "status": "error" } }, "InvalidAttachmentId": { "description": "Error response returned when the attachment ID is invalid.", "summary": "Invalid attachment ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "record not deleted", "status": "error" } }, "InvalidData": { "description": "Error response returned when the record ID is invalid.", "summary": "Invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "record not deleted", "status": "error" } }, "InvalidModule": { "description": "Error response returned when the module name is invalid.", "summary": "Invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response for invalid related id", "properties": { "code": { "description": "Represents the Error code indicating invalid module", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details", "properties": { "resource_path_index": { "description": "Index of the resource path causing the error", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue", "enum": [ "the related id given seems to be invalid", "record not deleted" ], "type": "string" }, "status": { "description": "Represents the error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DeleteAttachmentErrorResponseInvalidRelatedId" }, { "additionalProperties": false, "description": "Error response for invalid module name", "properties": { "code": { "description": "Represents the error code indicating invalid module", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details", "properties": { "resource_path_index": { "description": "Index of the resource path causing the error", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DeleteAttachmentErrorResponseInvalidModule" } ], "description": "Wrapper for delete attachment error responses", "x-zs-$id": "DeleteAttachmentErrorResponseWrapper" } } }, "description": "Error response for invalid request, including invalid record ID, invalid module name, or attachment already deleted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.attachments.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.attachments.ALL" ] } ], "summary": "Delete Link Attachment", "tags": [ "attachments" ], "x-zoho-document": "attachments" }, "get": { "description": "Download the file content of a specific attachment by its ID. This endpoint returns the actual file (image, PDF, document, etc.). Returns an error for link attachments, as they cannot be downloaded.", "operationId": "getAttachmentById", "parameters": [ { "$ref": "#/components/parameters/AttachmentsRecordId" }, { "$ref": "#/components/parameters/AttachmentsModuleApiName" }, { "$ref": "#/components/parameters/AttachmentsId" } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "description": "The binary content of the attachment file", "format": "binary", "type": "string", "x-zs-$id": "AttachmentFileBinary" } } }, "description": "Successfully downloaded attachment file" }, "204": { "description": "No Content - Invalid attachment ID" }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "description": "Error response returned when the module name is invalid.", "summary": "Invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecordId": { "description": "Error response returned when the record ID is invalid.", "summary": "Invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "LinkAttachmentError": { "description": "Error response returned when attempting to download a link attachment.", "summary": "Link attachment cannot be downloaded", "value": { "code": "DOWNLOAD_NOT_ALLOWED", "details": {}, "message": "As it is a linked attachment, you can not download it", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response for invalid module name", "properties": { "code": { "description": "Represents the error code", "enum": [ "DOWNLOAD_NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details", "properties": { "param_name": { "description": "Represents the name of the missing parameter", "maxLength": 100, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message", "enum": [ "As it is a linked attachment, you can not download it" ], "type": "string" }, "status": { "description": "Represents the error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DownloadNotAllowedError" }, { "additionalProperties": false, "description": "Error response for invalid record ID", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details", "properties": { "resource_path_index": { "description": "Represents the index of the resource path causing the error", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidRecordIdError" }, { "additionalProperties": false, "description": "Error response for invalid module name", "properties": { "code": { "description": "Error code", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details", "properties": { "resource_path_index": { "description": "Index of the resource path causing the error", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Error message", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the error status.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" } ], "description": "Wrapper for get attachment by ID error responses", "x-zs-$id": "GetAttachmentByIdErrorResponseWrapper" } } }, "description": "Bad request - invalid parameters or link attachment download attempt" }, "401": { "$ref": "#/components/responses/AttachmentsUnauthorized" }, "403": { "$ref": "#/components/responses/AttachmentsForbidden" }, "404": { "$ref": "#/components/responses/AttachmentsNotFound" }, "429": { "$ref": "#/components/responses/AttachmentsTooManyRequests" }, "500": { "$ref": "#/components/responses/AttachmentsInternalServerError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.attachments.READ" ] } ], "summary": "Download a specific attachment file", "tags": [ "attachments" ], "x-zoho-document": "attachments" } }, "/crm/v8/{moduleApiName}/{recordId}/actions/download_mail_merge": { "post": { "description": "To download the merged document created from a mail merge template for a specific record in your Zoho CRM organization. You can choose the output format as **pdf**, **html**, or **docx**, and optionally set a password for PDF documents.", "operationId": "postDownloadMailMerge", "parameters": [ { "$ref": "#/components/parameters/ParamPathModuleApiName" }, { "$ref": "#/components/parameters/ParamPathRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a download mail merge request using a named template with PDF output format and an optional password.", "summary": "Download mail merge request body", "value": { "download_mail_merge": [ { "file_name": "testdocument", "mail_merge_template": { "name": "mailmergename" }, "output_format": "pdf", "password": "tester123" } ] } } }, "schema": { "$ref": "#/components/schemas/PostdownloadmailmergeRequest" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain a **download_mail_merge** array with one object specifying the mail merge template and its optional output settings." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response when the download mail merge operation is initiated.", "summary": "Example of a successful download mail merge response.", "value": { "download_mail_merge": [ { "code": "SUCCESS", "message": "download mail merge action initiated successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body for a successful download mail merge request.", "properties": { "download_mail_merge": { "description": "Represents the list of download mail merge response objects.", "items": { "additionalProperties": false, "description": "Each object represents an individual response item for the download mail merge operation.", "properties": { "code": { "description": "Represents the response code indicating the result of the download mail merge operation.", "maxLength": 255, "type": "string" }, "message": { "description": "Represents the message describing the result of the download mail merge operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the download mail merge operation.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "type": "object", "x-zs-$id": "PostdownloadmailmergeResponse200" } } }, "description": "Returns the result of the download mail merge operation, indicating that the merged document generation was initiated successfully." }, "400": { "content": { "application/json": { "examples": { "Error400": { "description": "Shows the error response when the required mail merge template field is missing from the request body.", "summary": "Example of a missing required field error response.", "value": { "download_mail_merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "mail_merge_template", "json_path": "$.download_mail_merge[0].mail_merge_template" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ExpectedParamMissingError" }, { "$ref": "#/components/schemas/InvalidDataUrlError" }, { "$ref": "#/components/schemas/InvalidModuleParamError" }, { "$ref": "#/components/schemas/MailMergeInvalidRequestMethodError" }, { "additionalProperties": false, "description": "Represents an error response containing a list of validation errors for the download mail merge request body.", "properties": { "download_mail_merge": { "description": "Represents the list of error objects for the download mail merge operation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MailMergeMandatoryFieldNotFoundError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataTypeError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataMaxLengthError" } ], "description": "Each object represents an individual error object for the download mail merge request." }, "maxItems": 25, "type": "array" } }, "required": [ "download_mail_merge" ], "type": "object", "x-zs-$id": "PostdownloadmailmergeError400Wrapper" } ], "description": "Represents the error response body for an invalid download mail merge request.", "x-zs-$id": "PostdownloadmailmergeError400" } } }, "description": "The download mail merge request could not be processed due to invalid input. \n**Resolution**: Verify that the request body contains all required fields with valid values, and that the module API name and record ID in the URL are correct.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.mailmerge.CREATE", "ZohoWriter.documentEditor.ALL", "ZohoWriter.merge.ALL" ] } ], "summary": "Download mail merge document", "tags": [ "mail_merge" ], "x-zoho-document": "mail_merge" } }, "/crm/v8/{moduleApiName}/{recordId}/actions/get_related_records_count": { "post": { "description": "To retrieve the count of related records for a specified parent record in your Zoho CRM organization. Supports optional filtering by approval status, conversion status, category type, and field-level equality criteria. A single request can include up to 20 related list count specifications. You can use this API to get the count of records in the following types of related lists:\n\n- **System-defined related lists**, such as:\n - Survey\n - Desk\n - Projects\n - Visits\n - Expense\n - Invoice\n - Subscription\n- **Custom related lists** created via Lookup fields.\n- **Custom related lists** created via Multi-select Lookup fields.\n- **Custom related lists** created via Multi-module Lookup fields.\n- **Related lists** created when history tracking is enabled for a picklist field.", "operationId": "getRelatedRecordsCount", "parameters": [ { "$ref": "#/components/parameters/GetRelatedRecordsCountModuleApiName" }, { "$ref": "#/components/parameters/GetRelatedRecordsCountRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "ApprovalStateFilter": { "description": "Shows a count request for the Quotes related list, filtered to include only records in the approved approval state where the Quote_Stage field equals Accepted.", "summary": "Count records filtered by approval state", "value": { "get_related_records_count": [ { "params": { "approval_state": "approved", "filters": { "comparator": "equal", "field": { "api_name": "Quote_Stage" }, "value": "Accepted" } }, "related_list": { "api_name": "Quotes", "id": "4150868000001038006" } } ] } }, "BasicCount": { "description": "Shows a minimal count request for a single related list identified by its API name and ID, with no optional filtering criteria.", "summary": "Basic related list count without filters", "value": { "get_related_records_count": [ { "related_list": { "api_name": "Contacts", "id": "4150868000001038001" } } ] } }, "CategoryFilter": { "description": "Shows a count request for the Attachments related list, filtered by category to include only file-type attachments where the File_Type field equals PDF.", "summary": "Count related records filtered by category type", "value": { "get_related_records_count": [ { "params": { "category": "files", "filters": { "comparator": "equal", "field": { "api_name": "File_Type" }, "value": "PDF" } }, "related_list": { "api_name": "Attachments", "id": "4150868000001038005" } } ] } }, "ConvertedFilter": { "description": "Shows a count request for the Leads related list, filtered to include only converted records where the Status field equals Qualified.", "summary": "Count only converted leads in a related list", "value": { "get_related_records_count": [ { "params": { "converted": true, "filters": { "comparator": "equal", "field": { "api_name": "Status" }, "value": "Qualified" } }, "related_list": { "api_name": "Leads", "id": "4150868000001038004" } } ] } }, "FilteredCount": { "description": "Shows a count request for the Deals related list, filtered to include only approved records where the Stage field equals Closed Won.", "summary": "Count request with field filter and approval status", "value": { "get_related_records_count": [ { "params": { "approved": true, "filters": { "comparator": "equal", "field": { "api_name": "Stage" }, "value": "Closed Won" } }, "related_list": { "api_name": "Deals", "id": "4150868000001038002" } } ] } }, "MultipleRelatedLists": { "description": "Shows a single request that retrieves counts for three related lists — Contacts, Deals, and Tasks — in one API call.", "summary": "Count multiple related lists in one request", "value": { "get_related_records_count": [ { "related_list": { "api_name": "Contacts", "id": "4150868000001038001" } }, { "related_list": { "api_name": "Deals", "id": "4150868000001038002" } }, { "related_list": { "api_name": "Tasks", "id": "4150868000001038003" } } ] } } }, "schema": { "$ref": "#/components/schemas/GetRelatedRecordsCountRequest" } } }, "description": "The request body must contain a **get_related_records_count** array. You can include a maximum of 20 objects per request. Use the [Get Related Records API](related_records.yaml#$.paths./{parentRecordModule}/{parentRecord}/{relatedList}.get) to get the ID of the related list in the key ID.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "EmptyCount": { "description": "Shows a successful response where no Tasks records match the specified criteria, returning a count of zero.", "summary": "Count response with zero matching records", "value": { "get_related_records_count": [ { "count": 0, "related_list": { "api_name": "Tasks", "id": "4150868000001038003" } } ] } }, "FilteredCountResult": { "description": "Shows a successful response with the count of three Deals records that match the specified filter criteria.", "summary": "Count response after applying filter criteria", "value": { "get_related_records_count": [ { "count": 3, "related_list": { "api_name": "Deals", "id": "4150868000001038002" } } ] } }, "MultipleRelatedLists": { "description": "Shows a successful response with counts for two related lists: 15 Contacts and eight Deals records associated with the specified parent record.", "summary": "Successful count response for multiple related lists", "value": { "get_related_records_count": [ { "count": 15, "related_list": { "api_name": "Contacts", "id": "4150868000001038001" } }, { "count": 8, "related_list": { "api_name": "Deals", "id": "4150868000001038002" } } ] } }, "SuccessfulCount": { "description": "Shows a successful response with the count of 15 Contacts records associated with the specified parent record.", "summary": "Successful count response for a single related list", "value": { "get_related_records_count": [ { "count": 15, "related_list": { "api_name": "Contacts", "id": "4150868000001038001" } } ] } } }, "schema": { "$ref": "#/components/schemas/GetRelatedRecordsCountResponse" } } }, "description": "Returns an array of count results for the requested related lists, each containing the count of matching records and the related list identifier." }, "207": { "content": { "application/json": { "examples": { "PartialSuccessInvalidData": { "description": "Response with a mix of successful counts and per-item errors. Index 0 returned a count successfully; index 1 failed because the related_list id was invalid.", "summary": "Partial success with INVALID_DATA error", "value": { "get_related_records_count": [ { "count": 0, "related_list": { "api_name": "Notes", "id": "4987786000000002730" } }, { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.get_related_records_count[1].related_list.id" }, "message": "Given related_list is invalid", "status": "error" } ] } }, "PartialSuccessMandatoryNotFound": { "description": "Response with a mix of successful counts and per-item errors. Index 0 returned a count successfully; index 1 failed because the related_list field was missing.", "summary": "Partial success with MANDATORY_NOT_FOUND error", "value": { "get_related_records_count": [ { "count": 0, "related_list": { "api_name": "Notes", "id": "4987786000000002730" } }, { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "related_list", "json_path": "$.get_related_records_count[1].related_list" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/GetRelatedRecordsCountPartialSuccessResponse" }, { "$ref": "#/components/schemas/PartialSuccessMandatoryNotFoundResponse" } ], "x-zs-$id": "GetRelatedRecordsCount207Response" } } }, "description": "Multi-Status. Returned when the request contains multiple related list count items where some succeed and others fail (partial success). Each item in the get_related_records_count array independently reports either a successful count or an error." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "description": "The ID and API name of the related list do not match, causing ambiguity", "summary": "ID and API name mismatch", "value": { "get_related_records_count": [ { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.get_related_records_count[0].related_list.id" }, { "api_name": "api_name", "json_path": "$.get_related_records_count[0].related_list.api_name" } ] }, "message": "Ambiguity while processing the request", "status": "error" } ] } }, "AuthorizationFailed": { "description": "You do not have sufficient permission to read the module records", "summary": "Insufficient permissions", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "You do not have sufficient permission to read the module records", "status": "error" } }, "ExpectedFieldMissing": { "description": "Specify at least one field", "summary": "Missing ID or API name", "value": { "get_related_records_count": [ { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "api_name", "json_path": "$.get_related_records_count[0].related_list.api_name" }, { "api_name": "id", "json_path": "$.get_related_records_count[0].related_list.id" } ] }, "message": "Specify atleast one field", "status": "error" } ] } }, "IdAlreadyConverted": { "description": "The given record ID refers to an already converted record and cannot be processed again", "summary": "Record ID already converted", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "id already converted", "status": "error" } }, "InvalidDataRelatedList": { "description": "The given related_list is invalid", "summary": "Invalid related list ID or API name", "value": { "get_related_records_count": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.get_related_records_count[0].related_list.id" }, "message": "Given related_list is invalid", "status": "error" } ] } }, "InvalidModule": { "description": "The module name given seems to be invalid", "summary": "Invalid module API name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecordId": { "description": "The related record ID given in the URL path is invalid", "summary": "Invalid record ID in URL path", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidRequest": { "description": "Unable to process your request", "summary": "Invalid request", "value": { "code": "INVALID_REQUEST", "details": {}, "message": "unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.", "status": "error" } }, "InvalidRequestMethod": { "description": "The HTTP request method type is not valid", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFound": { "description": "Shows a 400 error response when the required related_list field is absent from a request object in the get_related_records_count array.", "summary": "MANDATORY_NOT_FOUND error for a missing required field", "value": { "get_related_records_count": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "related_list", "json_path": "$.get_related_records_count[0].related_list" }, "message": "required field not found", "status": "error" } ] } }, "NotSupportedFilters": { "description": "Filters are not supported for the specified module's related list", "summary": "Filters not supported for module", "value": { "get_related_records_count": [ { "code": "NOT_SUPPORTED", "details": { "api_name": "filters", "expected_data_type": "json_type", "json_path": "$.get_related_records_count[0].params.filters" }, "message": "Filters are not supported for this modules", "status": "error" } ] } }, "NotSupportedRelatedList": { "description": "The given related list ID is not supported in API", "summary": "Related list not supported in API", "value": { "get_related_records_count": [ { "code": "NOT_SUPPORTED", "details": {}, "message": "The given related list id is not supported in api", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/GetRelatedRecordsCountInvalidDataError" }, { "$ref": "#/components/schemas/InvalidDataRecordIdError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountMandatoryNotFoundError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountInvalidModuleError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountExpectedFieldMissingError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountAmbiguityDuringProcessingError" }, { "$ref": "#/components/schemas/NotSupportedFiltersError" }, { "$ref": "#/components/schemas/NotSupportedRelatedListError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountAuthorizationFailedError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountInvalidRequestMethodError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountInvalidRequestError" } ], "x-zs-$id": "GetRelatedRecordsCount400Response" } } }, "description": "The request contains invalid, missing, or unsupported data.\n**Resolution:** The error code and details in the response body identify the specific validation failure. The request must be corrected before retrying." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "You have not authenticated the API call with valid access token", "summary": "Authentication failure", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "InvalidToken": { "description": "Your access token has expired or is invalid", "summary": "Invalid or expired token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid API token", "status": "error" } }, "OAuthScopeMismatch": { "description": "The access token you have used to make this API call does not have the required scope", "summary": "OAuth scope mismatch", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token does not have the required scope", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/GetRelatedRecordsCountAuthenticationFailureError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountInvalidTokenError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountOAuthScopeMismatchError" } ], "x-zs-$id": "GetRelatedRecordsCount401Response" } } }, "description": "Unauthorized. Authentication failed due to invalid, expired, or missing access token, or the token lacks required OAuth scopes." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "You do not have permission to read records from the module", "summary": "No permission to read records", "value": { "code": "NO_PERMISSION", "details": {}, "message": "You do not have permission to read records from the module", "status": "error" } }, "NotAllowed": { "description": "You do not have permission to read related records from the module", "summary": "Not allowed to read related records", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "You do not have permission to read related records from the module", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/GetRelatedRecordsCountNoPermissionError" }, { "$ref": "#/components/schemas/GetRelatedRecordsCountNotAllowedError" } ], "x-zs-$id": "GetRelatedRecordsCount403Response" } } }, "description": "Forbidden. You do not have permission to perform this operation, either due to insufficient user privileges or organizational restrictions." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "The request URL is incorrect", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "The request URL is incorrect. Please check the URL", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/GetRelatedRecordsCountInvalidUrlPatternError" } } }, "description": "Not Found. The requested URL pattern is incorrect or the resource does not exist." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Unexpected and unhandled exception in the server", "summary": "Internal server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/GetRelatedRecordsCountInternalError" } } }, "description": "Internal Server Error. Unexpected and unhandled exception in the server. Contact support if the error persists." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Get related records count", "tags": [ "get_related_records_count" ], "x-zoho-document": "get_related_records_count" } }, "/crm/v8/{moduleApiName}/{recordId}/actions/send_mail_merge": { "post": { "description": "To send a personalized email to one or more recipients using a mail merge template associated with a specific record in your Zoho CRM organization. You can include recipients in the To, CC, and BCC fields, and optionally attach the merged document either as an inline image or a separate file.", "operationId": "postSendMailMerge", "parameters": [ { "$ref": "#/components/parameters/ParamPathModuleApiName" }, { "$ref": "#/components/parameters/ParamPathRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a send mail merge request using a named template with recipient addresses, subject, CC, BCC, and an attachment type.", "summary": "Send mail merge request body", "value": { "send_mail_merge": [ { "attachment_name": "testdocument", "bcc_email": [ { "type": "email", "value": "ceo.zylker@gmail.com" } ], "cc_email": [ { "type": "email", "value": "brie.c@gmail.com" } ], "from_address": { "type": "email", "value": "p.boyle@gmail.com" }, "mail_merge_template": { "name": "mailmergename" }, "message": "Big Deal", "subject": "Hi there", "to_address": [ { "type": "email", "value": "smith@abc.com" }, { "type": "email", "value": "john@abc.com" } ], "type": "attachment" } ] } } }, "schema": { "$ref": "#/components/schemas/PostsendmailmergeRequest" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain a **send_mail_merge** array with one object specifying the mail merge template, recipient addresses, and optional email content settings." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response when the send mail merge operation is initiated, with the report link in the details.", "summary": "Successful send mail merge response", "value": { "send_mail_merge": [ { "code": "SUCCESS", "details": { "report_link": "https://writer.zoho.com/writer/v1/mailmerge/job/4791a19ea20e60e4a17c03f3b5feb149ef2caa18572d9587f26e041e5c47d868dca099732f2d7c6c51fed0693f066194" }, "message": "send mail merge action initiated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostsendmailmergeResponse200" } } }, "description": "Returns the result of the send mail merge operation, indicating that the email sending was initiated successfully." }, "400": { "content": { "application/json": { "examples": { "Error400": { "description": "Shows the error response when the required mail merge template field is missing from the request body.", "summary": "Example of a missing required field error response.", "value": { "send_mail_merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "mail_merge_template", "json_path": "$.send_mail_merge[0].mail_merge_template" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidModulePathError" }, { "$ref": "#/components/schemas/MailMergeRequiredParamMissingError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataParamError" }, { "$ref": "#/components/schemas/MailMergeInvalidRequestMethodError" }, { "additionalProperties": false, "description": "Represents an error response containing a list of validation errors for the send mail merge request body.", "properties": { "send_mail_merge": { "description": "Represents the list of error objects for the send mail merge request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MailMergeMandatoryFieldNotFoundError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataTypeError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataMaxLengthError" } ], "description": "Each object represents an individual error object for the send mail merge request." }, "maxItems": 25, "type": "array" } }, "required": [ "send_mail_merge" ], "type": "object", "x-zs-$id": "PostsendmailmergeError400Wrapper" } ], "description": "Represents the error response body for an invalid send mail merge request.", "x-zs-$id": "PostsendmailmergeError400" } } }, "description": "The send mail merge request could not be processed due to invalid input. \n**Resolution**: Verify that the request body contains all required fields with valid values, and that the module API name and record ID in the URL are correct.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.mailmerge.CREATE", "ZohoWriter.documentEditor.ALL", "ZohoWriter.merge.ALL", "ZohoCRM.settings.emails.ALL" ] } ], "summary": "Send mail merge email", "tags": [ "mail_merge" ], "x-zoho-document": "mail_merge" } }, "/crm/v8/{moduleApiName}/{recordId}/actions/share": { "delete": { "description": "To revoke all sharing on a specific record in a module of your Zoho CRM organization. Use this operation to remove access that was previously granted to users, roles, or groups through record-level sharing.", "operationId": "deleteShareRecords", "parameters": [ { "$ref": "#/components/parameters/ShareRecordsModuleApiName" }, { "$ref": "#/components/parameters/ShareRecordsRecordId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "RevokeSharingSuccess": { "description": "Shows the response returned when sharing on the record is revoked successfully, including the ID of the record.", "summary": "An example response for sharing revoked successfully.", "value": { "share": { "code": "SUCCESS", "details": { "id": "2922942000003922003" }, "message": "Sharing Revoked", "status": "success" } } } }, "schema": { "additionalProperties": false, "description": "Represents the revoke sharing success response.", "properties": { "share": { "additionalProperties": false, "description": "Represents the share record revoke response details.", "properties": { "code": { "description": "Represents the response code returned by the API.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional information about the response.", "properties": { "id": { "description": "Represents the unique ID of the details.", "maxLength": 19, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the response message returned by the API.", "enum": [ "Sharing Revoked" ], "type": "string" }, "status": { "description": "Represents the status of the API call. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "type": "object", "x-zs-$id": "RevokeSharingSuccess" } } }, "description": "Returns a confirmation that sharing on the record has been revoked successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleName": { "description": "Shows the bad request response returned when the module API name in the request URL is not a valid CRM module.", "summary": "An example of invalid module API name in the URL.", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecordId": { "description": "Shows the bad request response returned when the record ID in the request URL is invalid or does not belong to the specified module.", "summary": "An example of invalid record ID in the URL.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "ENTITY_ID_INVALID", "status": "error" } }, "NoSharingThroughTheRecord": { "description": "Shows the bad request response returned when the record has no active share entries to revoke.", "summary": "An example response for when no sharing exists to revoke.", "value": { "code": "CANNOT_PROCESS", "details": {}, "message": "No sharing through this record is available to revoke", "status": "error" } } }, "schema": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/NoSharingAvailableToRevokeErrorResponse" }, { "$ref": "#/components/schemas/InvalidRecordIdErrorResponse" }, { "$ref": "#/components/schemas/InvalidModuleNameErrorResponse" } ], "description": "Represents the revoke sharing bad request response.", "type": "object", "x-zs-$id": "RevokeSharingBadRequest" } } }, "description": "Returns an error response when the request URL, path parameters, or share entries fail validation." }, "403": { "content": { "application/json": { "examples": { "RevokeSharingForbidden": { "description": "Shows the forbidden response returned when the user lacks permission to call the share records API.", "summary": "Permission denied to revoke sharing", "value": { "code": "NO_PERMISSION", "details": {}, "message": "permission denied - access the api", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/CommonForbiddenErrorResponse" } } }, "description": "Returns an error response when the user does not have permission to perform the sharing revoke or when the share operation is blocked by an org-level restriction." } }, "security": [ { "OAuth2": [ "ZohoCRM.share.leads.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.contacts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.accounts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.deals.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.products.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.tasks.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.events.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.calls.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.quotes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.invoices.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.campaigns.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.vendors.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.pricebooks.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.salesorders.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.purchaseorders.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.solutions.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.cases.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.bundles.DELETE" ] }, { "OAuth2": [ "ZohoCRM.share.custom.DELETE" ] } ], "summary": "Revoke sharing on a record", "tags": [ "share_records" ], "x-zoho-document": "share_records" }, "get": { "description": "To retrieve the share details of a specific record in a module of your Zoho CRM organization. The response lists each entry with the recipient, the access level, and the sharing metadata.", "operationId": "getShareRecords", "parameters": [ { "$ref": "#/components/parameters/ShareRecordsModuleApiName" }, { "$ref": "#/components/parameters/ShareRecordsRecordId" }, { "$ref": "#/components/parameters/SharedTo" }, { "$ref": "#/components/parameters/View" }, { "$ref": "#/components/parameters/ShareRecordsApproved" }, { "$ref": "#/components/parameters/CurrentUser" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetShareRecordsSuccess": { "description": "Shows a successful response listing one share entry with the recipient role, the access level, the time of sharing, and the user who shared the record.", "summary": "An example response of active share entries on a record.", "value": { "share": [ { "permission": "full_access", "share_related_records": false, "shared_by": { "id": "2922942000000512001", "name": "we edited1", "zuid": "76602839" }, "shared_through": { "id": "2922942000003922003", "module": { "id": "2922942000000000125", "name": "Leads" } }, "shared_time": "2025-12-31T13:36:56+05:30", "shared_with": { "id": "2922942000000015969", "name": "Manager", "type": "roles" }, "type": "private" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response.", "properties": { "share": { "description": "Represents the list of share records.", "items": { "additionalProperties": false, "description": "Each object represents a single share entry, including the recipient, the access level, and the sharing metadata.", "properties": { "permission": { "description": "Represents the level of access granted to the entity\nfor the shared record. **Possible values**: \n\n- read_only\n\n- read_write\n\n- full_access\n", "enum": [ "read_only", "read_write", "full_access" ], "type": "string" }, "share_related_records": { "description": "Indicates whether the related records of the shared record are also shared with the entity.", "type": "boolean" }, "shared_by": { "additionalProperties": false, "description": "Represents the details of the user who shared the record.", "properties": { "id": { "description": "Represents the unique ID of the entity.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the entity.", "maxLength": 100, "type": "string" }, "zuid": { "description": "Represents the ZUID of the user who shared the record.", "maxLength": 19, "type": "string" } }, "required": [ "name", "id", "zuid" ], "type": "object" }, "shared_through": { "additionalProperties": false, "description": "Represents the details of the record through which sharing is granted, including its module.", "properties": { "id": { "description": "Represents the unique ID of the record through which sharing is enabled.", "maxLength": 19, "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the module details of the record through which sharing is granted.", "properties": { "id": { "description": "Represents the unique ID of the module.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the module.", "maxLength": 100, "type": "string" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "module", "id" ], "type": "object" }, "shared_time": { "description": "Represents the date and time at which the record was shared, in ISO 8601 format.", "format": "date-time", "type": "string" }, "shared_with": { "additionalProperties": false, "description": "Represents the details of the entity (user, role, or group) with which the record is shared.", "properties": { "id": { "description": "Represents the unique ID of the entity with whom the record is shared.", "maxLength": 19, "type": "string" }, "name": { "description": "Represents the name of the entity with whom the record is shared.", "maxLength": 100, "type": "string" }, "type": { "description": "Represents the type of sharing applied to the\nrecord. \n\n**Possible values**: \n\n- users\n\n- roles\n\n- groups\n", "enum": [ "users", "roles", "groups" ], "type": "string" } }, "required": [ "name", "id", "type" ], "type": "object" }, "type": { "description": "Represents the type of sharing applied to the\nrecord. \n\n**Possible values**: \n\n- private\n\n- public\n", "enum": [ "private", "public" ], "type": "string" } }, "required": [ "shared_with", "share_related_records", "shared_through", "permission", "type" ], "type": "object" }, "maxItems": 2147483647, "type": "array" } }, "type": "object", "x-zs-$id": "GetShareRecordsSuccess" } } }, "description": "Returns the list of share entries currently active on the record, with the recipient, the access level, and the sharing metadata for each entry." }, "204": { "description": "Returns an empty response when the record has no active share entries." }, "400": { "content": { "application/json": { "examples": { "InvalidModuleName": { "description": "Shows the bad request response returned when the module API name in the request URL is not a valid CRM module.", "summary": "An example of invalid module API name in the URL.", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecordId": { "description": "Shows the bad request response returned when the record ID in the request URL is invalid or does not belong to the specified module.", "summary": "An example of invalid record ID in the URL.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "ENTITY_ID_INVALID", "status": "error" } }, "ViewParamWithManageValue": { "description": "Shows the bad request response returned when the \n**view** query parameter is set to an unsupported value.", "summary": "An example of invalid value for the **view** query parameter.", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "api_name": "view" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/ViewAndApprovedParamValueErrorResponse" }, { "$ref": "#/components/schemas/InvalidRecordIdErrorResponse" }, { "$ref": "#/components/schemas/InvalidModuleNameErrorResponse" } ], "description": "Represents the error responses for the API request.", "type": "object", "x-zs-$id": "GetShareRecordsBadRequest" } } }, "description": "Returns an error response when the request URL, path parameters, or share entries fail validation." }, "403": { "content": { "application/json": { "examples": { "GetShareRecordsForbidden": { "description": "Shows the forbidden response returned when the user lacks permission to call the share records API.", "summary": "An example of permission denied to read share details.", "value": { "code": "NO_PERMISSION", "details": {}, "message": "permission denied - access the api", "status": "error" } }, "RecordNoPermission": { "description": "Shows the forbidden response returned when the user is missing a record-level permission, such as **Crm_Implied_View_Leads**.", "summary": "An example of record-level permission missing.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/CommonForbiddenErrorResponse" }, { "$ref": "#/components/schemas/RecordForbiddenErrorResponse" } ], "description": "Represents the error responses for the API request.", "x-zs-$id": "GetShareRecordsForbidden" } } }, "description": "Returns an error response when the user does not have permission to perform the share details retrieval or when the share operation is blocked by an org-level restriction." } }, "security": [ { "OAuth2": [ "ZohoCRM.share.leads.READ" ] }, { "OAuth2": [ "ZohoCRM.share.contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.share.accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.share.deals.READ" ] }, { "OAuth2": [ "ZohoCRM.share.products.READ" ] }, { "OAuth2": [ "ZohoCRM.share.tasks.READ" ] }, { "OAuth2": [ "ZohoCRM.share.events.READ" ] }, { "OAuth2": [ "ZohoCRM.share.calls.READ" ] }, { "OAuth2": [ "ZohoCRM.share.quotes.READ" ] }, { "OAuth2": [ "ZohoCRM.share.invoices.READ" ] }, { "OAuth2": [ "ZohoCRM.share.campaigns.READ" ] }, { "OAuth2": [ "ZohoCRM.share.vendors.READ" ] }, { "OAuth2": [ "ZohoCRM.share.pricebooks.READ" ] }, { "OAuth2": [ "ZohoCRM.share.salesorders.READ" ] }, { "OAuth2": [ "ZohoCRM.share.purchaseorders.READ" ] }, { "OAuth2": [ "ZohoCRM.share.solutions.READ" ] }, { "OAuth2": [ "ZohoCRM.share.cases.READ" ] }, { "OAuth2": [ "ZohoCRM.share.bundles.READ" ] }, { "OAuth2": [ "ZohoCRM.share.custom.READ" ] } ], "summary": "Share Records", "tags": [ "share_records" ], "x-zoho-document": "share_records" }, "post": { "description": "To share a specific record in a module with one or more users, roles, or groups. A record can be shared with up to 10 users, 5 roles, and 5 groups.\n> **Note**:\n> - The records can be shared to other users in the organization only if certain conditions are met. For simplicity, let us assume that User A shares a record with User B. Now, User A can share the record successfully only if:\n> - User B is a **confirmed** and **active** user.\n> - User B **does not already have access** to that particular record.\n> - User B has access to that particular module. For instance, to share a contact, User B must have access to the Contacts module.\n> - You cannot share the records in Calls, Meetings, Tasks, and Linking modules directly. They can be shared as related lists.\n> - The users who have profiles with **share** permission can share any records that they have access to, except the records that are shared to them. To check the same, go to Setup > Users and Control > Security Control > Choose the profile > Tool Permissions. Check if **share** is enabled. It is enabled by default for Standard and Administrator Profiles.\n> - The details of the records that form many-to-many relationships (with multi-select lookup) cannot be shared.\n> - A record can be shared only with **10 users**, **5 groups**, and **5 roles**.\n> - Once the record gets shared successfully, the user who initiated the share operation can be notified via email.\n", "operationId": "createShareRecords", "parameters": [ { "$ref": "#/components/parameters/ShareRecordsModuleApiName" }, { "$ref": "#/components/parameters/ShareRecordsRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "CreateShareRecordsRequest": { "description": "Shares a record privately with a single role and grants full access without sharing related records.", "summary": "An example response of share a record with a role.", "value": { "notify_on_completion": true, "notify_shared_members": false, "share": [ { "permission": "full_access", "share_related_records": false, "shared_with": { "id": "111111000000000874", "type": "roles" }, "type": "private" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body.", "properties": { "notify_on_completion": { "description": "Specify whether to send an email notification to the record\nowner once the share action is completed. \n\n**Possible values**: \n\n- true\n\n- false\n", "type": "boolean" }, "notify_shared_members": { "description": "Specify whether to send a notification to the members with\nwhom the record is shared. \n\n**Possible values**: \n\n- true\n\n- false\n", "type": "boolean" }, "share": { "description": "Specify the list of share entries to apply. Each entry defines a recipient, the access level, and the type of sharing. You can provide a maximum of **20** entries in a single request.", "items": { "additionalProperties": false, "description": "Each object represents an entry in the array.", "properties": { "permission": { "description": "Specify the level of access to grant for the shared\nrecord. \n\n**Possible values**: \n\n- read_only\n\n- read_write\n\n- full_access\n", "enum": [ "read_only", "read_write", "full_access" ], "type": "string" }, "share_related_records": { "description": "Specify whether to share the related records along\nwith the record. \n\n\n**Possible values**: \n\n- true\n\n- false\n", "type": "boolean" }, "shared_with": { "anyOf": [ { "additionalProperties": false, "description": "Indicates that you can share the record along with roles.", "properties": { "id": { "description": "Represents the ID of the role with whom the record is being shared.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } }, "type": { "description": "type of entity with whom the record is shared", "enum": [ "roles" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "ShareWithRoles" }, { "additionalProperties": false, "description": "Indicates that you can share the record along with groups.", "properties": { "id": { "description": "Represents the ID of the group with whom the record is being shared.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUserGroups", "propertyId": "UserGroupId" } ], "resource": "user_groups" } }, "type": { "description": "type of entity with whom the record is shared", "enum": [ "groups" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "ShareWithGroups" }, { "additionalProperties": false, "description": "Indicates that you can share the record along with users.", "properties": { "id": { "description": "Represents the ID of the user with whom the record is being shared.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } }, "type": { "description": "type of entity with whom the record is shared", "enum": [ "users" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "ShareWithUsers" } ], "description": "Specify the details of the entity (user, role, or group) with which to share the record." }, "type": { "description": "Specify the type of sharing to apply to the record. \n\n**Possible values**: \n- private \n- public\n", "enum": [ "private", "public" ], "type": "string" } }, "required": [ "type", "permission", "shared_with" ], "type": "object" }, "maxItems": 20, "type": "array" } }, "required": [ "share" ], "type": "object" } } }, "description": "The request body contains the data required to perform the operation.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "CreateShareRecordsSuccess": { "description": "Shows a per-entry success result that the API returns after creating the share entry successfully.", "summary": "An example of successful share response.", "value": { "share": [ { "code": "SUCCESS", "details": {}, "message": "record will be shared successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response of the API request.", "properties": { "share": { "description": "Represents details of each share record creation result.", "items": { "$ref": "#/components/schemas/CreateAndUpdateSuccessResponse" }, "maxItems": 20, "type": "array" } }, "required": [ "share" ], "type": "object", "x-zs-$id": "CreateShareRecordsSuccess" } } }, "description": "Returns a per-entry success result for each share entry created on the record." }, "207": { "content": { "application/json": { "examples": { "CreateShareRecordsPartialSuccess": { "description": "Shows a mixed-result response where one share entry succeeds and another fails validation on the `shared_with` field.", "summary": "An example of partial success response with one valid and one invalid entry.", "value": { "share": [ { "code": "SUCCESS", "details": {}, "message": "record will be shared successfully", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "shared_with", "json_path": "$.share[1].shared_with" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response of partial success.", "properties": { "share": { "description": "Represents the details of each share record creation result.", "items": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/CreateAndUpdateSuccessResponse" }, { "anyOf": [ { "$ref": "#/components/schemas/ShareRecordsMandatoryNotFound" }, { "$ref": "#/components/schemas/InvalidTypeErrorResponse" }, { "$ref": "#/components/schemas/InvalidShareWithValueErrorResponse" }, { "$ref": "#/components/schemas/InvalidShareWithIdErrorResponse" }, { "$ref": "#/components/schemas/ActivityModuleRelatedIssueErrorResponse" }, { "$ref": "#/components/schemas/ShareLimitExceedErrorResponse" } ], "description": "Each string represents the per-entry result for one share entry, which can be either a success or a specific error.", "x-zs-$id": "CreateAndUpdateMultipleStatusCaseErrorResponse" } ], "description": "Represents the per-entry result for one share entry, which can be either a success result or a specific error.", "type": "object" }, "maxItems": 20, "type": "array" } }, "type": "object", "x-zs-$id": "CreateShareRecordsPartialSuccess" } } }, "description": "Returns a per-entry result for each share entry in the request, where each entry is either a success or a specific error." }, "400": { "content": { "application/json": { "examples": { "ActivityModuleRelatedIssue": { "description": "Shows the per-entry error returned when `share_related_records` is set on a module that does not support sharing related records.", "summary": "`share_related_records` not supported on the module", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "share_related_records", "json_path": "$.share[0].share_related_records" }, "message": "cannot share the related records", "status": "error" } ] } }, "InvalidRecordId": { "description": "Shows the bad request response returned when the record ID in the request URL is invalid or does not belong to the specified module.", "summary": "Invalid record ID in the URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "ENTITY_ID_INVALID", "status": "error" } }, "InvalidShareWithUserId": { "description": "Shows the per-entry error returned when the user ID specified in `shared_with.id` is invalid.", "summary": "Invalid user ID in `shared_with`", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.share[0].shared_with.id" }, "message": "invalid user Id", "status": "error" } ] } }, "InvalidShareWithValue": { "description": "Shows the per-entry error returned when the `shared_with` value does not match the dependent `type` field.", "summary": "`shared_with` value invalid for the given type", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_with", "dependee": { "api_name": "type", "json_path": "$.share[0].type" }, "json_path": "$.share[0].shared_with" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryParamMissing": { "description": "Shows the per-entry error returned when a mandatory field, such as `permission`, is missing from the share entry.", "summary": "Mandatory field missing in a share entry", "value": { "share": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "permission", "json_path": "$.share[0].permission" }, "message": "required field not found", "status": "error" } ] } }, "NonSubordinateUser": { "description": "Shows the per-entry error returned when the share entry targets a user with whom the record cannot be shared, such as a non-subordinate user.", "summary": "Cannot share with a non-subordinate user", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_with", "json_path": "$.share[0].shared_with" }, "message": "cannot share to the user", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateAndUpdateShareRecordsBadRequest", "additionalProperties": true, "description": "bad request response", "type": "object", "x-zs-$id": "CreateShareRecordsBadRequest" } } }, "description": "Returns an error response when the request URL, path parameters, or share entries fail validation." }, "403": { "content": { "application/json": { "examples": { "CreateShareRecordsForbidden": { "description": "Shows the forbidden response returned when the user lacks permission to call the share records API.", "summary": "An example of permission denied to access the share API.", "value": { "code": "NO_PERMISSION", "details": {}, "message": "permission denied - access the api", "status": "error" } }, "NotifySharedMembersWithoutFeeds": { "description": "Shows the response returned when **notify_shared_members** is set to **true** but Feeds is not enabled for the organization.", "summary": "An example of notification requested without Feeds enabled.", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "notify_shared_members", "json_path": "$.notify_shared_members" }, "message": "Feeds is not enabled for this org", "status": "error" } }, "RecordLevelSharingNotSupportedForModule": { "description": "Shows the response returned when the module specified in the request URL does not support record-level sharing.", "summary": "An example of record-level sharing unsupported for the module.", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Record Level Sharing is not supported for this module", "status": "error" } }, "SchedularAlreadyRunning": { "description": "Shows the response returned when a previous share operation on the record is still in progress.", "summary": "An example of share operation already in progress.", "value": { "code": "CANNOT_PROCESS", "details": {}, "message": "Scheduler is running", "status": "error" } }, "SharingSharedRecord": { "description": "Shows the response returned when a record that was already shared with the current user cannot be re-shared to other users.", "summary": "An example attempt to re-share a shared record.", "value": { "code": "INVALID_DATA", "details": {}, "message": "Shared record cannot be shared to other users", "status": "error" } } }, "schema": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/CommonForbiddenErrorResponse" }, { "$ref": "#/components/schemas/SchedularAlreadyRunningErrorResponse" }, { "$ref": "#/components/schemas/SharingSharedRecordErrorResponse" }, { "$ref": "#/components/schemas/RecordLevelSharingNotSupportedForModuleErrorResponse" }, { "$ref": "#/components/schemas/NotifyMembersWithoutFeeds" }, { "$ref": "#/components/schemas/RecordForbiddenErrorResponse" } ], "description": "Represents the response when the user does not have enough permissions.", "type": "object", "x-zs-$id": "UpdateShareRecordsForbidden" } } }, "description": "Returns an error response when the user does not have permission to perform the share create or when the share operation is blocked by an org-level restriction." } }, "security": [ { "OAuth2": [ "ZohoCRM.share.leads.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.contacts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.accounts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.deals.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.products.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.tasks.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.events.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.calls.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.quotes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.invoices.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.campaigns.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.vendors.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.pricebooks.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.salesorders.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.purchaseorders.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.solutions.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.cases.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.bundles.CREATE" ] }, { "OAuth2": [ "ZohoCRM.share.custom.CREATE" ] } ], "summary": "Share a record", "tags": [ "share_records" ], "x-zoho-document": "share_records" }, "put": { "description": "To update the sharing permissions of a specific record in a module of your Zoho CRM organization. The update can change the access level, change the visibility between private and public, or alter whether related records are shared along with the record.", "operationId": "updateShareRecords", "parameters": [ { "$ref": "#/components/parameters/ShareRecordsModuleApiName" }, { "$ref": "#/components/parameters/ShareRecordsRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateShareRecordsRequest": { "description": "Updates a single share entry to grant a role full access privately, without sharing related records.", "summary": "An example of updating a share entry for a role.", "value": { "notify_on_completion": true, "notify_shared_members": false, "share": [ { "permission": "full_access", "share_related_records": false, "shared_with": { "id": "111111000000000874", "type": "roles" }, "type": "private" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body.", "properties": { "notify_on_completion": { "description": "Specify whether to send an email notification to the record\nowner once the share action is completed. \n\n**Possible values*: \n\n- true\n\n- false\n", "type": "boolean" }, "notify_shared_members": { "description": "Specify whether to send a notification to the members with\nwhom the record is shared. \n\n**Possible values**: \n\n- true\n\n- false\n", "type": "boolean" }, "share": { "description": "Specify the list of share entries to update. Each entry defines a recipient, the access level, and the type of sharing.", "items": { "additionalProperties": false, "description": "Each object represents one entry in the array.", "properties": { "permission": { "description": "Specify the level of access to grant for the shared\nrecord. \n\n**Possible values**: \n\n- read_only\n\n- read_write\n\n- full_access\n", "enum": [ "read_only", "read_write", "full_access" ], "type": "string" }, "share_related_records": { "description": "Specify whether to share the related records along\nwith the record. \n\n**Possible values**: \n\n- true\n\n- false\n", "type": "boolean" }, "shared_with": { "anyOf": [ { "additionalProperties": false, "description": "Specify the role with which to share the record.", "properties": { "id": { "description": "Represents the ID of the role with which the record is being shared.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRoles", "propertyId": "RoleId" } ], "resource": "roles" } }, "type": { "description": "Specify the type of entity with which to share the record.", "enum": [ "roles" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "UpdateShareWithRoles" }, { "additionalProperties": false, "description": "Specify the group with which to share the record.", "properties": { "id": { "description": "Represents the ID of the group with which the record is being shared.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUserGroups", "propertyId": "UserGroupId" } ], "resource": "user_groups" } }, "type": { "description": "Specify the type of entity with which to share the record.", "enum": [ "groups" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "UpdateShareWithGroups" }, { "additionalProperties": false, "description": "Specify the user with whom to share the record.", "properties": { "id": { "description": "Represents the ID of the user with whom the record is being shared.", "maxLength": 19, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getUsers", "propertyId": "UserId" } ], "resource": "users" } }, "type": { "description": "Specify the type of entity with which to share the record.", "enum": [ "users" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object", "x-zs-$id": "UpdateShareWithUsers" } ], "description": "Specify the details of the entity (user, role, or group) with which to share the record." }, "type": { "description": "Specify the type of sharing to apply to the record. \n**Possible values**: \n- private\n- public\n", "enum": [ "private", "public" ], "type": "string" } }, "required": [ "type", "permission", "shared_with" ], "type": "object" }, "maxItems": 20, "type": "array" } }, "required": [ "share" ], "type": "object" } } }, "description": "The request body must contain a **share** array with one or more share entries to update. Each entry defines the recipient, the access level, and the type of sharing. You can include up to **20 share entries per request**.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "UpdateShareRecordsSuccess": { "description": "Shows a per-entry success result that the API returns after updating the share entry successfully.", "summary": "An example of successful update response.", "value": { "share": [ { "code": "SUCCESS", "details": {}, "message": "record will be shared successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the update share records success response.", "properties": { "share": { "description": "Represents the details of each share record creation result.", "items": { "$ref": "#/components/schemas/CreateAndUpdateSuccessResponse" }, "maxItems": 20, "type": "array" } }, "required": [ "share" ], "type": "object", "x-zs-$id": "UpdateShareRecordsSuccess" } } }, "description": "Returns a per-entry success result for each share entry updated on the record." }, "207": { "content": { "application/json": { "examples": { "CreateShareRecordsPartialSuccess": { "description": "Shows a mixed-result response where one share entry succeeds and another fails validation on the `shared_with` field.", "summary": "An example of partial success response with one valid and one invalid entry.", "value": { "share": [ { "code": "SUCCESS", "details": {}, "message": "record will be shared successfully", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "shared_with", "json_path": "$.share[1].shared_with" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the partial success response.", "properties": { "share": { "description": "Represents the details of each share record creation result.", "items": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/CreateAndUpdateSuccessResponse" }, { "anyOf": [ { "$ref": "#/components/schemas/ShareRecordsMandatoryNotFound" }, { "$ref": "#/components/schemas/InvalidTypeErrorResponse" }, { "$ref": "#/components/schemas/InvalidShareWithValueErrorResponse" }, { "$ref": "#/components/schemas/InvalidShareWithIdErrorResponse" }, { "$ref": "#/components/schemas/ActivityModuleRelatedIssueErrorResponse" }, { "$ref": "#/components/schemas/ShareLimitExceedErrorResponse" } ], "description": "Each string represents the per-entry result for one share entry, which can be either a success or a specific error.", "x-zs-$id": "CreateAndUpdateMultipleStatusCaseErrorResponse" } ], "description": "Each object represents the per-entry result for one share entry, which can be either a success result or a specific error.", "type": "object" }, "maxItems": 20, "type": "array" } }, "type": "object", "x-zs-$id": "UpdateShareRecordsPartialSuccess" } } }, "description": "Returns a per-entry result for each share entry in the request, where each entry is either a success or a specific error." }, "400": { "content": { "application/json": { "examples": { "ActivityModuleRelatedIssue": { "description": "Shows the per-entry error returned when `share_related_records` is set on a module that does not support sharing related records.", "summary": "`share_related_records` not supported on the module", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "share_related_records", "json_path": "$.share[0].share_related_records" }, "message": "cannot share the related records", "status": "error" } ] } }, "InvalidModuleName": { "description": "Shows the bad request response returned when the module API name in the request URL is not a valid CRM module.", "summary": "Invalid module API name in the URL", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecordId": { "description": "Shows the bad request response returned when the record ID in the request URL is invalid or does not belong to the specified module.", "summary": "Invalid record ID in the URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "ENTITY_ID_INVALID", "status": "error" } }, "InvalidShareWithUserId": { "description": "Shows the per-entry error returned when the user ID specified in `shared_with.id` is invalid.", "summary": "Invalid user ID in `shared_with`", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.share[0].shared_with.id" }, "message": "invalid user Id", "status": "error" } ] } }, "InvalidShareWithValue": { "description": "Shows the per-entry error returned when the `shared_with` value does not match the dependent `type` field.", "summary": "`shared_with` value invalid for the given type", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_with", "dependee": { "api_name": "type", "json_path": "$.share[0].type" }, "json_path": "$.share[0].shared_with" }, "message": "invalid data", "status": "error" } ] } }, "MandatoryParamMissing": { "description": "Shows the per-entry error returned when a mandatory field, such as `permission`, is missing from the share entry.", "summary": "Mandatory field missing in a share entry", "value": { "share": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "permission", "json_path": "$.share[0].permission" }, "message": "required field not found", "status": "error" } ] } }, "NonSubordinateUser": { "description": "Shows the per-entry error returned when the share entry targets a user with whom the record cannot be shared, such as a non-subordinate user.", "summary": "Cannot share with a non-subordinate user", "value": { "share": [ { "code": "INVALID_DATA", "details": { "api_name": "shared_with", "json_path": "$.share[0].shared_with" }, "message": "cannot share to the user", "status": "error" } ] } }, "ShareLimitForATypeExceeded": { "description": "Shows the per-entry error returned when the number of share entries for a recipient type exceeds the per-record limit (10 users, 5 roles, 5 groups).", "summary": "Share limit exceeded for the recipient type", "value": { "share": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "type", "json_path": "$.share[5].shared_with.type", "limit": 5 }, "message": "Cannot share a record to more than 5 roles", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/CreateAndUpdateShareRecordsBadRequest", "additionalProperties": true, "description": "bad request response", "type": "object", "x-zs-$id": "UpdateShareRecordsBadRequest" } } }, "description": "Returns an error response when the request URL, path parameters, or share entries fail validation." }, "403": { "content": { "application/json": { "examples": { "RecordLevelSharingNotSupportedForModule": { "description": "Shows the response returned when the module specified in the request URL does not support record-level sharing.", "summary": "An example for record-level sharing unsupported for the module.", "value": { "code": "NOT_ALLOWED", "details": {}, "message": "Record Level Sharing is not supported for this module", "status": "error" } }, "SchedularAlreadyRunning": { "description": "Shows the response returned when a previous share operation on the record is still in progress.", "summary": "An example of share operation already in progress.", "value": { "code": "CANNOT_PROCESS", "details": {}, "message": "Scheduler is running", "status": "error" } }, "SharingSharedRecord": { "description": "Shows the response returned when a record that was already shared with the current user cannot be re-shared to other users.", "summary": "An example attempt to re-share a shared record.", "value": { "code": "INVALID_DATA", "details": {}, "message": "Shared record cannot be shared to other users", "status": "error" } }, "UpdateShareRecordsForbidden": { "description": "Shows the forbidden response returned when the user lacks permission to call the share records API.", "summary": "An example of permission denied to access the share API.", "value": { "code": "NO_PERMISSION", "details": {}, "message": "permission denied - access the api", "status": "error" } } }, "schema": { "additionalProperties": true, "anyOf": [ { "$ref": "#/components/schemas/CommonForbiddenErrorResponse" }, { "$ref": "#/components/schemas/SchedularAlreadyRunningErrorResponse" }, { "$ref": "#/components/schemas/SharingSharedRecordErrorResponse" }, { "$ref": "#/components/schemas/RecordLevelSharingNotSupportedForModuleErrorResponse" }, { "$ref": "#/components/schemas/RecordForbiddenErrorResponse" }, { "$ref": "#/components/schemas/NotifyMembersWithoutFeeds" } ], "description": "Represents the error response when the user does not have enough permission to perform the request.", "type": "object", "x-zs-$id": "CreateShareRecordsForbidden" } } }, "description": "Returns an error response when the user does not have permission to perform the share update or when the share operation is blocked by an org-level restriction." } }, "security": [ { "OAuth2": [ "ZohoCRM.share.leads.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.contacts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.accounts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.deals.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.products.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.tasks.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.events.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.calls.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.quotes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.invoices.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.campaigns.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.vendors.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.pricebooks.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.salesorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.purchaseorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.solutions.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.cases.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.bundles.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.share.custom.UPDATE" ] } ], "summary": "Update share permissions", "tags": [ "share_records" ], "x-zoho-document": "share_records" } }, "/crm/v8/{moduleApiName}/{recordId}/actions/sign_mail_merge": { "post": { "description": "To send a merged document to one or more recipients for signing or approval using a mail merge template associated with a specific record in your Zoho CRM organization. Before using this operation for the first time, you must access the Merge and Sign dialog in the Zoho Writer UI once.", "operationId": "postSignMailMerge", "parameters": [ { "$ref": "#/components/parameters/ParamPathModuleApiName" }, { "$ref": "#/components/parameters/ParamPathRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a sign mail merge request using a named template, a file name, sequential signing order, and a list of signers with mixed sign and approve actions.", "summary": "Sign mail merge request body", "value": { "sign_mail_merge": [ { "file_name": "testdocument", "mail_merge_template": { "name": "mailmergename" }, "sign_in_order": true, "signers": [ { "action_type": "sign", "recipient": { "type": "email", "value": "smith@gmail.com" }, "recipient_name": "Sam" }, { "action_type": "approve", "recipient": { "type": "email", "value": "john@gmail.com" }, "recipient_name": "John" }, { "action_type": "approve", "recipient": { "type": "merge_field", "value": "${!Leads.Last_Name}" }, "recipient_name": "John" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/PostsignmailmergeRequest" }, "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "description": "The request body must contain a **sign_mail_merge** array with one object specifying the mail merge template, the file name, and the list of signers." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows a successful response when the sign mail merge operation is initiated, with the sign resource ID and report link in the details.", "summary": "Successful sign mail merge response", "value": { "sign_mail_merge": [ { "code": "SUCCESS", "details": { "report_link": "https://writer.zoho.com/writer/v1/mailmerge/job/e1aee66cb489b8e89f8df4c8e36847ff2c1ec12b0b945e6f41314d5ca9a0870f710d651349ecdc916fbff687b9db8b3e", "sign_resource_id": "112953000000044001" }, "message": "send mail merge action initiated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostsignmailmergeResponse200" } } }, "description": "Returns the result of the sign mail merge operation, indicating that the document was sent for signing or approval successfully." }, "400": { "content": { "application/json": { "examples": { "Error400": { "description": "Shows the error response when the required mail merge template field is missing from the request body.", "summary": "Example of missing required field error response.", "value": { "sign_mail_merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "mail_merge_template", "json_path": "$.sign_mail_merge[0].mail_merge_template" }, "message": "Required field is missing", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MailMergeExpectedFieldMissingError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataParamError" }, { "$ref": "#/components/schemas/InvalidModulePathError" }, { "additionalProperties": false, "description": "Represents an error response containing a list of validation errors for the sign mail merge request body.", "properties": { "sign_mail_merge": { "description": "Represents the list of error objects for the sign mail merge request.", "items": { "anyOf": [ { "$ref": "#/components/schemas/MandatoryFieldNotFoundBodyError" }, { "$ref": "#/components/schemas/MailMergeMandatoryFieldNotFoundError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataTypeError" }, { "$ref": "#/components/schemas/MailMergeInvalidDataMaxLengthError" } ], "description": "Represents an individual error object for the sign mail merge request." }, "maxItems": 25, "type": "array" } }, "required": [ "sign_mail_merge" ], "type": "object", "x-zs-$id": "PostsignmailmergeError400Wrapper" }, { "$ref": "#/components/schemas/MailMergeInvalidRequestMethodError" } ], "description": "Represents the error response body for an invalid sign mail merge request.", "x-zs-$id": "PostsignmailmergeError400" } } }, "description": "The sign mail merge request could not be processed due to invalid input. \n**Resolution**: Verify that the request body contains all required fields with valid values, and that the module API name and record ID in the URL are correct.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.mailmerge.CREATE", "ZohoWriter.documentEditor.ALL", "ZohoWriter.merge.ALL", "ZohoSign.documents.ALL" ] } ], "summary": "Send mail merge document for signing", "tags": [ "mail_merge" ], "x-zoho-document": "mail_merge" } }, "/crm/v8/{moduleName}/{id}/actions/send_mail": { "post": { "description": "To send an email to a specific record in your Zoho CRM organization using a template or custom email content.", "operationId": "sendMail", "parameters": [ { "$ref": "#/components/parameters/SendMailModuleName" }, { "$ref": "#/components/parameters/SendMailId" } ], "requestBody": { "content": { "application/json": { "examples": { "FullRequest": { "summary": "Comprehensive send mail request with all recipient fields", "value": { "data": [ { "bcc": [ { "email": "admin@company.com" } ], "cc": [ { "email": "manager@company.com" } ], "content": "

Hello

", "from": { "email": "sales@company.com", "user_name": "Sales" }, "mail_format": "html", "org_email": true, "reply_to": { "email": "support@company.com" }, "subject": "Product Update", "to": [ { "email": "lead@client.com", "user_name": "Lead" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/SendMailRequest" } } }, "description": "The request body must contain a data array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "summary": "Successful email send response", "value": { "data": [ { "code": "SUCCESS", "details": { "message_id": "2cceafa...867" }, "message": "Mail sent successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/SendMailSuccessResponse" } } }, "description": "Returns the result of the email send operation, including a status code and message for each email." }, "400": { "content": { "application/json": { "examples": { "MandatoryMissing": { "summary": "Missing required field error", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/StandardErrorResponse" }, { "$ref": "#/components/schemas/FlatErrorResponse" } ], "x-zs-$id": "SendMailError400Wrapper" } } }, "description": "The request contains invalid or missing field values. **Resolution:** The required fields must be present in the request and all field values must be valid." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "summary": "Permission denied error", "value": { "code": "NO_PERMISSION", "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/FlatErrorResponse" } } }, "description": "Permission denied to send email using this account. **Resolution:** The CRM administrator must grant the required permission to the user's profile, and the OAuth token must include the ZohoCRM.send_mail.all.CREATE scope." } }, "security": [ { "OAuth2": [ "ZohoCRM.send_mail.all.CREATE" ] } ], "summary": "Send an email to a record", "tags": [ "send_mail" ], "x-zoho-document": "send_mail" } }, "/crm/v8/{moduleName}/{recordId}/Locking_Information__s": { "get": { "description": "To retrieve the locking information details of a locked record in your Zoho CRM account, including the user who locked the record, the lock source, reason, and timestamp.", "operationId": "getRecordLockingInformationOfTheRecord", "parameters": [ { "$ref": "#/components/parameters/LockingInformationsModuleName" }, { "$ref": "#/components/parameters/LockingInformationsRecordId" }, { "$ref": "#/components/parameters/LockingInformationsFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "AutomaticLockCase": { "summary": "Successful retrieval - automatically locked record (locked by a record locking rule)", "value": { "data": [ { "$editable": false, "$field_states": null, "$sharing_permission": "read_only", "$zia_visions": null, "Feature_Type__s": "record_locking", "Lock_Source__s": "Automatic", "Locked_By__s": null, "Locked_For__s": { "id": "111111000000053560", "module": { "api_name": "Deals", "id": "111111000000000048" }, "name": "locked" }, "Locked_Reason__s": null, "Locked_Time__s": "2021-07-21T18:08:12+05:30", "Record_Locking_Configuration_Id__s": "111111000000053641", "Record_Locking_Rule_Id__s": "111111000000054290", "id": "111111000000054022" } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 } } }, "SuccessCase": { "summary": "Successful retrieval - manually locked record", "value": { "data": [ { "$editable": true, "$field_states": null, "$sharing_permission": "full_access", "$zia_visions": null, "Feature_Type__s": "record_locking", "Lock_Source__s": "Manual", "Locked_By__s": { "id": "111111000000047487", "name": "priya v" }, "Locked_For__s": { "id": "111111000000053560", "module": { "api_name": "Deals", "id": "111111000000000048" }, "name": "locked" }, "Locked_Reason__s": "fff", "Locked_Time__s": "2021-07-21T18:08:12+05:30", "Record_Locking_Configuration_Id__s": "111111000000053641", "Record_Locking_Rule_Id__s": null, "id": "111111000000054020" } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "additionalProperties": false, "description": "Contains the locking information details and pagination metadata for the locked record.", "properties": { "data": { "description": "Contains the locking information details of the locked record.", "items": { "additionalProperties": false, "description": "Represents the locking information details of a locked record.", "properties": { "$editable": { "description": "Indicates whether the locked record is editable by the current user. Possible values: **true** - The record is editable. **false** - The record is not editable.", "type": "boolean" }, "$field_states": { "anyOf": [ { "description": "Contains the locking information details and pagination metadata for the locked record.", "maxLength": 255, "type": "string" }, { "description": "Contains the locking information details and pagination metadata for the locked record.", "type": "null" } ], "description": "Represents the field-level lock states of the record. Returns **null** when no field-level locking is applied." }, "$sharing_permission": { "description": "Represents the sharing permission level of the current user on the locked record.", "maxLength": 10000, "type": "string" }, "$zia_visions": { "anyOf": [ { "description": "Contains the Zia Visions related information.", "maxLength": 255, "type": "string" }, { "description": "Null when Zia Visions data is not available.", "type": "null" } ], "description": "Represents Zia Visions data associated with the record. Returns **null** when Zia Visions data is not available." }, "Feature_Type__s": { "description": "Represents the feature type associated with the locking information.", "maxLength": 255, "type": "string" }, "Lock_Source__s": { "description": "Indicates the source of the record lock. Possible values: **Manual** - The record was locked manually by a user. **Automatic** - The record was locked automatically by a rule. **Both** - The record has both manual and automatic locks.", "enum": [ "Manual", "Both", "Automatic" ], "maxLength": 255, "type": "string" }, "Locked_By__s": { "additionalProperties": false, "description": "An object containing the details of the user who locked the record. Returns **null** for automatically locked records where no specific user performed the lock.", "properties": { "id": { "description": "Represents the unique identifier of the user who locked the record.", "maxLength": 255, "type": "string" }, "module": { "description": "Represents the module to which the user who locked the record belongs.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who locked the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "Locked_For__s": { "additionalProperties": false, "description": "Represents the details of the record that is locked.", "properties": { "id": { "description": "Represents the unique identifier of the locked record.", "maxLength": 255, "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the details of the module to which the locked record belongs.", "properties": { "api_name": { "description": "Represents the API name of the module of the locked record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the module of the locked record.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Represents the name of the locked record.", "maxLength": 255, "type": "string" } }, "required": [ "module", "name", "id" ], "type": "object" }, "Locked_Reason__s": { "description": "Represents the reason for locking the record. Returns **null** for automatically locked records.", "maxLength": 3000, "type": [ "string", "null" ] }, "Locked_Time__s": { "description": "Represents the timestamp when the record was locked.", "format": "date-time", "type": "string" }, "Record_Locking_Configuration_Id__s": { "description": "Represents the unique identifier of the record locking configuration applied to this record.", "maxLength": 255, "type": "string" }, "Record_Locking_Rule_Id__s": { "description": "Represents the unique identifier of the record locking rule. Returns **null** for manually locked records.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique identifier of the locking information record.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" }, "info": { "additionalProperties": false, "description": "An object containing the pagination details.", "properties": { "count": { "description": "Represents the total number of locking information records returned in the response.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether more locking information records are available beyond the current page. Possible values: **true** - More records are available. **false** - No more records are available.", "type": "boolean" }, "next_page_token": { "description": "Represents the token used to fetch the next page of records. Returns **null** when token-based pagination is not in use or no next page exists.", "maxLength": 255, "type": [ "string", "null" ] }, "page": { "description": "Represents the current page number of the response.", "format": "int32", "type": "integer" }, "page_token_expiry": { "description": "Represents the expiry timestamp of the page token. Returns **null** when token-based pagination is not in use.", "maxLength": 255, "type": [ "string", "null" ] }, "per_page": { "description": "Represents the number of records displayed per page.", "format": "int32", "type": "integer" }, "previous_page_token": { "description": "Represents the token used to fetch the previous page of records. Returns **null** when token-based pagination is not in use or no previous page exists.", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "GetRecordLockingInformationOfTheRecordResponse" } } }, "description": "Returns the locking information details of the locked record, including the user who locked it, the lock source, reason, and timestamp." }, "204": { "description": "The record does not have any active locks from the record locking configuration." }, "400": { "content": { "application/json": { "examples": { "InvalidDataMainRecordId": { "summary": "Invalid record ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNotFound": { "summary": "Relation not found error", "value": { "code": "INVALID_DATA", "details": {}, "message": "relation not found", "status": "error" } }, "InvalidMainModule": { "summary": "Invalid module name error", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "NotAllowedLockConfigMissing": { "summary": "Locking configuration missing error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Required Record Locking Configuration is not present", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "This error occurs when the specified relation is not found.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "relation not found" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataRelationNotFound" }, { "additionalProperties": false, "description": "This error occurs when the module name provided is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidModuleError" }, { "additionalProperties": false, "description": "This error occurs when the relation ID provided is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InvalidDataMainRecordId" }, { "additionalProperties": false, "description": "This error occurs when the required record locking configuration is not present.", "properties": { "code": { "description": "Represents the error code indicating the action is not allowed.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "Required Record Locking Configuration is not present" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "NotAllowedLockConfigMissing" } ], "x-zs-$id": "GetRecordLockingInformationOfTheRecordErrorResponse" } } }, "description": "The request contains invalid or missing parameters. **Resolution:** Verify that the module name, record ID, and field names in the request are valid." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.READ" ] } ], "summary": "Get record locking information", "tags": [ "locking_informations" ], "x-zoho-document": "locking_informations" }, "post": { "description": "To lock a record in the specified module of your Zoho CRM account with a reason for locking.", "operationId": "lockRecord", "parameters": [ { "$ref": "#/components/parameters/LockingInformationsRecordId" }, { "$ref": "#/components/parameters/LockingInformationsModuleName" } ], "requestBody": { "content": { "application/json": { "examples": { "LockRecord": { "summary": "Lock record request with reason", "value": { "data": [ { "Locked_Reason__s": "Locking the record for review" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the request payload for the locking operation.", "properties": { "data": { "description": "Specify the locking information details for the record.", "items": { "additionalProperties": false, "description": "Specify the locking details for the record.", "properties": { "Locked_Reason__s": { "description": "Specify the reason for locking the record.", "maxLength": 3000, "type": "string" } }, "required": [ "Locked_Reason__s" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessCase": { "summary": "Successful record lock", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111111000000047241", "name": "priya" }, "Created_Time": "2021-07-13T18:54:49+05:30", "Modified_By": { "id": "111111000000047241", "name": "priya" }, "Modified_Time": "2021-07-13T18:54:49+05:30", "id": "111111000000054029" }, "message": "record added", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the success response for the lock operation.", "properties": { "data": { "description": "Contains the response details for the lock operation.", "items": { "additionalProperties": false, "description": "Represents the result of the lock operation for a record.", "properties": { "code": { "description": "Represents the response code for the lock operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Contains the success response for the lock operation.", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the details of the user who created the record.", "properties": { "id": { "description": "Represents the unique identifier of the user who created the record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who created the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the timestamp of the locking information record creation.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the details of the user who last modified the record.", "properties": { "id": { "description": "Represents the unique identifier of the user who last modified the record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who last modified the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Represents the timestamp when the locking information record was last modified.", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique identifier of the newly created locking information record.", "maxLength": 255, "type": "string" } }, "required": [ "id", "Created_Time", "Modified_Time", "Modified_By", "Created_By" ], "type": "object", "x-zs-$id": "LockRecordDetailsFull" }, { "additionalProperties": false, "description": "Contains the success response for the lock operation.", "properties": { "id": { "description": "Represents the unique identifier of the newly created locking information record.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "LockRecordDetailsMinimal" } ] }, "message": { "description": "Represents the response message for the lock operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the lock operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "LockRecordResponse" } } }, "description": "Returns a success response when the record is locked successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataRelationId": { "summary": "Relation not found error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNotFound": { "summary": "Relation not found error", "value": { "code": "INVALID_DATA", "details": {}, "message": "relation not found", "status": "error" } }, "InvalidModule": { "summary": "Invalid module name error", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "summary": "Invalid HTTP method error", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFound": { "summary": "Missing mandatory field error", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Locked_Reason__s", "json_path": "$.data[0].Locked_Reason__s" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowed": { "summary": "Locking configuration missing error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Required Record Locking Configuration is not present", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "This error occurs when a required field is missing in the request payload.", "properties": { "data": { "description": "Contains the list of error details for the failed operation.", "items": { "additionalProperties": false, "description": "Represents the error details for a missing mandatory field.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory field in the request payload.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MandatoryNotFoundLockRecord" }, { "additionalProperties": false, "description": "This error occurs when the specified relation is not found.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidRequestMethodError" }, { "additionalProperties": false, "description": "This error occurs when the specified relation is not found.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Additional details about the invalid data error.", "type": "object", "x-zs-$id": "InvalidDataDetailsEmpty" }, { "additionalProperties": false, "description": "Details about the invalid data error including the resource path index.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "InvalidDataDetailsResourcePathIndex" } ] }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidRequestMethodError400" }, { "additionalProperties": false, "description": "This error occurs when the module name provided is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidModuleError400" }, { "additionalProperties": false, "description": "This error occurs when the required record locking configuration is not present.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "NotAllowedLockConfigMissing400" } ], "x-zs-$id": "LockRecordErrorResponse400" } } }, "description": "The request contains invalid or missing parameters. **Resolution:** Verify that the module name, record ID, and request body are valid." }, "403": { "content": { "application/json": { "examples": { "NotAllowedCase1": { "summary": "Record already locked error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "record is already locked", "status": "error" } }, "NotAllowedCase2": { "summary": "Automatic locking only configured error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "record cannot be locked, only automatic locking is configured", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "A JSON object containing the error response when the lock operation is not allowed.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED", "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LockRecordErrorResponse" } } }, "description": "The lock operation is not permitted for this record. **Resolution:** Verify that the record is not already locked and that manual locking is enabled for the module." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.CREATE" ] } ], "summary": "Lock a record", "tags": [ "locking_informations" ], "x-zoho-document": "locking_informations" } }, "/crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}": { "delete": { "description": "To remove the lock from a locked record in the specified module of your Zoho CRM account.", "operationId": "removeLockFromLockedRecord", "parameters": [ { "description": "The ID of the locked record from which the lock is to be removed. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module ID and API name.", "in": "path", "name": "moduleName", "required": true, "schema": { "maxLength": 256, "type": "string" } }, { "description": "The ID of the locked record from which the lock is to be removed.", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 32, "type": "string" } }, { "$ref": "#/components/parameters/LockId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "description": "Shows a successful response when the lock is removed from the specified record.", "summary": "Successful lock removal", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "431525000001114019" }, "message": "relation removed", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the success response for the unlock operation.", "properties": { "data": { "description": "Contains the response details for the unlock operation.", "items": { "additionalProperties": false, "description": "Represents the result of the unlock operation.", "properties": { "code": { "description": "Represents the response code for the unlock operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Contains the success response for the unlock operation.", "properties": { "Created_By": { "additionalProperties": false, "description": "Contains the details of the successfully unlocked record.", "properties": { "id": { "description": "Contains the details of the successfully unlocked record.", "maxLength": 32, "type": "string" }, "name": { "description": "Contains the details of the successfully unlocked record.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Contains the details of the successfully unlocked record.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains the details of the successfully unlocked record.", "properties": { "id": { "description": "Contains the details of the successfully unlocked record.", "maxLength": 32, "type": "string" }, "name": { "description": "Contains the details of the successfully unlocked record.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Contains the details of the successfully unlocked record.", "format": "date-time", "type": "string" }, "id": { "description": "Contains the details of the successfully unlocked record.", "maxLength": 32, "type": "string" } }, "required": [ "id" ], "type": "object" }, { "additionalProperties": false, "description": "Contains the success response for the unlock operation.", "properties": { "id": { "description": "Contains the details of the successfully unlocked record.", "maxLength": 32, "type": "string" } }, "required": [ "id" ], "type": "object" } ], "description": "Contains the details of the unlocked record, including its unique identifier and audit timestamps." }, "message": { "description": "Represents the response message for the unlock operation.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the unlock operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RemoveLockFromLockedRecordsResponse" } } }, "description": "Returns a success response when the lock is removed from the record successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataChildId": { "description": "Shows the error response when the lock ID provided in the request path is invalid.", "summary": "Invalid lock ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidDataConfigurationNotCreated": { "description": "Shows the error response when the locking information relation is not found for the specified record.", "summary": "Relation not found error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "relation not found", "status": "error" } }, "InvalidDataRelation": { "description": "Shows the error response when the record ID provided in the request path is invalid.", "summary": "Invalid relation ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidModuleData": { "description": "Shows the error response when the module name provided in the request path is invalid.", "summary": "Invalid module name error", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows the error response when an invalid HTTP method is used for this endpoint.", "summary": "Invalid HTTP method error", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFound": { "description": "Shows the error response when a required field is missing from the request payload.", "summary": "Missing mandatory field error", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Locked_Reason__s", "json_path": "$.data[0].Locked_Reason__s" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowedConfigurationNotCreated": { "description": "Shows the error response when the required record locking configuration is missing for the specified module.", "summary": "Locking configuration missing error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Required Record Locking Configuration is not present", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Invalid request method error", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteLockReasonResponseError400" }, { "additionalProperties": false, "description": "This error occurs when a required field is missing in the request payload.", "properties": { "data": { "description": "Contains the list of error details for the failed operation.", "items": { "additionalProperties": false, "description": "Represents the error details for a missing mandatory field.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory field in the request payload.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteMandatoryNotFoundLockRecord" }, { "additionalProperties": false, "description": "This error occurs when the specified relation is not found.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "relation not found" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteLockReasonResponse400InvalidData" }, { "additionalProperties": false, "description": "This error occurs when the required record locking configuration is not present.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "Required Record Locking Configuration is not present" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteNotAllowedLockConfigMissing400" }, { "additionalProperties": false, "description": "This error occurs when the module name provided is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteInvalidModuleError400" }, { "additionalProperties": false, "description": "This error occurs when the specified record ID is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteLockReasonResponse400InvalidDataRecordId" }, { "additionalProperties": false, "description": "This error occurs when the specified record ID is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "the id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "DeleteLockReasonResponse400InvalidDataChildId" } ], "description": "Error response returned when the request contains invalid or missing parameters for the remove lock operation.", "x-zs-$id": "DeleteLockReasonResponse400" } } }, "description": "The request contains invalid or missing parameters. **Resolution:** Verify that the module name, record ID, and lock ID in the request are valid." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response when the requesting user does not have permission to unlock the specified record.", "summary": "No permission to unlock error", "value": { "code": "NO_PERMISSION", "details": { "resource_path_index": 1 }, "message": "You do not have permission to unlock this record", "status": "error" } }, "NotAllowed": { "description": "Shows the error response when attempting to manually unlock a record that was locked automatically.", "summary": "Automatic lock cannot be manually unlocked error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "Automatically locked records can not be unlocked manually", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response indicating insufficient permissions or security restrictions.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NO_PERMISSION", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "DeleteLockReasonResponse403" } } }, "description": "The unlock operation is not permitted for this record. **Resolution:** Verify that you have the required permission and that the record was not locked automatically." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.DELETE" ] } ], "summary": "Remove lock from a locked record", "tags": [ "locking_informations" ], "x-zoho-document": "locking_informations" }, "get": { "description": "To retrieve the locking information details of a specific locked record in your Zoho CRM account using its locking information ID, including the user who locked the record, the lock source, reason, and timestamp.", "operationId": "getRecordLockingInformationById", "parameters": [ { "$ref": "#/components/parameters/LockingInformationsModuleName" }, { "$ref": "#/components/parameters/LockingInformationsRecordId" }, { "$ref": "#/components/parameters/LockId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "description": "Shows a successful response containing the locking information details of the specified locked record, including the lock source, user, reason, and timestamp.", "summary": "Successful locking information retrieval by ID", "value": { "data": [ { "$editable": false, "$field_states": null, "$sharing_permission": "read_only", "$zia_visions": null, "Feature_Type__s": "record_locking", "Lock_Source__s": "Automatic", "Locked_By__s": null, "Locked_For__s": { "id": "1961304000010927002", "module": { "api_name": "Leads", "id": "1961304000000000125" }, "name": "Test" }, "Locked_Reason__s": null, "Locked_Time__s": "2026-06-28T23:00:07+05:30", "Record_Locking_Configuration_Id__s": "1961304000010324013", "Record_Locking_Rule_Id__s": "1961304000011000517", "id": "1961304000011003523" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the locking information details of the specified locked record.", "properties": { "data": { "description": "Contains the locking information details of the specified locked record.", "items": { "additionalProperties": false, "description": "Represents the locking information details of a locked record.", "properties": { "$editable": { "description": "Indicates whether the locked record is editable by the current user. Possible values: **true** - The record is editable. **false** - The record is not editable.", "type": "boolean" }, "$field_states": { "anyOf": [ { "description": "Contains the locking information details of the specified locked record.", "maxLength": 255, "type": "string" }, { "description": "Contains the locking information details of the specified locked record.", "type": "null" } ], "description": "Represents the field-level lock states of the record. Returns **null** when no field-level locking is applied." }, "$sharing_permission": { "description": "Represents the sharing permission level of the current user on the locked record.", "maxLength": 10000, "type": "string" }, "$zia_visions": { "anyOf": [ { "description": "Contains the Zia Visions related information.", "maxLength": 255, "type": "string" }, { "description": "Null when Zia Visions data is not available.", "type": "null" } ], "description": "Represents Zia Visions data associated with the record. Returns **null** when Zia Visions data is not available." }, "Feature_Type__s": { "description": "Represents the feature type associated with the locking information.", "maxLength": 255, "type": "string" }, "Lock_Source__s": { "description": "Indicates the source of the record lock. Possible values: **Manual** - The record was locked manually by a user. **Automatic** - The record was locked automatically by a rule. **Both** - The record has both manual and automatic locks.", "enum": [ "Manual", "Both", "Automatic" ], "maxLength": 255, "type": "string" }, "Locked_By__s": { "additionalProperties": false, "description": "An object containing the details of the user who locked the record. Returns **null** for automatically locked records where no specific user performed the lock.", "properties": { "id": { "description": "Represents the unique identifier of the user who locked the record.", "maxLength": 255, "type": "string" }, "module": { "description": "Represents the module to which the user who locked the record belongs.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who locked the record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": [ "object", "null" ] }, "Locked_For__s": { "additionalProperties": false, "description": "Represents the details of the record that is locked.", "properties": { "id": { "description": "Represents the unique identifier of the locked record.", "maxLength": 255, "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the details of the module to which the locked record belongs.", "properties": { "api_name": { "description": "Represents the API name of the module of the locked record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique identifier of the module of the locked record.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Represents the name of the locked record.", "maxLength": 255, "type": "string" } }, "required": [ "module", "name", "id" ], "type": "object" }, "Locked_Reason__s": { "description": "Represents the reason for locking the record. Returns **null** for automatically locked records.", "maxLength": 3000, "type": [ "string", "null" ] }, "Locked_Time__s": { "description": "Represents the timestamp when the record was locked.", "format": "date-time", "type": "string" }, "Record_Locking_Configuration_Id__s": { "description": "Represents the unique identifier of the record locking configuration applied to this record.", "maxLength": 255, "type": "string" }, "Record_Locking_Rule_Id__s": { "description": "Represents the unique identifier of the record locking rule. Returns **null** for manually locked records.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique identifier of the locking information record.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "GetRecordLockingInformationByIdResponse" } } }, "description": "Returns the locking information details of the specified locked record, including the user who locked it, the lock source, reason, and timestamp." }, "204": { "description": "No locking information exists for the specified lock ID, or the record has no active lock." }, "400": { "content": { "application/json": { "examples": { "InvalidDataMainRecordId": { "description": "Shows the error response when the record ID provided in the request path is invalid.", "summary": "Invalid record ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNotFound": { "description": "Shows the error response when the locking information relation is not found for the specified record.", "summary": "Relation not found error", "value": { "code": "INVALID_DATA", "details": {}, "message": "relation not found", "status": "error" } }, "InvalidMainModule": { "description": "Shows the error response when the module name provided in the request path is invalid.", "summary": "Invalid module name error", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "NotAllowedLockConfigMissing": { "description": "Shows the error response when the required record locking configuration is missing for the specified module.", "summary": "Locking configuration missing error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Required Record Locking Configuration is not present", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "This error occurs when the specified relation is not found.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "relation not found" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetByIdInvalidDataRelationNotFound" }, { "additionalProperties": false, "description": "This error occurs when the module name provided is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetByIdInvalidModuleError" }, { "additionalProperties": false, "description": "This error occurs when the relation ID provided is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "the related id given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetByIdInvalidDataMainRecordId" }, { "additionalProperties": false, "description": "This error occurs when the required record locking configuration is not present.", "properties": { "code": { "description": "Represents the error code indicating the action is not allowed.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "Required Record Locking Configuration is not present" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetByIdNotAllowedLockConfigMissing" } ], "description": "Error response returned when the request contains invalid or missing parameters for the get locking information by ID operation.", "x-zs-$id": "GetRecordLockingInformationByIdErrorResponse" } } }, "description": "The request contains invalid or missing parameters. **Resolution:** Verify that the module name, record ID, and lock ID in the request are valid." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response when the requesting user profile does not have permission to access the record locking configuration for the specified module.", "summary": "No permission error", "value": { "code": "NO_PERMISSION", "details": { "resource_path_index": 1 }, "message": "Record Locking Configuration is not supported for the profile of the user", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response indicating insufficient permissions or security restrictions.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NO_PERMISSION", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "GetRecordLockingInformationByIdResponse403" } } }, "description": "The request is not permitted. **Resolution:** Verify that you have the required permission and that record locking is supported for your edition and profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the error response when the lock ID in the request path is not a valid numeric identifier, resulting in an invalid URL pattern.", "summary": "Invalid URL pattern error", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the URL pattern is invalid, typically due to a malformed lock ID.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_URL_PATTERN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetRecordLockingInformationByIdResponse404" } } }, "description": "The requested URL is invalid. **Resolution:** Verify that the lock ID in the path is a valid numeric identifier." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.READ" ] } ], "summary": "Get record locking information by ID", "tags": [ "locking_informations" ], "x-zoho-document": "locking_informations" }, "put": { "description": "To update the locking reason of a locked record in the specified module of your Zoho CRM account.", "operationId": "updateReasonofLockedRecord", "parameters": [ { "description": "The unique identifier of the record whose locking reason needs to be updated. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module IDs.", "in": "path", "name": "moduleName", "required": true, "schema": { "examples": [ "Leads", "Contacts", "Deals", "Accounts" ], "maxLength": 255, "type": "string" } }, { "description": "The unique identifier of the record whose locking reason needs to be updated.", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 32, "type": "string" } }, { "$ref": "#/components/parameters/LockId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateLockReason": { "description": "Shows a request payload to update the locking reason for a manually locked record in the specified module.", "summary": "Update lock reason request", "value": { "data": [ { "Locked_Reason__s": "Updating the lock reason for review" } ] } } }, "schema": { "additionalProperties": false, "description": "The request body must contain a data array with one object specifying the updated locking reason.", "properties": { "data": { "description": "Specify the locking information details for the record.", "items": { "additionalProperties": false, "description": "Specify the locking details for the record.", "properties": { "Locked_Reason__s": { "description": "Specify the reason for locking the record.", "maxLength": 3000, "type": "string" } }, "required": [ "Locked_Reason__s" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "description": "The request body must contain a data array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessCase": { "description": "Shows a successful response after the locking reason for the specified record is updated.", "summary": "Successful lock reason update", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "111111000000053293" }, "message": "relation updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the success response for the lock reason update operation.", "properties": { "data": { "description": "Contains the response details for the update operation.", "items": { "additionalProperties": false, "description": "Represents the result of the lock reason update operation.", "properties": { "code": { "description": "Represents the response code for the update operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Contains the success response for the lock reason update operation.", "properties": { "Created_By": { "additionalProperties": false, "description": "Contains the details of the successfully updateed record.", "properties": { "id": { "description": "Contains the details of the successfully updateed record.", "maxLength": 255, "type": "string" }, "name": { "description": "Contains the details of the successfully updateed record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Contains the details of the successfully updateed record.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains the details of the successfully updateed record.", "properties": { "id": { "description": "Contains the details of the successfully updateed record.", "maxLength": 255, "type": "string" }, "name": { "description": "Contains the details of the successfully updateed record.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Contains the details of the successfully updateed record.", "format": "date-time", "type": "string" }, "id": { "description": "Contains the details of the successfully updateed record.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, { "additionalProperties": false, "description": "Contains the success response for the lock reason update operation.", "properties": { "id": { "description": "Contains the details of the successfully updateed record.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" } ], "description": "Contains the details of the successfully updated locked record, including its unique identifier and audit timestamps." }, "message": { "description": "Represents the response message for the update operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the update operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UpdateLockReasonResponse" } } }, "description": "Returns a success response after the locking reason update completes." }, "400": { "content": { "application/json": { "examples": { "InvalidDataChildId": { "description": "Shows the error response when the lock ID provided in the request path is invalid.", "summary": "Invalid lock ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidDataConfigurationNotCreated": { "description": "Shows the error response when the locking information relation is not found for the specified record.", "summary": "Relation not found error", "value": { "code": "INVALID_DATA", "details": {}, "message": "relation not found", "status": "error" } }, "InvalidDataRelation": { "description": "Shows the error response when the record ID provided in the request path is invalid.", "summary": "Invalid relation ID error", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidModuleData": { "description": "Shows the error response when the module name provided in the request path is invalid.", "summary": "Invalid module name error", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows the error response when an invalid HTTP method is used for this endpoint.", "summary": "Invalid HTTP method error", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFound": { "description": "Shows the error response when the required Locked_Reason__s field is missing from the request payload.", "summary": "Missing mandatory field error", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Locked_Reason__s", "json_path": "$.data[0].Locked_Reason__s" }, "message": "required field not found", "status": "error" } ] } }, "NotAllowedConfigurationNotCreated": { "description": "Shows the error response when the required record locking configuration is missing for the specified module.", "summary": "Locking configuration missing error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 2 }, "message": "Required Record Locking Configuration is not present", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Invalid request method error", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_REQUEST_METHOD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateInvalidRequestMethodError400" }, { "additionalProperties": false, "description": "This error occurs when a required field is missing in the request payload.", "properties": { "data": { "description": "Contains the list of error details for the failed operation.", "items": { "additionalProperties": false, "description": "Represents the error details for a missing mandatory field.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "api_name": { "description": "Represents the API name of the missing mandatory field.", "maxLength": 256, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing mandatory field in the request payload.", "maxLength": 256, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "enum": [ "required field not found" ], "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UpdateMandatoryNotFoundLockRecord" }, { "additionalProperties": false, "description": "This error occurs when the specified relation is not found.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateLockReasonResponseError400" }, { "additionalProperties": false, "description": "This error occurs when the required record locking configuration is not present.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateNotAllowedLockConfigMissing400" }, { "additionalProperties": false, "description": "This error occurs when the module name provided is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateInvalidModuleError400" }, { "additionalProperties": false, "description": "This error occurs when the specified record ID is invalid.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UpdateLockReasonResponse400InvalidDataRecordId" } ], "description": "Error response returned when the request contains invalid or missing parameters for the update locking reason operation.", "x-zs-$id": "UpdateLockReasonResponse400" } } }, "description": "The request contains invalid or missing parameters. **Resolution:** Verify that the module name, record ID, lock ID, and request body are valid." }, "403": { "content": { "application/json": { "examples": { "NotAllowedCase1": { "description": "Shows the error response when attempting to update the locking reason on a record that is already locked automatically.", "summary": "Record already locked error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "record is already locked", "status": "error" } }, "NotAllowedCase2": { "description": "Shows the error response when the record locking configuration only allows automatic locking and not manual locking.", "summary": "Automatic locking only configured error", "value": { "code": "NOT_ALLOWED", "details": { "resource_path_index": 1 }, "message": "record cannot be locked, only automatic locking is configured", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response indicating insufficient permissions or security restrictions.", "properties": { "code": { "description": "Represents the error code for this response.", "enum": [ "NO_PERMISSION", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path segment where the error occurred.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message providing details about the failure.", "maxLength": 256, "type": "string" }, "status": { "description": "Represents the status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UpdateLockReasonResponse403" } } }, "description": "The update operation is not permitted for this record. **Resolution:** Verify that you have the required permission and that the record is locked manually." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.modules.ALL" ] } ], "summary": "Update locking reason of a locked record", "tags": [ "locking_informations" ], "x-zoho-document": "locking_informations" } }, "/crm/v8/{module}": { "delete": { "description": "To permanently delete more records from the specified module in your Zoho CRM organization, use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs. A maximum of 100 records can be deleted per API call. By default, all workflows related to this API are executed. All subforms related to the deleted records are also deleted.", "operationId": "deleteRecords", "parameters": [ { "$ref": "#/components/parameters/RecordModule" }, { "$ref": "#/components/parameters/RecordIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDeletion": { "description": "Shows the successful response for the deleteRecords operation, including the record ID and audit metadata.", "summary": "Successfully deleted records", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "410405000002264040" }, "message": "record deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "410405000002264025" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteSuccessResponse" } } }, "description": "Returns the deletion status for each records successfully deleted." }, "207": { "content": { "application/json": { "examples": { "MixedResults": { "description": "Shows the 207 multi-status response with a mix of successful and failed records in the data array.", "summary": "Mixed results with success and failure items", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "410405000002264040" }, "message": "record deleted", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "4150868000005067099" }, "message": "record not deleted", "status": "error" }, { "code": "SUCCESS", "details": { "id": "410405000002264025" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteMultiStatusResponse" } } }, "description": "Returns a multi-status response when some record deletion operations succeed and others fail. Each item in the data array independently reports the outcome for the corresponding record." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows the error response when the user does not have sufficient privileges for this operation.", "summary": "Insufficient privileges for the operation", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to delete records", "status": "error" } }, "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows the error response when an unsupported HTTP method is used for this endpoint.", "summary": "Unsupported HTTP method for this endpoint", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MissingParam": { "description": "Shows the error response when a required parameter is missing from the request.", "summary": "Required parameter missing from the request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } }, "NotApproved": { "description": "Shows the error response when the record has not been approved and cannot be deleted.", "summary": "Record is not approved and cannot be deleted", "value": { "data": [ { "code": "NOT_APPROVED", "details": {}, "message": "cannot delete record that is not approved yet", "status": "error" } ] } }, "RecordLocked": { "description": "Shows the error response when the target record is locked and cannot be modified.", "summary": "Record is locked and cannot be modified", "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "5040565000001052497" }, "message": "You cannot perform this operation as the record is locked.", "status": "error" } ] } }, "UnableToParseDataType": { "description": "Shows the error response when the request body or parameters are in an incorrect format.", "summary": "Request body or parameters in incorrect format", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "5040565000001052497" }, "message": "either the request body or parameters is in wrong format", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteBadRequestResponse" } } }, "description": "The request could not be processed because of an invalid module, missing parameters, or invalid record IDs.\n**Resolution:** The request must include valid module API name and record IDs." }, "401": { "content": { "application/json": { "examples": { "ScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to delete", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeletePermissionResponse" } } }, "description": "Permission denied to delete records in the specified module.\n**Resolution:** The CRM administrator must grant the required deletion permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern.\n**Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.DELETE" ] } ], "summary": "Delete records from a specified module", "tags": [ "record" ], "x-zoho-document": "record" }, "get": { "description": "Retrieves records from the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use \"sort_by\" and \"sort_order\" to control the sorting of records. To fetch up to 2000 records, use \"page\" (1-10) and \"per_page\" (maximum 200). To fetch more than 2000 records, use the \"page_token\" returned in the response. Consecutive page tokens can be used to navigate through up to 100,000 records. The \"$has_more\" key is returned when fetching a specific record and indicates whether more records are available in subforms, multi-select lookup fields, and multi-user lookup fields. To retrieve details of a related list, use the [Get Related Records API](related_records.yaml#$.paths./{parentRecordModule}/{parentRecord}/{relatedList}.get).", "operationId": "getRecords", "parameters": [ { "$ref": "#/components/parameters/RecordModule" }, { "$ref": "#/components/parameters/RecordFields" }, { "$ref": "#/components/parameters/TerritoryId" }, { "$ref": "#/components/parameters/RecordIds" }, { "$ref": "#/components/parameters/RecordCvid" }, { "$ref": "#/components/parameters/RecordFilters" }, { "$ref": "#/components/parameters/RecordCrossFilters" }, { "$ref": "#/components/parameters/FilterId" }, { "$ref": "#/components/parameters/RecordPerPage" }, { "$ref": "#/components/parameters/RecordPage" }, { "$ref": "#/components/parameters/RecordPageToken" }, { "$ref": "#/components/parameters/RecordSortOrder" }, { "$ref": "#/components/parameters/RecordSortBy" }, { "$ref": "#/components/parameters/RecordConverted" }, { "$ref": "#/components/parameters/IncludeChild" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Leads": { "description": "Shows a successful Get Records response for the Leads module, including five records and pagination metadata in the info object.", "summary": "Successful retrieval of records from the Leads module", "value": { "data": [ { "Company": "Zylker Corp", "Created_Time": "2023-10-15T10:30:00+00:00", "Email": "john.doe@zylker.com", "First_Name": "John", "Last_Name": "Doe", "Lead_Status": "Not Contacted", "Modified_Time": "2023-10-15T14:20:00+00:00", "Owner": { "email": "patricia.boyle@example.com", "id": "4150868000000225013", "name": "Patricia Boyle" }, "Phone": "+1-555-123-4567", "id": "4150868000000002175" } ], "info": { "call": false, "count": 5, "email": false, "more_records": true, "next_page_token": "c8582xx9e7c7", "page": 1, "page_token_expiry": "2022-11-11T15:08:14+05:30", "per_page": 5, "previous_page_token": null, "sort_by": "id", "sort_order": "desc" } } } }, "schema": { "$ref": "#/components/schemas/RecordGETSuccessResponse" } } }, "description": "Returns the list of records retrieved from the specified module, including pagination metadata in the **info** object." }, "204": { "description": "Returns an empty response when the request is successful but no records match the specified criteria." }, "400": { "content": { "application/json": { "examples": { "DiscretePaginationLimitExceeded": { "description": "Shows the error response when records beyond the first 2,000 are requested without including the page_token parameter.", "summary": "Pagination limit exceeded without the page_token parameter", "value": { "code": "DISCRETE_PAGINATION_LIMIT_EXCEEDED", "details": { "limit": 2000 }, "message": "You can only get the first 2000 records without using page_token param", "status": "error" } }, "ExpiredValue": { "description": "Shows the error response when the page_token parameter value has expired and can no longer be used for pagination.", "summary": "Expired page_token parameter value", "value": { "code": "EXPIRED_VALUE", "details": { "api_name": "page_token", "json_path": "$.query.page_token" }, "message": "Page token expired", "status": "error" } }, "InvalidCvid": { "description": "Shows the error response when an invalid or non-existent Custom View ID is provided in the cvid parameter. Use the [Get Custom Views Metadata API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve valid Custom View IDs.", "summary": "Invalid Custom View ID in the cvid parameter", "value": { "code": "INVALID_DATA", "details": { "param_name": "cvid" }, "message": "invalid data", "status": "error" } }, "InvalidData": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request URL", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "LimitExceeded": { "description": "Shows the error response when the number of field API names in the fields parameter exceeds the allowed limit of 50.", "summary": "Field count exceeds the maximum allowed limit", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 50, "param_name": "fields" }, "message": "limit exceeded", "status": "error" } }, "PaginationLimitExceeded": { "description": "Shows the error response when the total number of records requested via page_token pagination exceeds 100,000.", "summary": "Pagination limit of 100,000 records exceeded", "value": { "code": "PAGINATION_LIMIT_EXCEEDED", "details": { "param_name": "page_token" }, "message": "You can only get upto 100000 records using page_token param", "status": "error" } }, "RequiredParamMissing": { "description": "Shows the error response when the required fields parameter is missing from the request.", "summary": "Required fields parameter missing from the request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "required param is missing", "status": "error" } }, "TokenBoundDataMismatch": { "description": "Shows the error response when the page_token value does not match the original request parameters used when the token was generated.", "summary": "Page token mismatch due to changed request parameters", "value": { "code": "TOKEN_BOUND_DATA_MISMATCH", "details": { "param_name": "page_token" }, "message": "The page_token given seems to be invalid or input param is added or altered or deleted", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/InvalidDataGETError" }, { "$ref": "#/components/schemas/InvalidDataSortByError" }, { "$ref": "#/components/schemas/TokenBoundDataMismatchGETError" }, { "$ref": "#/components/schemas/InvalidModuleGETError" }, { "$ref": "#/components/schemas/RequiredParamMissingGETError" }, { "$ref": "#/components/schemas/LimitExceededGETError" }, { "$ref": "#/components/schemas/ExpiredValueGETError" }, { "$ref": "#/components/schemas/PatternNotMatchedGetError" }, { "$ref": "#/components/schemas/DiscretePaginationLimitExceededGETError" }, { "$ref": "#/components/schemas/AmbiguityDuringProcessingGETError" }, { "$ref": "#/components/schemas/PaginationLimitExceededGETError" } ], "description": "Represents the error response returned when a Get Records operation fails due to a validation, pagination, or processing error. The specific error variant is resolved via the discriminator on the **code** field.", "x-zs-$id": "RecordGETErrorResponse" } } }, "description": "The request could not be processed due to invalid input or a missing required parameter. **Resolution:** The request must include all required parameters with valid values." }, "401": { "content": { "application/json": { "examples": { "ScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required read scope for the requested module.", "summary": "OAuth access token missing the required read scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope. **Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user's CRM profile does not include the permission required to retrieve records from the specified module.", "summary": "User profile lacks module access permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to retrieve records from the specified module. **Resolution:** The CRM administrator must grant the required module access permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern. **Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs while processing the request.", "summary": "Unexpected internal server error during request processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request. **Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Get records from a specified module", "tags": [ "record" ], "x-zoho-document": "record" }, "post": { "description": "Creates one or more records in the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the available field API names and data types. You can create up to 100 records in a single API call. Specify the required field API names and their corresponding values in the request body.", "operationId": "createRecords", "parameters": [ { "$ref": "#/components/parameters/RecordModule" } ], "requestBody": { "content": { "application/json": { "examples": { "AccountsCreateExample": { "description": "Example request body for creating a new Account record with standard and custom fields. Account_Name is mandatory to create a new record in the Accounts module.", "summary": "Create a new Account record", "value": { "data": [ { "Account_Name": "Bentley Systems", "Account_Number": "10023", "Account_Site": "Headquarters", "Account_Type": "Customer", "Annual_Revenue": 25000000, "Billing_City": "Exton", "Billing_Code": "19341", "Billing_Country": "USA", "Billing_State": "Pennsylvania", "Billing_Street": "1000 Commerce Drive", "Description": "Key strategic account", "Employees": 1200, "Fax": "555-2233446", "Industry": "Engineering", "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Ownership": "Private", "Parent_Account": { "id": "5725767000007908001", "name": "Bentley Holdings" }, "Phone": "555-2233445", "SIC_Code": "3827", "Shipping_City": "Exton", "Shipping_Code": "19341", "Shipping_Country": "USA", "Shipping_State": "Pennsylvania", "Shipping_Street": "1000 Commerce Drive", "Tag": [ { "name": "Enterprise" } ], "Ticker_Symbol": "BSY", "Website": "www.bentleysystems.com" } ] } }, "CallsCreateExample": { "description": "Example request body for creating a new Call record with standard and custom fields. In Calls module, the call duration for an Inbound or Outbound call cannot be zero.", "summary": "Create a new Call record", "value": { "data": [ { "Call_Duration": "00:20", "Call_Purpose": "Prospecting", "Call_Result": "Interested", "Call_Start_Time": "2026-01-20T10:00:00-05:00", "Call_Type": "Outbound", "Description": "Discussed renewal pricing options and next steps", "Subject": "Discuss renewal pricing", "Tag": [ { "name": "Renewal" } ], "Who_Id": { "id": "5725767000011356002", "name": "Anna Kingsley" } } ] } }, "CampaignsCreateExample": { "description": "Example request body for creating a new Campaign record with standard and custom fields. 'Campaign_Name' is mandatory.", "summary": "Create a new Campaign record", "value": { "data": [ { "Actual_Cost": 18500, "Budgeted_Cost": 20000, "Campaign_Name": "Fall Renewal Campaign", "Currency": "USD", "Description": "Renewal-focused email and webinar campaign", "End_Date": "2026-09-30", "Expected_Response": 25, "Expected_Revenue": 150000, "Num_sent": 5000, "Parent_Campaign": { "id": "5725767000004498133", "name": "2026 Annual Marketing Plan" }, "Start_Date": "2026-09-01", "Status": "In Progress", "Tag": [ { "name": "Q3" } ], "Type": "Webinar" } ] } }, "CasesCreateExample": { "description": "Example request body for creating a new Case record with standard and custom fields. 'Status', 'Case_Origin', and 'Subject' are mandatory to create a new record in the Cases module.", "summary": "Create a new Case record", "value": { "data": [ { "Account_Name": { "id": "5725767000011373001", "name": "Bentley Systems" }, "Case_Origin": "Email", "Case_Reason": "Product Defect", "Comments": "Awaiting customer confirmation", "Currency": "USD", "Deal_Name": { "id": "5725767000011360004", "name": "Bentley Systems - Annual License Renewal" }, "Description": "Customer reports PDF export fails with a timeout error", "Email": "anna.kingsley@bentleysystems.com", "Internal_Comments": "Escalated to engineering team", "Phone": "555-3344556", "Priority": "High", "Product_Name": { "id": "5725767000006754021", "name": "CRM Enterprise Suite" }, "Reported_By": "Anna Kingsley", "Solution": "Restart the export service and retry", "Status": "In Progress", "Subject": "Unable to export report as PDF", "Tag": [ { "name": "Escalated" } ], "Type": "Question" } ] } }, "ContactsCreateExample": { "description": "Example request body for creating a new contact record with standard and custom fields. \"Last_Name\" is the mandatory field for creating a Contact record in the Contacts module. Please note that the mandatory-field behavior is changing, you must specify at least one of \"First_Name\" or \"Last_Name\" when creating a Contact record.", "summary": "Create a new Contact record", "value": { "data": [ { "Account_Name": { "id": "5725767000007910001", "name": "Bentley Systems" }, "Assistant": "Diane Cole", "Date_of_Birth": "1985-04-12", "Department": "Sales", "Description": "Primary decision maker", "Email": "anna.kingsley@bentley.com", "Email_Opt_Out": false, "Fax": "555-3344559", "First_Name": "Kane", "Full_Name": "Anna Kingsley", "Home_Phone": "555-3344557", "Last_Name": "Kingslei", "Mailing_City": "Philadelphia", "Mailing_Country": "USA", "Mailing_State": "Pennsylvania", "Mailing_Street": "220 Market Street", "Mailing_Zip": "19103", "Mobile": "555-3344550", "Other_Phone": "555-3344558", "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Phone": "555-33445561", "Skype_ID": "anna.kingsley", "Title": "VP of Sales" } ] } }, "CustomModuleCreateExample": { "description": "To create a record in a custom module, resolve the following metadata first. Retrieve the custom module API name from the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource — custom modules are identified by generated_type: \"custom\". Retrieve valid field API names from the [Get Fields Metadata](fields.yaml#$.paths./settings/fields.get) resource with `module={api_name}`, which returns each field's `api_name`, `system_mandatory`, `field_read_only`, and `data_type`. If the module has more than one layout, retrieve the Layout ID from the [Get Layouts](layouts.yaml#$.paths./settings/layouts.get) resource with `module={api_name}` and include it as `Layout: { id: \"\" }` in the record payload. Once resolved, send the creation request to `POST /crm/v8/{module_api_name}` with a `data` array using the confirmed field API names.", "summary": "Create a record in a custom module", "value": { "data": [ { "Currency": "USD", "Description": "Custom module records inherit these system fields (Owner, Name, Email, Currency, Tag, etc.) plus your own user-defined fields", "Email": "warranty-admin@zylker.com", "Email_Opt_Out": false, "Name": "Extended Warranty - Bentley Systems", "Owner": { "id": "554023000000235011", "name": "Patricia Boyle" }, "Secondary_Email": "warranty-admin2@zylker.com", "Tag": [ { "name": "Custom" } ] } ] } }, "DealsCreateExample": { "description": "Example request body for creating a new Deal record with standard and custom fields. Deal_Name, Closing_Date, Pipeline, and Stage are mandatory to create a new record in the Deals module.", "summary": "Create a new Deal record", "value": { "data": [ { "Account_Name": { "id": "5725767000007908001", "name": "Bentley Systems" }, "Amount": 85000, "Closing_Date": "2026-09-30", "Contact_Name": { "id": "5725767000011356002", "name": "Anna Kingsley" }, "Deal_Name": "Bentley Systems - Annual License Renewal", "Description": "Renewal negotiation for enterprise licensing", "Expected_Revenue": 80000, "Lead_Source": "Partner Referral", "Next_Step": "Send revised contract", "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Pipeline": "Standard (Standard)", "Stage": "Negotiation/Review", "Tag": [ { "name": "Renewal" } ], "Type": "Existing Business" } ] } }, "EventsCreateExample": { "description": "Example request body for creating a new Event record with standard and custom fields. \"Event_Title\", \"Meeting_Venue__s\", \"Start_DateTime\", and \"End_DateTime\" are mandatory to create a new record in the Events module. To retrieve the cancellation status of a Meeting using the Get Records API, specify \"$event_cancelled\" in the \"fields\" parameter. The \"$event_cancelled\" key in the response indicates whether the Meeting has been cancelled.", "summary": "Create a new Event record", "value": { "data": [ { "All_day": false, "Description": "Review the final renewal terms with Bentley Systems", "End_DateTime": "2026-08-25T11:00:00-05:00", "Event_Title": "Renewal Contract Review", "Meeting_Venue__s": "Client location", "Participants": [ { "Email": "alice@mail.com", "name": "Alice Brown", "participant": "5725767000005425036", "type": "lead" } ], "Remind_At": [ { "period": "minutes", "unit": 15 } ], "Start_DateTime": "2026-08-25T10:00:00-05:00", "Tag": [ { "name": "Renewal" } ], "Who_Id": { "id": "5725767000011356002", "name": "Anna Kingsley" }, "venue": "Zoho Conference Room" } ] } }, "InvoicesCreateExample": { "description": "Example request body for creating a new Invoice record with standard and custom fields. \"Subject\", \"Account_Name\", \"Invoiced_Items\", and \"Product_Name\" are mandatory to create a new record in the Invoices module.", "summary": "Create a new Invoice record", "value": { "data": [ { "Account_Name": { "id": "5725767000011373001", "name": "Bentley Systems" }, "Billing_City": "Exton", "Billing_Code": "19341", "Billing_Country": "USA", "Billing_State": "Pennsylvania", "Billing_Street": "1000 Commerce Drive", "Contact_Name": { "id": "5725767000011356002", "name": "Anna Kingsley" }, "Description": "Renewal invoice", "Due_Date": "2026-09-30", "Grand_Total": 85000, "Invoice_Date": "2026-09-01", "Invoice_Number": "INV-3021", "Invoiced_Items": [ { "Product_Name": { "id": "5725767000011358006", "name": "CRM Enterprise Suite" }, "discount": 5, "list_price": 999, "quantity": 90, "total": 85414.5 } ], "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Purchase_Order": "PO-88213", "Sales_Order": { "id": "5725767000011355014", "name": "SO-00567" }, "Shipping_City": "Exton", "Shipping_Code": "19341", "Shipping_Country": "USA", "Shipping_State": "Pennsylvania", "Shipping_Street": "1000 Commerce Drive", "Subject": "Invoice for Bentley Systems Renewal", "Terms_and_Conditions": "Payment due within 30 days" } ] } }, "LeadsCreateExample": { "description": "Example request body for creating a new Lead record with standard and custom fields. \"Last_Name\" is the mandatory field for creating a Lead record in the Leads module. Please note that the mandatory-field behavior is changing, you must specify at least one of \"First_Name\" or \"Last_Name\" when creating a Lead record.", "summary": "Create a new Lead record", "value": { "data": [ { "Annual_Revenue": 500000, "City": "Newark", "Company": "ABC Corp", "Country": "USA", "Description": "Interested in enterprise licensing", "Email": "boyle@abc.com", "Email_Opt_Out": false, "Fax": "555-7654321", "First_Name": "Patricia", "Industry": "Technology", "Last_Name": "Boyle", "Lead_Source": "Web Download", "Lead_Status": "Not Contacted", "Mobile": "555-9876543", "No_of_Employees": 250, "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Phone": "111-1234567", "Rating": "Hot", "Secondary_Email": "patricia.b@abc.com", "Skype_ID": "patricia.boyle", "State": "New Jersey", "Street": "24 Vine Street", "Website": "www.abc.com", "Zip_Code": "07102" } ] } }, "PriceBooksCreateExample": { "description": "Example request body for creating a new Price Book record with standard and custom fields. \"Price_Book_Name\" and \"Pricing_Details\" are mandatory to create a new record in the Price Books module. Specify the module API name as 'Price_Books' in the URL.", "summary": "Create a new Price Book record", "value": { "data": [ { "Active": true, "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Price_Book_Name": "Standard Price Book 2026", "Pricing_Details": [ { "discount": 0, "from_range": 1, "to_range": 10, "unit_price": 999 }, { "discount": 10, "from_range": 11, "to_range": 50, "unit_price": 899.1 } ], "Pricing_Model": "Flat", "Tag": [ { "name": "2026" } ] } ] } }, "ProductsCreateExample": { "description": "Example request body for creating a new Product record with standard and custom fields. 'Product_Name' is mandatory to create a new record in the Products module.", "summary": "Create a new Product record", "value": { "data": [ { "Commission_Rate": 5, "Description": "Enterprise-grade CRM licensing bundle", "Manufacturer": "Zylker Corp", "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Product_Active": true, "Product_Category": "Software", "Product_Code": "PRD-2001", "Product_Name": "CRM Enterprise Suite", "Qty_Ordered": 100, "Qty_in_Demand": 20, "Qty_in_Stock": 50, "Reorder_Level": 10, "Sales_End_Date": "2027-12-31", "Sales_Start_Date": "2026-01-01", "Support_Expiry_Date": "2027-12-31", "Support_Start_Date": "2026-01-01", "Tag": [ { "name": "Flagship" } ], "Taxable": true, "Unit_Price": 999, "Usage_Unit": "License", "Vendor_Name": { "id": "5725767000001693003", "name": "Zylker Hardwares" } } ] } }, "PurchaseOrdersCreateExample": { "description": "Example request body for creating a new Purchase Order record with standard and custom fields. \"Subject\", \"Vendor_Name\", \"Purchase_Items\", and \"Product_Name\" are mandatory to create a new record in the Purchase Orders module. Specify the module API name as 'Purchase_Orders' in the URL", "summary": "Create a new Purchase Order record", "value": { "data": [ { "Adjustment": 0, "Billing_City": "Trenton", "Billing_Code": "08608", "Billing_Country": "USA", "Billing_State": "New Jersey", "Billing_Street": "88 Industrial Ave", "Carrier": "UPS", "Contact_Name": { "id": "5725767000011356002", "name": "Anna Kingsley" }, "Description": "Restocking order for enterprise licenses", "Discount": 0, "Due_Date": "2026-09-01", "Excise_Duty": 0, "Grand_Total": 50000, "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "PO_Date": "2026-08-15", "PO_Number": "PO-88213", "Purchase_Items": [ { "Product_Name": { "id": "5725767000011358006", "name": "CRM Enterprise Suite" }, "discount": 0, "list_price": 999, "quantity": 50, "total": 49950 } ], "Requisition_No": "REQ-4021", "Sales_Commission": 0, "Shipping_City": "Exton", "Shipping_Code": "19341", "Shipping_Country": "USA", "Shipping_State": "Pennsylvania", "Shipping_Street": "1000 Commerce Drive", "Status": "Approved", "Sub_Total": 50000, "Subject": "Purchase Order for CRM Enterprise Suite Stock", "Tax": 0, "Terms_and_Conditions": "Net 30", "Tracking_Number": "1Z999AA10123456784", "Vendor_Name": { "id": "5725767000011346004", "name": "Zylker Hardwares" } } ] } }, "QuotesCreateExample": { "description": "Example request body for creating a new Quote record with standard and custom fields. \"Subject\", \"Account_Name\", \"Quoted_Items\", and \"Product_Name\" are mandatory to create a new record in the Quotes module.", "summary": "Create a new Quote record", "value": { "data": [ { "Account_Name": { "id": "5725767000011373001", "name": "Bentley Systems" }, "Adjustment": 0, "Billing_City": "Exton", "Billing_Code": "19341", "Billing_Country": "USA", "Billing_State": "Pennsylvania", "Billing_Street": "1000 Commerce Drive", "Carrier": "FedEx", "Contact_Name": { "id": "5725767000011356002", "name": "Anna Kingsley" }, "Deal_Name": { "id": "5725767000011360004", "name": "Bentley Systems - Annual License Renewal" }, "Description": "Renewal quote for enterprise licensing", "Discount": 5000, "Grand_Total": 85000, "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Quote_Number": "Q-00234", "Quote_Stage": "Delivered", "Quoted_Items": [ { "Product_Name": { "name": "CRM Enterprise Suite" } } ], "Shipping_City": "Exton", "Shipping_Code": "19341", "Shipping_Country": "USA", "Shipping_State": "Pennsylvania", "Shipping_Street": "1000 Commerce Drive", "Sub_Total": 90000, "Subject": "Quote for Bentley Systems Renewal", "Tax": 0, "Team": "Sales Team East", "Terms_and_Conditions": "Payment due within 30 days", "Valid_Till": "2026-09-15" } ] } }, "SalesOrdersCreateExample": { "description": "Example request body for creating a new Sales Order record with standard and custom fields. \"Subject\", \"Account_Name\", \"Odered_Items\", and \"Product_Name\" are mandatory to create a new record in the Sales Orders module. Specify the module API name as 'Sales_Orders' in the URL", "summary": "Create a new Sales Order record", "value": { "data": [ { "Account_Name": { "id": "5725767000011373001", "name": "Bentley Systems" }, "Adjustment": 0, "Billing_City": "Exton", "Billing_Code": "19341", "Billing_Country": "USA", "Billing_State": "Pennsylvania", "Billing_Street": "1000 Commerce Drive", "Carrier": "FedEx", "Contact_Name": { "id": "5725767000011356002", "name": "Anna Kingsley" }, "Customer_No": "CUST-1042", "Deal_Name": { "id": "5725767000011360004", "name": "Bentley Systems - Annual License Renewal" }, "Description": "Renewal sales order", "Discount": 5000, "Due_Date": "2026-09-20", "Excise_Duty": 0, "Grand_Total": 85000, "Ordered_Items": [ { "Product_Name": { "Product_Code": "PRD-2001", "Qty_Ordered": 100, "Qty_in_Stock": 50, "Tax": [], "Taxable": true, "Unit_Price": 999, "id": "5725767000011358006", "name": "CRM Enterprise Suite" } } ], "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Pending": "0.00", "Purchase_Order": "PO-88213", "Quote_Name": { "id": "5725767000011359014", "name": "Q-00234" }, "SO_Number": "SO-00567", "Sales_Commission": 5, "Shipping_City": "Exton", "Shipping_Code": "19341", "Shipping_Country": "USA", "Shipping_State": "Pennsylvania", "Shipping_Street": "1000 Commerce Drive", "Status": "Created", "Sub_Total": 90000, "Subject": "Sales Order for Bentley Systems Renewal", "Tax": 0, "Terms_and_Conditions": "Payment due within 30 days" } ] } }, "SolutionsCreateExample": { "description": "Example request body for creating a new Solution record with standard and custom fields. 'Solution_Title' is mandatory to create a new record in the Solutions module.", "summary": "Create a new Solution record", "value": { "data": [ { "Answer": "Restart the export service from Setup > System Settings and retry the export.", "Product_Name": { "id": "5725767000006754021", "name": "CRM Enterprise Suite" }, "Question": "Why does the PDF export fail with a timeout error?", "Solution_Title": "How to resolve PDF export timeout error", "Tag": [ { "name": "Known Issue" } ] } ] } }, "TasksCreateExample": { "description": "Example request body for creating a new Task record with standard and custom fields. 'Subject' is mandatory to create a new record in the Tasks module.", "summary": "Create a new Task record", "value": { "data": [ { "Description": "Confirm terms before sending final contract", "Due_Date": "2026-08-28", "Priority": "High", "Status": "In Progress", "Subject": "Follow up on renewal contract", "Tag": [ { "name": "Renewal" } ], "Who_Id": { "id": "5725767000011356002", "name": "Anna Kingsley" } } ] } }, "VendorsCreateExample": { "description": "Example request body for creating a new Vendor record with standard and custom fields. \"Vendor_Name\" is mandatory to create a new record in the Vendors module.", "summary": "Create a new Vendor record", "value": { "data": [ { "Category": "Hardware Supplier", "City": "Trenton", "Country": "USA", "Description": "Primary hardware supplier", "Email": "sales@zylkerhardwares.com", "Owner": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Phone": "555-4455667", "State": "New Jersey", "Street": "88 Industrial Ave", "Tag": [ { "name": "Preferred Vendor" } ], "Vendor_Name": "Zylker Hardwares", "Website": "www.zylkerhardwares.com", "Zip_Code": "08608" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordsInputSchema", "description": "The request body for Records Post" } } }, "description": "To insert a single record, send only one JSON object in the input with the necessary keys and values. Duplicates are checked for every insert record API call based on unique fields. A maximum of 100 records can be inserted per API call. You must use only Field API names in the input. You can obtain the field API names from the [Fields metadata API](fields.yaml#$.paths./settings/fields.get) Choose \"Fields\" from the \"Filter By\" drop-down. In the Calls module, the call duration for an Inbound or Outbound call cannot be zero. For any module, specify all the mandatory fields while creating a record. When inserting multiple records, the Response JSON array maintains the same order as the input records, allowing each response to be mapped to its respective input record. In case of partial success or failure, the API returns an HTTP status 207 (Multi-Status), where individual record-level success or error details are provided within the response array in the same order. You must provide the layout ID field if you want to, include the layout specific mandatory fields in the API-level mandatory check. Include only the fields that are defined in your layout for API-level processing and ignore the rest.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the 201 response for a successfully created record, including the record ID, audit timestamps, and approval state.", "summary": "Successfully created a single record", "value": { "data": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "5725767000000524157" }, "message": "record added", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordSuccessResponse" } } }, "description": "Returns the details of each successfully created record, including the record ID and audit metadata." }, "207": { "content": { "application/json": { "examples": { "MixedResults": { "description": "Shows the 207 multi-status response when one record is created successfully and another fails validation.", "summary": "Mixed create results with one success and one validation error", "value": { "data": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "5725767000000524157" }, "message": "record added", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "Last_Name", "json_path": "$.data[1].Last_Name" }, "message": "the field api name given seems to be invalid", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response returned when a bulk record create operation results in mixed success and failure outcomes.", "properties": { "data": { "allOf": [ { "description": "Ensures the response contains at least one successfully created record in the data array." }, { "description": "Ensures the response contains at least one record create operation that encountered an error in the data array." } ], "description": "Contains the list of per-record results. Each item represents either a successfully created record or an error identified by its **code** value.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordPostSuccessDataItem" }, { "$ref": "#/components/schemas/RecordPostErrorDataItem" } ], "description": "Represents a single record create result, which is either a success item or an error item identified by the **status** field." }, "maxItems": 100, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordsCreateMultiStatusResponse" } } }, "description": "Returns a multi-status response when some record create operations succeed and others fail. Each item in the data array independently reports the outcome for the corresponding record." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows the error response when the user does not have sufficient privileges to create a record in the specified module.", "summary": "Insufficient privileges to create a record", "value": { "data": [ { "code": "AUTHORIZATION_FAILED", "details": { "resource_path_index": 0 }, "message": "User does not have sufficient privilege to perform this action", "status": "error" } ] } }, "DependentFieldMissing": { "description": "Shows the error response when a required dependent field is absent because its triggering field was provided.", "summary": "Required dependent field missing from the request", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Product_Subcategory", "dependee": { "api_name": "Product_Category", "json_path": "$.data[0].Product_Category" }, "json_path": "$.data[0].Product_Subcategory" }, "message": "The field 'Product_Subcategory' is required when 'Product_Category' is provided", "status": "error" } ] } }, "DependentMismatch": { "description": "Shows the error response when the value of a dependent field conflicts with the requirements of its controlling field.", "summary": "Dependent field value conflicts with controlling field", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be greater than current Time.", "status": "error" } ] } }, "DependentServiceError": { "description": "Shows the error response when a dependent external service fails while processing the record create request.", "summary": "Dependent service error during record creation", "value": { "data": [ { "code": "DEPENDENT_SERVICE_ERROR", "details": { "dependency_error": "NO_PERMISSION" }, "message": "The dependent service does not have permission to complete the operation", "status": "error" } ] } }, "DuplicateDataError": { "description": "Shows the error response when a record with the same unique field value already exists in the module.", "summary": "Duplicate field value matches an existing record", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Unique_1", "duplicate_record": { "Owner": { "id": "2008662000000454001", "name": "Pranav", "zuid": "75092197" }, "id": "2008662000006256222" }, "id": "2008662000006256222", "json_path": "$.data[0].Unique_1", "more_records": false }, "message": "duplicate data", "status": "error" } ] } }, "InvalidData": { "description": "Shows the error response when an invalid value is provided for a field in the create request.", "summary": "Invalid field value in the create request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Company", "json_path": "$.data[0].Company" }, "message": "The field value given for Company is invalid", "status": "error" } ] } }, "InvalidDataLength": { "description": "Shows the error response when a field value exceeds the maximum allowed length.", "summary": "Field value exceeds the maximum allowed length", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "json_path": "$.data[0].Number_1", "maximum_length": 2 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataType": { "description": "Shows the error response when a field value does not match the expected data type.", "summary": "Field value has an incorrect data type", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "expected_data_type": "integer", "json_path": "$.data[0].Number_1" }, "message": "invalid data", "status": "error" } ] } }, "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request URL", "value": { "data": [ { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "InvalidRequestMethod": { "description": "Shows the error response when an unsupported HTTP method is used for this endpoint.", "summary": "Unsupported HTTP method for this endpoint", "value": { "data": [ { "code": "INVALID_REQUEST_METHOD", "details": { "resource_path_index": 0 }, "message": "The HTTP request method type is not a valid one.", "status": "error" } ] } }, "InvalidSupportedValue": { "description": "Shows the error response when an unsupported value is provided for a field that only accepts a fixed set of values.", "summary": "Unsupported value for a fixed-value field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.apply_feature_execution[0].name", "supported_values": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ] }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFound": { "description": "Shows the error response when a required field is missing from the create request.", "summary": "Required field missing from the create request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.data.service.id" }, "message": "Service Id Not Found", "status": "error" } ] } }, "MandatoryNotFoundLayoutRule": { "description": "Shows the error response when a field made mandatory by a Layout Rule is absent from the create request. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve Layout IDs.", "summary": "Layout rule mandatory field absent from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Phone", "json_path": "$.data[0].Phone", "layout_rule": { "id": "5410702000000761547", "name": "Layout Rule" } }, "message": "required field not found", "status": "error" } ] } }, "MultipleErrors": { "description": "Shows the error response when a single record has multiple validation failures, such as duplicate values in two different unique fields.", "summary": "Multiple validation errors in a single record", "value": { "data": [ { "code": "MULTIPLE_OR_MULTI_ERRORS", "details": { "errors": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Email", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000000428295", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Email", "more_records": true }, "message": "duplicate data", "status": "error" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "Mobile", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000002432007", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Mobile", "more_records": true }, "message": "duplicate data", "status": "error" } ] }, "message": "Multiple errors in the request", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordsPostErrorResponse" } } }, "description": "The request could not be processed because one or more records contain invalid data or missing required fields. **Resolution:** Each error in the data array identifies the specific record and field that caused the failure. The request must be corrected and resubmitted." }, "401": { "content": { "application/json": { "examples": { "OauthScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required create scope for the requested module.", "summary": "OAuth access token missing the required create scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not have the required scope. **Resolution:** Generate a new access token with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module create permission.", "summary": "User profile lacks module create permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to create records in the specified module. **Resolution:** The CRM administrator must grant the required create permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern. **Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs while processing the request.", "summary": "Unexpected internal server error during record creation", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request. **Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CREATE" ] } ], "summary": "Create records in a specified module", "tags": [ "record" ], "x-zoho-document": "record" }, "put": { "description": "Updates one or more existing records in the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API name and the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field API names.\nA maximum of 100 records can be updated per API call. Use only Field API names in the input. You can update all fields supported by the Insert Records API operation.\nWhen updating multiple records, the response array maintains the same order as the input records, allowing each response to be mapped to its corresponding input record. \nTo update multiple subform records, specify the subform API name as a key within the record and provide the subform records as a JSON array. Use the subform field API names as keys within each subform record. For detailed information on subforms, refer to the [Manipulating Subform using Zoho CRM APIs](https://help.zoho.com/portal/en/community/topic/kaizen-124-accessing-subform-using-zoho-crm-apis).\nUse the [Modules API](modules.yaml#$.paths./settings/modules.get) and [Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the API names of the subform and its fields. To update an existing subform record, include its record ID in the subform JSON array. Use the [Get Records API](record.yaml#$.paths./module.get) with the subform API name to retrieve subform record IDs.\nWhen adding a new subform record, it is appended to the existing records. Passing an empty JSON array for a subform deletes all its records. To delete a specific subform record, specify its record ID and set \"_delete\" to \"null\". Deleting the parent record also deletes all its subform records.\n ", "operationId": "updateRecords", "parameters": [ { "$ref": "#/components/parameters/RecordModule" } ], "requestBody": { "content": { "application/json": { "examples": { "Leads": { "description": "Shows the request body structure for the updateRecords operation.", "summary": "Records retrieved from the Leads module", "value": { "apply_feature_execution": [ { "name": "layout_rules" } ], "data": [ { "Company": "ABC", "Email": "p.daly@zylker.com", "First_Name": "Paul", "Last_Name": "Daly", "Layout": { "id": "554023000002734009" }, "Lead_Source": "Employee Referral", "State": "Texas", "id": "111112000000142001" } ], "skip_feature_execution": [ { "name": "cadences" } ], "trigger": [ "approval", "workflow", "blueprint", "pathfinder", "orchestration" ] } }, "SubformExample": { "description": "Example request body for updating multiple subform records. \"Project_Details\" is the subform API name, and \"Project_Name\", \"Project_Type\", and \"Expected_Budget\" are fields in the subform.", "value": { "data": [ { "Company": "Info Technology", "Last_Name": "Patricia", "Project_Details": [ { "Expected_Budget": 50000, "Project_Name": "Mobile App Development", "Project_Type": "Development" }, { "Expected_Budget": 30000, "Project_Name": "Infrastructure Upgrade", "Project_Type": "Infrastructure" } ], "id": "111112000000142001" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordsPutInputSchema", "description": "Request body containing the updated resource data to modify the existing record." } } }, "description": "The request body must contain a **data** array. You can include a maximum of 100 objects per request. Each object must include an **id** field to identify the record to update.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the successful response for the updateRecords operation, including the record ID and audit metadata.", "summary": "Successfully completed operation", "value": { "data": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "5725767000000524157" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordSuccessResponse" } } }, "description": "Returns the details of each successfully updated records, including the record ID and audit metadata." }, "207": { "content": { "application/json": { "examples": { "MixedResults": { "description": "Shows the 207 multi-status response with a mix of successful and failed records in the data array.", "summary": "Mixed results with success and failure items", "value": { "data": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "111112000000142001" }, "message": "record updated", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "Last_Name", "json_path": "$.data[1].Last_Name" }, "message": "the field api name given seems to be invalid", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response returned when a bulk operation results in mixed success and failure outcomes.", "properties": { "data": { "allOf": [ { "description": "Ensures the response contains at least one successful result in the data array." }, { "description": "Ensures the response contains at least one failed result in the data array." } ], "description": "Contains the list of per-record results for the operation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordPostSuccessDataItem" }, { "$ref": "#/components/schemas/RecordPutErrorDataItem" } ], "description": "Represents a single record operation result, which is either a success or error item identified by the **status** field." }, "maxItems": 100, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordsPutMultiStatusResponse" } } }, "description": "Returns a multi-status response when some record update operations succeed and others fail. Each item in the data array independently reports the outcome for the corresponding record." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows the error response when the user does not have sufficient privileges for this operation.", "summary": "Insufficient privileges for the operation", "value": { "data": [ { "code": "AUTHORIZATION_FAILED", "details": { "resource_path_index": 0 }, "message": "User does not have sufficient privilege to perform this action", "status": "error" } ] } }, "DependentFieldMissing": { "description": "Shows the error response when a required dependent field is absent from the request.", "summary": "Required dependent field missing from the request", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Product_Subcategory", "dependee": { "api_name": "Product_Category", "json_path": "$.data[0].Product_Category" }, "json_path": "$.data[0].Product_Subcategory" }, "message": "The field 'Product_Subcategory' is required when 'Product_Category' is provided", "status": "error" } ] } }, "DependentMismatch": { "description": "Shows the error response when a dependent field value conflicts with its controlling field.", "summary": "Dependent field value conflicts with controlling field", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be greater than current Time.", "status": "error" } ] } }, "DependentServiceError": { "description": "Shows the error response when a dependent external service fails during the operation.", "summary": "Dependent external service error during processing", "value": { "data": [ { "code": "DEPENDENT_SERVICE_ERROR", "details": { "dependency_error": "NO_PERMISSION" }, "message": "The dependent service does not have permission to complete the operation", "status": "error" } ] } }, "DuplicateDataError": { "description": "Shows the error response when a unique field value already exists in the module.", "summary": "Duplicate unique field value matches an existing record", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Unique_1", "duplicate_record": { "Owner": { "id": "2008662000000454001", "name": "Pranav", "zuid": "75092197" }, "id": "2008662000006256222" }, "id": "2008662000006256222", "json_path": "$.data[0].Unique_1", "more_records": false }, "message": "duplicate data", "status": "error" } ] } }, "DuplicateLinkingDataError": { "description": "Shows the error response when duplicate MxN linking field associations are detected.", "summary": "Duplicate MxN linking field association detected", "value": { "data": [ { "code": "DUPLICATE_LINKING_DATA", "details": { "id": "1385235000011590004", "linking_fields": [ "Bugs_MxN", "CM_MxN" ] }, "message": "duplicate association", "status": "error" } ] } }, "InvalidData": { "description": "Shows the error response when invalid data is provided in the request.", "summary": "Invalid field value in the request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Company", "json_path": "$.data[0].Company" }, "message": "The field value given for Company is invalid", "status": "error" } ] } }, "InvalidDataLength": { "description": "Shows the error response when a field value exceeds the maximum allowed length.", "summary": "Field value exceeds the maximum allowed length", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "json_path": "$.data[0].Number_1", "maximum_length": 2 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataType": { "description": "Shows the error response when a field value does not match the expected data type.", "summary": "Field value with an incorrect data type", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "expected_data_type": "integer", "json_path": "$.data[0].Number_1" }, "message": "invalid data", "status": "error" } ] } }, "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request", "value": { "data": [ { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "InvalidRequestMethod": { "description": "Shows the error response when an unsupported HTTP method is used for this endpoint.", "summary": "Unsupported HTTP method for this endpoint", "value": { "data": [ { "code": "INVALID_REQUEST_METHOD", "details": { "resource_path_index": 0 }, "message": "The HTTP request method type is not a valid one.", "status": "error" } ] } }, "InvalidSupportedValue": { "description": "Shows the error response when an unsupported value is provided for a fixed-value field.", "summary": "Unsupported value for a fixed-value field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.apply_feature_execution[0].name", "supported_values": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ] }, "message": "invalid data", "status": "error" } ] } }, "LimitExceededError": { "description": "Shows the error response when the number of records in the request exceeds the allowed limit.", "summary": "Record count exceeds the allowed limit per request", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "data", "maximum_length": 100 }, "message": "count of records in your request exceeds the limit", "status": "error" } ] } }, "MandatoryNotFound": { "description": "Shows the error response when a required field is missing from the request.", "summary": "Required field missing from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.data.service.id" }, "message": "Service Id Not Found", "status": "error" } ] } }, "MandatoryNotFoundLayoutRule": { "description": "Shows the error response when a field made mandatory by a Layout Rule is absent from the update request. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve Layout IDs.", "summary": "Layout rule mandatory field absent from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Phone", "json_path": "$.data[0].Phone", "layout_rule": { "id": "5410702000000761547", "name": "Layout Rule" } }, "message": "required field not found", "status": "error" } ] } }, "MultipleErrors": { "description": "Shows the error response when a single record has multiple validation failures.", "summary": "Multiple validation errors in a single record", "value": { "data": [ { "code": "MULTIPLE_OR_MULTI_ERRORS", "details": { "errors": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Email", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000000428295", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Email", "more_records": true }, "message": "duplicate data", "status": "error" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "Mobile", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000002432007", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Mobile", "more_records": true }, "message": "duplicate data", "status": "error" } ] }, "message": "Multiple errors in the request", "status": "error" } ] } }, "NotApprovedError": { "description": "Shows the error response when the record has not been approved and cannot be modified.", "summary": "Record is not approved and cannot be modified", "value": { "data": [ { "code": "NOT_APPROVED", "details": { "resource_path_index": 1 }, "message": "Cannot update record that is not approved yet", "status": "error" } ] } }, "NotReviewedError": { "description": "Shows the error response when the record is under review and cannot be modified.", "summary": "Record is under review and cannot be modified", "value": { "data": [ { "code": "NOT_REVIEWED", "details": {}, "message": "record in review", "status": "error" } ] } }, "RecordLockedError": { "description": "Shows the error response when the target record is locked and cannot be modified.", "summary": "Record is locked and cannot be modified", "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "api_name": "id", "json_path": "$.data[0].id" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordsPutErrorResponse" } } }, "description": "The request could not be processed because one or more records contain invalid data or missing required fields.\n**Resolution:** Each error in the data array identifies the specific record and field that caused the failure. The request must be corrected and resubmitted." }, "401": { "content": { "application/json": { "examples": { "OauthScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to update records in the specified module.\n**Resolution:** The CRM administrator must grant the required update permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern.\n**Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "412": { "content": { "application/json": { "examples": { "AlreadyModified": { "description": "Shows the 412 error response when the record has been modified after the If-Unmodified-Since timestamp.", "summary": "Record already modified after the specified timestamp", "value": { "data": [ { "code": "ALREADY_MODIFIED", "details": { "Created_By": { "id": "492070000000209017", "name": "Senthilkumar" }, "Created_Time": "2023-04-17T16:23:25+05:30", "Modified_By": { "id": "492070000000209017", "name": "Senthilkumar" }, "Modified_Time": "2023-06-04T12:00:24+05:30", "id": "492070000199308229" }, "message": "record updated time has already passed if-unmodified-since time", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the record has been modified after the If-Unmodified-Since timestamp.", "properties": { "data": { "description": "Contains the list of per-record results for the operation.", "items": { "additionalProperties": false, "description": "Represents a single record operation result, which is either a success or error item identified by the **status** field.", "properties": { "code": { "description": "Contains the list of per-record results for the operation.", "enum": [ "ALREADY_MODIFIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "Created_By": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" }, "name": { "description": "Contains the list of per-record results for the operation.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Contains the list of per-record results for the operation.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" }, "name": { "description": "Contains the list of per-record results for the operation.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Contains the list of per-record results for the operation.", "format": "date-time", "type": "string" }, "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Contains the list of per-record results for the operation.", "type": "string" }, "status": { "description": "Contains the list of per-record results for the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordAlreadyModifiedErrorResponse" } } }, "description": "The record has been modified after the timestamp specified in the If-Unmodified-Since header.\n**Resolution:** The latest version of the record must be retrieved and the update must be resubmitted with the current modification timestamp." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Update records in a specified module", "tags": [ "record" ], "x-zoho-document": "record" } }, "/crm/v8/{module}/actions/add_tags": { "post": { "description": "Associates tags to one or more records in the specified module.", "operationId": "postAddTags", "parameters": [ { "$ref": "#/components/parameters/ParamPathModule" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "ids": "[\"3060320000002538026\"]", "over_write": true, "tags": [ { "color_code": "#F17574", "name": "test" }, { "color_code": "#63C57E", "name": "new" }, { "color_code": "#E7A826", "name": "34ytwerfdgjhfwgerfs" } ] } } }, "schema": { "$ref": "#/components/schemas/PostaddtagsRequest" } } }, "description": "Request body containing the tags to associate and the record IDs." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "data": [ { "code": "SUCCESS", "details": { "affected_data": null, "id": "3060320000002538026", "tags": [ { "color_code": "#F17574", "id": "3060320000000666862", "name": "test" }, { "color_code": "#63C57E", "id": "3060320000000669006", "name": "new" }, { "color_code": "#E7A826", "id": "3060320000000666022", "name": "34ytwerfdgjhfwgerfs" } ] }, "message": "tags updated successfully", "status": "success" } ], "locked_count": "0" } } }, "schema": { "$ref": "#/components/schemas/PostaddtagsResponse200" } } }, "description": "OK - Tags associated successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: tags)", "value": { "code": "INVALID_DATA", "details": { "api_name": "tags", "json_path": "$.tags", "maximum_length": 3 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tags[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tags[*].name", "maximum_length": 25 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: color_code)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "expected_data_type": "text", "json_path": "$.tags[*].color_code" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: color_code)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[*].color_code", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "summary": "Error response with code INVALID_MODULE: the given module is not supported for this api", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "summary": "Error response with code INVALID_REQUEST_METHOD: The http request method type is not a valid one", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "RecordLockedResponse1": { "summary": "Error response with code RECORD_LOCKED: Sorry, you cannot perform this operation as the record is locked.", "value": { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "3060320000002538026" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } }, "RequiredParamMissingResponse1": { "summary": "Error response with code REQUIRED_PARAM_MISSING: One of the expected param is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "module" }, "message": "One of the expected param is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TagsActionsRecordLockedError" }, { "$ref": "#/components/schemas/TagsInvalidDataError" }, { "$ref": "#/components/schemas/TagsActionsInvalidModuleNameError" }, { "$ref": "#/components/schemas/TagsActionsModuleTagsNotSupportedError" }, { "$ref": "#/components/schemas/TagsActionsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/TagsActionsRequiredParamMissingError" }, { "additionalProperties": false, "description": "Wrapped error response with per-tag validation errors", "properties": { "tags": { "description": "Array of error objects for tag field validation failures", "items": { "anyOf": [ { "$ref": "#/components/schemas/TagFieldInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsActionsTagFieldMaxLengthError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PostaddtagsError" }, { "additionalProperties": false, "description": "Permission denied error when attempting bulk tag addition without write access", "properties": { "code": { "description": "Error code", "enum": [ "FAILURE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error context", "type": "object" }, "message": { "description": "Human-readable error message", "enum": [ "permission denied to update records" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PostAddTagsNoWritePermissionError" } ], "description": "Error response for status 400", "x-zs-$id": "PostaddtagsError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax or validation errors. Review the error details and correct the issues before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Leads", "Crm_Implied_Tags_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsActionsNoPermissionError", "description": "Error response for status 403", "x-zs-$id": "PostaddtagsError403" } } }, "description": "Forbidden - The client does not have access rights to perform the operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.ALL" ] } ], "summary": "Add Tags to Records", "tags": [ "tags_actions" ], "x-zoho-document": "tags_actions" } }, "/crm/v8/{module}/actions/assign_territories": { "post": { "description": "To assign one or more territories to multiple records in your Zoho CRM organization.", "operationId": "assignTerritoriesToRecords", "parameters": [ { "$ref": "#/components/parameters/TerritoriesModule", "description": "The API name of the module that contains the records." } ], "requestBody": { "content": { "application/json": { "examples": { "SuccessTerritoryAssign": { "summary": "Assign territories to multiple records", "value": { "data": [ { "Territories": [ { "id": "123456712345623456" }, { "id": "123456712345623467" } ], "id": "record id" }, { "Territories": [ { "id": "123456712345623456" }, { "id": "123456712345623467" } ], "id": "record id" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the records and territories to assign.", "properties": { "data": { "description": "Specify the list of records and their associated territories to assign.", "items": { "additionalProperties": false, "description": "Specify the record ID and the list of territories to assign to that record.", "properties": { "Territories": { "description": "Specify the list of territories to assign to the record. Each object in the array must contain the unique ID of the territory.", "items": { "additionalProperties": false, "description": "Specify a territory to assign to the record.", "properties": { "id": { "description": "Specify the unique ID of the territory to assign to the record.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "id": { "description": "Specify the unique ID of the record for which to assign the territories.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecord", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "id", "Territories" ], "type": "object", "x-zs-$id": "AssignTerritoriesToRecordsRequestDataItem" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "AssignTerritoriesToRecordsRequestBody" }, "x-zs-llm-examples": [ "SuccessTerritoryAssign" ] } }, "description": "The request body must contain a **data** array. You can include a maximum of 10 objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AssignTerritoriesSuccess": { "summary": "Successful territory assignment response", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "5319055000000749946" }, "message": "the territories data updated successfully", "status": "success" }, { "code": "SUCCESS", "details": { "id": "5319055000000749947" }, "message": "the territories data updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryAssignSuccessResponse" } } }, "description": "Returns the list of territory assignment results when territories are assigned immediately to the requested records." }, "202": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Scheduled territory assignment response", "value": { "data": [ { "code": "SCHEDULED", "details": { "id": "2345678234534545", "job_id": "482367546723546372" }, "message": "Territory assignment process scheduled successfully", "status": "success" }, { "code": "SCHEDULED", "details": { "id": "2345678234534545", "job_id": "482367546723546372" }, "message": "Territory assignment process scheduled successfully", "status": "success" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignScheduledResponse" }, { "$ref": "#/components/schemas/TerritoryAssignSuccessResponse" } ], "description": "Represents the response returned when a territory assignment job has been scheduled.", "x-zs-$id": "TerritoryAssignRecordsResponse" } } }, "description": "Returns a multi-status scheduled response indicating that the territory assignment jobs were queued. The **code** field is set to **SCHEDULED**, and the **details** object contains the record ID and job ID for each record." }, "400": { "content": { "application/json": { "examples": { "DuplicateTerritoryError": { "summary": "Duplicate territory ID in the request", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Territories[1].id" }, "message": "Given Territory already exists for that record", "status": "error" } ] } }, "InvalidModuleError": { "summary": "Invalid module name in the request URL", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "the api is not supported for this module", "status": "error" } }, "InvalidRecordIdError": { "summary": "Invalid record ID in the request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": " $.data[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidTerritoryIdError": { "summary": "Invalid territory ID in the request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": " $.data[0].Territories[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "LimitExceededOnAssign": { "summary": "Territory assignment limit exceeded for a record", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Territories", "json_path": "$.data[0].Territories", "limit": 10 }, "message": "Maximum limit of territories for that record exceeds", "status": "error" } ] } }, "MandatoryNotFoundError": { "summary": "Missing mandatory field in the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": " $.data[0].Territories[1].id" }, "message": "required field not found", "status": "error" } ] } }, "TerritoryNotEnabled": { "summary": "Territory feature not enabled for the organization", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignInvalidDataTerritoryId" }, { "$ref": "#/components/schemas/TerritoryAssignInvalidDataOnURL" }, { "$ref": "#/components/schemas/TerritoryAssignMandatoryNotFound" }, { "$ref": "#/components/schemas/TerritoryAssignDuplicateData" }, { "$ref": "#/components/schemas/TerritoryAssignNotSupported" }, { "$ref": "#/components/schemas/TerritoryAssignAlreadyUsed" }, { "$ref": "#/components/schemas/TerritoryAssignRecordLocked" }, { "$ref": "#/components/schemas/TerritoryAssignInvalidDataMaxLen" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/AssignTerritoryAssignErrorDataObject" }, { "$ref": "#/components/schemas/InvalidModule" } ], "description": "Represents the error response for an invalid or failed territory assignment request.", "x-zs-$id": "AssignTerritoryAssignErrorResponse" } } }, "description": "The territory assignment request contains invalid or missing data.\n**Resolution:** All required fields must be present, and the record and territory IDs must be valid and within the configured assignment limits." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure due to an invalid token", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "NoPermissionForTerritoryId": { "summary": "No permission to assign or remove the territory", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "api_name": "id", "json_path": "$.data[0].Territories" }, "message": "User has no permission to add / remove the Territories", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignNoPermission" }, { "$ref": "#/components/schemas/UnauthorizedError" } ], "x-zs-$id": "TerritoryAssignUnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API." }, "403": { "content": { "application/json": { "examples": { "NOPermissionForRecord": { "summary": "No permission to update the record", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "api_name": "id", "json_path": "$.data[0].id" }, "message": "User has no permission to update the record", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryRecordUpdateNoPermission" } ], "x-zs-$id": "TerritoryAssignPermissionDenied" } } }, "description": "The territory feature is not enabled or the user lacks permission to update the record.\n**Resolution:** The CRM administrator must enable the territory feature in the organization settings and grant the required permissions to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Assign territories to multiple records", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Assigns territories to multiple records in the specified module in a single request. The module is passed as a URL path parameter. Returns 202 - assignments are processed asynchronously. To track the asynchronous job status on a record, use getFeatureSpecificInfo (feature_specific_info.json) with features=territory_scheduled_jobs along with the module and record id. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/{module}/actions/change_owner": { "post": { "description": "Updates the owner of multiple records in the module. Note: The module name `Deals` is accepted and internally resolved to `Potentials`. `Meetings` is internally resolved to `Events`.", "operationId": "changeOwnerBulk", "parameters": [ { "$ref": "#/components/parameters/ChangeOwnerModule" }, { "deprecated": true, "description": "Deprecated — use the `ids` array in the request body instead.", "in": "query", "name": "ids", "required": false, "schema": { "maxLength": 9975, "type": "string" } }, { "deprecated": true, "description": "Deprecated — use the `notify` field in the request body instead.", "in": "query", "name": "notify", "required": false, "schema": { "type": "boolean" } }, { "deprecated": true, "description": "Deprecated — use the `owner.id` field in the request body instead.", "in": "query", "name": "owner_id", "required": false, "schema": { "maxLength": 19, "type": "string" } }, { "deprecated": true, "description": "Deprecated — use the `related_modules` array in the request body instead.", "in": "query", "name": "related_modules", "required": false, "schema": { "maxLength": 2000, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "BulkChangeOwnerExample": { "value": { "ids": [ "5725767000000291001", "5725767000000291002" ], "notify": true, "owner": { "id": "5725767000000291003" }, "related_modules": [ { "api_name": "Tasks", "id": "5725767000000293001" }, { "api_name": "Calls", "id": "5725767000000294001" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the record IDs and owner details for the bulk owner change request.", "properties": { "ids": { "description": "Specify the IDs of the records for which you want to change the owner.", "items": { "description": "Specify a record ID.", "maxLength": 19, "type": "string" }, "maxItems": 500, "type": "array" }, "notify": { "description": "Specify whether to notify the new owner via email when the records are assigned.\\nPossible values:\\n**true** - The new owner is notified via email.\\n**false** - The new owner is not notified via email.", "type": [ "boolean", "null" ] }, "owner": { "additionalProperties": false, "description": "Specify the details of the new owner for the records.", "properties": { "id": { "description": "Specify the user ID of the new owner.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "related_modules": { "description": "Specify the related modules for which you want to transfer record ownership along with the main record.", "items": { "additionalProperties": false, "description": "Specify the API name and record ID of a related module record to transfer to the new owner.", "properties": { "api_name": { "description": "Specify the API name of the related module for which the records are transferred.\\nPossible values:\\n**Tasks**\\n**Events**\\n**Calls**\\n**Contacts**\\n**Deals**", "enum": [ "Tasks", "Events", "Calls", "Contacts", "Deals" ], "type": "string" }, "id": { "description": "Specify the record ID of the related module record to transfer to the new owner.", "maxLength": 19, "type": "string" } }, "type": "object" }, "maxItems": 5, "type": "array" } }, "required": [ "ids", "owner" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "value": { "data": [ { "code": "SUCCESS", "details": { "id": "475418000007459055" }, "message": "owner is successfully updated", "status": "success" }, { "code": "SUCCESS", "details": { "id": "475418000007459060" }, "message": "owner is successfully updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful owner change response", "properties": { "data": { "description": "Data containing the result of the owner change operation", "items": { "additionalProperties": false, "description": "Result of the owner change operation for the record", "properties": { "code": { "description": "Response code indicating success", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the updated record", "properties": { "id": { "description": "The ID of the updated record", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Success message", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the operation", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 500, "type": "array" } }, "x-zs-$id": "SuccessResponseBulk" } } }, "description": "Returns the result of the owner change operation for the requested records." }, "202": { "content": { "application/json": { "examples": { "PartialSuccessResponse": { "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4987786000003224001" }, "message": "owner is successfully updated", "status": "success" }, { "code": "CANNOT_PROCESS", "details": { "id": "4987786000003224629", "index": 1 }, "message": "The record is in stop-processing state.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Partial bulk change-owner response returned to direct API callers.", "properties": { "data": { "description": "Per-record outcome array containing a mix of success and error objects.", "items": { "additionalProperties": true, "description": "Per-record outcome entry.", "properties": { "code": { "description": "Outcome code for this record. `SUCCESS` on success; an error code such as `CANNOT_PROCESS`, `NOT_MERGED`, or `CANNOT_PERFORM_ACTION` on failure.", "maxLength": 100, "type": "string" }, "status": { "description": "Status of the operation for this record.", "enum": [ "success", "error" ], "type": "string" } }, "type": "object" }, "maxItems": 500, "type": "array" } }, "x-zs-$id": "BulkChangeOwnerPartialResponseDirect" } } }, "description": "Partial success (direct API calls) — one or more records failed while others succeeded. Same body shape as 207." }, "207": { "content": { "application/json": { "examples": { "PartialSuccessResponse": { "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4987786000003224001" }, "message": "owner is successfully updated", "status": "success" }, { "code": "CANNOT_PROCESS", "details": { "id": "4987786000003224629", "index": 1 }, "message": "The record is in stop-processing state.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Partial bulk change-owner response returned to client SDK callers.", "properties": { "data": { "description": "Per-record outcome array containing a mix of success and error objects.", "items": { "additionalProperties": true, "description": "Per-record outcome entry.", "properties": { "code": { "description": "Outcome code for this record. `SUCCESS` on success; an error code such as `CANNOT_PROCESS`, `NOT_MERGED`, or `CANNOT_PERFORM_ACTION` on failure.", "maxLength": 100, "type": "string" }, "status": { "description": "Status of the operation for this record.", "enum": [ "success", "error" ], "type": "string" } }, "type": "object" }, "maxItems": 500, "type": "array" } }, "x-zs-$id": "BulkChangeOwnerPartialResponseSDK" } } }, "description": "Partial success (client SDK calls) — one or more records failed while others succeeded. Each element in `data` carries an individual `code` and `status` indicating the per-record outcome." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedError": { "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_version": 3 }, "message": "Change Owner is not supported in this API version", "status": "error" } }, "CannotProcessError": { "value": { "code": "CANNOT_PROCESS", "details": { "id": "4987786000003224629", "index": 0 }, "message": "The record is in stop-processing state.", "status": "error" } }, "InactiveOwnerError": { "summary": "New owner's user account is not active", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id", "owner_status": "inactive" }, "message": "The user to whom you are trying to transfer the records is not active.", "status": "error" } }, "InvalidDataError": { "value": { "code": "INVALID_DATA", "details": { "api_name": "owner", "json_path": "$.owner.id" }, "message": "Invalid data provided", "status": "error" } }, "InvalidDataTypeError": { "value": { "data": { "code": "INVALID_DATA", "details": { "api_name": "ids", "expected_data_type": "long", "json_path": "$.ids[1]" }, "message": "invalid data", "status": "error" } } }, "LiteUserOwnerError": { "summary": "New owner is a Lite user", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id" }, "message": "The user to whom you are trying to transfer the records is a Lite User.", "status": "error" } }, "NonSubordinateUser": { "description": "Returned when owner-restriction settings prevent assigning to a non-subordinate user (role hierarchy or territory hierarchy restriction).", "summary": "Owner is not a subordinate of the current user.", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id", "owner_status": "include_subordinate_owners" }, "message": "The user to whom you are trying to transfer the records is not a subordinate.", "status": "error" } }, "NotSupportedError": { "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "The requested operation is not supported", "status": "error" } }, "RecordLockingConflictError": { "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "4987786000003224629" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ] } }, "ServiceProviderOwnerError": { "summary": "New owner is a Service Provider user not allowed for this module", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.owner.id" }, "message": "Service Provider User can only be assigned to tasks, meetings, calls, and appointments", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response for unsupported operations, invalid module, or unsupported API version.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**NOT_SUPPORTED** - The specified module or operation is not supported.\\n**INVALID_DATA** - The input data is invalid.\\n**INVALID_MODULE** - The module API name in the request URL is invalid.\\n**API_NOT_SUPPORTED** - The Change Owner API is not supported in the requested API version (minimum version 3 required for customer calls).", "enum": [ "NOT_SUPPORTED", "INVALID_DATA", "INVALID_MODULE", "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path in the request that caused the error.", "format": "int32", "type": "integer" }, "supported_version": { "description": "Minimum supported API version. Returned with the API_NOT_SUPPORTED error code.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "Errorresponseforunsupportedoperationsorinvalidmodule" }, { "additionalProperties": false, "description": "Represents an error response for invalid data or a mandatory field that was not found.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**INVALID_DATA** - The input data provided is invalid.\\n**NOT_SUPPORTED** - The specified module or operation is not supported.\\n**MANDATORY_NOT_FOUND** - A required field is missing from the request.", "enum": [ "INVALID_DATA", "NOT_SUPPORTED", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the invalid or missing field.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the error.", "maxLength": 500, "type": "string" }, "owner_status": { "description": "Represents the owner-restriction context that triggered the owner validation error. Possible values: **include_subordinate_owners** - Indicates that ownership can be assigned only to users who are subordinates of the current user based on the role or territory hierarchy. **inactive** - Indicates that the new owner's user account is not active. Returned only when the error is caused by a subordinate-owner or inactive-owner permission check.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorresponseforinvaliddataormandatoryfieldnotFound" }, { "additionalProperties": false, "description": "Represents an error response when a required field in the request is missing.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**EXPECTED_FIELD_MISSING** - A required field in the related modules object is missing from the request.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the missing expected fields.", "properties": { "expected_fields": { "description": "Represents the list of expected fields that are missing from the request.", "items": { "additionalProperties": false, "description": "Represents an expected field that is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the missing expected field.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing expected field in the request body.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ErrorresponseformissingexpectedFields" }, { "additionalProperties": false, "description": "Represents an error response when the request contains ambiguous data that cannot be processed.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**AMBIGUITY_DURING_PROCESSING** - The request contains ambiguous data that cannot be resolved.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the ambiguous data in the request.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields that contain ambiguous values in the request.", "items": { "additionalProperties": false, "description": "Represents a field that contains ambiguous data in the request.", "properties": { "api_name": { "description": "Represents the API name of the field containing ambiguous data.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field containing ambiguous data in the request body.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ErrorresponseforambiguousdataduringProcessing" }, { "additionalProperties": false, "description": "Error response for invalid data type in the request", "properties": { "data": { "additionalProperties": false, "description": "Error details for invalid data type.", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the data type mismatch", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 200, "type": "string" }, "expected_data_type": { "description": "Denotes the expected data type of the field.", "maxLength": 50, "type": "string" }, "json_path": { "description": "JSON path to the field that caused the error", "maxLength": 500, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message describing the issue", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ErrorresponseforinvaliddatatypeMismatch" }, { "additionalProperties": false, "description": "Error response when one or more records are locked", "properties": { "data": { "description": "List of records that are locked", "items": { "additionalProperties": false, "description": "Details of a record that is locked", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the locked record", "properties": { "action": { "description": "The action that caused the locking conflict", "maxLength": 100, "type": "string" }, "id": { "description": "Represents the ID of the locked record", "maxLength": 19, "type": "string" } }, "required": [ "action", "id" ], "type": "object" }, "message": { "description": "Inidcates the error message describing the issue", "maxLength": 500, "type": "string" }, "status": { "description": "Denotes the status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 500, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ErrorresponseforRecordLockingConflict" }, { "additionalProperties": false, "description": "Returned (per record) when a record is in a stop-processing state and the Change Owner action is blocked.", "properties": { "code": { "description": "Error code indicating the record is in a stop-processing state. Possible values: **CANNOT_PROCESS** - The record's privacy settings block the Change Owner action.", "enum": [ "CANNOT_PROCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the affected record.", "properties": { "id": { "description": "The ID of the record that is in stop-processing state.", "maxLength": 19, "type": "string" }, "index": { "description": "The zero-based index of the record in the request.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message describing why the Change Owner action was blocked.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseBulkForRecordInStopProcessingState" }, { "additionalProperties": false, "description": "Returned when the new owner is a Service Provider user and the target module does not allow Service Provider ownership.", "properties": { "code": { "description": "Error code indicating the ownership restriction. Possible values: **NOT_ALLOWED** - Service Provider users can only be assigned as owner of Tasks, Events, Calls, and Appointments.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the owner field that caused the error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the error.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message describing the ownership restriction.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseBulkForServiceProviderOwnerRestriction" } ], "x-zs-$id": "BadRequestResponse" } } }, "description": "Invalid request. The module is unsupported, the data is invalid, or a required field is missing.\\n**Resolution:** The module API name in the request URL must be valid, the record IDs must exist, and the owner ID must be specified correctly." }, "403": { "content": { "application/json": { "examples": { "CannotAssignError": { "value": { "code": "CANNOT_ASSIGN", "details": { "permissions": [ "Crm_Implied_Role_View_Leads" ] }, "message": "The user you are trying to assign does not have permission for this module.", "status": "error" } }, "CannotPerformActionError": { "value": { "code": "CANNOT_PERFORM_ACTION", "details": { "id": "4987786000003224629", "index": 0 }, "message": "You do not have permission to change the owner of this record.", "status": "error" } }, "ClosedOrDeletedUserError": { "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id", "owner_status": "deleted" }, "message": "The user to whom you are trying to transfer the records has closed their account.", "status": "error" } }, "NoPermissionError": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Change_Owner_Leads" ] }, "message": "You do not have permission to perform this operation", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response when the user lacks the required permission to change record ownership.", "properties": { "code": { "description": "Represents the error code indicating the cause of the permission failure. \\nPossible values:\\n**NO_PERMISSION** - The user's CRM profile lacks the required permission to change record ownership.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the missing permissions.", "properties": { "permissions": { "description": "Represents the list of required permissions that the user's profile is missing.", "items": { "description": "Represents the name of a required permission that is missing from the user's profile.", "maxLength": 200, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "ErrorresponsewhenuserlacksrequiredPermissions" }, { "additionalProperties": false, "description": "Returned when the new owner lacks view permission for the target module or a specified related module.", "properties": { "code": { "description": "Error code indicating a permission gap on the new owner. Possible values: **CANNOT_ASSIGN** - The new owner does not have view access to the required module.", "enum": [ "CANNOT_ASSIGN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context listing the missing permissions.", "properties": { "permissions": { "description": "List of permissions that the new owner lacks.", "items": { "description": "Name of a missing permission.", "maxLength": 200, "type": "string" }, "maxItems": 10, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Error message describing the missing module permission.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseBulkForTransfereeNoModulePermission" }, { "additionalProperties": false, "description": "Returned (per record in a partial-failure response) when the current user lacks permission to change ownership of a specific record.", "properties": { "code": { "description": "Error code indicating a per-record permission denial. Possible values: **CANNOT_PERFORM_ACTION** - The current user does not have permission to change ownership of this record.", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the record for which the action was denied.", "properties": { "id": { "description": "The ID of the record for which the action was denied.", "maxLength": 19, "type": "string" }, "index": { "description": "The zero-based index of the record in the request.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message describing why the action was denied for this record.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseBulkForRecordPermissionDenied" }, { "additionalProperties": false, "description": "Returned when the target user account is closed or deleted.", "properties": { "code": { "description": "Error code indicating the target user is closed or deleted. Possible values: **INVALID_DATA** - The supplied owner ID refers to a closed or deleted user.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the invalid owner field.", "properties": { "api_name": { "description": "The API name of the field that contains the invalid owner reference.", "maxLength": 200, "type": "string" }, "json_path": { "description": "The JSON path to the field that contains the invalid owner reference.", "maxLength": 500, "type": "string" }, "owner_status": { "description": "Indicates the state of the target user. Possible values: **deleted** - The user account is closed or deleted.", "enum": [ "deleted" ], "type": "string" } }, "required": [ "api_name", "json_path", "owner_status" ], "type": "object" }, "message": { "description": "Error message describing why the owner assignment was rejected.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseBulkForClosedOrDeletedTargetUser" } ], "x-zs-$id": "ForbiddenResponse" } } }, "description": "Permission denied to change record ownership in this module.\\n**Resolution:** The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.change_owner.CREATE" ] } ], "summary": "Change Owner", "tags": [ "change_owner" ], "x-zoho-document": "change_owner" } }, "/crm/v8/{module}/actions/enrol_in_cadences": { "post": { "description": "Enrolls CRM records into one or more cadences.\n**Notes**\n- Only Manual Enrollment cadences can be enrolled through this API.\n- Available only in Enterprise edition and above.\n- Supports Leads, Contacts, Deals, Vendors, and custom modules.\n- A request may contain up to 5 cadence IDs.\n- A request may contain up to 100 record IDs.", "operationId": "postEnrolInCadences", "parameters": [ { "$ref": "#/components/parameters/CadencesExecutionModule" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a sample request with Cadence IDs and record IDs for enrollment into Cadences.", "summary": "Sample enroll records request", "value": { "cadences_ids": [ "534412000002201155", "534412000002201156" ], "ids": [ "1234567890234567", "1234567890456789", "2345678902345678" ] } } }, "schema": { "$ref": "#/components/schemas/PostCadencesRequest" } } }, "description": "The request body must contain a Cadence IDs array and a record IDs array for the enrollment request." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows the successful enrollment result for a record, including the record ID and the associated Cadences.", "summary": "Successful enrollment result", "value": { "data": [ { "code": "SUCCESS", "details": { "cadences": [ { "id": "1234567890456789", "name": "Cadence 1" }, { "id": "1234567890456789", "name": "Cadence 2" } ], "id": "534412000002201155" }, "message": "records manually enrolled", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostcadencesResponse200" } } }, "description": "Returns the enrollment result for all records in the request." }, "202": { "content": { "application/json": { "examples": { "Success202": { "description": "None", "summary": "Enrollment request accepted for background processing", "value": { "data": [ { "code": "SCHEDULED", "details": {}, "message": "Cadence manual enrolment is in progress.", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostcadencesResponse202" } } }, "description": "The enrollment request was accepted and queued for background processing. The response body contains a SCHEDULED status marker." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Shows a multi-status response with one successful and one failed per-record enrollment result.", "summary": "Multi-status response with partial enrollment success", "value": { "data": [ { "code": "SUCCESS", "details": { "cadences": [ { "id": "1234567890456789", "name": "Cadence 1" }, { "id": "1234567890456789", "name": "Cadence 2" } ], "id": "534412000002201155" }, "message": "records manually enrolled", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "ids", "json_path": "$.ids[1]" }, "message": "given id seems to be invalid", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/PostcadencesResponse207" } } }, "description": "Returns a multi-status response when some records were enrolled successfully and others failed. Each item in the data array independently indicates success or failure for the corresponding record." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "Shows the API_NOT_SUPPORTED error returned when a client portal user attempts to call this API.", "summary": "API_NOT_SUPPORTED error for client portal users", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_login_user_type": "Client Portal User" }, "message": "api not supported for client portal user", "status": "error" } }, "ApiNotSupportedResponse2": { "description": "Shows the API_NOT_SUPPORTED error returned when the API is accessed from an unsupported domain.", "summary": "API_NOT_SUPPORTED error for unsupported domain", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_domains": [ "eu", "com", "in", "au", "ca", "cn", "jp" ] }, "message": "api not supported", "status": "error" } }, "InvalidDataResponse1": { "description": "Shows the INVALID_DATA error returned when an entry in the Cadence ID array is invalid, such as exceeding the maximum string length.", "summary": "INVALID_DATA error - invalid entry in Cadence ID array", "value": { "code": "INVALID_DATA", "details": { "api_name": "cadences_ids", "json_path": "$.cadences_ids", "maximum_length": 5 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "description": "None", "summary": "Error response - record IDs expected as an array", "value": { "code": "INVALID_DATA", "details": { "api_name": "ids", "expected_data_type": "jsonarray", "json_path": "$.ids" }, "message": "Record ids not found", "status": "error" } }, "InvalidDataResponse3": { "description": "None", "summary": "Error response - Cadence IDs expected as an array", "value": { "code": "INVALID_DATA", "details": { "api_name": "cadences_ids", "expected_data_type": "jsonarray", "json_path": "$.cadences_ids" }, "message": "Cadences ids not found", "status": "error" } }, "InvalidDataResponse4": { "description": "None", "summary": "Error response - invalid Cadence ID provided", "value": { "code": "INVALID_DATA", "details": { "api_name": "cadences_ids", "json_path": "$.cadences_ids" }, "message": "the given id seems to be invalid", "status": "error" } }, "InvalidDataResponse5": { "description": "None", "summary": "Error response - invalid record ID provided", "value": { "code": "INVALID_DATA", "details": { "api_name": "ids", "json_path": "$.ids" }, "message": "the given id seems to be invalid", "status": "error" } }, "LimitExceededResponse1": { "description": "Shows the LIMIT_EXCEEDED error returned when more than five Cadence IDs are included in the request.", "summary": "LIMIT_EXCEEDED error - Cadence ID array exceeds the limit", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 5, "limit_due_to": [ { "api_name": "cadences_ids", "json_path": "$.cadences_ids" } ] }, "message": "Limit Exceeded, You cannot give more than 5 cadences ids", "status": "error" } }, "LimitExceededResponse2": { "description": "Shows the LIMIT_EXCEEDED error returned when more than 100 record IDs are included in the request.", "summary": "LIMIT_EXCEEDED error for ids exceeding 100", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 100, "limit_due_to": [ { "api_name": "ids", "json_path": "$.ids" } ] }, "message": "Limit Exceeded, You cannot give more than 100 record ids", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "None", "summary": "Error response - record IDs not provided", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "ids", "json_path": "$.ids" }, "message": "Record ids not found", "status": "error" } }, "MandatoryNotFoundResponse2": { "description": "None", "summary": "Error response - Cadence IDs not provided", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "cadences_ids", "json_path": "$.cadences_ids" }, "message": "Cadences ids not found", "status": "error" } }, "NotAllowedResponse1": { "description": "Shows the NOT_ALLOWED error returned when a Cadence ID in the request does not correspond to a manual enrollment Cadence.", "summary": "NOT_ALLOWED error for non-manual Cadence ID", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "cadences_id", "json_path": "$.cadences_id[0]" }, "message": "id given is not manual enrollment cadence", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseApiNotSupportedClientPortal" }, { "$ref": "#/components/schemas/ErrorResponseApiNotSupportedDomain" }, { "$ref": "#/components/schemas/ErrorResponseLimitExceededCadenceIds" }, { "$ref": "#/components/schemas/ErrorResponseLimitExceededRecordIds" }, { "$ref": "#/components/schemas/CadencesExecutionErrorResponseNotAllowed" }, { "$ref": "#/components/schemas/ErrorResponseInvalidDataCadenceIds" }, { "$ref": "#/components/schemas/CadencesExecutionErrorResponseMandatoryNotFound" }, { "$ref": "#/components/schemas/ErrorResponseDataInvalidDataType" }, { "$ref": "#/components/schemas/ErrorResponseDataInvalidId" }, { "$ref": "#/components/schemas/ErrorResponseDataInvalidIdArray" } ], "description": "Represents one of the possible error responses for a 400 Bad Request status, indicating an invalid or unsupported request parameter.", "x-zs-$id": "EnrolCadences400Schema" } } }, "description": "The request could not be processed due to invalid or unsupported input.\n**Resolution:** The record IDs and Cadence IDs must be valid, the API must be accessed from a supported domain, and the specified Cadences must support manual enrollment." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows the NO_PERMISSION error returned when the requesting user's CRM profile lacks the Crm_Implied_Manage_UnEnroll_Series permission.", "summary": "NO_PERMISSION error for missing profile permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_UnEnroll_Series" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse403", "description": "Represents the error response for a 403 Forbidden status, indicating insufficient permissions to perform the enrollment operation." } } }, "description": "The requesting user does not have the required permission to perform Cadence enrollment.\n**Resolution:** The CRM administrator must grant the **Crm_Implied_Manage_UnEnroll_Series** permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.CREATE" ] } ], "summary": "Enroll Records to Cadences", "tags": [ "cadences_execution" ], "x-zoho-document": "cadences_execution", "x-zs-llm-description": "Enrolls the given records into the given manual_enrollment cadences. v8 takes a flat cadences_ids array (by id) and an ids array of record ids. Returns 200 when processed synchronously, 202 when accepted for asynchronous processing, or 207 Multi-Status for mixed per-record outcomes.", "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "/crm/v8/{module}/actions/mass_change_owner": { "get": { "description": "To retrieve the status of a previously scheduled mass change owner job in your Zoho CRM organization. The OAuth scope enforced is specific to the target module (for example, **ZohoCRM.change_owner.leads.READ** for Leads); modules without a dedicated scope fall back to a generic custom-module scope.", "operationId": "getMassChangeOwnerStatus", "parameters": [ { "description": "Specify the API name of the CRM module. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. **Deals** and **Meetings** are normalized internally to **Potentials** and **Events** respectively before the job's module is checked.", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 255, "type": "string" } }, { "$ref": "#/components/parameters/MassChangeOwnerJobId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "JobStatusResponse": { "description": "Shows a **COMPLETED** mass change owner job where all 10 records were successfully updated.", "summary": "An example of a completed mass change owner job with all records updated.", "value": { "data": [ { "Failed_Count": 0, "Not_Updated_Count": 0, "Status": "COMPLETED", "Total_Count": 10, "Updated_Count": 10 } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the job status data returned for a successful retrieval request.", "properties": { "data": { "description": "Contains the job status details for the mass change owner job.", "items": { "additionalProperties": false, "description": "Represents the status and record counts for a mass change owner job.", "properties": { "Failed_Count": { "description": "Represents the number of records for which the ownership change operation failed. ", "format": "int32", "type": "integer" }, "Not_Updated_Count": { "description": "Represents the number of records for which the ownership has not yet been updated. ", "format": "int32", "type": "integer" }, "Status": { "description": "Represents the current status of the mass change\nowner job.\n\nPossible values:\n\n**COMPLETED** - The job is finished successfully.\n\n**SCHEDULED** - The job is queued and has not\nstarted processing yet.\n\n**FAILED** - The job did not complete successfully.\n", "enum": [ "COMPLETED", "SCHEDULED", "FAILED" ], "type": "string" }, "Total_Count": { "description": "Represents the total number of records that were processed by the mass change owner job.", "format": "int32", "type": "integer" }, "Updated_Count": { "description": "Represents the number of records for which the ownership was successfully updated. ", "format": "int32", "type": "integer" } }, "required": [ "Status", "Failed_Count", "Not_Updated_Count", "Updated_Count", "Total_Count" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "JobStatusResponse" } } }, "description": "Returns the status details of the mass change owner job identified by the specified job ID." }, "204": { "content": { "application/json": { "examples": { "NoDataFound": { "description": "Shows the error body returned when no job data could be found for the specified job ID.", "summary": "Example of no job data found for the specified job ID.", "value": { "code": "NO_DATA", "message": "there is no data to show" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when no job data could be found for the specified job ID.", "properties": { "code": { "description": "Represents the error code for the response.\n\nPossible values:\n\n**NO_DATA** - No job data was found for the specified\njob ID.\n", "enum": [ "NO_DATA" ], "type": "string" }, "message": { "description": "Represents the message describing the absence of job data.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message" ], "type": "object", "x-zs-$id": "Errorresponsewhennocontentfoundforjob" } } }, "description": "Returned when the specified job ID does not correspond to any mass change owner job, whether currently scheduled or aged out of the live job store (jobs older than 60 days are looked up from the audit log). Despite the 204 status, the response carries a JSON error body." }, "400": { "content": { "application/json": { "examples": { "RequiredParamMissing": { "description": "Shows the error returned when the required **job_id** query parameter is missing from the request.", "summary": "An example of the missing job_id query parameter in request.", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "job_id" }, "message": "Required parameter is missing", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the **job_id** query parameter is missing from the request.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**REQUIRED_PARAM_MISSING** - A required query parameter is\nmissing.\n", "enum": [ "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the missing parameter. ", "properties": { "param_name": { "description": "Represents the name of the missing required query parameter. ", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue. ", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponseformissingrequiredqueryparamete" } } }, "description": "The **job_id** query parameter is missing from the request. \nResolution: The request must include a valid **job_id** obtained from the response of the previous [Mass Change Owner API](mass_change_owner.yaml#$.paths./{module}/actions/mass_change_owner.post) call.\n" }, "404": { "content": { "application/json": { "examples": { "JobBelongsToAnotherModule": { "description": "Shows the error returned when the job ID was scheduled for a different module than the one specified in the request. The exact **code**/**message** values are illustrative and should be confirmed against the live response before relying on them.", "summary": "Example of a job ID belonging to a different module.", "value": { "code": "NOT_FOUND", "details": {}, "message": "The specified job does not belong to this module", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the job ID belongs to a mass change owner job scheduled for a different module than the one specified in the request.", "properties": { "code": { "description": "Represents the error code for the failed request. May be absent when the underlying exception does not populate an error code.", "maxLength": 255, "type": [ "string", "null" ] }, "details": { "additionalProperties": false, "description": "Represents the additional error details, if any.", "type": "object" }, "message": { "description": "Represents the error message describing the module mismatch. May be absent when the underlying exception does not populate an error message.", "maxLength": 255, "type": [ "string", "null" ] }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status" ], "type": "object", "x-zs-$id": "Errorresponsewhenjobbelongstoanothermodule" } } }, "description": "Returned when the specified job ID corresponds to a mass change owner job that was scheduled for a different module than the one specified in the **module** path parameter. This module check is only performed while the job is still tracked by the live job scheduler; once a job ages out of the live store (see the 60-day retention note above), a module mismatch on an older job instead returns **204** with the **NO_DATA** body, not this 404." } }, "security": [ { "OAuth2": [ "ZohoCRM.change_owner.READ" ] } ], "summary": "Get mass change owner job status", "tags": [ "mass_change_owner" ], "x-zoho-document": "mass_change_owner" }, "post": { "description": "To bulk update the ownership of records in a specified module based on a Custom View, territory, or field-based criteria in your Zoho CRM organization. You cannot change the owner of related records using this API. You can change the owner of up to 50,000 records in a custom view. This API schedules the operation as a job and returns a job ID, which you can use to check the job status. Job statuses are available for up to 60 days. The Mass Change Owner API is available only in the Enterprise and Ultimate editions. The OAuth scope enforced is specific to the target module (for example, **ZohoCRM.change_owner.leads.CREATE** for Leads); modules without a dedicated scope fall back to a generic custom-module scope.", "operationId": "massChangeOwner", "parameters": [ { "$ref": "#/components/parameters/MassChangeOwnerModule" } ], "requestBody": { "content": { "application/json": { "examples": { "MassChangeOwnerExample": { "description": "Shows a mass change owner request that reassigns records in the Deals module matching the **Stage = Qualification** criteria within a territory and its child territories.", "summary": "An example of mass change owner request with territory and criteria filter.", "value": { "criteria": { "comparator": "equal", "field": { "api_name": "Stage", "id": "2423488000000000525" }, "value": "Qualification" }, "cvid": "2423488000000091545", "owner": { "id": "2423488000000483001" }, "territory": { "id": "2423488000000780003", "include_child": true } } } }, "schema": { "additionalProperties": false, "description": "Specify the details for the mass change owner operation, including the target Custom View, the new owner, an optional territory, and an optional criteria filter.", "properties": { "criteria": { "additionalProperties": false, "description": "Specify the criteria to filter which records are included in the ownership change.", "properties": { "comparator": { "description": "Specify the comparison operator for the criteria.\n\nPossible values:\n\n**equal** - Matches records where the field equals the\nspecified value.\n\n**not_equal** - Matches records where the field does not\nequal the specified value.\n\n**starts_with** - Matches records where the field starts\nwith the specified value.\n\n**ends_with** - Matches records where the field ends\nwith the specified value.\n\n**greater_than** - Matches records where the field is\ngreater than the specified value.\n\n**less_than** - Matches records where the field is less\nthan the specified value.\n\n**greater_equal** - Matches records where the field is\ngreater than or equal to the specified value.\n\n**less_equal** - Matches records where the field is less\nthan or equal to the specified value.\n\n**between** - Matches records where the field value\nfalls within a specified range.\n\n**not_between** - Matches records where the field value\nfalls outside a specified range.\n", "enum": [ "equal", "ends_with", "not_equal", "greater_than", "less_than", "not_between", "starts_with", "between", "less_equal", "greater_equal" ], "type": "string" }, "field": { "additionalProperties": false, "description": "Specify the module field on which the criteria condition applies.", "properties": { "api_name": { "description": "Specify the API name of the field. Refer to the [Get Fields](fields.yaml#$.paths./settings/fields.get) resource for valid values.", "maxLength": 255, "type": "string" }, "id": { "description": "Specify the unique ID of the field. Refer to the [Get Fields](fields.yaml#$.paths./settings/fields.get) resource for valid values.", "maxLength": 19, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "value": { "description": "Specify the value to compare against the field using the criteria comparator.", "maxLength": 255, "type": "string" } }, "required": [ "field", "comparator", "value" ], "type": "object", "x-zs-$id": "ValueBasedCriteria" }, "cvid": { "description": "Specify the unique ID of the Custom View whose records are to be reassigned. Refer to the [Get Custom Views](custom_views.yaml#$.paths./settings/custom_views.get) resource for valid values.", "maxLength": 19, "type": "string" }, "owner": { "additionalProperties": false, "description": "Specify the details of the user to assign as the new owner of the selected records.", "properties": { "id": { "description": "Specify the unique ID of the user to assign as the new owner. Refer to the [Get Users](users.yaml#$.paths./users.get) resource for valid values.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "territory": { "additionalProperties": false, "description": "Specify the territory to use as the source of records for the ownership change.", "properties": { "id": { "description": "Specify the unique ID of the territory. Refer to the [Get Territories](territories.yaml#$.paths./settings/territories.get) resource for valid values.", "maxLength": 19, "type": "string" }, "include_child": { "description": "Specify whether to include records from child\nterritories of the specified territory in the ownership\nchange.\n\nPossible values:\n\n**true** - Include records from child territories.\n\n**false** - Restrict to records in the specified\nterritory only.\n", "type": [ "boolean", "null" ] } }, "required": [ "id" ], "type": "object" } }, "required": [ "cvid", "owner" ], "type": "object" } } }, "description": "The request body contains the data required to perform the operation.", "required": true }, "responses": { "202": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows the successful response when the mass change owner request is accepted and a job is scheduled.", "summary": "Example of a successful mass change owner job scheduling.", "value": { "data": [ { "code": "SCHEDULED", "details": { "job_id": "2423488000001234567" }, "message": "change owner is successfully scheduled", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the details of the scheduled ownership change job.", "properties": { "data": { "description": "Contains the job scheduling details returned when the mass change owner request is accepted.", "items": { "additionalProperties": false, "description": "Represents the details of the scheduled mass change owner job.", "properties": { "code": { "description": "Represents the response code for the scheduled job.\n\nPossible values:\n\n**SCHEDULED** - The mass change owner job is\nsuccessfully scheduled.\n", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the scheduled mass change owner job. ", "properties": { "job_id": { "description": "Represents the unique ID of the scheduled mass change owner job.", "maxLength": 19, "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the response message for the scheduled job.", "enum": [ "change owner is successfully scheduled" ], "type": "string" }, "status": { "description": "Represents the status of the mass change owner\noperation.\n\nPossible values:\n\n**success** - The mass change owner job was\nsuccessfully scheduled.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ErrorResponse202" } } }, "description": "Returns the job details after the mass change owner request is accepted and scheduled for processing." }, "400": { "content": { "application/json": { "examples": { "AmbiguityDuringProcessing": { "description": "Shows the error returned when both **criteria.field.id** and **criteria.field.api_name** are provided, creating an ambiguity in the field specification.", "summary": "Example of ambiguous criteria field with both id and api_name provided.", "value": { "code": "AMBIGUITY_DURING_PROCESSING", "details": { "ambiguity_due_to": [ { "api_name": "id", "json_path": "$.criteria.field.id" }, { "api_name": "api_name", "json_path": "$.criteria.field.api_name" } ] }, "message": "required field not found", "status": "error" } }, "CombinedCriteriaLimitExceeded": { "description": "Shows the error returned when the combined number of criteria conditions in the Custom View and the request **criteria** exceeds the limit of 25.", "summary": "Example of combined criteria count exceeding the limit of 25.", "value": { "code": "COMBINED_CRITERIA_LIMIT_EXCEEDED", "details": { "limit": 25 }, "message": "Given CVID has more than 25 criteria, so change owner not done.", "status": "error" } }, "DependentFieldMissing": { "description": "Shows the error returned when the criteria object includes a field reference but is missing the required **comparator** or **value** property.", "summary": "Example of missing dependent comparator or value in criteria.", "value": { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "field|comparator|value", "dependee": { "api_name": "field", "json_path": "$.criteria.field" }, "json_path": "$." }, "message": "Dependent Field missing", "status": "error" } }, "ExpectedFieldMissing": { "description": "Shows the error returned when the criteria object does not include a required **group** or **field** property.", "summary": "Example of missing required field or group in criteria object.", "value": { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "group", "json_path": "$.criteria.group" }, { "api_name": "field", "json_path": "$.criteria.field" } ] }, "message": "Specify atleast one field", "status": "error" } }, "InvalidDataExpectedField": { "description": "Shows the error returned when **criteria.field** is not provided as a JSON object.", "summary": "Example of criteria field value provided as wrong data type.", "value": { "code": "INVALID_DATA", "details": { "api_name": "field", "expected_data_type": "jsonobject", "json_path": "$.criteria.field" }, "message": "the value given is invalid", "status": "error" } }, "InvalidDataOwnerStatus": { "description": "Shows the error returned when the specified owner ID belongs to a user who is not a CRM user.", "summary": "An example of a specified owner not being a CRM user.", "value": { "code": "INVALID_DATA", "details": { "api_name": "owner", "json_path": "$.owner.id", "owner_status": "not_crm_user" }, "message": "Invalid data provided", "status": "error" } }, "MandatoryNotFound": { "description": "Shows the error returned when the required **cvid** parameter is missing from the request.", "summary": "An example of missing required cvid parameter.", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "cvid", "json_path": "$.cvid" }, "message": "Required field is missing", "status": "error" } }, "NonSubordinateUser": { "description": "Shows the error returned when the target owner is not a valid subordinate of the current user. This can occur when the 'List subordinates only' (role-based) or 'Territories and Sub-Territory Users Only' (territory-based) permission setting is enabled.", "summary": "Example of a non-subordinate user assigned as new owner.", "value": { "code": "INVALID_DATA", "details": { "param_name": "owner_id" }, "message": "The user to whom you are trying to transfer the records is not a subordinate user.", "status": "error" } }, "NotAllowedServiceProviderOwner": { "description": "Shows the error returned when the new owner specified is a Service Provider user, who can only be assigned ownership of Tasks, Meetings, Calls, and Appointments records.", "summary": "Example of assigning ownership to a Service Provider user outside allowed modules.", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.owner.id" }, "message": "Service Provider User can only be assigned to tasks, meetings, calls, and appointments", "status": "error" } }, "RecordLimitExceeded": { "description": "Shows the error returned when the number of records in the Custom View exceeds the limit of 50,000.", "summary": "Example of custom view record count exceeding the 50,000 limit.", "value": { "code": "RECORD_LIMIT_EXCEEDED", "details": { "limit": 50000 }, "message": "The number of records exceeds the limit", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when a required field is missing from the request.", "properties": { "code": { "description": "Represents the error code for the failed request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the missing field.", "properties": { "api_name": { "description": "Represents the API name of the missing required field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing required field in the request body.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing required field.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponseformissingmandatoryfields" }, { "additionalProperties": false, "description": "Represents the error response returned when the provided data is invalid or the operation is not supported for the specified module.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**INVALID_DATA** - The provided data is invalid.\n\n**NOT_SUPPORTED** - The operation is not supported for\nthis module.\n", "enum": [ "INVALID_DATA", "NOT_SUPPORTED" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error detail containing the API name of the invalid field.", "properties": { "api_name": { "description": "Represents the API name of the invalid field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "Detailsabouttheinvalidfield" }, { "additionalProperties": false, "description": "Represents the error detail containing the JSON path to the invalid field.", "properties": { "json_path": { "description": "Represents the JSON path to the invalid field in the request body.", "maxLength": 255, "type": "string" } }, "required": [ "json_path" ], "type": "object", "x-zs-$id": "DetailsabouttheinvalidfieldJson" }, { "additionalProperties": false, "description": "Represents the error detail containing the index of the invalid segment in the request URL path.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid segment in the request URL path.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "Detailsaboutinvalidresourcepath" }, { "additionalProperties": false, "description": "Represents the error detail returned when the specified owner user is invalid, deleted, or inactive.", "properties": { "api_name": { "description": "Represents the API name of the field in which the invalid owner ID was provided.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in which the invalid owner ID was provided.", "maxLength": 255, "type": "string" }, "owner_status": { "description": "Represents the status of the specified owner\nuser.\n\nPossible values:\n\n**not_crm_user** - The specified user is not a\nCRM user.\n\n**deleted** - The specified user account is\ndeleted.\n\n**inactive** - The specified user account is\ninactive.\n", "enum": [ "not_crm_user", "deleted", "inactive" ], "type": "string" } }, "required": [ "owner_status", "api_name", "json_path" ], "type": "object", "x-zs-$id": "Whenthegivenowneridisnotvalid" }, { "additionalProperties": false, "description": "Represents the error detail returned when a field value has an unexpected data type.", "properties": { "api_name": { "description": "Represents the API name of the field with the data type mismatch.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the expected data type for the field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field with the data type mismatch.", "maxLength": 255, "type": "string" } }, "required": [ "expected_data_type", "api_name", "json_path" ], "type": "object", "x-zs-$id": "Detailsaboutexpecteddatatypemismatch" } ], "description": "Represents the additional error details about the invalid data or unsupported operation." }, "message": { "description": "Represents the error message describing the invalid data or unsupported module.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "Errorresponseforinvaliddataormodule" }, { "additionalProperties": false, "description": "Represents the error response returned when the number of records in the Custom View exceeds the allowed limit.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**RECORD_LIMIT_EXCEEDED** - The number of records in\nthe Custom View exceeds the allowed limit.\n", "enum": [ "RECORD_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the exceeded record limit.", "properties": { "limit": { "description": "Represents the maximum number of records allowed per ownership change request.", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the record count limit exceeded.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "Errorresponsewhenrecordlimitisexceeded" }, { "additionalProperties": false, "description": "Represents the error response returned when the combined number of criteria across the Custom View and the request body exceeds the allowed limit.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**COMBINED_CRITERIA_LIMIT_EXCEEDED** - The combined\nnumber of criteria in the Custom View and the request\n**criteria** exceeds the allowed limit of 25.\n", "enum": [ "COMBINED_CRITERIA_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the exceeded combined criteria limit.", "properties": { "limit": { "description": "Represents the maximum combined criteria count allowed across the Custom View and the request body.", "format": "int32", "type": "integer" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the exceeded combined criteria limit.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "Errorresponsewhencombinedcriterialimitisexceeded" }, { "additionalProperties": false, "description": "Represents the error response returned when the specified new owner is a Service Provider user who cannot own records in this module.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**NOT_ALLOWED** - The specified owner is a Service\nProvider user who can only own records in the Tasks,\nEvents, Calls, and Appointments modules.\n", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the disallowed owner assignment.", "properties": { "api_name": { "description": "Represents the API name of the field carrying the disallowed owner.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the disallowed owner field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the disallowed ownership assignment.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponsewhenownerisaserviceprovideruser" }, { "additionalProperties": false, "description": "Represents the error response returned when required fields are missing from the criteria object.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**EXPECTED_FIELD_MISSING** - A required field is\nmissing from the criteria object.\n", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the missing criteria fields.", "properties": { "expected_fields": { "description": "Represents the list of expected fields that are missing from the criteria object.", "items": { "additionalProperties": false, "description": "Represents an expected field that is missing from the criteria object.", "properties": { "api_name": { "description": "Represents the API name of the missing expected field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing expected field.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing criteria fields.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponsewhenexpectedfieldsaremissingincriteria" }, { "additionalProperties": false, "description": "Represents the error response returned when both the field ID and API name are provided, causing ambiguity.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**AMBIGUITY_DURING_PROCESSING** - Both the field ID\nand API name were provided, causing ambiguity.\n", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the ambiguous field specification.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields that caused the ambiguity.", "items": { "additionalProperties": false, "description": "Represents a field that contributed to the ambiguous specification.", "properties": { "api_name": { "description": "Represents the API name of the field that caused ambiguity.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that caused ambiguity.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 2, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message describing the ambiguity in the field specification.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponsewhenambiguousfieldsareprovided" }, { "additionalProperties": false, "description": "Represents the error response returned when a required dependent field is missing or does not match the expected value.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**DEPENDENT_FIELD_MISSING** - A required dependent\nfield is missing from the criteria.\n\n**DEPENDENT_MISMATCH** - A dependent field value does\nnot match the expected value.\n", "enum": [ "DEPENDENT_FIELD_MISSING", "DEPENDENT_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the missing or mismatched dependent field.", "properties": { "api_name": { "description": "Represents the API name of the missing or mismatched dependent field.", "maxLength": 255, "type": "string" }, "dependee": { "additionalProperties": false, "description": "Represents the details of the field that requires the missing dependent field.", "properties": { "api_name": { "description": "Represents the API name of the field that requires the dependent field.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that requires the dependent field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the missing or mismatched dependent field.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "json_path", "dependee" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing or mismatched dependent field.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponseformissingdependentfields" }, { "additionalProperties": false, "description": "Represents the error response returned when the specified owner is not a valid subordinate of the current user.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**INVALID_DATA** - The specified owner is not a valid\nsubordinate user.\n", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the invalid owner parameter.", "properties": { "param_name": { "description": "Represents the name of the parameter that triggered the validation error.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the subordinate user validation failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "Errorresponsefornonsubordinateuserownerchange" } ], "description": "Represents one of the possible error responses returned when the mass change owner request fails due to invalid or missing parameters.", "x-zs-$id": "MultiResponse400" } } }, "description": "The mass change owner request failed due to invalid or missing\ninput. Resolution: Review the error details in the response to\nidentify and correct the specific validation issue.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error returned when the current user lacks the Mass Transfer permission for the module.", "summary": "Example of missing mass-transfer permission for the module.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "MASSTRANSFER_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the current user lacks the Mass Transfer permission required to change ownership in the specified module.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**NO_PERMISSION** - The current user does not have\npermission to change ownership of records in this\nmodule.\n", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the missing permission.", "properties": { "permissions": { "description": "Represents the list of permission keys required to perform this operation.", "items": { "description": "Represents a permission key required to perform this operation.", "maxLength": 255, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing permission.", "enum": [ "permission denied" ], "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponsewhenusermissingmasstransferpermission" } } }, "description": "The current user does not have permission to change record ownership in the specified module.\nResolution: Request the Mass Transfer (change owner) permission for this module from your CRM administrator.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.change_owner.CREATE" ] } ], "summary": "Submit mass change owner job", "tags": [ "mass_change_owner" ], "x-zoho-document": "mass_change_owner" } }, "/crm/v8/{module}/actions/mass_delete": { "get": { "description": "To retrieve the status and record counts of a previously scheduled mass delete job in your Zoho CRM organization.", "operationId": "getMassDeleteJobStatus", "parameters": [ { "$ref": "#/components/parameters/MassDeleteModule" }, { "description": "Specify the job ID returned in the response of the [Mass Delete API](mass_delete.yaml#$.paths./{module}/actions/mass_delete.post).", "in": "query", "name": "job_id", "required": true, "schema": { "format": "string", "pattern": "^[0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "CompletedJob": { "description": "Shows the status response for a completed mass delete job where all targeted records were successfully deleted.", "summary": "An example of completed mass delete job with all records deleted.", "value": { "data": [ { "Deleted_Count": 18, "Failed_Count": 0, "Status": "COMPLETED", "Total_Count": 18 } ] } }, "InProgressJob": { "description": "Shows the status response when a mass delete job is currently running, with a portion of the targeted records already deleted.", "summary": "An example of mass delete job currently in progress.", "value": { "data": [ { "Deleted_Count": 12, "Failed_Count": 0, "Status": "RUNNING", "Total_Count": 18 } ] } }, "PartialFailure": { "description": "Shows the status response for a completed mass delete job where some records were successfully deleted and others failed.", "summary": "Example of mass delete job completed with some record failures.", "value": { "data": [ { "Deleted_Count": 15, "Failed_Count": 3, "Status": "COMPLETED", "Total_Count": 18 } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response payload for a successful mass delete job status retrieval.", "properties": { "data": { "description": "Contains the mass delete job status details. ", "items": { "additionalProperties": false, "description": "Represents an individual mass delete job status object, including the current status and record counts.", "properties": { "Deleted_Count": { "description": "Represents the number of records successfully deleted by the mass delete job. ", "format": "int32", "minimum": 0, "type": "integer" }, "Failed_Count": { "description": "Represents the number of records that could not be deleted by the mass delete job. ", "format": "int32", "minimum": 0, "type": "integer" }, "Status": { "description": "Represents the current status of the mass delete\njob. \n\nPossible values:\n\n**COMPLETED** - The job has finished processing all\nrecords.\n\n**SCHEDULED** - The job is scheduled and waiting to\nstart.\n\n**QUEUED** - The job is in the queue awaiting\nprocessing.\n\n**RUNNING** - The job is currently in progress.\n\n**SUSPENDED** - The job has been paused.\n\n**FAILED** - The job ended with an error and did not\ncomplete.\n", "enum": [ "COMPLETED", "SCHEDULED", "QUEUED", "RUNNING", "SUSPENDED", "FAILED" ], "type": "string" }, "Total_Count": { "description": "Represents the total number of records targeted for deletion by the mass delete job. ", "format": "int32", "minimum": 0, "type": "integer" } }, "required": [ "Status", "Total_Count", "Deleted_Count", "Failed_Count" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "GetMassDeleteSuccess" } } }, "description": "Returns the current status and record counts of the requested mass delete job." }, "400": { "content": { "application/json": { "examples": { "InvalidJobIdFormat": { "description": "Shows the error response when the **job_id** query parameter value does not match a valid job ID.", "summary": "An example of invalid job_id format (non-numeric).", "value": { "code": "INVALID_DATA", "details": { "param_name": "job_id" }, "message": "The jobid given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows the error response when the module API name specified in the request path is invalid.", "summary": "An example of invalid module name in path.", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "MissingJobId": { "description": "Shows the error response when the required **job_id** query parameter is not included in the request.", "summary": "An example of missing required job_id parameter.", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "param_name": "job_id" }, "message": "mandatory param missing", "status": "error" } }, "UnableToParseJobId": { "description": "Shows the error response when the **job_id** parameter value cannot be parsed due to an invalid data format.", "summary": "An example of non-numeric job_id causing parse failure.", "value": { "code": "UNABLE_TO_PARSE_DATA_TYPE", "details": {}, "message": "either the request body or parameters is in wrong format", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response when the required **job_id** query parameter is missing from the request.", "properties": { "code": { "const": "MANDATORY_NOT_FOUND", "description": "Represents the error code for the response.", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error, including the name of the missing parameter. ", "properties": { "param_name": { "const": "job_id", "description": "Represents the name of the missing required query parameter. ", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "const": "mandatory param missing", "description": "Represents the error message for the response. ", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteMandatoryNotFoundObject" }, { "additionalProperties": false, "description": "Represents the error response when the **job_id** value is invalid or does not refer to an existing mass delete job.", "properties": { "code": { "const": "INVALID_DATA", "description": "Represents the error code for the response.", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error, including the name of the invalid parameter. ", "properties": { "param_name": { "const": "job_id", "description": "Represents the name of the invalid query parameter. ", "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "const": "The jobid given seems to be invalid", "description": "Represents the error message for the response. ", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response.", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusInvalidJobIdObject" }, { "additionalProperties": false, "description": "Represents the error response when the module name in the request path is invalid.", "properties": { "code": { "const": "INVALID_MODULE", "description": "Represents the error code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error, including the index of the invalid path segment. ", "properties": { "resource_path_index": { "const": 0, "description": "Represents the index of the resource path segment that contains the invalid module name. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "const": "the module name given seems to be invalid", "description": "Represents the error message for the response. ", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response.", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "GetMassDeleteInvalidModuleObject" }, { "additionalProperties": false, "description": "Represents the error response when the **job_id** parameter value cannot be parsed due to an invalid format.", "properties": { "code": { "const": "UNABLE_TO_PARSE_DATA_TYPE", "description": "Represents the error code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error. ", "type": "object" }, "message": { "const": "either the request body or parameters is in wrong format", "description": "Represents the error message for the response.", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "GetMassDeleteUnableToParseObject" } ], "description": "Represents the error response payload for an invalid request. Contains one of the possible error scenarios.", "x-zs-$id": "GetMassDeleteBadrequest" } } }, "description": "The request is invalid due to a missing or invalid inputs.\n\n**Resolution:** The **job_id** query parameter is mandatory, and the\nmodule API name in the request path must be valid.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.mass_delete.READ" ] } ], "summary": "Retrieve mass delete job status", "tags": [ "mass_delete" ], "x-zoho-document": "mass_delete" }, "post": { "description": "To delete records in bulk from a specified module in your Zoho CRM organization, either by providing record IDs for synchronous deletion or a Custom View ID for asynchronous batch deletion.", "operationId": "massDelete", "parameters": [ { "$ref": "#/components/parameters/MassDeleteModule" } ], "requestBody": { "content": { "application/json": { "examples": { "CVIDAndTerritory": { "description": "Shows a mass delete operation using a Custom View ID with a territory filter applied.", "summary": "An example of mass delete operation using Custom View ID and territory filter.", "value": { "cvid": "3652397000000538003", "territory": { "id": "3652397000007622003", "include_child": true } } }, "MultipleIds": { "description": "Shows a mass delete operation that specifies a list of record IDs to delete.", "summary": "An example of mass delete operation using multiple record IDs.", "value": { "ids": [ "1990117000035827873", "1990117000035107169", "1990117000035107158", "1990117000035107147", "1990117000035107136", "1990117000035107125", "1990117000035107114", "1990117000035107103", "1990117000035107092", "1990117000035107081" ] } } }, "schema": { "additionalProperties": false, "anyOf": [ { "additionalProperties": false, "description": "Specify record IDs to delete in bulk. This variant requires the **ids** array and does not allow **cvid** or **territory**.", "properties": { "ids": { "description": "Specify the list of record IDs to delete. Use the [Get Records API](record.yaml#$.paths./{module}.get) to get the valid record values. ", "items": { "description": "Specify a unique record ID to delete.", "format": "string", "pattern": "^[0-9]+$", "type": "string" }, "maxItems": 500, "minItems": 1, "type": "array" } }, "required": [ "ids" ], "type": "object", "x-zs-$id": "MassDeleteIdsRequest" }, { "additionalProperties": false, "description": "Specify a Custom View ID to delete all records from that view. You can also include a **territory** filter if required. If **cvid** is provided the API does not accept the **ids** array.", "properties": { "cvid": { "description": "Specify the unique ID of the Custom View for which you want to delete records. Refer to the [Get Custom Views](custom_views.yaml#$.paths./settings/custom_views.get) resource for valid values.", "format": "string", "pattern": "^[0-9]+$", "type": "string" }, "territory": { "additionalProperties": false, "description": "Specify the territory filter to restrict the delete operation to records within a specific territory. Only valid when using **cvid**.", "properties": { "id": { "description": "Specify the unique ID of the territory for which you want to delete records. Refer to the [Get Territories](territories.yaml#$.paths./settings/territories.get) resource for valid values.", "format": "string", "pattern": "^[0-9]+$", "type": "string" }, "include_child": { "description": "Specify whether to include records from child\nterritories in the delete operation.\n\nPossible values:\n\n**true** - Include records from child territories.\n\n**false** - Restrict the delete operation to records\nin the specified territory only.\n", "type": "boolean" } }, "required": [ "id" ], "type": "object" } }, "required": [ "cvid" ], "type": "object", "x-zs-$id": "MassDeleteCvidRequest" } ], "description": "Specify either a list of record IDs or a Custom View ID to identify the records to delete. Use the **territory** property to filter by territory when using a Custom View ID.", "properties": { "cvid": { "description": "Specify the unique ID of the Custom View for which you want\nto delete records. Use the [Get Custom\nViews](custom_views.yaml#$.paths./settings/custom_views.get)\nAPI for valid values.\n\n\n> Note:\n\n> The cvid key is supported for mass delete via API in the\nfollowing editions:\n\n> - Enterprise\n\n> - Ultimate\n\n> - CRM Plus\n\n> - Zoho One Enterprise\n", "format": "string", "pattern": "^[0-9]+$", "type": "string" }, "ids": { "description": "Specify the list of record IDs to delete. Use the [Get Records API](record.yaml#$.paths./{module}.get) to get the valid records ID. ", "items": { "description": "Each string represents a unique record ID to delete.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } }, "maxItems": 500, "minItems": 1, "type": "array" }, "territory": { "additionalProperties": false, "description": "The unique ID of the territory whose records you want to delete. This key is valid only when you provide a custom view ID. ", "properties": { "id": { "description": "Specify the unique ID of the territory for which you want to delete records. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to get the ID of the territory.", "format": "string", "pattern": "^[0-9]+$", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } }, "include_child": { "description": "Specify whether to include records from child\nterritories in the delete operation.\n\nPossible values:\n\n**true** - Include records from child territories.\n\n**false** - Restrict the delete operation to records in\nthe specified territory only.\n", "type": "boolean" } }, "required": [ "id" ], "type": "object" } }, "type": "object" } } }, "description": "The request body must contain either an **ids** array to delete specific records or a **cvid** field to delete records from a Custom View.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "CVIDMassDeleteScheduled": { "description": "Shows the success response when a mass delete job is scheduled using a Custom View ID, returning the job ID for status tracking.", "summary": "An example of mass delete job scheduled using Custom View ID.", "value": { "data": [ { "code": "SUCCESS", "details": { "job_id": "1990117000035877396" }, "message": "mass delete scheduled successfully", "status": "success" } ] } }, "MultipleRecordsDeleted": { "description": "Shows the success response when multiple records are deleted synchronously using their record IDs.", "summary": "An example of multiple records deleted synchronously by record IDs.", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "1990117000035107169" }, "message": "record is deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "1990117000035827873" }, "message": "record is deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the success response payload for a mass delete operation.", "properties": { "data": { "description": "Contains the array of success responses for record deletions or batch job scheduling. ", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents the success response for a record deleted synchronously, including the record ID in the details.", "properties": { "code": { "const": "SUCCESS", "description": "Represents the success code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the deleted record, including the record ID. ", "properties": { "id": { "description": "Represents the ID of the deleted record. ", "format": "string", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "const": "record is deleted", "description": "Represents the success message for the response. ", "type": "string" }, "status": { "const": "success", "description": "Represents the status of the response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusSuccessResponse" }, { "additionalProperties": false, "description": "Represents the success response when a mass delete job is scheduled asynchronously, including the job ID in the details.", "properties": { "code": { "const": "SUCCESS", "description": "Represents the success code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the scheduled batch delete job, including the job ID. ", "properties": { "job_id": { "description": "Represents the unique ID of the scheduled mass delete job. Use this ID with the [Mass Delete Status API](mass_delete.yaml\n#$.paths./{module}/actions/mass_delete.get) to track the job progress. ", "format": "string", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "const": "mass delete scheduled successfully", "description": "Represents the success message for the response. ", "type": "string" }, "status": { "const": "success", "description": "Represents the status of the response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusBatchResponse" } ], "description": "Represents an individual success response for either a record deletion or a scheduled batch delete job." }, "maxItems": 500, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MassDeleteSuccessResponse" } } }, "description": "Returns the result of the mass delete operation, either a per-record deletion status for ID-based requests or a job ID for custom-view-based requests." }, "207": { "content": { "application/json": { "examples": { "MixedResults": { "description": "Shows the multi-status response when some records are deleted successfully and others fail validation.", "summary": "An example of partial success: some records deleted, others failed validation.", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "1990117000035107169" }, "message": "record is deleted", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "1990117000035827873" }, "message": "Record locked or invalid permissions", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response payload when some records were deleted and others failed validation.", "properties": { "data": { "description": "Contains the array of per-record results for the mass delete operation. Each item independently indicates success or failure for the corresponding record. ", "items": { "anyOf": [ { "additionalProperties": false, "description": "Represents the success entry for a record that was successfully deleted in the multi-status response.", "properties": { "code": { "const": "SUCCESS", "description": "Represents the success code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the successfully deleted record, including the record ID. ", "properties": { "id": { "description": "Represents the ID of the successfully deleted record. ", "format": "string", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "const": "record is deleted", "description": "Represents the success message for the response. ", "type": "string" }, "status": { "const": "success", "description": "Represents the status of the response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusMultiCodeErrorObject" }, { "additionalProperties": false, "description": "Represents the error entry for a record that failed deletion in the multi-status response.", "properties": { "code": { "description": "Represents the error code for the response. ", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the record that failed deletion, including the record ID. ", "properties": { "id": { "description": "Represents the ID of the record that failed deletion. ", "format": "string", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message describing the reason for the deletion failure. ", "format": "string", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteInvaliddataObject" } ], "description": "Represents an individual record result, independently indicating success or failure for that record." }, "maxItems": 500, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MassDeleteStatus207" } } }, "description": "Returns a multi-status response when record deletion is partially successful. Each item in the **data** array independently indicates success or failure for the corresponding record." }, "400": { "content": { "application/json": { "examples": { "InvalidCvid": { "description": "Shows the error response when the specified Custom View ID is invalid.", "summary": "Example of an invalid Custom View ID.", "value": { "code": "INVALID_DATA", "details": { "api_name": "cvid", "id": "3652397000000538003", "json_path": "$.cvid" }, "message": "the cvid given seems to be invalid", "status": "error" } }, "InvalidDataType": { "description": "Shows the error response when the **ids** array contains an invalid record ID format.", "summary": "Example of an invalid data type for ids field.", "value": { "code": "INVALID_DATA", "details": { "api_name": "ids", "id": "1990117000035827873", "json_path": "$.ids[0]" }, "message": "the id given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows the error response when the module API name in the request path is invalid or not supported.", "summary": "An example of unsupported or invalid module name.", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "MissingRequiredField": { "description": "Shows the error response when neither the **ids** array nor the **cvid** field is included in the request body.", "summary": "An example of missing required field (ids or cvid).", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "ids", "expected_data_type": "jsonarray" }, "message": "required field not found", "status": "error" } }, "NoRecordsFound": { "description": "Shows the error response when the Custom View specified by **cvid** contains no records to delete.", "summary": "An example of no records found in the specified Custom View.", "value": { "code": "NO_RECORDS_FOUND", "details": {}, "message": "no record found to update", "status": "error" } }, "OperationNotSupported": { "description": "Shows the error response when the mass delete operation is not supported for the specified module.", "summary": "An example of mass delete not supported for this module.", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "Mass delete is not supported for this module", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response when neither the **ids** nor the **cvid** field is provided in the request body.", "properties": { "code": { "const": "MANDATORY_NOT_FOUND", "description": "Represents the error code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error, including the name and expected data type of the missing field. ", "properties": { "api_name": { "description": "Represents the API name of the missing required field. ", "format": "string", "type": "string" }, "expected_data_type": { "description": "Represents the expected data type of the missing required field. ", "format": "string", "type": "string" } }, "type": "object" }, "message": { "const": "required field not found", "description": "Represents the error message for the response. ", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusMandatoryNotFoundObject" }, { "additionalProperties": false, "description": "Represents the error response when a mass delete job is already scheduled or running for the provided Custom View ID.", "properties": { "code": { "const": "ALREADY_SCHEDULED", "description": "Represents the error code returned when a mass delete job is already running for the provided Custom View. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduling conflict, including the request parameter that triggered the error. ", "properties": { "api_name": { "description": "Represents the API name of the key that caused the scheduling conflict. ", "enum": [ "cvid" ], "format": "string", "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Represents the error message indicating that a mass delete job is already scheduled for the provided Custom View. ", "format": "string", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusAlreadyScheduled" }, { "additionalProperties": false, "description": "Represents the error response when the provided **cvid** or one of the **ids** values is invalid.", "properties": { "code": { "const": "INVALID_DATA", "description": "Represents the error code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the invalid field, including its name, JSON path, and ID.", "properties": { "api_name": { "description": "Represents the API name of the invalid field. ", "format": "string", "type": "string" }, "id": { "description": "Represents the invalid record ID that triggered the error. ", "format": "string", "pattern": "^[0-9]+$", "type": "string" }, "json_path": { "description": "Represents the JSON path to the invalid field in the request. ", "format": "string", "type": "string" } }, "required": [ "api_name", "json_path", "id" ], "type": "object" }, "message": { "description": "Represents the error message for the response. ", "format": "string", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response.", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusInvalidCvid" }, { "additionalProperties": false, "description": "Represents the error response when the module name in the request path is invalid.", "properties": { "code": { "const": "INVALID_MODULE", "description": "Represents the error code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error, including the index of the invalid path segment. ", "properties": { "resource_path_index": { "const": 0, "description": "Represents the index of the resource path segment that contains the invalid module name. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "const": "the module name given seems to be invalid", "description": "Represents the error message for the response.", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusInvalidModule" }, { "additionalProperties": false, "description": "Represents the error response when mass delete is not supported for the specified module.", "properties": { "code": { "const": "NOT_SUPPORTED", "description": "Represents the error code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error, including the index of the unsupported resource path segment. ", "properties": { "resource_path_index": { "const": 0, "description": "Represents the index of the unsupported resource path segment. ", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message for the response. ", "format": "string", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusNotSupportedObject" }, { "additionalProperties": false, "description": "Represents the error response when no records are found in the specified Custom View.", "properties": { "code": { "const": "NO_RECORDS_FOUND", "description": "Represents the error code for the response. ", "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional details about the error.", "type": "object" }, "message": { "const": "no record found to update", "description": "Represents the error message for the response. ", "type": "string" }, "status": { "const": "error", "description": "Represents the status of the error response. ", "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusNoRecordsFoundObject" } ], "description": "Represents the error response payload for an invalid request. Contains one of the possible error scenarios.", "x-zs-$id": "MassDeleteBadrequest" } } }, "description": "The request is invalid due to a missing required field, invalid data\ntype, unsupported module, or no records found in the Custom View.\n\n**Resolution:** The request body must include either a valid **ids**\narray or a valid **cvid** key, and the module API name in the\nrequest path must be supported.\n" }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response when the current user lacks the mass delete permission for the module.", "summary": "Example of missing mass-delete permission for the module.", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Mass_Delete_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the current user lacks the permission required to delete records in the specified module.", "properties": { "code": { "description": "Represents the error code for the failed request.\n\nPossible values:\n\n**NO_PERMISSION** - The current user does not have\npermission to delete records in this module.\n", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional error details about the missing permission.", "properties": { "permissions": { "description": "Represents the list of permission keys required to perform this operation.", "items": { "description": "Represents a permission key required to perform this operation.", "maxLength": 255, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing permission.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request failed due to an error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassDeleteStatusNoPermissionObject" } } }, "description": "The current user does not have permission to delete records in the specified module.\nResolution: Request the mass delete permission for this module from your CRM administrator.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.mass_delete.DELETE" ] } ], "summary": "Delete records in bulk by record IDs or Custom View", "tags": [ "mass_delete" ], "x-zoho-document": "mass_delete" } }, "/crm/v8/{module}/actions/mass_update": { "get": { "description": "To retrieve the current status and record-processing counts of an asynchronous mass update job that was previously scheduled in your Zoho CRM organization. The job is identified by the `job_id` returned in the response of the scheduler-type mass update request. The response reports the job state along with the total, updated, not-updated, and failed record counts so that the caller can track progress until the job completes.", "operationId": "getMassUpdateStatus", "parameters": [ { "$ref": "#/components/parameters/MassUpdateModule" }, { "$ref": "#/components/parameters/MassUpdateJobId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ScheduledJob": { "description": "Illustrates the response when the mass update job is in the SCHEDULED state. The `Total_Count` reports the number of records queued for the job, and the `Not_Updated_Count` matches the total because record processing has not started yet.", "summary": "An example of mass update job in SCHEDULED state.", "value": { "data": [ { "Failed_Count": 0, "Not_Updated_Count": 18, "Status": "SCHEDULED", "Total_Count": 18, "Updated_Count": 0 } ] } } }, "schema": { "additionalProperties": false, "description": "The request body contains the data required to perform the operation.", "properties": { "data": { "description": "Represents the array that contains the status object for the requested mass update job.", "items": { "additionalProperties": false, "description": "Represents the status object that contains the current state and processed-record counts for the mass update job.", "properties": { "Failed_Count": { "description": "Represents the number of records that failed to update due to validation errors or other processing failures during the mass update job.", "format": "int32", "type": "integer" }, "Not_Updated_Count": { "description": "Represents the number of records that are not yet updated by the mass update job.", "format": "int32", "type": "integer" }, "Status": { "description": "Represents the current state of the mass update job.\n\nPossible values:\n\nCOMPLETED - The mass update job has finished\nprocessing all records.\n\nSCHEDULED - The mass update job has been queued and\nis waiting to start.\n\nQUEUED - The mass update job is queued in the\nsystem.\n\nRUNNING - The mass update job is currently\nprocessing records.\n\nSUSPENDED - The mass update job has been paused.\n\nFAILED - The mass update job has terminated due to a\nfailure.\n", "enum": [ "COMPLETED", "SCHEDULED", "QUEUED", "RUNNING", "SUSPENDED", "FAILED" ], "type": "string" }, "Total_Count": { "description": "Represents the total number of records that were scheduled to be mass updated by the job.", "format": "int32", "type": "integer" }, "Updated_Count": { "description": "Represents the number of records that were successfully updated by the mass update job.", "format": "int32", "type": "integer" } }, "required": [ "Failed_Count", "Updated_Count", "Total_Count", "Not_Updated_Count", "Status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MassUpdateStatus200Response" } } }, "description": "Returns the current state and record-processing counts of the requested mass update job." }, "400": { "content": { "application/json": { "examples": { "InvalidJobId": { "description": "Illustrates the error returned when the `job_id` query parameter is invalid or does not match any scheduled mass update job.", "summary": "An example of invalid job_id being provided in the request.", "value": { "code": "INVALID_DATA", "details": { "param_name": "job_id" }, "message": "The jobid given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the required `job_id` query parameter is missing from the request URL.", "properties": { "code": { "description": "Represents the error code returned when a required parameter is missing from the request.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the missing mandatory parameter, including the name of the parameter that was not provided.", "type": "object" }, "message": { "description": "Represents the error message describing the validation failure for the missing parameter.", "format": "string", "type": "string" }, "status": { "description": "Represents the overall status of the API response.", "enum": [ "error" ], "format": "string", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MassUpdateMandatoryNotFound" }, { "additionalProperties": false, "description": "Returned when the `job_id` value provided in the request is invalid or does not correspond to a scheduled mass update job.", "properties": { "code": { "description": "Represents the error code returned when the provided parameter value fails validation.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid parameter, including the name of the parameter whose value failed validation.", "type": "object" }, "message": { "description": "Represents the error message describing the invalid parameter value.", "format": "string", "type": "string" }, "status": { "description": "Represents the overall status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MassUpdateInvalidJobId" }, { "additionalProperties": false, "description": "Returned when the module API name in the request URL is invalid.", "properties": { "code": { "description": "Represents the error code returned when the module specified in the request URL is invalid or not supported.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid module, including the index of the unsupported segment in the request path.", "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the module validation failure.", "format": "string", "type": "string" }, "status": { "description": "Represents the overall status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdateInvalidModule" } ], "description": "Represents the response wrapper for a failed mass update status request, returning one of the validation or module errors that prevented the request from being processed.", "x-zs-$id": "MassUpdateStatus400Response" } } }, "description": "Returns an error when the request fails because of a missing or\ninvalid `job_id` parameter or an unsupported module.\n\n**Resolution**: Use the job ID received in the response of [Mass\nUpdate API](mass_update.yaml#$./{module}/actions/mass_update.post).\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.mass_update.READ" ] }, { "OAuth2": [ "ZohoCRM.mass_update.Leads.READ" ] } ], "summary": "Get mass update job status", "tags": [ "mass_update" ], "x-zoho-document": "mass_update" }, "post": { "description": "To update a specific field value across multiple records of a module in your Zoho CRM organization in a single API call. The operation supports two modes. In the non-scheduler mode, the caller supplies a list of record IDs in the `ids` array and the system updates those records synchronously, with a maximum of 500 records per request. In the scheduler mode, the caller supplies a Custom View ID in `cvid` and the request schedules an asynchronous background job that processes up to 50,000 records matching the view; the response returns a `job_id` that can be passed to the corresponding GET endpoint to track the job's progress. The Deals module accepts up to three fields per request; all other supported modules accept only one field per request. Email, lookup, multi-line, layout, and line item fields cannot be mass updated.", "operationId": "massUpdateRecords", "parameters": [ { "$ref": "#/components/parameters/MassUpdateModule" } ], "requestBody": { "content": { "application/json": { "examples": { "BasicFieldUpdate": { "description": "Illustrates a synchronous mass update that sets the `Venue` field to `Zylker` on the two records identified by their IDs in the `ids` array.", "summary": "Example of updating a single field across multiple records.", "value": { "data": [ { "Venue": "Estancia" } ], "ids": [ "1990117000035808053", "1990117000035808020" ] } }, "CvidUpdate": { "description": "Illustrates a scheduler-type request that mass updates the `Age` field on all records matching the provided Custom View ID. ", "summary": "An example of scheduling an asynchronous mass update using a Custom View.", "value": { "cvid": "1990117000000091529", "data": [ { "Age": "12121" } ] } }, "NestedObjectUpdate": { "description": "Illustrates a synchronous mass update that sets multiple fields on a single record, including a `Layout` field whose value is provided as an object with `id` and `display_label`. ", "summary": "An example of updating fields that reference nested objects.", "value": { "data": [ { "Layout": { "display_label": "Standard", "id": "1990117000000095023" }, "Pipeline": "1990117000027199960", "Stage": "Value Proposition" } ], "ids": [ "1990117000035107169" ] } } }, "schema": { "additionalProperties": false, "anyOf": [ { "description": "Represents the synchronous variant of the request payload, provided when records are targeted by a list of record IDs. This variant does not accept the `territory` key.", "properties": { "territory": { "description": "Ensures that the `territory` key is not provided along with the `ids` key." } }, "required": [ "ids" ], "x-zs-$id": "MassUpdateRequestWithIds" }, { "description": "Represents the scheduled variant of the request payload, provided when records are targeted by a Custom View ID. This variant accepts the optional `territory` key.", "required": [ "cvid" ], "x-zs-$id": "MassUpdateRequestWithCvid" } ], "description": "Represents the mass update request payload. The payload must include the `data` array along with either `ids` for a synchronous update or `cvid` for an asynchronous scheduled update. `ids` and `cvid` are mutually exclusive.", "properties": { "cvid": { "description": "Specify the Custom View ID whose matching records must be mass updated. Use `cvid` to schedule an asynchronous background job that processes the records in the Custom View. Use the [Get Custom View API](custom_views.yaml#$.paths./settings/custom_views.get) to get the ID of the requires custom view. \n\nThe response returns a `job_id` that can be passed to [Get Mass Update Status API](mass_update.yaml#$.paths./{module}/actions/mass_update.get) to track the progress of the scheduled job.\n\n> **Note**:\n> The cvid key is supported for mass update via API in the following editions:\n> - Enterprise\n> - Ultimate\n> - CRM Plus\n> - Zoho One Enterprise\n", "format": "int64", "pattern": "^[0-9]+$", "type": "string" }, "data": { "description": "Specify the array of objects, where each object maps a field's API name to the new value to be applied across the targeted records. The key must be provided along with either `ids` or `cvid`.", "items": { "additionalProperties": true, "description": "Each object maps one or more field API names to the new\nvalues to be applied. \n\n\n> **Note**:\n\n> The Deals module allows up to three fields per object;\nall other supported modules allow only one field per\nobject.\n> Email, lookup, multi-line, layout, and line item fields\ncannot be mass updated.\n", "type": "object" }, "maxItems": 1, "type": "array" }, "ids": { "description": "Specify the record IDs to be mass updated synchronously. Use\n`ids` for non-scheduler updates that target a small batch of\nrecords and require immediate processing. Use the [Get\nRecords API](record.yaml#$.paths./{module}.get) to get the\nvalid IDs of the required records.\n\n\n> **Note**:\n\n> - You can use either **ids** key or the **cvid** key, you\ncannot use them both in a request.\n\n> - Scheduler type(using record IDs):\n\n> - You can mass update a maximum of 50,000 records in a\nsingle API call.\n\n> - Automation rules are triggered automatically when the\nrecord count is less than 1000. When the record count is\ngreater than 1000, automation rules do not get triggered.\n\n> - If some of the records have invalid data, only those\nrecords will not be processed in the API call.\n\n> - Non-scheduler type(using CVID and territory ID):\n\n> - You can mass update a maximum of 500 records in a\nsingle API call.\n\n> - Automation rules such as approvals, blueprints, and\nworkflows are triggered automatically.\n\n> - When you want to mass update records in a territory,\nyou must specify the custom view ID.\n\n> - You cannot mass update Email, lookup fields, layout\nfields, multi-line fields, and line items.\n\n> - You can mass update up to three fields in the Deals\nmodule and only one field in all other modules in a single\nAPI call.\n", "items": { "description": "Each string specifies the unique ID of a record to be updated.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } }, "maxItems": 500, "type": "array" }, "territory": { "additionalProperties": false, "description": "Specify the territory whose records must be mass updated. This key is valid only when you provide a Custom View ID in `cvid`.", "properties": { "id": { "description": "Specify the unique ID of the territory. Use the [Get Territories API](territories.yaml#$.paths./settings/territories.get) to get the ID of the required territory.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" }, "include_child": { "description": "Specify whether to include the records of the child\nterritories in the mass update.\n\nPossible values:\n\n**true** - Include the records of the child territories.\n\n**false** - Restrict the mass update to the records in\nthe specified territory only.\n", "type": "boolean" } }, "required": [ "id" ], "type": "object" } }, "required": [ "data" ], "type": "object" } } }, "description": "The request body contains the data required to perform the operation.\n\n\nMass update of records happens in two ways:\n\n\n**Scheduler type**: When you specify a custom view ID and territory\nID, a job is scheduled in the background and the system returns a\n\"job_id\". Use this job_id in the [Get Mass Update Status\nAPI](mass_update.yaml#$.paths./{module}/actions/mass_update.get) to\nget the status of the job. You can update a maximum of **50,000\nrecords** in this type.\n\n\n**Non-scheduler type**: When you specify the record IDs, system\nupdates the records instantly. You can update a maximum of **500\nrecords** in a single API call in this type of mass update.\n", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulMassUpdate": { "description": "Illustrates a successful response for a non-scheduler-type request, returning the result of the updated record, including its ID, creation and modification timestamps, and the users who created and modified the record.", "summary": "An example of successful synchronous mass update of a record.", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "1990117000000450001", "name": "Dharun Kumar Dharun Kumar 95" }, "Created_Time": "2025-11-25T15:07:02+05:30", "Modified_By": { "id": "1990117000000450001", "name": "Dharun Kumar Dharun Kumar 95" }, "Modified_Time": "2025-11-26T14:37:55+05:30", "id": "1990117000035808053" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response wrapper returned when the mass update operation is accepted, containing one or more outcome entries for the processed records or the scheduled job.", "properties": { "data": { "description": "Represents the array that contains one response object per record processed or one entry describing the scheduled job.", "items": { "additionalProperties": false, "description": "Represents a single response entry, containing either the scheduled job details (when the request was made using `cvid`) or the updated record details (when the request was made using `ids`).", "properties": { "code": { "description": "Represents the result code for the individual entry.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": true, "anyOf": [ { "additionalProperties": false, "description": "Represents the scheduler-type details, returned when the mass update is scheduled via a Custom View ID. Contains the `job_id` that can later be used to track the job's progress using the [Get Mass Update Status API](mass_update.yaml#$.paths./{module}/actions/mass_update.get). ", "properties": { "job_id": { "description": "Represents the unique ID of the scheduled mass update job. Pass this value as the `job_id` query parameter to [Get Mass Update Status API](mass_update.yaml#$.paths./{module}/actions/mass_update.get) to retrieve the job's current status and record counts.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "job_id" ], "type": "object", "x-zs-$id": "MassUpdate200AsyncDetails" }, { "additionalProperties": false, "description": "Represents the non-scheduler-type details, returned when the API processes individual records synchronously. ", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the user who originally created the record.", "properties": { "id": { "description": "Represents the unique ID of the user who created the record.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the display name of the user who created the record.", "format": "string", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Created_Time": { "description": "Represents the date and time, in ISO 8601 format, when the record was originally created.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who performed the mass update on the record.", "properties": { "id": { "description": "Represents the unique ID of the user who modified the record.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the display name of the user who modified the record.", "format": "string", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "Modified_Time": { "description": "Represents the date and time, in ISO 8601 format, when the record was last modified by the mass update operation.", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique ID of the record that the mass update operation modified.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id", "Modified_Time", "Modified_By", "Created_By", "Created_Time" ], "type": "object", "x-zs-$id": "MassUpdate200SyncDetails" } ], "description": "Represents additional details about the response. ", "type": "object" }, "message": { "description": "Represents the message describing the result of the operation.", "format": "string", "type": "string" }, "status": { "description": "Represents the status of the operation for this entry.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 500, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MassUpdate200Response" } } }, "description": "Returns the outcome of the mass update operation." }, "207": { "content": { "application/json": { "examples": { "PartialMassUpdate": { "description": "Illustrates a multi-status response in which two records are updated successfully and one record fails because it is locked by the record locking configuration.", "summary": "An example of two records updated successfully and one record failing.", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "1990117000000450001", "name": "Dharun Kumar Dharun Kumar 95" }, "Created_Time": "2026-08-04T17:55:37+05:30", "Modified_By": { "id": "1990117000000450001", "name": "Dharun Kumar Dharun Kumar 95" }, "Modified_Time": "2026-08-12T19:02:29+05:30", "id": "1990117000045575047" }, "message": "record updated", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "1990117000000450001", "name": "Dharun Kumar Dharun Kumar 95" }, "Created_Time": "2026-08-04T17:55:54+05:30", "Modified_By": { "id": "1990117000000450001", "name": "Dharun Kumar Dharun Kumar 95" }, "Modified_Time": "2026-08-12T19:02:29+05:30", "id": "1990117000045575059" }, "message": "record updated", "status": "success" }, { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "1990117000045639003" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response wrapper returned when a non-scheduler-type mass update results in mixed responses, containing at least one successfully updated record and at least one failed record.", "properties": { "data": { "allOf": [ { "description": "Represents the constraint ensuring that the response contains at least one successfully updated record." }, { "description": "Represents the constraint ensuring that the response contains at least one record that failed to update." } ], "description": "Represents the array that contains one response object per record processed, indicating whether the mass update succeeded or failed for that record.", "items": { "additionalProperties": false, "description": "Represents a single per-record entry, containing either the details of the updated record or the error that prevented the record from being updated.", "properties": { "code": { "description": "Represents the result code for the individual\nrecord.\n\nPossible values:\n\nSUCCESS - The record was updated successfully.\n\nMANDATORY_NOT_FOUND - A required property is missing\nfrom the payload for the record.\n\nINVALID_DATA - The request data is invalid for the\nrecord.\n\nMAPPING_MISMATCH - The provided value violates a\nfield mapping relationship for the record.\n\nRECORD_LOCKED - The record is locked and cannot be\nupdated.\n\nCONVERTED_RECORD - The record has already been\nconverted and cannot be updated.\n", "enum": [ "SUCCESS", "MANDATORY_NOT_FOUND", "INVALID_DATA", "MAPPING_MISMATCH", "RECORD_LOCKED", "CONVERTED_RECORD" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the response. For an updated record, it contains the record ID along with its creation and modification details. For a failed record, it contains the details of the failure, such as the ID of the record that could not be updated.", "type": "object" }, "message": { "description": "Represents the message describing the result of the operation for this record.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation for this\nrecord.\n\nPossible values:\n\nsuccess - The record was updated.\n\nerror - The record was not updated.\n", "enum": [ "success", "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MassUpdate207DataItem" }, "maxItems": 500, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MassUpdate207Response" } } }, "description": "Returns a multi-status response when some records are updated successfully while others fail." }, "400": { "content": { "application/json": { "examples": { "InvalidFieldValue": { "description": "Illustrates a per-record error returned when the provided picklist value for the `Pipeline` field is not present in the layout assigned to the record.", "summary": "An example of picklist value not present in the record layout.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Pipeline", "id": "1990117000035827873" }, "message": "picklist not found in record layout", "status": "error" } ] } }, "MandatoryFieldMissing": { "description": "Illustrates a per-record error returned when a required field is missing from the update payload.", "summary": "An example of mandatory field missing in the payload.", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": {}, "message": "required field not found", "status": "error" } ] } }, "NoRecordsFound": { "description": "Illustrates a per-record `INVALID_DATA` error returned when the provided record ID does not exist in the targeted module. The remaining valid record IDs in the same request are still processed.", "summary": "Example of a record ID supplied in the request is invalid.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "19901170000358080" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "NonSubordinateUser": { "description": "Illustrates a per-record error returned when a user assigned\nto a user lookup field is not eligible under the calling\nuser's hierarchy permissions.\n\n\nThis error can occur in the following cases:\n\n\n- **Role hierarchy permission: List Subordinates Only**\n\nThe calling user can assign only users who are their\nsubordinates in the role hierarchy.\n\n- **Territory hierarchy permission: Territories and\nSub-Territory Users Only**\n\nThe calling user can assign only users who belong to their\nterritory or its sub-territories.\n\nFor example, consider the following territory hierarchy:\n - Root Territory\n - Territory A (User1, User2)\n - Territory B (User3, User4)\n - Territory C (User5, User6)\nA user in Territory A can assign users from Territory A and\nTerritory B, but cannot assign users from Territory C.\n", "summary": "An example of non-subordinate user assigned to a user lookup field.", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].User_lookup.id" }, "message": "Non Subordinate User Found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Returned when the supplied Custom View ID is syntactically a valid bigint but does not resolve to an existing custom view.", "properties": { "code": { "description": "Represents the error code for the response.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details identifying the invalid cvid request key.", "properties": { "api_name": { "description": "Represents the API name of the key that caused the error.", "enum": [ "cvid" ], "type": "string" }, "json_path": { "description": "Represents the JSON path to the invalid key in the request.", "enum": [ "$.cvid" ], "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message for the response.", "enum": [ "the cvid given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the overall status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdate400InvalidCvid" }, { "additionalProperties": false, "description": "Returned when a mass update job is already scheduled or running for the supplied Custom View ID.", "properties": { "code": { "description": "Represents the error code returned when a mass update job is already running for the provided Custom View.", "enum": [ "ALREADY_SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the scheduling conflict, including the request parameter that triggered the error.", "properties": { "api_name": { "description": "Represents the API name of the key that caused the scheduling conflict.", "enum": [ "cvid" ], "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Represents the error message indicating that a mass update job is already scheduled for the provided Custom View.", "format": "string", "type": "string" }, "status": { "description": "Represents the overall status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdate400AlreadyScheduled" }, { "additionalProperties": false, "description": "Returned when the module API name in the request URL is invalid.", "properties": { "code": { "description": "Represents the error code returned when the module specified in the request URL is invalid or not supported by the Mass Update API.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid module, including the index of the unsupported segment in the request path.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the unsupported segment in the request URL path.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the module validation failure.", "format": "string", "type": "string" }, "status": { "description": "Represents the overall status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdate400InvalidModule" }, { "additionalProperties": false, "description": "Returned when mass update is not supported for the requested module, such as Services or Appointments.", "properties": { "code": { "description": "Represents the error code returned when the module specified in the request URL is not supported by the Mass Update API.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported module, including the index of the unsupported segment in the request path.", "properties": { "resource_path_index": { "const": 0, "description": "Represents the zero-based index of the unsupported segment in the request URL path.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message indicating that the module is not supported by the Mass Update API.", "enum": [ "the given module is not supported for this api", "the given module is not supported in api" ], "type": "string" }, "status": { "description": "Represents the overall status of the API response.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdate400ModuleNotSupported" }, { "additionalProperties": false, "description": "Represents the per-record error envelope returned when one or more records fail to be mass updated, with one error entry per failed record.", "properties": { "data": { "description": "Represents the array of per-record error responses returned when one or more records fail to be mass updated.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Returned when a required property is missing from the payload for a record.", "properties": { "code": { "description": "Represents the error code returned when a required property is missing from the payload for a record.", "enum": [ "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the missing mandatory property.", "properties": {}, "type": "object" }, "message": { "description": "Represents the error message indicating that a required property is missing from the payload.", "format": "string", "type": "string" }, "status": { "description": "Represents the status of the operation for this record.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MassUpdate400MandatoryNotFound" }, { "additionalProperties": false, "description": "Returned when the request data is invalid for a record, including an unknown record ID, an unsupported field value, a value that exceeds the allowed length or numeric range, or a non-subordinate user provided for a user lookup field.", "properties": { "code": { "description": "Represents the error code returned when the request data fails validation for a record.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the invalid data, including the invalid record ID, field API name, or the constraint that was violated.", "properties": { "id": { "description": "Represents the unique ID of the record for which the validation failed.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" }, "limit": { "description": "Represents the maximum allowed limit that was exceeded for the field.", "format": "int32", "minimum": 1, "type": "integer" }, "maximum_decimal_place": { "description": "Represents the maximum number of decimal places allowed for the field value.", "format": "int32", "minimum": 0, "type": "integer" }, "maximum_length": { "description": "Represents the maximum number of characters allowed for the field value.", "format": "int32", "minimum": 1, "type": "integer" }, "range": { "additionalProperties": false, "description": "Represents the inclusive numeric range within which the field value must fall.", "properties": { "from": { "description": "Represents the minimum allowed value, inclusive, for the field.", "format": "int64", "type": "integer" }, "to": { "description": "Represents the maximum allowed value, inclusive, for the field.", "format": "int64", "type": "integer" } }, "required": [ "from", "to" ], "type": "object" } }, "type": "object" }, "message": { "description": "Represents the error message describing the validation failure for the record.", "format": "string", "type": "string" }, "status": { "description": "Represents the status of the operation for this record.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MassUpdate400InvalidData" }, { "additionalProperties": false, "description": "Returned when there is a mapping mismatch between fields for a record, such as a `Stage` value that does not belong to the selected `Pipeline` or a picklist value that is not present in the supplied `Layout`.", "properties": { "code": { "description": "Represents the error code returned when the provided value violates a field mapping relationship.", "enum": [ "MAPPING_MISMATCH" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the mapping mismatch, including the API name of the field that does not match the mapping, the field that owns the mapping relationship, and the JSON path of the mismatched element.", "properties": { "api_name": { "description": "Represents the API name of the field whose value does not match the mapping.", "format": "string", "type": "string" }, "json_path": { "description": "Represents the JSON path to the mismatched element in the request body.", "format": "string", "type": "string" }, "mapped_field": { "description": "Represents the field that owns the mapping relationship.", "format": "string", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the mapping mismatch.", "format": "string", "type": "string" }, "status": { "description": "Represents the status of the operation for this record.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "MassUpdate400MappingMismatch" }, { "additionalProperties": false, "description": "Returned when the requested operation or module is not supported for a record. The Services and Appointments modules are not supported by the Mass Update API.", "properties": { "code": { "description": "Represents the error code returned when the\nrequested operation or module is not\nsupported by the Mass Update API.\n\nPossible values:\n\nNOT_SUPPORTED - The requested operation is\nnot supported for the targeted record or\nmodule.\n\nINVALID_MODULE - The module is not supported\nby the Mass Update API.\n", "enum": [ "NOT_SUPPORTED", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the unsupported request, including the index of the unsupported segment in the request URL path.", "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing why the operation or module is not supported.", "format": "string", "type": "string" }, "status": { "description": "Represents the status of the operation for this record.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdate400NotSupported" }, { "additionalProperties": false, "description": "Returned when the record is locked by the record locking configuration or a GDPR setting and cannot be modified by the mass update operation.", "properties": { "code": { "description": "Represents the error code returned when the record is locked and cannot be updated.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the locked record, including the ID of the locked record and the action that placed the lock.", "properties": { "action": { "description": "Represents the action that placed the lock on the record.", "enum": [ "record_locking" ], "type": "string" }, "id": { "description": "Represents the unique ID of the locked record that could not be updated.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "action", "id" ], "type": "object" }, "message": { "description": "Represents the error message indicating that the record is locked.", "format": "string", "type": "string" }, "status": { "description": "Represents the status of the operation for this record.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdate400RecordLocked" }, { "additionalProperties": false, "description": "Returned when the record (for example, a converted Lead) has already been converted and cannot be modified by the mass update operation.", "properties": { "code": { "description": "Represents the error code returned when the record has already been converted and cannot be updated.", "enum": [ "CONVERTED_RECORD" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the converted record, including its unique ID.", "properties": { "id": { "description": "Represents the unique ID of the record that has already been converted.", "format": "int64", "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the error message indicating that the record has already been converted and cannot be updated.", "format": "string", "type": "string" }, "status": { "description": "Represents the status of the operation for the record.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "MassUpdate400ConvertedRecord" } ], "description": "Represents a single per-record error entry. Each object describes the specific failure that occurred for the corresponding record in the request." }, "maxItems": 500, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "MassUpdate400Response" } ], "description": "Represents the error response wrapper for a failed mass update request. The response is one of the request-level error variants (`ALREADY_SCHEDULED`, `INVALID_MODULE`) or a per-record error envelope that lists individual record failures.", "x-zs-$id": "MassUpdate400Responses" } } }, "description": "Returns an error when the mass update request cannot be processed, either at the request level (such as a scheduling conflict or an unsupported module) or for individual records (such as missing mandatory fields, invalid data, locked records, or converted records)." } }, "security": [ { "OAuth2": [ "ZohoCRM.mass_update.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.mass_update.Leads.UPDATE" ] } ], "summary": "Mass update records", "tags": [ "mass_update" ], "x-zoho-document": "mass_update" } }, "/crm/v8/{module}/actions/portal_invite": { "get": { "description": "To retrieve the status of a scheduled portal invitation job in your Zoho CRM organization using the job identifier returned when invitations were scheduled.", "operationId": "getScheduledInviteUsersInfo", "parameters": [ { "$ref": "#/components/parameters/PortalUsersModule" }, { "description": "The ID of the job you received in the response of the [Bulk Invite Users to a Portal API](https://www.zoho.com/crm/developer/docs/api/v8/portal-bulk-invite-users.html). When you do not include this parameter, the response will contain an array of all the jobs that were scheduled previously. \nIf you give an incorrect job_id, you will get an empty response(HTTP 204).", "in": "query", "name": "job_id", "required": false, "schema": { "description": "Represents the unique identifier of the scheduled invitation job.", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "inviteUsers", "propertyId": "BulkInviteJobId" } ], "resource": "portal_users" } } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows a successful response with a completed invitation job, including one processed record with a SUCCESS status.", "summary": "Scheduled invitation job with completion status", "value": { "portal_invite": [ { "data": [ { "code": "SUCCESS", "details": { "id": "1234567890" }, "message": "An Invite has been sent to the personality.", "status": "success" } ], "job_id": "1234567", "status": "completed" } ] } } }, "schema": { "additionalProperties": false, "description": "Response for portal user invitation requests", "properties": { "portal_invite": { "description": "Represents the list of portal invitation response objects. Contains one object per invitation batch.", "items": { "additionalProperties": false, "description": "Represents the invitation result for a single portal invitation batch.", "properties": { "data": { "description": "Represents the list of individual invitation results for this job batch.", "items": { "additionalProperties": false, "description": "Represents the invitation result for a single portal invitation batch.", "properties": { "code": { "description": "Represents the error code. Possible values: **SUCCESS**, **CANNOT_PROCESS**, **INVALID_DATA**, **REQUIRED_PARAM_MISSING**, **LICENSE_LIMIT_EXCEEDED**, **NOT_REVIEWED**, **NOT_APPROVED**, **DUPLICATE_DATA**.", "enum": [ "SUCCESS", "CANNOT_PROCESS", "INVALID_DATA", "REQUIRED_PARAM_MISSING", "LICENSE_LIMIT_EXCEEDED", "NOT_REVIEWED", "NOT_APPROVED", "DUPLICATE_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the operation result.", "properties": { "id": { "description": "Represents the unique identifier of the CRM record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the success or informational message for this operation result.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**, **error**.", "enum": [ "success", "error" ], "type": "string" } }, "type": "object" }, "maxItems": 200, "type": "array" }, "job_id": { "description": "Represents the unique identifier of the scheduled invitation job.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **scheduled**, **completed**, **in_progress**. ", "enum": [ "scheduled", "completed", "in_progress" ], "type": "string" } }, "required": [ "data", "job_id", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "GetScheduledInviteUsersInfoResponse" } } }, "description": "Returns the status of the scheduled portal invitation job." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when retrieving invitation status is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "GetScheduledInviteUsersInfoApiNotSupportedResponse" } } }, "description": "This API is not supported in sandbox environments. Resolution: The request must be made from a production Zoho CRM organization, not a sandbox." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.READ" ] } ], "summary": "Invite portal users", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "Used to fetch the current status of the scheduler which was scheduled for bulk invites. In this need to pass jobid which will be taken from POST bulk invite" }, "post": { "description": "To send portal invitations in bulk to CRM records in your Zoho CRM organization for the specified module, scheduling them as asynchronous invitation jobs.", "operationId": "inviteUsers", "parameters": [ { "$ref": "#/components/parameters/PortalUsersModule" } ], "requestBody": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows the Example1 scenario for this operation.", "summary": "Example1 example", "value": { "portal_invite": [ { "data": [ { "id": "5843104000000624013", "language": "en_US", "type": "invite", "user_type_id": "5843104000000411001" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for inviting portal users", "properties": { "portal_invite": { "description": "Specify the list of portal invitation objects. Each object must contain a **data** array of user records to invite.", "items": { "additionalProperties": false, "description": "Specify the invitation data for a single portal invitation batch.", "properties": { "data": { "description": "Specify the list of user records to include in this invitation batch.", "items": { "additionalProperties": false, "description": "Specify the invitation data for a single portal invitation batch.", "properties": { "id": { "description": "Specify the unique identifier of the CRM record to invite as a portal user.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } }, "language": { "description": "Specify the locale code of the language for the invitation email. Omit or set to null to use the portal's default language.", "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 ], "type": [ "string", "null" ] }, "type": { "description": "Specify the invitation action type. Possible values: **invite** (new invitation), **reinvite** (re-send invitation).", "enum": [ "reinvite", "invite" ], "type": "string" }, "user_type_id": { "description": "Specify the unique identifier of the portal user type to assign. Refer to the [Get Portal User Types](https://www.zoho.com/crm/developer/docs/api/v8/get-user-types.html) resource for valid values.", "format": "int64", "maxLength": 255, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getPortalUserTypes", "propertyId": "PortalUserTypesId" } ], "resource": "portal_user_type" } } }, "required": [ "id", "user_type_id", "type" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object" }, "x-zs-llm-examples": [ "Example1" ] } }, "description": "The request body must contain a **portal_invite** array. You can include up to 100 invitation objects, each containing a **data** array of user records to invite.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Example1": { "description": "Shows a successful response when a bulk portal invitation is scheduled, including the job ID returned for status tracking.", "summary": "Successful scheduled bulk portal invitation", "value": { "portal_invite": [ { "code": "SCHEDULED", "details": { "job_id": "5020928000002338037" }, "message": "Portal bulk invite scheduled successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response for portal user invitation requests", "properties": { "portal_invite": { "description": "Represents the list of portal invitation response objects. Contains one object per invitation batch.", "items": { "additionalProperties": false, "description": "Represents the invitation result for a single portal invitation batch.", "properties": { "code": { "description": "Represents the error code. Possible values: **SCHEDULED**. ", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the operation result.", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled invitation job.", "maxLength": 255, "type": "string", "x-zs-$id": "BulkInviteJobId" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the success or informational message for this operation result.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "InviteUsersResponse" } } }, "description": "Returns the scheduled invitation job information." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when the bulk invite operation is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "MandatoryNotFound": { "description": "Shows the MANDATORY_NOT_FOUND error returned when a required field, such as **user_type_id**, is missing from the request body.", "summary": "Error when a required field is missing from the request", "value": { "portal_invite": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "user_type_id", "json_path": "$.portal_invite[0].data[0].user_type_id" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response containing a list of portal invitation errors, one per failed invitation.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation error objects. Contains one error object per failed invitation.", "items": { "additionalProperties": false, "description": "Represents the error details for a single failed portal invitation.", "properties": { "code": { "description": "Represents the error code. Possible values: **MANDATORY_NOT_FOUND**, **INVALID_DATA**. ", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "InviteUsersErrorResponse" }, { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "InviteUsersApiNotSupportedResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "InviteUsersBadRequestResponse" } } }, "description": "Invalid request - one or more fields in the invitation request are invalid or missing. Resolution: Check the error code and correct the request body before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissions": { "description": "Shows the NO_PERMISSION error returned when the authenticated user does not have the required client portal create permission.", "summary": "Error when the user lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal_Users" ] }, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response returned when the module specified in the request path is invalid or not accessible.", "properties": { "code": { "description": "Represents the error code. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "InviteNoPermissionErrorResponse" }, { "additionalProperties": false, "description": "Error response containing a list of portal invitation errors, one per failed invitation.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": false, "description": "Represents the permission error for a single portal invitation.", "properties": { "code": { "description": "Represents the status code of the operation.", "maxLength": 255, "type": "string" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "InvitePortalInviteErrorResponse" }, { "additionalProperties": false, "description": "Alternative error response format for portal invitation failures.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": true, "description": "Represents the permission error for a single portal invitation.", "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "InviteAlternativePortalInviteErrorResponse" }, { "additionalProperties": false, "description": "Error response containing an array of portal invitation error objects.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": true, "description": "Represents the permission error for a single portal invitation.", "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "InviteAdditionalPortalInviteErrorResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "InviteUsersForbiddenResponse" } } }, "description": "Permission denied. Resolution: The CRM administrator must grant the **ZohoCRM.settings.clientportal** scope permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.CREATE" ] } ], "summary": "Invite portal users", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "Portal invitation will be sent for the records which are present in request body for specific module with language and invitation type" } }, "/crm/v8/{module}/actions/remove_tags": { "post": { "description": "Removes tags from one or more records in the specified module.", "operationId": "postRemoveTags", "parameters": [ { "$ref": "#/components/parameters/ParamQueryModule1" }, { "$ref": "#/components/parameters/ParamPathModule" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "ids": "[\"3060320000002496003\"]", "tags": [ { "name": "newtd" } ] } } }, "schema": { "$ref": "#/components/schemas/PostremovetagsRequest" } } }, "description": "Request body containing the tags to remove and the record IDs." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "3060320000002496003", "tags": [] }, "message": "tags updated successfully", "status": "success" } ], "locked_count": "0" } } }, "schema": { "$ref": "#/components/schemas/PostremovetagsResponse200" } } }, "description": "OK - Tags removed successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: tags)", "value": { "code": "INVALID_DATA", "details": { "api_name": "tags", "json_path": "$.tags", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tags[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tags[*].name", "maximum_length": 25 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "summary": "Error response with code INVALID_MODULE: the given module is not supported for this api", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "summary": "Error response with code INVALID_REQUEST_METHOD: The http request method type is not a valid one", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "RecordLockedResponse1": { "summary": "Error response with code RECORD_LOCKED: Sorry, you cannot perform this operation as the record is locked.", "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "3060320000002538026" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ], "locked_count": "1" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Wrapped error response with per-record errors", "properties": { "data": { "description": "Array of error objects for records that failed the operation", "items": { "$ref": "#/components/schemas/TagsActionsRecordLockedError" }, "maxItems": 25, "type": "array" }, "locked_count": { "description": "Number of records that are locked and could not be updated", "maxLength": 10, "type": "string" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostremovetagsError400Wrapper" }, { "$ref": "#/components/schemas/TagsInvalidDataError" }, { "$ref": "#/components/schemas/TagsActionsInvalidModuleNameError" }, { "$ref": "#/components/schemas/TagsActionsModuleTagsNotSupportedError" }, { "$ref": "#/components/schemas/TagsActionsInvalidRequestMethodError" }, { "additionalProperties": false, "description": "Wrapped error response with per-tag validation errors", "properties": { "tags": { "description": "Array of error objects for tag field validation failures", "items": { "anyOf": [ { "$ref": "#/components/schemas/TagFieldInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsActionsTagFieldMaxLengthError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PostremovetagsError" } ], "description": "Error response for status 400", "x-zs-$id": "PostremovetagsError400" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax or validation errors. Review the error details and correct the issues before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Leads", "Crm_Implied_Tags_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsActionsNoPermissionError", "description": "Error response for status 403", "x-zs-$id": "PostremovetagsError403" } } }, "description": "Forbidden - The client does not have access rights to perform the operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.ALL" ] } ], "summary": "Remove Tags from Records", "tags": [ "tags_actions" ], "x-zoho-document": "tags_actions" } }, "/crm/v8/{module}/actions/remove_territories": { "post": { "description": "To remove one or more territories from multiple records in your Zoho CRM organization. Supported modules are Leads, Accounts, Contacts, and Deals. The removal can be processed synchronously or scheduled as a background job, depending on the number of records.", "operationId": "removeTerritoriesFromRecords", "parameters": [ { "$ref": "#/components/parameters/TerritoriesModule", "description": "The API name of the module that contains the records." } ], "requestBody": { "content": { "application/json": { "examples": { "RemoveTerritoriesSuccess": { "summary": "Remove territories from multiple records", "value": { "data": [ { "Territories": [ { "id": "423456712345623" } ], "id": "456789098764332" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the records and their associated territories to remove.", "properties": { "data": { "description": "Specify the list of records and their associated territories to remove.", "items": { "additionalProperties": false, "description": "Specify the record ID and the list of territories to remove from that record.", "properties": { "Territories": { "description": "Specify the list of territories to remove from the record. Refer to the [Get Territories](territories.yaml#$.paths./settings/territories.get) resource for valid values.", "items": { "additionalProperties": false, "description": "Specify a territory object containing the unique ID of the territory to remove.", "properties": { "id": { "description": "Specify the unique ID of the territory to remove from the record. Refer to the [Get Territories](territories.yaml#$.paths./settings/territories.get) resource for valid values.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "id": { "description": "Specify the unique record ID of the record from which to remove the territories.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecord", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "id", "Territories" ], "type": "object", "x-zs-$id": "RemoveTerritoriesFromRecordsRequestDataItem" }, "maxItems": 10, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RemoveTerritoriesFromRecordsRequestBody" }, "x-zs-llm-examples": [ "RemoveTerritoriesSuccess" ] } }, "description": "The request body must contain a **data** array. You can include a maximum of 10 objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "RemoveTerritoriesSuccess": { "summary": "Successful territory removal from multiple records", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "5319055000000750908" }, "message": "the territories data removed successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryRemoveSuccessResponse" } } }, "description": "Returns the territory removal results for all records in the request." }, "202": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Scheduled territory removal for multiple records", "value": { "data": [ { "code": "SCHEDULED", "details": { "id": "2345678234534545", "job_id": "482367546723546372" }, "message": "Territory removal process scheduled successfully", "status": "success" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryRemoveScheduledResponse" }, { "$ref": "#/components/schemas/TerritoryRemoveSuccessResponse" } ], "description": "Represents the scheduled territory removal response, returned when the removal jobs are queued for processing.", "x-zs-$id": "TerritoryRemoveRecordsResponse" } } }, "description": "Returns a scheduled response indicating that territory removal jobs were queued successfully. The **code** field is set to **SCHEDULED**, and the **details** object contains the record ID and job ID for each record." }, "400": { "content": { "application/json": { "examples": { "InvalidDataErrorOnDelete": { "summary": "Territory not assigned to the specified record", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Territories[1].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidModuleError": { "summary": "Invalid module name in request URL", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "the api is not supported for this module", "status": "error" } }, "InvalidRecordIdError": { "summary": "Invalid record ID in remove-territories request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": " $.data[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidTerritoryIdError": { "summary": "Invalid territory ID in remove-territories request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": " $.data[0].Territories[1].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "LimitExceededOnAssign": { "summary": "Territory limit exceeded for a record", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Territories", "json_path": "$.data[0].Territories", "limit": 10 }, "message": "Maximum limit of territories for that record exceeds", "status": "error" } ] } }, "MandatoryNotFoundError": { "summary": "Missing mandatory field in remove-territories request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": " $.data[0].Territories[1].id" }, "message": "required field not found", "status": "error" } ] } }, "TerritoryNotEnabled": { "summary": "Territory management not enabled for the module", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignInvalidDataTerritoryId" }, { "$ref": "#/components/schemas/TerritoryAssignMandatoryNotFound" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryAssignNotSupported" }, { "$ref": "#/components/schemas/TerritoryRemoveSystemAssignedNotAllowed" }, { "$ref": "#/components/schemas/TerritoryAssignAlreadyUsed" }, { "$ref": "#/components/schemas/TerritoryAssignRecordLocked" }, { "$ref": "#/components/schemas/TerritoryAssignInvalidDataMaxLen" }, { "$ref": "#/components/schemas/InvalidModule" }, { "$ref": "#/components/schemas/AssignTerritoryAssignErrorDataObject" } ], "description": "Represents the error response for an invalid or failed territory removal request.", "x-zs-$id": "RemoveTerritoriesAssignErrorResponse" } } }, "description": "One or more records in the request contain invalid data or missing required fields.\n**Resolution:** Verify that all required fields are present, the record and territory IDs are valid, and the territories are currently assigned to the records." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure due to invalid OAuth token", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "NoPermissionForTerritoryId": { "summary": "User lacks permission to remove territories from the record", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "api_name": "id", "json_path": "$.data[0].Territories" }, "message": "User has no permission to add / remove the Territories", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignNoPermission" }, { "$ref": "#/components/schemas/UnauthorizedError" } ], "x-zs-$id": "TerritoryRemoveUnauthorizedError" } } }, "description": "Authentication failure due to missing, expired, or invalid OAuth token.\n**Resolution:** A new access token must be generated with the required scope for this API." }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryRecordUpdateNoPermission" } ], "x-zs-$id": "TerritoryRemoveForbiddenError" } } }, "description": "Territory management is not enabled for the organization, or the user does not have permission to update the record.\n**Resolution:** The CRM administrator must enable territory management in the organization settings and grant the required profile permission to the user." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Remove territories from multiple records", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Removes territory associations from multiple records in the specified module in a single request. The module is passed as a URL path parameter. Returns 202 - removals are processed asynchronously. To track the asynchronous job status on a record, use getFeatureSpecificInfo (feature_specific_info.json) with features=territory_scheduled_jobs along with the module and record id. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/{module}/actions/unblock_email": { "post": { "description": "To unblock soft-bounced email addresses for multiple records in your Zoho CRM organization. When emails sent from CRM bounce temporarily, the Email field on the affected records is blocked. This operation removes those blocks in bulk so email communication with the records can resume.", "operationId": "unblockEmailByModule", "parameters": [ { "$ref": "#/components/parameters/UnblockEmailModule" } ], "requestBody": { "content": { "application/json": { "examples": { "UnblockMultipleEmails": { "description": "Shows a request to unblock the **Email** field for multiple records by specifying their record IDs.", "summary": "An example response to unblock emails for multiple records in a module.", "value": { "ids": [ "5545974000000224001", "5545974000000224002" ], "unblock_fields": [ "Email" ] } } }, "schema": { "additionalProperties": false, "description": "Specify the record IDs and email fields to unblock in bulk.", "properties": { "ids": { "description": "Specify the record IDs for which you want to unblock the email fields. Use the [Get Records API](record.yaml#$.paths./{module}.get) to get valid values. You can specify up to 500 record IDs.", "items": { "description": "Each string specifies the unique identifier of the record for which you want to unblock the email.", "maxLength": 50, "type": "string" }, "maxItems": 100, "type": "array" }, "unblock_fields": { "description": "To unblock emails, specify one or both of the system-defined\nfields : **Email** and **Secondary_Email**.\n", "items": { "description": "Each string specifies the API name of the field that has the email address to unblock.", "enum": [ "Email" ], "type": "string" }, "maxItems": 2, "type": "array" } }, "required": [ "ids", "unblock_fields" ], "type": "object" }, "x-zs-llm-examples": [ "UnblockMultipleEmails" ] } }, "description": "The request body contains the data required to perform the operation. ", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUnblock": { "description": "Shows a successful response after unblocking the email field for a single record in the bulk request, including the record ID and confirmation message.", "summary": "An example response of successful bulk email unblock request.", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "5545974000000224001" }, "message": "Email unblocked successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Contains the per-record results of the bulk email unblock operation.", "properties": { "data": { "description": "Contains the list of per-record results for the bulk email unblock operation.", "items": { "additionalProperties": false, "description": "Each object represents the result of the unblock operation for an individual record, including the status code, record details, and confirmation message.", "properties": { "code": { "description": "Represents the result code of the unblock operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the identifying information of the record for which the email was unblocked.", "properties": { "id": { "description": "Each string represents the unique identifier of the record for which the email was unblocked.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the descriptive message returned by the server for the unblock operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the unblock operation for the record.", "maxLength": 50, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UnblockEmailByModuleResponse200" } } }, "description": "Returns the per-record results of the bulk email unblock operation, including the status code, record details, and a confirmation message for each record." }, "400": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows an error response returned when the provided OAuth token is invalid or expired.", "summary": "An example response for invalid OAuth token error.", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "invalid oauth token", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response returned when the request fails due to an invalid or expired OAuth token.", "properties": { "code": { "description": "Represents the error code returned by the server.\n\nPossible values:\n\n**INVALID_URL_PATTERN** - The request URL is\nincorrect.\n\n**INVALID_DATA** - The request contains invalid data.\n\n**INVALID_REQUEST_METHOD** - The HTTP method is not\nvalid for this endpoint.\n\n**INVALID_TOKEN** - The OAuth token is invalid or\nexpired.\n", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_REQUEST_METHOD", "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the error, such as the field or parameter that caused the failure.", "type": "object" }, "message": { "description": "Represents the error message returned by the server indicating the issue.", "enum": [ "invalid oauth token" ], "type": "string" }, "status": { "description": "Represents the response status indicating an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnblockEmailByModuleAuthError" }, { "additionalProperties": false, "description": "Represents an error response returned when the request fails due to an invalid module name, incorrect request URL, or invalid record data.", "properties": { "code": { "description": "Represents the error code returned by the server.\n\nPossible values:\n\n**INVALID_URL_PATTERN** - The request URL is\nincorrect.\n\n**INVALID_DATA** - The request contains invalid data.\n\n**INVALID_REQUEST_METHOD** - The HTTP method is not\nvalid for this endpoint.\n\n**INVALID_MODULE** - The specified module name is not\nvalid.\n", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_REQUEST_METHOD", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error, including the index of the resource in the request path that caused the failure.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the resource segment in the request path that triggered the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the reason the request failed, such as an invalid token, invalid record, or invalid module name.", "enum": [ "invalid oauth token", "Invalid record provided", "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the response status indicating an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnblockEmailByModuleRequestError" }, { "additionalProperties": false, "description": "Represents an error response returned when the request fails due to invalid data, a missing mandatory field, or an invalid module name.", "properties": { "code": { "description": "Represents the error code returned by the server.\n\nPossible values:\n\n**INVALID_DATA** - The request contains invalid data.\n\n**INVALID_MODULE** - The specified module name is not\nvalid.\n\n**MANDATORY_NOT_FOUND** - A required field is missing\nfrom the request body.\n", "enum": [ "INVALID_DATA", "INVALID_MODULE", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Contains the expected data type, API name, and JSON path of the field that caused the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected by the server for the field that caused the error.", "maxLength": 50, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the validation error.", "maxLength": 1000, "type": "string" } }, "type": "object", "x-zs-$id": "UnblockEmailByModuleDataErrorWithType" }, { "additionalProperties": false, "description": "Contains the API name and JSON path of the field that caused the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the validation error.", "maxLength": 1000, "type": "string" } }, "type": "object", "x-zs-$id": "UnblockEmailByModuleDataErrorWithoutType" } ], "description": "Contains additional context about the validation error, including the expected data type and the field that caused the failure." }, "message": { "description": "Represents the error message describing the validation or data issue encountered by the server.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the response status indicating an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnblockEmailByModuleDataError" } ], "description": "Contains one of several error response structures returned when the bulk unblock request fails due to invalid parameters, authentication issues, or data validation errors.", "x-zs-$id": "UnblockEmailByModuleResponse400" } } }, "description": "The request is invalid.\n\n**Resolution:** Valid module API names and record IDs must be\nspecified, and the OAuth token must include the required scope.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.UPDATE" ] } ], "summary": "Unblock emails for multiple records in a module", "tags": [ "unblock_email" ], "x-zoho-document": "unblock_email", "x-zs-llm-description": "Use to unblock the `Email` field for up to 100 records of a module in a single call. Pass `module` in the path (currently `Leads` only), and send `ids` (array of record ids, max 100) and `unblock_fields: [\"Email\"]` in the body. Returns a `data` array with per-record SUCCESS results." } }, "/crm/v8/{module}/actions/unenrol_from_cadences": { "post": { "description": "To manually unenroll records of a supported module from one or more Cadences in your Zoho CRM organization.", "operationId": "postUnenrolFromCadences", "parameters": [ { "$ref": "#/components/parameters/CadencesExecutionModule" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "description": "Shows a sample request with Cadence IDs and record IDs for un-enrollment from Cadences.", "summary": "Sample unenroll records request", "value": { "cadences_ids": [ "534412000002201155", "534412000002201156" ], "ids": [ "1234567890234567", "1234567890456789", "2345678902345678" ] } } }, "schema": { "$ref": "#/components/schemas/PostCadencesRequest" } } }, "description": "The request body must contain a Cadence IDs array and a record IDs array for the unenrollment request." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "description": "Shows the successful un-enrollment result for a record, including the record ID and the associated Cadences.", "summary": "Successful un-enrollment result", "value": { "data": [ { "code": "SUCCESS", "details": { "cadences": [ { "id": "1234567890456789", "name": "Cadence 1" }, { "id": "1234567890456789", "name": "Cadence 2" } ], "id": "534412000002201155" }, "message": "records manually unenrolled", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostcadencesResponse200" } } }, "description": "Returns the un-enrollment result for all records in the request." }, "207": { "content": { "application/json": { "examples": { "Success207": { "description": "Shows a multi-status response with one successful and one failed per-record un-enrollment result.", "summary": "Multi-status response with partial un-enrollment success", "value": { "data": [ { "code": "SUCCESS", "details": { "cadences": [ { "id": "1234567890456789", "name": "Cadence 1" }, { "id": "1234567890456789", "name": "Cadence 2" } ], "id": "534412000002201155" }, "message": "records manually unenrolled", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "ids", "json_path": "$.ids[1]" }, "message": "given id seems to be invalid", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/PostcadencesResponse207" } } }, "description": "Returns a multi-status response when some records were unenrolled successfully and others failed. Each item in the data array independently indicates success or failure for the corresponding record." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedResponse1": { "description": "Shows the API_NOT_SUPPORTED error returned when a client portal user attempts to call this API.", "summary": "API_NOT_SUPPORTED error for client portal users", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_login_user_type": "Client Portal User" }, "message": "api not supported for client portal user", "status": "error" } }, "ApiNotSupportedResponse2": { "description": "Shows the API_NOT_SUPPORTED error returned when the API is accessed from an unsupported domain.", "summary": "API_NOT_SUPPORTED error for unsupported domain", "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_domains": [ "eu", "com", "in", "au", "ca", "cn", "jp" ] }, "message": "api not supported", "status": "error" } }, "InvalidDataResponse1": { "description": "Shows the INVALID_DATA error returned when an entry in the Cadence ID array is invalid, such as exceeding the maximum string length.", "summary": "INVALID_DATA error - invalid entry in Cadence ID array", "value": { "code": "INVALID_DATA", "details": { "api_name": "cadences_ids", "json_path": "$.cadences_ids", "maximum_length": 5 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "description": "None", "summary": "Error response - record IDs expected as an array", "value": { "code": "INVALID_DATA", "details": { "api_name": "ids", "expected_data_type": "jsonarray", "json_path": "$.ids" }, "message": "Record ids not found", "status": "error" } }, "InvalidDataResponse3": { "description": "None", "summary": "Error response - Cadence IDs expected as an array", "value": { "code": "INVALID_DATA", "details": { "api_name": "cadences_ids", "expected_data_type": "jsonarray", "json_path": "$.cadences_ids" }, "message": "Cadences ids not found", "status": "error" } }, "InvalidDataResponse4": { "description": "None", "summary": "Error response - invalid Cadence ID provided", "value": { "code": "INVALID_DATA", "details": { "api_name": "cadences_ids", "json_path": "$.cadences_ids" }, "message": "the given id seems to be invalid", "status": "error" } }, "InvalidDataResponse5": { "description": "None", "summary": "Error response - invalid record ID provided", "value": { "code": "INVALID_DATA", "details": { "api_name": "ids", "json_path": "$.ids" }, "message": "the given id seems to be invalid", "status": "error" } }, "InvalidDataResponseArray": { "description": "None", "summary": "Error response - multiple invalid record IDs", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "ids", "json_path": "$.ids[0]" }, "message": "given id seems to be invalid", "status": "error" }, { "code": "INVALID_DATA", "details": { "api_name": "ids", "json_path": "$.ids[1]" }, "message": "given id seems to be invalid", "status": "error" } ] } }, "LimitExceededResponse1": { "description": "Shows the LIMIT_EXCEEDED error returned when more than five Cadence IDs are included in the request.", "summary": "LIMIT_EXCEEDED error - Cadence ID array exceeds the limit", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 5, "limit_due_to": [ { "api_name": "cadences_ids", "json_path": "$.cadences_ids" } ] }, "message": "Limit Exceeded, You cannot give more than 5 cadences ids", "status": "error" } }, "LimitExceededResponse2": { "description": "Shows the LIMIT_EXCEEDED error returned when more than 100 record IDs are included in the request.", "summary": "LIMIT_EXCEEDED error for ids exceeding 100", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": 100, "limit_due_to": [ { "api_name": "ids", "json_path": "$.ids" } ] }, "message": "Limit Exceeded, You cannot give more than 100 record ids", "status": "error" } }, "MandatoryNotFoundResponse1": { "description": "None", "summary": "Error response - record IDs not provided", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "ids", "json_path": "$.ids" }, "message": "Record ids not found", "status": "error" } }, "MandatoryNotFoundResponse2": { "description": "None", "summary": "Error response - Cadence IDs not provided", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "cadences_ids", "json_path": "$.cadences_ids" }, "message": "Cadences ids not found", "status": "error" } }, "NotAllowedResponse1": { "description": "Shows the NOT_ALLOWED error returned when a Cadence ID in the request does not correspond to a manual enrollment Cadence.", "summary": "NOT_ALLOWED error for non-manual Cadence ID", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "cadences_id", "json_path": "$.cadences_id[0]" }, "message": "id given is not manual enrollment cadence", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ErrorResponseApiNotSupportedClientPortal" }, { "$ref": "#/components/schemas/ErrorResponseApiNotSupportedDomain" }, { "$ref": "#/components/schemas/ErrorResponseLimitExceededCadenceIds" }, { "$ref": "#/components/schemas/ErrorResponseLimitExceededRecordIds" }, { "$ref": "#/components/schemas/CadencesExecutionErrorResponseNotAllowed" }, { "$ref": "#/components/schemas/ErrorResponseInvalidDataCadenceIds" }, { "$ref": "#/components/schemas/CadencesExecutionErrorResponseMandatoryNotFound" }, { "$ref": "#/components/schemas/ErrorResponseDataInvalidDataType" }, { "$ref": "#/components/schemas/ErrorResponseDataInvalidId" }, { "$ref": "#/components/schemas/ErrorResponseDataInvalidIdArray" } ], "description": "Represents one of the possible error responses for a 400 Bad Request status, indicating an invalid or unsupported request parameter.", "x-zs-$id": "UnenrolCadences400Schema" } } }, "description": "The request could not be processed due to invalid or unsupported input.\n**Resolution:** The record IDs and Cadence IDs must be valid, the API must be accessed from a supported domain, and the specified Cadences must support manual enrollment." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "description": "Shows the NO_PERMISSION error returned when the requesting user's CRM profile lacks the Crm_Implied_Manage_UnEnroll_Series permission.", "summary": "NO_PERMISSION error for missing profile permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_UnEnroll_Series" ] }, "message": "No permission", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse403", "description": "Represents the error response for a 403 Forbidden status, indicating insufficient permissions to perform the un-enrollment operation." } } }, "description": "The requesting user does not have the required permission to perform Cadence un-enrollment.\n**Resolution:** The CRM administrator must grant the **Crm_Implied_Manage_UnEnroll_Series** permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.CREATE" ] } ], "summary": "Un-enroll Records from Cadences", "tags": [ "cadences_execution" ], "x-zoho-document": "cadences_execution", "x-zs-llm-description": "Removes the given records from the given cadences. Updates CRMENTITYSERIES (Member_Status=Un-enrolled, Series_Status=Stopped/Completed/Failed, UNENROLLED_DATE=now), deletes any scheduled future follow-up actions for the affected records (CRMTRIGGERENTITYREL) and pending scheduled enrollments (CRMWFRULEENTITYREL).", "x-zs-llm-examples": [ "SamplePostRequest" ] } }, "/crm/v8/{module}/bulk/search": { "post": { "description": "Searches for records in the specified module that match the given search criteria. This API accepts the same search parameters as the GET /{module}/search API, but they are provided in the request body instead of query parameters. Use this API when the search criteria are too long to be passed as query parameters. You must specify at least one of the following search parameters: criteria, email, phone, or word. A maximum of 2,000 records can be retrieved per search, with up to 15 criteria conditions. Newly created or updated records may not appear immediately in the search results due to indexing delays.", "operationId": "bulkSearchRecords", "parameters": [ { "$ref": "#/components/parameters/ModuleSearchModule" }, { "$ref": "#/components/parameters/ModuleSearchApprovalState" }, { "$ref": "#/components/parameters/ModuleSearchCriteria" }, { "$ref": "#/components/parameters/ModuleSearchConverted" }, { "$ref": "#/components/parameters/SearchWord" }, { "$ref": "#/components/parameters/SearchEmail" }, { "$ref": "#/components/parameters/SearchPhone" }, { "$ref": "#/components/parameters/ModuleSearchFields" }, { "$ref": "#/components/parameters/ModuleSearchPage" }, { "$ref": "#/components/parameters/ModuleSearchPerPage" }, { "$ref": "#/components/parameters/ModuleSearchSortBy" }, { "$ref": "#/components/parameters/ModuleSearchSortOrder" }, { "$ref": "#/components/parameters/ModuleSearchType" } ], "responses": { "200": { "content": { "application/json": { "examples": { "LeadBulkSearchResult": { "summary": "Sample lead bulk search result", "value": { "data": [ { "Company": "Zylker", "Created_By": { "id": "", "name": "John Smith" }, "Created_Time": "2023-01-15T10:30:00+00:00", "Email": "john.smith@zylker.com", "Lead_Status": "Qualified", "Modified_By": { "id": "", "name": "John Smith" }, "Modified_Time": "2023-01-20T14:45:00+00:00", "Owner": { "email": "john.smith@zylker.com", "id": "", "name": "John Smith" }, "id": "" } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "additionalProperties": false, "description": "Successful bulk search response containing matched records and pagination information", "properties": { "data": { "description": "Array of records matching the search criteria", "items": { "additionalProperties": true, "description": "Record object containing module-specific fields and system fields", "properties": { "Created_By": { "additionalProperties": false, "description": "User who created the record", "properties": { "email": { "description": "Email address of the user who created the record", "format": "email", "type": "string" }, "id": { "description": "Unique identifier of the user who created the record", "maxLength": 50, "type": "string" }, "name": { "description": "Name of the user who created the record", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "Created_Time": { "description": "Timestamp when the record was created", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "User who last modified the record", "properties": { "email": { "description": "Email address of the user who last modified the record", "format": "email", "type": "string" }, "id": { "description": "Unique identifier of the user who last modified the record", "maxLength": 50, "type": "string" }, "name": { "description": "Name of the user who last modified the record", "maxLength": 255, "type": "string" } }, "type": "object" }, "Modified_Time": { "description": "Timestamp when the record was last modified", "format": "date-time", "type": "string" }, "Owner": { "additionalProperties": false, "description": "Owner information of the record", "properties": { "email": { "description": "Email address of the owner", "format": "email", "type": "string" }, "id": { "description": "Unique identifier of the owner", "maxLength": 50, "type": "string" }, "name": { "description": "Name of the record owner", "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "Unique identifier of the record", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Pagination and response metadata", "properties": { "count": { "description": "Number of records in current response", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates if more records are available", "type": "boolean" }, "page": { "description": "Current page number", "format": "int32", "type": "integer" }, "per_page": { "description": "Number of records per page", "format": "int32", "type": "integer" }, "sort_by": { "description": "Field used for sorting the records", "maxLength": 100, "type": "string" }, "sort_order": { "description": "Order of sorting the records", "enum": [ "asc", "desc" ], "type": "string" } }, "type": "object" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ModuleBulkSearchResponse" } } }, "description": "Successful response containing the list of records matching the search criteria." }, "204": { "description": "No Content - The request was successful, but no records matched the search criteria. This may occur due to indexing delays when searching for recently created/modified records." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "summary": "Invalid module specified", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "MissingParameter": { "summary": "Missing required search parameter", "value": { "code": "EXPECTED_PARAM_MISSING", "details": { "param_names": [ "criteria", "email", "phone", "word" ] }, "message": "one of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MissingRequiredParameterErrorResponse" }, { "$ref": "#/components/schemas/ModuleSearchInvalidModuleErrorResponse" } ], "x-zs-$id": "ModuleBulkSearchBadRequestErrorResponse" } } }, "description": "Bad Request - The request could not be processed due to invalid input, missing mandatory parameters, or malformed search criteria." }, "401": { "content": { "application/json": { "examples": { "OauthScopeMismatch": { "summary": "Missing required OAuth scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Unauthorized - Authentication failed or insufficient OAuth scope permissions." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "summary": "Insufficient permissions for module access", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Permission denied to read", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Forbidden - User lacks permission to access the requested module or perform the search operation." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "summary": "Invalid API endpoint URL", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Not Found - The requested URL pattern is invalid or the specified resource does not exist." }, "429": { "content": { "application/json": { "examples": { "RateLimitExceeded": { "summary": "API rate limit exceeded", "value": { "code": "RATE_LIMIT_EXCEEDED", "details": {}, "message": "Too many requests. Please try again later.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Too Many Requests - Rate limit exceeded. Wait before making additional requests." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Internal Server Error - An unexpected error occurred on the server. Contact support if the issue persists." }, "502": { "content": { "application/json": { "examples": { "ServiceUnavailable": { "summary": "Upstream service failure", "value": { "code": "SERVICE_UNAVAILABLE", "details": {}, "message": "Service temporarily unavailable", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Bad Gateway - Temporary service dependency failure. The request should be retried." }, "503": { "content": { "application/json": { "examples": { "MaintenanceMode": { "summary": "Service under maintenance", "value": { "code": "SERVICE_UNAVAILABLE", "details": {}, "message": "Service temporarily unavailable for maintenance", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Service Unavailable - The service is temporarily unavailable due to maintenance or capacity issues." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Invoices.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Forecasts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Activities.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Attachments.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.READ" ] }, { "OAuth2": [ "ZohoCRM.users.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.READ", "ZohoCRM.users.READ" ] } ], "summary": "Bulk Search Records by Criteria, Word, Email, or Phone", "tags": [ "module_search" ], "x-zoho-document": "module_search", "x-zs-llm-description": "Use this tool when you want to bulk search records matching for the given criteria within a single module in CRM using a POST request with the search parameters supplied in the request body (useful when the criteria payload is too large for a query string)." } }, "/crm/v8/{module}/deleted": { "get": { "description": "To retrieve the list of deleted records from the specified module in your Zoho CRM organization, including records in the recycle bin and permanently deleted records. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name.", "operationId": "getDeletedRecords", "parameters": [ { "$ref": "#/components/parameters/RecordModule" }, { "$ref": "#/components/parameters/DeletedRecordsType" }, { "$ref": "#/components/parameters/RecordPage" }, { "$ref": "#/components/parameters/RecordPerPage" }, { "$ref": "#/components/parameters/RecordIfModifiedSince" } ], "responses": { "200": { "content": { "application/json": { "examples": { "DeletedRecords": { "description": "Shows the successful response containing deleted records with their deletion metadata and type information.", "summary": "List of deleted records with metadata", "value": { "data": [ { "created_by": { "id": "410888000000086001", "name": "Patricia Boyle" }, "deleted_by": { "id": "410888000000086001", "name": "Patricia Boyle" }, "deleted_time": "2015-06-19T11:19:38+05:30", "display_name": "Patricia", "id": "410888000000099071", "type": "recycle" }, { "created_by": { "id": "410888000000086001", "name": "Patricia Boyle" }, "deleted_by": { "id": "410888000000086001", "name": "Patricia Boyle" }, "deleted_time": "2015-04-07T17:43:33+05:30", "display_name": "Patricia", "id": "410888000000094004", "type": "recycle" }, { "created_by": null, "deleted_by": null, "deleted_time": "2016-10-26T11:44:15+05:30", "display_name": null, "id": "410888000000680013", "type": "permanent" }, { "created_by": null, "deleted_by": null, "deleted_time": "2016-10-26T11:44:15+05:30", "display_name": null, "id": "410888000000680009", "type": "permanent" } ], "info": { "count": 4, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "$ref": "#/components/schemas/DeletedRecordsSuccessResponse" } } }, "description": "Returns the deletion status for each records successfully deleted." }, "204": { "description": "Returns an empty response when the request is successful but no records match the specified criteria." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request", "value": { "data": [ { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "PatternNotMatched": { "description": "Shows the error response when the provided value does not match the expected pattern.", "summary": "Value does not match the expected pattern", "value": { "data": [ { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "type" }, "message": "Please check whether the input values are correct", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/DeletedRecordsErrorResponse" } } }, "description": "The request could not be processed because of an invalid module, missing parameters, or invalid record IDs.\n**Resolution:** The request must include valid module API name and record IDs." }, "401": { "content": { "application/json": { "examples": { "ScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to delete records in the specified module.\n**Resolution:** The CRM administrator must grant the required deletion permission to the user's profile." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Get deleted records from a specified module", "tags": [ "record" ], "x-zoho-document": "record" } }, "/crm/v8/{module}/search": { "get": { "description": "To search for records within a specified module in your Zoho CRM organization using criteria-based conditions, full-text word search, or lookup by email or phone number.", "operationId": "searchRecords", "parameters": [ { "$ref": "#/components/parameters/ModuleSearchModule" }, { "$ref": "#/components/parameters/ModuleSearchApprovalState" }, { "$ref": "#/components/parameters/ModuleSearchCriteria" }, { "$ref": "#/components/parameters/ModuleSearchConverted" }, { "$ref": "#/components/parameters/SearchWord" }, { "$ref": "#/components/parameters/SearchEmail" }, { "$ref": "#/components/parameters/SearchPhone" }, { "$ref": "#/components/parameters/ModuleSearchFields" }, { "$ref": "#/components/parameters/ModuleSearchPage" }, { "$ref": "#/components/parameters/ModuleSearchPerPage" }, { "$ref": "#/components/parameters/ModuleSearchSortBy" }, { "$ref": "#/components/parameters/ModuleSearchSortOrder" }, { "$ref": "#/components/parameters/ModuleSearchType" }, { "$ref": "#/components/parameters/ModuleSearchIncludeLiteUsers" }, { "$ref": "#/components/parameters/ModuleSearchRoleId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "LeadSearchResult": { "description": "Shows a successful search response returning a single lead record with standard system fields and pagination metadata.", "summary": "Sample lead search result", "value": { "data": [ { "Company": "Zylker", "Created_By": { "id": "5843104000000411001", "name": "John Smith" }, "Created_Time": "2023-01-15T10:30:00+00:00", "Email": "lead@zylker.com", "Lead_Status": "Qualified", "Modified_By": { "id": "5843104000000411001", "name": "John Smith" }, "Modified_Time": "2023-01-20T14:45:00+00:00", "Owner": { "email": "john.smith@example.com", "id": "5843104000000411001", "name": "John Smith" }, "id": "5843104000000624035" } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 200 } } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response returned by the search operation, containing the matched records and pagination metadata.", "properties": { "data": { "description": "Represents the list of records matching the search criteria.", "items": { "additionalProperties": true, "description": "Represents a record that matches the search criteria. Contains standard system fields and module-specific fields for the matched record.", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the user who created the record.", "properties": { "email": { "description": "Searches for records using an email address. The API searches across all email fields in the specified module and returns matching records.", "format": "email", "type": "string" }, "id": { "description": "Represents the unique ID of the user who created the record.", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the name of the user who created the record.", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "Created_Time": { "description": "Represents the creation timestamp of the record.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified the record.", "properties": { "email": { "description": "Searches for records using an email address. The API searches across all email fields in the specified module and returns matching records.", "format": "email", "type": "string" }, "id": { "description": "Represents the unique ID of the user who last modified the record.", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the name of the user who last modified the record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "Modified_Time": { "description": "Represents the date and time when the record was last modified.", "format": "date-time", "type": "string" }, "Owner": { "additionalProperties": false, "description": "Represents the owner of the record.", "properties": { "email": { "description": "Searches for records using an email address. The API searches across all email fields in the specified module and returns matching records.", "format": "email", "type": "string" }, "id": { "description": "Represents the unique ID of the record owner.", "maxLength": 50, "type": "string" }, "name": { "description": "Represents the name of the record owner.", "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "Represents the unique ID of the record.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents the pagination and sort metadata for the response.", "properties": { "count": { "description": "Represents the number of records returned in the current page.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether more records are available beyond the current page.\nPossible values:\n**true** - More records are available.\n**false** - No more records are available.", "type": "boolean" }, "page": { "description": "Represents the current page number of the response.", "format": "int32", "type": "integer" }, "per_page": { "description": "Specify how many records to return per page. The default and the maximum possible value is 200.", "format": "int32", "type": "integer" }, "sort_by": { "description": "Represents the field used to sort the records in the response.", "maxLength": 100, "type": "string" }, "sort_order": { "description": "Represents the sort direction applied to the records in the response.\nPossible values:\n**asc** - Ascending order.\n**desc** - Descending order.", "enum": [ "asc", "desc" ], "type": "string" } }, "type": "object" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "ModuleSearchResponse" } } }, "description": "Returns the list of records that match the search criteria, along with pagination metadata." }, "204": { "description": "No matching records found. This may occur if no records match the search criteria or if recently created or modified records have not yet been indexed. Resolution: Verify the search parameters and retry." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "description": "Shows the error response when a non-existent or unsearchable module API name is provided.", "summary": "Invalid module specified", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "MissingParameter": { "description": "Shows the error response when none of the required search parameters (criteria, email, phone, or word) are included in the request.", "summary": "Missing required search parameter", "value": { "code": "EXPECTED_PARAM_MISSING", "details": { "param_names": [ "criteria", "email", "phone", "word" ] }, "message": "one of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error response returned when the search request contains an invalid value for one or more parameters.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**INVALID_REQUEST** - The request contains one or more invalid parameter values.", "enum": [ "INVALID_REQUEST" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the invalid request.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "InvalidRequestErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned when the search operation is not supported for the specified module.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**NOT_SUPPORTED** - The search operation is not supported for the specified module.", "enum": [ "NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the name of the module that does not support search.", "properties": { "module": { "description": "Represents the API name of the module that does not support the search operation.", "maxLength": 100, "type": "string" } }, "required": [ "module" ], "type": "object" }, "message": { "description": "Represents the error message describing the unsupported operation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "NotSupportedErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned when at least one of the required search parameters (criteria, email, phone, or word) is missing from the request.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**EXPECTED_PARAM_MISSING** - At least one of the required search parameters is absent from the request.", "enum": [ "EXPECTED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the names of the missing search parameters.", "properties": { "param_names": { "description": "Represents the list of search parameters that are missing from the request.\nPossible values in the array: **criteria**, **email**, **phone**, **word**.", "items": { "description": "Represents the name of a missing search parameter.", "enum": [ "criteria", "email", "phone", "word" ], "type": "string" }, "maxItems": 4, "type": "array" } }, "required": [ "param_names" ], "type": "object" }, "message": { "description": "Represents the error message describing the missing parameter.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "SearchMissingRequiredParameterErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned when the specified module API name does not exist or is not a searchable module.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**INVALID_MODULE** - The specified module does not exist or is not searchable.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the resource path index where the invalid module value was found.", "properties": { "resource_path_index": { "description": "Represents the index position in the request URL path where the invalid module value was found.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid module.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "SearchInvalidModuleErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned when the search criteria query is syntactically or semantically invalid.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**INVALID_QUERY** - The search criteria contains an invalid condition, operator, or field reference.", "enum": [ "INVALID_QUERY" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error details returned when a field value in the search criteria does not match the expected data type.", "properties": { "expected_data_type": { "description": "Represents the expected data type for the field referenced in the search criteria.", "maxLength": 100, "type": "string" }, "reason": { "description": "Represents the reason the search criteria is invalid due to a data type mismatch.", "maxLength": 500, "type": "string" } }, "required": [ "expected_data_type", "reason", "api_name" ], "type": "object", "x-zs-$id": "DataTypeMismatchErrorDetails" }, { "additionalProperties": false, "description": "Represents the error details for an unsupported operator in the search criteria.", "properties": { "operator": { "description": "Represents the invalid operator used in the search criteria.", "maxLength": 50, "type": "string" }, "reason": { "description": "Represents the reason the operator used in the search criteria is invalid.", "maxLength": 500, "type": "string" } }, "required": [ "operator", "reason", "api_name" ], "type": "object", "x-zs-$id": "InvalidOperatorErrorDetails" }, { "additionalProperties": false, "description": "Represents the error details returned when the search criteria cannot be processed due to a general query failure.", "properties": { "reason": { "description": "Represents the reason the search criteria failed to process.", "maxLength": 500, "type": "string" } }, "required": [ "api_name" ], "type": "object", "x-zs-$id": "GeneralQueryErrorDetails" }, { "additionalProperties": false, "description": "Represents empty details object for malformed query.", "maxProperties": 0, "type": "object", "x-zs-$id": "EmptyQueryErrorDetails" } ], "description": "Represents the query error details. The content varies based on the type of query error encountered." }, "message": { "description": "Represents the error message describing the query issue.", "enum": [ "the field in restricted in GDPR", "the field in restricted in Hipaa", "Invalid query formed" ], "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidQueryErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned when the IN operator in the search criteria exceeds the maximum allowed value count.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**INVALID_QUERY** - The IN operator criteria exceeds the allowed value count.", "enum": [ "INVALID_QUERY" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the name of the field whose IN operator criteria exceeded the allowed value count.", "properties": { "param_name": { "description": "Represents the name of the field whose IN operator criteria exceeded the allowed value count.", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the IN operator violation.", "enum": [ "Only 100 values are allowed in \"IN\" criteria", "Invalid query formed" ], "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "InvalidQueryErrorResponseInOperatorViolations" }, { "additionalProperties": false, "description": "Represents the error response returned when the number of records to iterate through exceeds the maximum limit of 2,000.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**LIMIT_REACHED** - The number of records to iterate through exceeds the maximum limit.", "enum": [ "LIMIT_REACHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error, including the maximum iteration limit value.", "properties": { "limit": { "description": "Represents the maximum number of records that can be iterated through in a single search operation.\nPossible values:\n**2000** - The maximum iteration limit for search results.", "enum": [ "2000" ], "type": "string" } }, "required": [ "limit" ], "type": "object" }, "message": { "description": "Represents the error message describing the limit reached condition.", "enum": [ "maximum response iteration limit reached" ], "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "LimitReachedErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned when the search criteria contains more than 15 conditions.", "properties": { "code": { "description": "Represents the error code for the response.\nPossible values:\n**CRITERIA_LIMIT_EXCEEDED** - The search criteria contains more than the allowed number of conditions.", "enum": [ "CRITERIA_LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the criteria limit exceeded condition.", "enum": [ "no of criterium that can be given exceed the limit 15" ], "type": "string" }, "status": { "description": "Represents the status of the response.\nPossible values:\n**error** - The request encountered an error.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "CriteriaLimitExceededErrorResponse" }, { "additionalProperties": false, "description": "Represents the error response returned for invalid request scenarios not covered by other specific error codes.", "type": "object", "x-zs-$id": "GenericBadRequestErrorResponse" } ], "description": "Represents the error response returned when the search request is invalid. The specific error format depends on the type of validation failure.", "x-zs-$id": "ModuleSearchBadRequestErrorResponse" } } }, "description": "The request could not be processed due to invalid, missing, or unsupported search parameters. Resolution: Ensure that at least one search parameter (criteria, email, phone, or word) is included and contains a valid value." }, "401": { "content": { "application/json": { "examples": { "OauthScopeMismatch": { "description": "Shows the error response when the access token does not include a valid module-level READ scope.", "summary": "Missing required OAuth scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "Authentication failed or the access token does not include the required OAuth scope. Resolution: Generate a new access token that includes the required module-level READ scope and retry the request." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the error response when the authenticated user does not have the required permission to access the module.", "summary": "Insufficient permissions for module access", "value": { "code": "NO_PERMISSION", "details": {}, "message": "Permission denied to read", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "The authenticated user does not have permission to access the specified module. Resolution: Contact the Zoho CRM administrator to grant the required module access." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the error response when the request URL does not match a valid API endpoint pattern.", "summary": "Invalid API endpoint URL", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "The request URL is invalid or the specified module does not exist. Resolution: Verify that the module API name and URL structure are correct." }, "429": { "content": { "application/json": { "examples": { "RateLimitExceeded": { "description": "Shows the error response when the API request rate limit has been exceeded.", "summary": "API rate limit exceeded", "value": { "code": "RATE_LIMIT_EXCEEDED", "details": {}, "message": "Too many requests. Please try again later.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "The API request rate limit has been exceeded. Resolution: Reduce the frequency of API calls and retry the request after the rate limit window resets." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the error response when an unexpected internal server error is encountered.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "An unexpected error occurred on the server. Resolution: Retry the request. If the issue persists, contact Zoho CRM support." }, "502": { "content": { "application/json": { "examples": { "ServiceUnavailable": { "description": "Shows the error response when a temporary upstream dependency failure causes the request to fail.", "summary": "Upstream service failure", "value": { "code": "SERVICE_UNAVAILABLE", "details": {}, "message": "Service temporarily unavailable", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "A temporary upstream dependency failure occurred. Resolution: Retry the request." }, "503": { "content": { "application/json": { "examples": { "MaintenanceMode": { "description": "Shows the error response when the service is unavailable due to scheduled maintenance.", "summary": "Service unavailable for maintenance", "value": { "code": "SERVICE_UNAVAILABLE", "details": {}, "message": "Service temporarily unavailable for maintenance", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/ModuleSearchErrorResponse" } } }, "description": "The service is temporarily unavailable due to scheduled maintenance or capacity constraints. Resolution: Retry the request after the maintenance window ends." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Invoices.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Forecasts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Activities.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Attachments.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.READ" ] }, { "OAuth2": [ "ZohoCRM.users.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.READ", "ZohoCRM.users.READ" ] } ], "summary": "Search Records by Criteria, Word, Email, or Phone", "tags": [ "module_search" ], "x-zoho-document": "module_search", "x-zs-llm-description": "Use this tool when you want to search records matching for the given criteria in param within single module in CRM" } }, "/crm/v8/{module}/upsert": { "post": { "description": "The Upsert API inserts a new record or updates an existing record based on duplicate check field values. If a matching record is found, it is updated; otherwise, a new record is inserted.\nWhen using the Upsert API, the system checks for duplicate records based on the duplicate check fields. There are two types of duplicate check fields: system-defined duplicate check fields and user-defined unique fields.\nSystem-defined duplicate check fields are predefined unique fields for each module. The system automatically checks these fields to prevent duplicate records. Refer to the System-defined Duplicate Check Fields section for module-specific details.\nUser-defined unique fields are fields for which the \"Do not allow duplicate values\" option is enabled. These fields allow users to define custom fields for duplicate checking. For more information, refer to [Mark a Field as Unique](https://help.zoho.com/portal/en/kb/crm/customize-crm-account/customizing-fields/articles/use-custom-fields#Mark_a_Field_as_Unique). When a record is upserted, the system first checks for duplicates in these fields. If a matching record exists, it gets updated; otherwise, a new record is inserted.\nYou can specify the order in which the system checks for duplicate records using the \"duplicate_check_fields\" array in the API request. The array can contain system-defined duplicate check fields, such as \"Email\" for the Leads module, and user-defined unique fields, such as \"Phone\" and \"Fax\".\nFor example, in the Leads module, you can specify: \"duplicate_check_fields\": [\"Email\", \"Phone\", \"Fax\"].\nIf \"duplicate_check_fields\" is not specified, the system checks duplicate records in the following order: 1. System-defined duplicate check fields. 2. User-defined unique fields.", "operationId": "upsertRecords", "parameters": [ { "$ref": "#/components/parameters/RecordModule" } ], "requestBody": { "content": { "application/json": { "examples": { "RequestBody": { "description": "Shows the request body structure for the upsertRecords operation.", "summary": "Sample request body for the upsertRecords operation", "value": { "data": [ { "Email": "a@gmail.com", "Last_Name": "test", "Phone": "987654321", "id": "5725767000000524001" } ], "duplicate_check_fields": [ "Phone" ] } } }, "schema": { "$ref": "#/components/schemas/RecordsUpsertSchema" } } }, "description": "The request body must contain a **data** array. You can include a maximum of 100 objects per request. You must use only Field API names in the input; obtain them from the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get). The \"INVALID_DATA\" error is returned if a field value exceeds the maximum length defined for that field. For example, if a Text field has a maximum length of 10 characters, the API cannot accept a value such as \"12345678901\", since it contains 11 characters. Records with subform details can also be inserted or updated through this API. Provide the layout ID to include layout-specific mandatory fields in the API-level mandatory field check; only the fields defined in that layout are considered for processing, and the rest are ignored.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the successful response for the upsertRecords operation, including the record ID and audit metadata.", "summary": "Successfully completed operation", "value": { "data": [ { "action": "update", "code": "SUCCESS", "details": { "Created_By": { "id": "4150868000000225013", "name": "Patricia Boyle" }, "Created_Time": "2019-09-11T16:21:15+05:30", "Modified_By": { "id": "4150868000000225013", "name": "Patricia Boyle" }, "Modified_Time": "2020-10-14T10:31:43+05:30", "id": "4150868000000376008" }, "duplicate_field": "Email", "message": "record updated", "status": "success" }, { "action": "insert", "code": "SUCCESS", "details": { "Created_By": { "id": "4150868000000225013", "name": "Patricia Boyle" }, "Created_Time": "2020-10-14T10:31:43+05:30", "Modified_By": { "id": "4150868000000225013", "name": "Patricia Boyle" }, "Modified_Time": "2020-10-14T10:31:43+05:30", "id": "4150868000003194003" }, "duplicate_field": "Email", "message": "record added", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordUpsertSuccessResponse" } } }, "description": "Returns the details of each successfully processed records, including the record ID and audit metadata." }, "207": { "content": { "application/json": { "examples": { "MixedResults": { "description": "Shows the 207 multi-status response with a mix of successful and failed records in the data array.", "summary": "Mixed results with success and failure items", "value": { "data": [ { "action": "insert", "code": "SUCCESS", "details": { "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "111112000000142001" }, "duplicate_field": "Email", "message": "record added", "status": "success" }, { "code": "INVALID_DATA", "details": { "api_name": "Company", "expected_data_type": "text", "json_path": "$.data[1].Company" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the multi-status response returned when a bulk operation results in mixed success and failure outcomes.", "properties": { "data": { "allOf": [ { "description": "Ensures the response contains at least one successful result in the data array." }, { "description": "Ensures the response contains at least one failed result in the data array." } ], "description": "Contains the list of per-record results for the operation.", "items": { "anyOf": [ { "$ref": "#/components/schemas/RecordUpsertSuccessDataItem" }, { "$ref": "#/components/schemas/RecordUpsertErrorDataItem" } ], "description": "Represents a single record operation result, which is either a success or error item identified by the **status** field." }, "maxItems": 100, "minItems": 2, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordsUpsertMultiStatusResponse" } } }, "description": "Returns a multi-status response when some record upsert operations succeed and others fail. Each item in the data array independently reports the outcome for the corresponding record." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows the error response when the user does not have sufficient privileges for this operation.", "summary": "Insufficient privileges for the operation", "value": { "data": [ { "code": "AUTHORIZATION_FAILED", "details": { "resource_path_index": 0 }, "message": "User does not have sufficient privilege to perform this action", "status": "error" } ] } }, "DependentFieldMissing": { "description": "Shows the error response when a required dependent field is absent from the request.", "summary": "Required dependent field missing from the request", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Product_Subcategory", "dependee": { "api_name": "Product_Category", "json_path": "$.data[0].Product_Category" }, "json_path": "$.data[0].Product_Subcategory" }, "message": "The field 'Product_Subcategory' is required when 'Product_Category' is provided", "status": "error" } ] } }, "DependentMismatch": { "description": "Shows the error response when a dependent field value conflicts with its controlling field.", "summary": "Dependent field value conflicts with controlling field", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be greater than current Time.", "status": "error" } ] } }, "DependentServiceError": { "description": "Shows the error response when a dependent external service fails during the operation.", "summary": "Dependent external service error during processing", "value": { "data": [ { "code": "DEPENDENT_SERVICE_ERROR", "details": { "dependency_error": "NO_PERMISSION" }, "message": "The dependent service does not have permission to complete the operation", "status": "error" } ] } }, "DuplicateDataError": { "description": "Shows the error response when a unique field value already exists in the module.", "summary": "Duplicate unique field value matches an existing record", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Unique_1", "duplicate_record": { "Owner": { "id": "2008662000000454001", "name": "Pranav", "zuid": "75092197" }, "id": "2008662000006256222" }, "id": "2008662000006256222", "json_path": "$.data[0].Unique_1", "more_records": false }, "message": "duplicate data", "status": "error" } ] } }, "InvalidData": { "description": "Shows the error response when invalid data is provided in the request.", "summary": "Invalid field value in the request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Company", "json_path": "$.data[0].Company" }, "message": "The field value given for Company is invalid", "status": "error" } ] } }, "InvalidDataLength": { "description": "Shows the error response when a field value exceeds the maximum allowed length.", "summary": "Field value exceeds the maximum allowed length", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "json_path": "$.data[0].Number_1", "maximum_length": 2 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataType": { "description": "Shows the error response when a field value does not match the expected data type.", "summary": "Field value with an incorrect data type", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "expected_data_type": "integer", "json_path": "$.data[0].Number_1" }, "message": "invalid data", "status": "error" } ] } }, "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request", "value": { "data": [ { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "InvalidRequestMethod": { "description": "Shows the error response when an unsupported HTTP method is used for this endpoint.", "summary": "Unsupported HTTP method for this endpoint", "value": { "data": [ { "code": "INVALID_REQUEST_METHOD", "details": { "resource_path_index": 0 }, "message": "The HTTP request method type is not a valid one.", "status": "error" } ] } }, "InvalidSupportedValue": { "description": "Shows the error response when an unsupported value is provided for a fixed-value field.", "summary": "Unsupported value for a fixed-value field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.apply_feature_execution[0].name", "supported_values": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ] }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFoundInsert": { "description": "Shows the error response when a required field is absent during a record create via the upsert operation.", "summary": "Required field missing during a record create via upsert", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.data.service.id" }, "message": "Service Id Not Found", "status": "error" } ] } }, "MandatoryNotFoundLayoutRule": { "description": "Shows the error response when a field made mandatory by a Layout Rule is absent from the upsert request.", "summary": "Layout rule mandatory field absent from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Designation", "id": "5410702000000761566", "json_path": "$.data[0].Designation", "layout_rule": { "id": "5410702000000761547", "name": "Layout Rule" } }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundLayoutRuleInsert": { "description": "Shows the error response when a field made mandatory by a Layout Rule is absent during a record create via the upsert operation. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve Layout IDs.", "summary": "Layout rule mandatory field absent during record insertion", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Phone", "json_path": "$.data[0].Phone", "layout_rule": { "id": "5410702000000761547", "name": "Layout Rule" } }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundRecordId": { "description": "Shows the error response when a required field is missing during an upsert operation that updates an existing record.", "summary": "Required field missing during upsert update", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Single_Line_1", "id": "5410702000000761568", "json_path": "$.data[0].Single_Line_1" }, "message": "required field not found", "status": "error" } ] } }, "MultipleErrors": { "description": "Shows the error response when a single record has multiple validation failures.", "summary": "Multiple validation errors in a single record", "value": { "data": [ { "code": "MULTIPLE_OR_MULTI_ERRORS", "details": { "errors": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Email", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000000428295", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Email", "more_records": true }, "message": "duplicate data", "status": "error" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "Mobile", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000002432007", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Mobile", "more_records": true }, "message": "duplicate data", "status": "error" } ] }, "message": "Multiple errors in the request", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordsUpsertErrorResponse" } } }, "description": "The request could not be processed because one or more records contain invalid data or missing required fields.\n**Resolution:** Each error in the data array identifies the specific record and field that caused the failure. The request must be corrected and resubmitted." }, "401": { "content": { "application/json": { "examples": { "OauthScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to upsert records in the specified module.\n**Resolution:** The CRM administrator must grant the required upsert permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern.\n**Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "412": { "content": { "application/json": { "examples": { "AlreadyModified": { "description": "Shows the 412 error response when the record has been modified after the If-Unmodified-Since timestamp.", "summary": "Record already modified after the specified timestamp", "value": { "data": [ { "code": "ALREADY_MODIFIED", "details": { "Created_By": { "id": "492070000000209017", "name": "Senthilkumar" }, "Created_Time": "2023-04-17T16:23:25+05:30", "Modified_By": { "id": "492070000000209017", "name": "Senthilkumar" }, "Modified_Time": "2023-06-04T12:00:24+05:30", "id": "492070000199308229" }, "message": "record updated time has already passed if-unmodified-since time", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the record has been modified after the If-Unmodified-Since timestamp.", "properties": { "data": { "description": "Contains the list of per-record results for the operation.", "items": { "additionalProperties": false, "description": "Represents a single record operation result, which is either a success or error item identified by the **status** field.", "properties": { "code": { "description": "Contains the list of per-record results for the operation.", "enum": [ "ALREADY_MODIFIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "Created_By": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" }, "name": { "description": "Contains the list of per-record results for the operation.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Contains the list of per-record results for the operation.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" }, "name": { "description": "Contains the list of per-record results for the operation.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Contains the list of per-record results for the operation.", "format": "date-time", "type": "string" }, "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Contains the list of per-record results for the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Contains the list of per-record results for the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "PostRecordAlreadyModifiedResponse" } } }, "description": "The record has been modified after the timestamp specified in the If-Unmodified-Since header.\n**Resolution:** The latest version of the record must be retrieved and the update must be resubmitted with the current modification timestamp." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CREATE" ] } ], "summary": "Create or update records in a specified module", "tags": [ "record" ], "x-zoho-document": "record" } }, "/crm/v8/{module}/{dealId}/Contact_Roles": { "delete": { "description": "Remove one or more contact role associations from a deal using their relation IDs.", "operationId": "deleteContactRoleRelations", "parameters": [ { "$ref": "#/components/parameters/DealContactRolesModule" }, { "$ref": "#/components/parameters/DealId" }, { "$ref": "#/components/parameters/DealContactRolesIds" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRelationsSuccessResponse" } } }, "description": "Represents the response of a successfully removed the specified contact role relations." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DealContactRolesInvalidDataError" }, { "$ref": "#/components/schemas/DealContactRolesInvalidModuleError" }, { "$ref": "#/components/schemas/DealContactRolesRequiredParamMissingError" }, { "$ref": "#/components/schemas/InvalidRelationNameError" } ], "description": "Error response for a bad request, which can be one of several specific error types.", "x-zs-$id": "DeleteErrorResponse" } } }, "description": "Represents the error response of cases such as Invalid data, invalid module, field limit exceeded, or required parameter missing." }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NoPermissionDealsError" }, { "$ref": "#/components/schemas/NoPermissionContactsError" } ], "description": "Represents the error response body when the user lacks permission to access deals or contacts.", "x-zs-$id": "DeleteForbiddenErrorResponse" } } }, "description": "Represents the error response when the user does not have enough permission to access deals or contacts." }, "500": { "$ref": "#/components/responses/DealContactRolesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CONTACTS.DELETE", "ZohoCRM.modules.DEALS.DELETE" ] } ], "summary": "Deal Contact Roles", "tags": [ "deal_contact_roles" ], "x-zoho-document": "deal_contact_roles" }, "get": { "description": "Retrieve contact roles associated with a deal.", "operationId": "getAssociatedContactRoles", "parameters": [ { "$ref": "#/components/parameters/DealContactRolesModule" }, { "$ref": "#/components/parameters/DealId" }, { "$ref": "#/components/parameters/DealContactRolesFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ContactRolesResponse": { "value": { "data": [ { "Contact_Role": { "id": "4408068000000007170", "name": "Developer/Evaluator" }, "Department": null, "Email": null, "Owner": { "email": "luffy@zohotest.com", "id": "4408068000000623001", "name": "luffy" }, "id": "4408068000000963425" } ], "info": { "count": 1, "more_records": false, "next_page_token": null, "page": 1, "page_token_expiry": null, "per_page": 100, "previous_page_token": null } } } }, "schema": { "additionalProperties": false, "description": "Response containing contact roles data and pagination details.", "properties": { "data": { "description": "Array of contact role records with fields specified in the query parameter", "items": { "additionalProperties": true, "description": "Contact role record with dynamic fields based on the 'fields' query parameter", "properties": { "Contact_Role": { "additionalProperties": false, "description": "Contact role information", "properties": { "id": { "description": "Role's unique identifier", "format": "int64", "type": "string" }, "name": { "description": "Role name (e.g., Developer/Evaluator)", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Department": { "description": "Department of the contact", "type": [ "string", "null" ] }, "Owner": { "additionalProperties": false, "description": "Owner information for the contact role", "properties": { "email": { "description": "Owner's email address", "format": "email", "type": "string" }, "id": { "description": "Owner's unique identifier", "format": "int64", "type": "string" }, "name": { "description": "Owner's display name", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": "object" }, "maxItems": 100, "type": "array" }, "info": { "additionalProperties": false, "description": "Pagination and response metadata", "properties": { "count": { "description": "Number of records in the current response", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates if more records are available", "type": "boolean" }, "next_page_token": { "description": "Token for retrieving the next page of results", "maxLength": 1024, "type": [ "string", "null" ] }, "page": { "description": "Current page number", "format": "int32", "type": "integer" }, "page_token_expiry": { "description": "Expiry timestamp for page tokens", "maxLength": 1024, "type": [ "string", "null" ] }, "per_page": { "description": "Number of records per page", "format": "int32", "type": "integer" }, "previous_page_token": { "description": "Token for retrieving the previous page of results", "maxLength": 1024, "type": [ "string", "null" ] } }, "required": [ "per_page", "count", "page", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "Successresponse" } } }, "description": "Successfully retrieved contact roles associated with the deal." }, "204": { "description": "No contact roles found for the specified deal." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DealContactRolesInvalidDataError" }, { "$ref": "#/components/schemas/DealContactRolesInvalidModuleError" }, { "$ref": "#/components/schemas/DealContactRolesRequiredParamMissingError" }, { "$ref": "#/components/schemas/InvalidRelationNameError" } ], "description": "Represents the error response, which can be one of several specific following error types.", "x-zs-$id": "ErrorResponse400" } } }, "description": "The response body of errors such as Invalid data, invalid module, field limit exceeded, or required parameter missing." }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NoPermissionDealsError" }, { "$ref": "#/components/schemas/NoPermissionContactsError" } ], "description": "Represents the error response body when the user lacks permission to access deals or contacts.", "x-zs-$id": "ErrorResponse403" } } }, "description": "Error response when the user does not have enough permission to access deals or contacts." }, "500": { "$ref": "#/components/responses/DealContactRolesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CONTACTS.READ", "ZohoCRM.modules.DEALS.READ" ] } ], "summary": "Deal Contact Roles", "tags": [ "deal_contact_roles" ], "x-zoho-document": "deal_contact_roles" }, "put": { "description": "Add contact roles to a deal or update existing contact role relations in bulk.", "operationId": "upsertContactRoleRelations", "parameters": [ { "$ref": "#/components/parameters/DealContactRolesModule" }, { "$ref": "#/components/parameters/DealId" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertRelationsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertRelationsSuccessResponse" } } }, "description": "Response of a successfully added or updated the specified contact role relations." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DealContactRolesInvalidDataError" }, { "$ref": "#/components/schemas/DealContactRolesInvalidModuleError" }, { "$ref": "#/components/schemas/DealContactRolesRequiredParamMissingError" }, { "$ref": "#/components/schemas/InvalidRelationNameError" } ], "description": "Error response for a bad request, which can be one of several specific error types.", "x-zs-$id": "UpdateErrorResponse400" } } }, "description": "Represents the error response of cases such as Invalid data, invalid module, field limit exceeded, or required parameter missing." }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NoPermissionDealsError" }, { "$ref": "#/components/schemas/NoPermissionContactsError" } ], "description": "Represents the error response when the user lacks permission to access deals or contacts.", "x-zs-$id": "ForbiddenErrorResponse" } } }, "description": "Represents the error response when the use does not have enough permission to access deals or contacts." }, "500": { "$ref": "#/components/responses/DealContactRolesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CONTACTS.UPDATE", "ZohoCRM.modules.DEALS.UPDATE" ] } ], "summary": "Deal Contact Roles", "tags": [ "deal_contact_roles" ], "x-zoho-document": "deal_contact_roles" } }, "/crm/v8/{module}/{dealId}/Contact_Roles/{contactId}": { "delete": { "description": "Remove a specific contact-deal relation using the contact identifier in the path.", "operationId": "deleteContactRoleRelation", "parameters": [ { "$ref": "#/components/parameters/DealContactRolesModule" }, { "$ref": "#/components/parameters/DealId" }, { "$ref": "#/components/parameters/Contact" } ], "responses": { "200": { "content": { "application/json": { "examples": { "DeleteSingleRelationSuccess": { "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4408068000000963455" }, "message": "relation removed", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/DeleteRelationsSuccessResponse" } } }, "description": "Represents the response body of a successfully removed the specified contact relation." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DealContactRolesInvalidDataError" }, { "$ref": "#/components/schemas/DealContactRolesInvalidModuleError" }, { "$ref": "#/components/schemas/DealContactRolesRequiredParamMissingError" }, { "$ref": "#/components/schemas/InvalidRelationNameError" } ], "description": "Error response for a bad request, which can be one of several specific error types.", "x-zs-$id": "DeleteErrorResponse400" } } }, "description": "Represents the error response of cases such as invalid data, invalid module, field limit exceeded, or required parameter missing." }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NoPermissionDealsError" }, { "$ref": "#/components/schemas/NoPermissionContactsError" } ], "description": "Error response for when the user lacks permission to access deals or contacts.", "x-zs-$id": "DeleteErrorResponse403" } } }, "description": "Represents the error response when the user does not have permission to access deals or contacts." }, "500": { "$ref": "#/components/responses/DealContactRolesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CONTACTS.DELETE", "ZohoCRM.modules.DEALS.DELETE" ] } ], "summary": "Deal Contact Roles", "tags": [ "deal_contact_roles" ], "x-zoho-document": "deal_contact_roles" }, "get": { "description": "Retrieves the contact role relation for a specific contact associated with a deal.", "operationId": "getDealContactRoleForContact", "parameters": [ { "$ref": "#/components/parameters/DealContactRolesModule" }, { "$ref": "#/components/parameters/DealId" }, { "$ref": "#/components/parameters/Contact" }, { "$ref": "#/components/parameters/DealContactRolesFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ContactRoleForContactResponse": { "value": { "data": [ { "Contact_Role": { "id": "4408068000000007170", "name": "Developer/Evaluator" }, "Department": null, "Email": null, "Owner": { "email": "luffy@zohotest.com", "id": "4408068000000623001", "name": "luffy" }, "id": "4408068000000963425" } ] } } }, "schema": { "additionalProperties": false, "description": "Response body containing the contact role relation for the specified contact.", "properties": { "data": { "description": "Array containing the contact role record for the specified contact", "items": { "additionalProperties": true, "description": "Contact role record with dynamic fields based on the 'fields' query parameter", "properties": { "Contact_Role": { "additionalProperties": false, "description": "Contact role information", "properties": { "id": { "description": "Role's unique identifier", "format": "int64", "type": "string" }, "name": { "description": "Role name (e.g., Developer/Evaluator)", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Department": { "description": "Department of the contact", "type": [ "string", "null" ] }, "Owner": { "additionalProperties": false, "description": "Owner information for the contact role", "properties": { "email": { "description": "Owner's email address", "format": "email", "type": "string" }, "id": { "description": "Owner's unique identifier", "format": "int64", "type": "string" }, "name": { "description": "Owner's display name", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "SuccessResponseGet" } } }, "description": "Response body of a successfully retrieved the contact role relation for the given contact." }, "204": { "description": "No contact role relation exists for the specified contact on this deal." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DealContactRolesInvalidDataError" }, { "$ref": "#/components/schemas/DealContactRolesInvalidModuleError" }, { "$ref": "#/components/schemas/DealContactRolesRequiredParamMissingError" }, { "$ref": "#/components/schemas/InvalidRelationNameError" } ], "description": "Represents the error response for a bad request, which can be one of several specific error types.", "x-zs-$id": "ErrorResponseGet400" } } }, "description": "Represents the response body of errors such as Invalid data, invalid module, field limit exceeded, or required parameter missing." }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NoPermissionDealsError" }, { "$ref": "#/components/schemas/NoPermissionContactsError" } ], "description": "Represents the error response for when the user lacks permission to access deals or contacts.", "x-zs-$id": "ErrorResponseGet403" } } }, "description": "Represents the error response when the user does not have enough permission to access deals or contacts." }, "500": { "$ref": "#/components/responses/DealContactRolesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CONTACTS.READ", "ZohoCRM.modules.DEALS.READ" ] } ], "summary": "Deal Contact Roles", "tags": [ "deal_contact_roles" ], "x-zoho-document": "deal_contact_roles" }, "put": { "description": "Assign or update a contact role for a specific contact on a deal.", "operationId": "associateContactRoleToDeal", "parameters": [ { "$ref": "#/components/parameters/DealContactRolesModule" }, { "$ref": "#/components/parameters/DealId" }, { "$ref": "#/components/parameters/Contact" } ], "requestBody": { "content": { "application/json": { "examples": { "AssociateContactRoleRequest": { "value": { "data": [ { "Contact_Role": { "id": "4408068000000007178", "name": "Engineering Lead" } } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request body containing the contact role assignment to apply.", "properties": { "data": { "description": "Single contact role relation definition", "items": { "additionalProperties": false, "description": "Contact role configuration for the specified contact", "properties": { "Contact_Role": { "additionalProperties": false, "description": "Contact role details to associate", "properties": { "id": { "description": "Unique identifier of the contact role", "format": "int64", "type": "string" }, "name": { "description": "Contact role display name", "maxLength": 255, "type": "string" } }, "type": "object" } }, "required": [ "Contact_Role" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AssociateContactRoleResponse": { "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4408068000000963455" }, "message": "relation updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Provides the response of updating the contact role relation.", "properties": { "data": { "description": "Status entries for the processed contact relation", "items": { "additionalProperties": false, "description": "Operation result for the contact relation", "properties": { "code": { "const": "SUCCESS", "description": "Operation status code", "type": "string" }, "details": { "additionalProperties": false, "description": "Details about the processed relation", "properties": { "id": { "description": "Identifier of the contact-deal relation", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "const": "relation updated", "description": "Result message", "type": "string" }, "status": { "const": "success", "description": "Operation status", "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "SuccessresponsePut" } } }, "description": "Represents the response of a successfully associated the contact role with the deal." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/DealContactRolesInvalidDataError" }, { "$ref": "#/components/schemas/DealContactRolesInvalidModuleError" }, { "$ref": "#/components/schemas/DealContactRolesRequiredParamMissingError" }, { "$ref": "#/components/schemas/InvalidRelationNameError" } ], "description": "Error response for a bad request, which can be one of several specific error types.", "x-zs-$id": "ErrorresponsePut400" } } }, "description": "Bad Request - Invalid data, invalid module, field limit exceeded, or required parameter missing" }, "403": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/NoPermissionDealsError" }, { "$ref": "#/components/schemas/NoPermissionContactsError" } ], "description": "Error response for when the user lacks permission to access deals or contacts.", "x-zs-$id": "ErrorresponsePut403" } } }, "description": "Represents the error response when the user does not have permission to access deals or contacts." }, "500": { "$ref": "#/components/responses/DealContactRolesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CONTACTS.UPDATE", "ZohoCRM.modules.DEALS.UPDATE" ] } ], "summary": "Deal Contact Roles", "tags": [ "deal_contact_roles" ], "x-zoho-document": "deal_contact_roles" } }, "/crm/v8/{module}/{id}/actions/add_tags": { "post": { "description": "Adds tags to a specific record in the specified module.", "operationId": "postAddTagsWithId", "parameters": [ { "$ref": "#/components/parameters/ParamPathModule" }, { "$ref": "#/components/parameters/TagsActionsParamPathId" }, { "$ref": "#/components/parameters/ParamQueryOverWrite" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "over_write": true, "tags": [ { "color_code": "#F17574", "name": "test" }, { "color_code": "#63C57E", "name": "new" }, { "color_code": "#E7A826", "name": "34ytwerfdgjhfwgerfs" } ] } } }, "schema": { "$ref": "#/components/schemas/PostaddtagsRequest" } } }, "description": "Request body containing the tags to add to the record." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "3060320000002538026", "modifiedTime": "Tue, 30 Dec 2025 03:42 PM", "tags": [ { "color_code": "#FEDA62", "id": "3060320000001987093", "name": "a" }, { "color_code": "#FD87BD", "id": "3060320000000666047", "name": "newtd" } ] }, "message": "tags updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostaddtagsResponse200" } } }, "description": "OK - Tags added successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: tags)", "value": { "code": "INVALID_DATA", "details": {}, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tags[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tags[*].name", "maximum_length": 25 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidDataResponse4": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: color_code)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "expected_data_type": "text", "json_path": "$.tags[*].color_code" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse5": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: color_code)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "color_code", "json_path": "$.tags[*].color_code", "maximum_length": 7 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "summary": "Error response with code INVALID_MODULE: the given module is not supported for this api", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "summary": "Error response with code INVALID_REQUEST_METHOD: The http request method type is not a valid one", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "RecordLockedResponse1": { "summary": "Error response with code RECORD_LOCKED: Sorry, you cannot perform this operation as the record is locked.", "value": { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "3060320000002538026" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TagsActionsRecordLockedError" }, { "$ref": "#/components/schemas/TagsInvalidDataError" }, { "$ref": "#/components/schemas/TagsActionsInvalidModuleNameError" }, { "$ref": "#/components/schemas/TagsActionsModuleTagsNotSupportedError" }, { "$ref": "#/components/schemas/TagsActionsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/TagErrorItemResponse" }, { "$ref": "#/components/schemas/TagInvalidDataTypeError" }, { "$ref": "#/components/schemas/MappingMismatchErrorResponse" }, { "additionalProperties": false, "description": "Wrapped error response with per-tag validation errors", "properties": { "tags": { "description": "Array of error objects for tag field validation failures", "items": { "anyOf": [ { "$ref": "#/components/schemas/TagFieldInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsActionsTagFieldMaxLengthError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PostaddtagsSingleRecError" }, { "additionalProperties": false, "description": "Permission denied error when attempting to add tags without write access", "properties": { "code": { "description": "Error code", "enum": [ "FAILURE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error context", "type": "object" }, "message": { "description": "Human-readable error message", "enum": [ "permission denied to update records" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PostAddTagsWithIdNoWritePermissionError" } ], "description": "Error response for status 400", "x-zs-$id": "PostaddtagsErrors" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax or validation errors. Review the error details and correct the issues before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Leads", "Crm_Implied_Tags_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsActionsNoPermissionError", "description": "Error response for status 403", "x-zs-$id": "PostaddtagsErrorSingleRec" } } }, "description": "Forbidden - The client does not have access rights to perform the operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.ALL" ] } ], "summary": "Add Tags to a Record", "tags": [ "tags_actions" ], "x-zoho-document": "tags_actions" } }, "/crm/v8/{module}/{id}/actions/remove_tags": { "post": { "description": "Removes tags from a specific record in the specified module.", "operationId": "postRemoveTagsWithId", "parameters": [ { "$ref": "#/components/parameters/ParamPathModule" }, { "$ref": "#/components/parameters/TagsActionsParamPathId" } ], "requestBody": { "content": { "application/json": { "examples": { "SamplePostRequest": { "summary": "Sample request body", "value": { "tags": [ { "name": "newtd" } ] } } }, "schema": { "$ref": "#/components/schemas/PostremovetagsRequest" } } }, "description": "Request body containing the tags to remove from the record." }, "responses": { "200": { "content": { "application/json": { "examples": { "Success200": { "summary": "Success response for status 200", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "3060320000002538026", "modifiedTime": "Tue, 30 Dec 2025 03:47 PM", "tags": [ { "id": "3060320000001987093", "name": "a" } ] }, "message": "tags updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/PostremovetagsResponse200" } } }, "description": "OK - Tags removed successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidDataResponse1": { "summary": "Error response with code INVALID_DATA: invalid data (Field: tags)", "value": { "code": "INVALID_DATA", "details": { "api_name": "tags", "expected_data_type": "jsonarray", "json_path": "$.tags", "maximum_length": 1 }, "message": "invalid data", "status": "error" } }, "InvalidDataResponse2": { "summary": "Error response with code INVALID_DATA: Invalid data type (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "expected_data_type": "text", "json_path": "$.tags[*].name" }, "message": "Invalid data type", "status": "error" } ] } }, "InvalidDataResponse3": { "summary": "Error response with code INVALID_DATA: Invalid data (Field: name)", "value": { "tags": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.tags[*].name", "maximum_length": 25 }, "message": "Invalid data", "status": "error" } ] } }, "InvalidModuleResponse1": { "summary": "Error response with code INVALID_MODULE: the module name given seems to be invalid", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidModuleResponse2": { "summary": "Error response with code INVALID_MODULE: the given module is not supported for this api", "value": { "code": "INVALID_MODULE", "details": {}, "message": "the given module is not supported for this api", "status": "error" } }, "InvalidRequestMethodResponse1": { "summary": "Error response with code INVALID_REQUEST_METHOD: The http request method type is not a valid one", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "RecordLockedResponse1": { "summary": "Error response with code RECORD_LOCKED: Sorry, you cannot perform this operation as the record is locked.", "value": { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "3060320000002538026" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TagsActionsRecordLockedError" }, { "$ref": "#/components/schemas/TagInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsActionsInvalidModuleNameError" }, { "$ref": "#/components/schemas/TagsActionsModuleTagsNotSupportedError" }, { "$ref": "#/components/schemas/TagsActionsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/TagsInvalidDataError" }, { "additionalProperties": false, "description": "Wrapped error response with per-tag validation errors", "properties": { "tags": { "description": "Array of error objects for tag field validation failures", "items": { "anyOf": [ { "$ref": "#/components/schemas/TagFieldInvalidDataTypeError" }, { "$ref": "#/components/schemas/TagsActionsTagFieldMaxLengthError" } ] }, "maxItems": 25, "type": "array" } }, "required": [ "tags" ], "type": "object", "x-zs-$id": "PostremovetagsSingleRec" }, { "additionalProperties": false, "description": "Permission denied error when attempting to remove tags without write access", "properties": { "code": { "description": "Error code", "enum": [ "FAILURE" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Additional error context", "type": "object" }, "message": { "description": "Human-readable error message", "enum": [ "permission denied to update records" ], "type": "string" }, "status": { "description": "Error status", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "PostRemoveTagsNoWritePermissionError" } ], "description": "Error response for status 400", "x-zs-$id": "PostremovetagsErrorSingleRec" } } }, "description": "Bad Request - The request cannot be processed due to invalid syntax or validation errors. Review the error details and correct the issues before retrying." }, "403": { "content": { "application/json": { "examples": { "NoPermissionResponse1": { "summary": "Error response with code NO_PERMISSION: permission denied", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Edit_Leads", "Crm_Implied_Tags_Leads" ] }, "message": "permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/TagsActionsNoPermissionError", "description": "Error response for status 403", "x-zs-$id": "PostremovetagsError403SingleRec" } } }, "description": "Forbidden - The client does not have access rights to perform the operation." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.ALL" ] } ], "summary": "Remove Tags from a Record", "tags": [ "tags_actions" ], "x-zoho-document": "tags_actions" } }, "/crm/v8/{module}/{id}/actions/unblock_email": { "post": { "description": "To unblock a soft-bounced email address for a single record in your Zoho CRM organization. When an email sent from CRM bounces temporarily, the Email field on the affected record is blocked. This operation removes that block so email communication with the record can resume.", "operationId": "unblockEmailById", "parameters": [ { "$ref": "#/components/parameters/UnblockEmailModule" }, { "$ref": "#/components/parameters/UnblockEmailId" } ], "requestBody": { "content": { "application/json": { "examples": { "UnblockSingleEmail": { "description": "Shows a request to unblock the **Email** field for a single record in a module.", "summary": "An example to unblock the primary email field for a single record.", "value": { "unblock_fields": [ "Email" ] } } }, "schema": { "additionalProperties": false, "description": "Specify the email fields to unblock for the record.", "properties": { "unblock_fields": { "description": "To unblock emails, specify one or both of the system-defined\nfields : **Email** and **Secondary_Email**.\n\n\n> **Note**\n\n> - The permanently blocked emails cannot be unblocked.\n\n> - A temporarily blocked email can be unblocked up to **5\ntimes**.\n\n> - A **custom email field** cannot be unblocked.\n\n> - You cannot merge records that are **locked** or in an\n**Approval Process/Review Process**.\n", "items": { "description": "Each string represents an email address to unblock.", "enum": [ "Email" ], "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "unblock_fields" ], "type": "object" }, "x-zs-llm-examples": [ "UnblockSingleEmail" ] } }, "description": "The request body contains the data required to perform the operation. ", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulSingleUnblock": { "description": "Shows a successful response after unblocking the email field for a single record, including the record ID and confirmation message.", "summary": "An example response of successful email unblock for a single record.", "value": { "code": "SUCCESS", "details": { "id": "5545974000000224001" }, "message": "Email unblocked successfully", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Contains the result of the email unblock operation for the specified record.", "properties": { "code": { "description": "Represents the status code of the unblock operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the record for which the email was unblocked.", "properties": { "id": { "description": "Represents the unique identifier of the record for which the email was unblocked.", "maxLength": 50, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the descriptive message returned by the server for the unblock operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Represents the overall status of the unblock operation for the record.", "maxLength": 255, "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "UnblockEmailByIdResponse200" } } }, "description": "Returns the result of the email unblock operation, including the status code, record details, and a confirmation message." }, "400": { "content": { "application/json": { "examples": { "InvalidTokenError": { "description": "Shows an error response returned when the provided OAuth token is invalid or expired.", "summary": "An example response of invalid OAuth token.", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "invalid oauth token", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response returned when the request fails due to an invalid or expired OAuth token.", "properties": { "code": { "description": "Represents the error code returned by the server.\n\nPossible values:\n\n**INVALID_URL_PATTERN** - The request URL is\nincorrect.\n\n**INVALID_DATA** - The request contains invalid data.\n\n**INVALID_REQUEST_METHOD** - The HTTP method is not\nvalid for this endpoint.\n\n**INVALID_TOKEN** - The OAuth token is invalid or\nexpired.\n", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_REQUEST_METHOD", "INVALID_TOKEN" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the error, such as the field or parameter that caused the failure.", "type": "object" }, "message": { "description": "Represents the error message returned by the server indicating the issue.", "enum": [ "invalid oauth token" ], "type": "string" }, "status": { "description": "Represents the response status indicating an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnblockEmailByModuleAuthError1" }, { "additionalProperties": false, "description": "Represents an error response returned when the request fails due to an invalid module name, incorrect request URL, or invalid record data.", "properties": { "code": { "description": "Represents the error code returned by the server.\n\nPossible values:\n\n**INVALID_URL_PATTERN** - The request URL is\nincorrect.\n\n**INVALID_DATA** - The request contains invalid data.\n\n**INVALID_REQUEST_METHOD** - The HTTP method is not\nvalid for this endpoint.\n\n**INVALID_MODULE** - The specified module name is not\nvalid.\n", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_REQUEST_METHOD", "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context about the error, including the index of the resource in the request path that caused the failure.", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the resource segment in the request path that triggered the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the reason the request failed, such as an invalid token, invalid record, or invalid module name.", "enum": [ "invalid oauth token", "Invalid record provided", "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the response status indicating an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnblockEmailByModuleRequestError2" }, { "additionalProperties": false, "description": "Represents an error response returned when the request fails due to invalid data, a missing mandatory field, or an invalid module name.", "properties": { "code": { "description": "Represents the error code returned by the server.\n\nPossible values:\n\n**INVALID_DATA** - The request contains invalid data.\n\n**INVALID_MODULE** - The specified module name is not\nvalid.\n\n**MANDATORY_NOT_FOUND** - A required field is missing\nfrom the request body.\n", "enum": [ "INVALID_DATA", "INVALID_MODULE", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Contains the expected data type, API name, and JSON path of the field that caused the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "expected_data_type": { "description": "Represents the data type expected by the server for the field that caused the error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the validation error.", "maxLength": 1000, "type": "string" } }, "type": "object", "x-zs-$id": "UnblockEmailByModuleDataErrorWithType4" }, { "additionalProperties": false, "description": "Contains the API name and JSON path of the field that caused the validation error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 255, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the validation error.", "maxLength": 1000, "type": "string" } }, "type": "object", "x-zs-$id": "UnblockEmailByModuleDataErrorWithoutType5" } ], "description": "Contains additional context about the validation error, including the expected data type and the field that caused the failure." }, "message": { "description": "Represents the error message describing the validation or data issue encountered by the server.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the response status indicating an error occurred.", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "UnblockEmailByModuleDataError3" } ], "description": "Contains one of several error response structures returned when the unblock request fails due to invalid parameters, authentication issues, or data validation errors.", "x-zs-$id": "UnblockEmailByIdResponse400" } } }, "description": "The request is invalid.\n\n\n**Resolution:** A valid module API name and record ID must be\nspecified in the request URL, and the OAuth token must include the\nrequired scope.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.UPDATE" ] } ], "summary": "Unblock email for a single record", "tags": [ "unblock_email" ], "x-zoho-document": "unblock_email", "x-zs-llm-description": "Use to unblock the `Email` field for a single record. Pass `module` (currently `Leads` only) and the record `id` in the path; body requires `unblock_fields: [\"Email\"]`. Returns a single SUCCESS result with the unblocked record id." } }, "/crm/v8/{module}/{masterRecordId}/actions/merge": { "get": { "description": "To retrieve the status of a scheduled merge job in your Zoho CRM organization. Use the optional job_id query parameter to filter results to a specific job.", "operationId": "getMergeJobStatus", "parameters": [ { "$ref": "#/components/parameters/FindAndMergeJobId" }, { "$ref": "#/components/parameters/MasterRecordId" }, { "$ref": "#/components/parameters/FindAndMergeModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "CompletedJob": { "description": "Shows a completed merge job with its unique job ID and final status. ", "summary": "Example of a merge job completed successfully. ", "value": { "merge": [ { "job_id": "1234567890", "status": "completed" } ] } }, "FailedJob": { "description": "Shows a failed merge job response with the job ID and failed status. ", "summary": "Example of merge job with a failed status. ", "value": { "merge": [ { "job_id": "1234567890", "status": "failed" } ] } }, "RunningJob": { "description": "Shows a merge job that is currently being processed with its job ID and running status. ", "summary": "Example of merge job currently in progress. ", "value": { "merge": [ { "job_id": "1234567890", "status": "running" } ] } }, "ScheduledJob": { "description": "Shows a merge job that has been queued for processing with its assigned job ID and scheduled status. ", "summary": "Example of merge job in scheduled state. ", "value": { "merge": [ { "job_id": "1041770000009251159", "status": "SCHEDULED" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response body containing the list of merge job status records for the specified master record. ", "properties": { "merge": { "description": "Contains the list of merge job status objects returned for the specified master record. ", "items": { "additionalProperties": false, "description": "Each object represents an individual merge job record, including its unique identifier and current processing status. ", "properties": { "job_id": { "description": "Represents the unique identifier of the merge job. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "status": { "description": "Represents the current processing status of the merge job. \nPossible values:\n**SCHEDULED** - The merge job is queued and waiting to be processed.\n**running** - The merge job is currently being processed.\n**completed** - The merge job has finished successfully.\n**failed** - The merge job encountered an error and did not complete. \n", "enum": [ "SCHEDULED", "running", "completed", "failed" ], "type": "string" } }, "required": [ "job_id", "status" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "merge" ], "type": "object", "x-zs-$id": "FindAndMergeGetMergeJobStatusResponse" } } }, "description": "Returns the current status of merge jobs for the specified master record. " }, "204": { "description": "Indicates that no merge jobs were found for the specified master record. " }, "400": { "content": { "application/json": { "examples": { "ApiNameNotMentioned": { "description": "Shows the MANDATORY_NOT_FOUND error when the api_name field is missing from the request. ", "summary": "Example of API name missing from configuration. ", "value": { "merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "API name of the field is not mentioned", "status": "error" } ] } }, "ChildRecordIdMissing": { "description": "Shows the MANDATORY_NOT_FOUND error when the child record ID is empty or not provided in the data array. ", "summary": "Example of child record ID missing from data array. ", "value": { "merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.merge[0].data[0].id" }, "message": "required id not found", "status": "error" } ] } }, "ClosedDealNotAllowed": { "description": "Shows the NOT_ALLOWED error when an attempt is made to merge a closed deal, as only open deals can be merged. ", "summary": "Example for an attempt to merge a closed deal. ", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "record", "resource_path_index": 1 }, "message": "Only Open Deals can be merged", "status": "error" } }, "ClosingDateNotAllowed": { "description": "Shows the NOT_ALLOWED error when the Closing Date field is specified in the request. Do not specify the closing date field, as it is automatically populated from the master record. ", "summary": "Example of Closing Date field specified in merge request. ", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Closing date will be automatically populated based on master record", "status": "error" } ] } }, "CpqAssociationError": { "description": "Shows the NOT_ALLOWED error when a child record has associations in CPQ product configurators or pricing rules that prevent the merge. ", "summary": "Example of child record has CPQ rule associations. ", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "data", "data": [ { "_associated_places": [ { "resources": [ { "id": "111111000000071837", "name": "asdfsdf" } ], "type": "product_configurators" }, { "resources": [ { "id": "111111000000072007", "name": "PR -sample" } ], "type": "pricing_rules" } ], "id": "111111000000071814" } ], "json_path": "$.merge[0].data" }, "message": "unable to merge records since there are association in child records", "status": "error" } ] } }, "DataArrayEmpty": { "description": "Shows the INVALID_DATA error when the data array is empty or not included in the request body. ", "summary": "Example of data array empty or missing from request. ", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.merge[0].data", "minimum_length": 1 }, "message": " Atleast one child record id is required to be merged.", "status": "error" } ] } }, "DataArraySizeExceeded": { "description": "Shows the INVALID_DATA error when more than two child record IDs are provided in the data array. ", "summary": "Example of data array exceeding maximum of two child records. ", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.merge[0].data", "maximum_length": 2 }, "message": " More than 2 child record ids cannot be merged.", "status": "error" } ] } }, "DuplicateFieldMention": { "description": "Shows the DUPLICATE_DATA error when the same field API name is specified more than once in the merge configuration. ", "summary": "Example of duplicate field API name in merge request. ", "value": { "merge": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "When one field is mentioned more than once", "status": "error" } ] } }, "DuplicateRecordIds": { "description": "Shows the DUPLICATE_DATA error when the same record ID is provided for two or more merge requests. ", "summary": "Example of duplicate record IDs in merge request. ", "value": { "merge": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "id", "json_path": "$.merge[0].data[0].id" }, "message": "Valid record ids need to be given for merging", "status": "error" } ] } }, "FileSizeLimitExceeded": { "description": "Shows the LIMIT_EXCEEDED error when the combined size of file or image upload fields across all merge participants exceeds the maximum allowed limit. ", "summary": "Example of total file size across merge participants exceeds limit. ", "value": { "merge": [ { "code": "LIMIT_EXCEEDED", "details": { "MAXIMUM_SIZE": "30 MB", "limit_due_to": [ { "api_name": "File_Upload_30MB", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, { "api_name": "File_Upload_30MB", "json_path": "$.merge[0].data[1]._fields[1].api_name" }, { "api_name": "File_Upload_30MB", "json_path": "$.merge[0].master_record_fields[1].api_name" } ] }, "message": "Attachment size limit exceeded", "status": "error" } ] } }, "FileUploadDataMissingChild": { "description": "Shows the DEPENDENT_FIELD_MISSING error when a file or image upload field is specified for a child record in the _fields array but the required _data array is not provided. ", "summary": "Example of _data array missing for child record file upload field. ", "value": { "merge": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "json_path": "$.merge[0].data[0]._fields[0]._data" }, "message": "_data array is not mentioned for the child record", "status": "error" } ] } }, "FileUploadDataMissingMaster": { "description": "Shows the DEPENDENT_FIELD_MISSING error when a file or image upload field is specified for the master record in the master_record_fields array but the required _data array is not provided. ", "summary": "Example of _data array missing for master record file upload field. ", "value": { "merge": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "api_name", "json_path": "$.merge[0].master_record_fields[0].api_name" }, "json_path": "$.merge[0].master_record_fields[0]._data" }, "message": "_data array is not mentioned for the master record", "status": "error" } ] } }, "InvalidModule": { "description": "Shows the INVALID_MODULE error when the module name provided in the request URL is not a valid CRM module. ", "summary": "Example of an invalid module name in request URL. ", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "MasterRecordApiNameMissing": { "description": "Shows the MANDATORY_NOT_FOUND error when the api_name field is missing from an entry in the master_record_fields array. ", "summary": "Example of API name missing from master_record_fields entry. ", "value": { "merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.merge[0].master_record_fields[0].api_name" }, "message": "API name not mentioned for the master record", "status": "error" } ] } }, "MasterRecordNotAvailable": { "description": "Shows the INVALID_DATA error when the master record ID specified in the request URL does not exist in the module. ", "summary": "Example of master record ID not available. ", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "Master record id is not available", "status": "error" } }, "MasterRecordNotFound": { "description": "Shows the INVALID_DATA error when the master record specified in the request URL cannot be found. ", "summary": "Example of master record not found in the module. ", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "Master record is not found", "status": "error" } }, "MergeArraySizeExceeded": { "description": "Shows the INVALID_DATA error when the merge array contains more than one object. ", "summary": "Example of merge array containing more than one object. ", "value": { "code": "INVALID_DATA", "details": {}, "message": "invalid data", "status": "error" } }, "ProbabilityRevenueNotAllowed": { "description": "Shows the error when the request includes the Expected Revenue or Probability field, which are automatically populated based on the chosen Stage. ", "summary": "Example of errors related to Expected Revenue and Probability fields. ", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Probability and Expected Revenue fields will be automatically populated based on chosen Stage", "status": "error" } ] } }, "RecordAlreadyBeingMerged": { "description": "Shows the error when a record in the request is already in the process of being merged and cannot be used in another merge operation. ", "summary": "Example of the error saying that the record is already being merged. ", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.merge[0].data[0].id" }, "message": "This record id is not allowed to be merged", "status": "error" } ] } }, "ReportingToChildOnly": { "description": "Shows the error when the Reporting To field is specified for a child record without specifying the Account field, which must belong to the same record. ", "summary": "Example of only Reporting To is given for child record. ", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Reporting to and account should belong to the same record", "status": "error" } ] } }, "ReportingToWithAccountMismatch": { "description": "Shows the error when the Reporting To field is specified for one record and the Account field for the other, as both must belong to the same record. ", "summary": "Example of Reporting To configured for child and Account for master (or vice versa). ", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Reporting to and account should belong to the same record", "status": "error" } ] } }, "StageFieldNotAllowed": { "description": "Shows the error when the Stage field is specified in the request body for records with different pipelines, as the Stage field gets automatically populated based on the chosen Pipeline. ", "summary": "Example of Stage being mentioned when child and master record have different pipelines. ", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Stage field will be automatically populated based on chosen Pipeline", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents a standard error response returned when the module name is invalid, the master record is not found, or the operation is not permitted. ", "properties": { "code": { "description": "Represents the error code that identifies the type of failure. \nPossible values:\n**INVALID_DATA** - The request contains invalid or malformed data.\n**INVALID_MODULE** - The specified module name is not valid.\n**NOT_ALLOWED** - The requested operation is not permitted. \n", "enum": [ "INVALID_DATA", "INVALID_MODULE", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context information about the error, such as the field API name, JSON path, and constraint limits that caused the validation failure. ", "properties": { "api_name": { "description": "Represents the API name of the field or resource that caused the validation error. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the validation error. ", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that caused the validation error. ", "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum required length for the field that caused the validation error. ", "format": "int32", "type": "integer" }, "resource_path_index": { "description": "Represents the zero-based index of the path parameter that caused the error, where 0 corresponds to the module API name parameter and 1 corresponds to the master record ID in the parameter. ", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message that describes the issue in detail. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. \n**error** - The request failed due to a validation error or other issue.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "FindAndMergeStandardErrorResponse" }, { "additionalProperties": false, "description": "Represents an error response returned when individual field-level or record-level validation errors occur within the merge operation. ", "properties": { "merge": { "description": "Contains the list of error details for each merge operation that failed validation. ", "items": { "additionalProperties": false, "description": "Each object represents an individual error that occurred during a merge operation, including the error code, details, and a descriptive message. ", "properties": { "code": { "description": "Represents the error code that identifies the type of failure for the merge operation. \nPossible values:\n**MANDATORY_NOT_FOUND** - A required field or property is missing from the request.\n**NOT_ALLOWED** - The operation is not permitted due to a business rule constraint.\n**INVALID_DATA** - The request contains invalid data.\n**DUPLICATE_DATA** - Duplicate values were detected for a field that must be unique.\n**DEPENDENT_FIELD_MISSING** - A field that depends on another field is missing from the request.\n**LIMIT_EXCEEDED** - A size or count limit has been exceeded.\n", "enum": [ "MANDATORY_NOT_FOUND", "NOT_ALLOWED", "INVALID_DATA", "DUPLICATE_DATA", "DEPENDENT_FIELD_MISSING", "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains detailed information about the field or resource that caused the error in the merge operation. ", "properties": { "MAXIMUM_SIZE": { "description": "Represents the maximum allowed size for file or image uploads associated with the merge operation. ", "maxLength": 50, "type": "string" }, "api_name": { "description": "Represents the API name of the field that caused the validation error in the merge operation. ", "maxLength": 100, "type": "string" }, "data": { "description": "Contains the list of records that are associated with external configurations, such as CPQ rules, that prevent the merge operation from completing. ", "items": { "additionalProperties": false, "description": "Represents a child record that has one or more CPQ rule associations that prevented the merge, identified by its record ID and associated configuration details. ", "properties": { "_associated_places": { "description": "Contains the list of CPQ configurations or external rule associations that prevent this record from being merged. ", "items": { "additionalProperties": false, "description": "Each object represents a single CPQ configuration association, including the association type and the specific resources involved. ", "properties": { "resources": { "description": "Contains the list of CPQ resources, such as product configurators or pricing rules, that are associated with the record. ", "items": { "additionalProperties": false, "description": "Each object represents an individual CPQ resource associated with the record, identified by its unique ID and display name. ", "properties": { "id": { "description": "Represents the unique numeric identifier of the CPQ resource. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the display name of the CPQ resource. ", "maxLength": 200, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "maxItems": 50, "type": "array" }, "type": { "description": "Represents the type of CPQ configuration that is associated with the record, such as product configurators or pricing rules. ", "maxLength": 100, "type": "string" } }, "required": [ "type", "resources" ], "type": "object" }, "maxItems": 50, "type": "array" }, "id": { "description": "Represents the unique numeric identifier of the child record that has CPQ associations preventing the merge. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 10, "type": "array" }, "dependee": { "additionalProperties": false, "description": "Contains the API name and JSON path of the field that another field depends on, returned when a dependent field is missing from the request. ", "properties": { "api_name": { "description": "Represents the API name of the field that the missing dependent field depends on. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that the missing dependent field depends on. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the validation error. ", "maxLength": 200, "type": "string" }, "limit_due_to": { "description": "Contains the list of fields whose combined file sizes caused the upload size limit to be exceeded. ", "items": { "additionalProperties": false, "description": "Each object represents a field whose file or image upload size contributed to exceeding the maximum allowed upload limit. ", "properties": { "api_name": { "description": "Represents the API name of the field that contributed to exceeding the upload size limit. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that contributed to exceeding the upload size limit. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 20, "type": "array" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that caused the validation error. ", "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum required length for the field that caused the validation error. ", "format": "int32", "type": "integer" }, "resource_path_index": { "description": "Represents the zero-based index of the path parameter that caused the error. ", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message that describes the specific validation failure for this merge operation. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the merge operation. \nPossible values: \n**error** - The merge operation failed due to a validation error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "merge" ], "type": "object", "x-zs-$id": "FindAndMergeMergeArrayErrorResponse" } ], "description": "Represents the error response body returned when the request fails due to validation errors, invalid data, or business rule violations. ", "x-zs-$id": "FindAndMergeGetMergeJobStatusErrorResponse" } } }, "description": "Returned when the request contains invalid parameters, module, or a business rule prevents the merge operation. \n**Resolution**: The request must be corrected based on the error code and the message returned in the response body. \n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.custom.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.leads.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.potentials.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.READ" ] } ], "summary": "Get Merge Job Status", "tags": [ "find_and_merge" ], "x-zoho-document": "find_and_merge" }, "post": { "description": "To merge duplicate records in your Zoho CRM organization into a single master record. Supports field-level value selection from child records and file attachment management. If a child record has more than 1000 related records, the merge processes asynchronously and returns a job_id for status tracking.", "operationId": "mergeRecords", "parameters": [ { "$ref": "#/components/parameters/MasterRecordId" }, { "$ref": "#/components/parameters/FindAndMergeModule" }, { "description": "Triggers the web record approval flow instead of the standard merge flow.", "in": "query", "name": "feature", "required": false, "schema": { "enum": [ "web_record_approval" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "BasicMerge": { "description": "Shows a merge request specifying one child record and selecting a field from the child and a field from the master record. ", "summary": "Example of a basic merge operation with field selection. ", "value": { "merge": [ { "data": [ { "_fields": [ { "api_name": "Last_Name" } ], "id": "111111000000116110" } ], "master_record_fields": [ { "api_name": "Company" } ] } ] } }, "FileDeleteMerge": { "description": "Shows a merge request where the _data field is set to null to delete all attachments for an image upload field in the master record. ", "summary": "Example of merge operation with file deletion. ", "value": { "merge": [ { "data": [ { "_fields": [ { "api_name": "Company" } ], "id": "111111000000116110" } ], "master_record_fields": [ { "_data": null, "api_name": "Image_Upload_1" } ] } ] } }, "FileUploadMerge": { "description": "Shows a merge request specifying file attachment IDs to retain for an image upload field on both the child and master record. ", "summary": "Example of a merge with file upload field configuration. ", "value": { "merge": [ { "data": [ { "_fields": [ { "_data": [ { "id": "5364788765222" } ], "api_name": "Image_Upload_1" } ], "id": "111111000000116110" } ], "master_record_fields": [ { "_data": [ { "id": "5364788765222" } ], "api_name": "Image_Upload_1" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the merge configuration for the records to be consolidated.", "properties": { "merge": { "description": "Specify the configurations for the merge. The array must contain exactly one object. ", "items": { "additionalProperties": false, "description": "Each object specifies the configuration for a single merge operation, including the child records to be merged and the field value selections for the merged record. ", "properties": { "data": { "description": "Specify the child records to be merged into the master record. The array must contain a minimum of one and a maximum of two child record objects. ", "items": { "additionalProperties": false, "description": "Each object specifies the child record identifier and the fields whose values should be used in the merged record. ", "properties": { "_fields": { "description": "Specify the API names of the fields from the child record whose values you wish to merge into the master record. ", "items": { "additionalProperties": false, "description": "Each object specifies the API name of the field and, for file upload or image upload fields, the attachment IDs to retain. ", "properties": { "_data": { "anyOf": [ { "description": "It represents the unique ID of a file or attachment. This field is specifically used for File Upload and Image Upload fields in a record. Use [GET Records API](record.yaml#$.paths./{module}.get) to retrieve the unique IDs of the files or attachments. ", "items": { "additionalProperties": false, "description": "Each object specifies the unique identifier of the file or image attachment. ", "properties": { "id": { "description": "Specify the unique numeric identifier of the file or image attachment. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 50, "type": "array", "x-zs-$id": "FileUploadDataArray" }, { "description": "Set to null to delete all file or image attachments for this field in the merged record. ", "type": "null", "x-zs-$id": "FileUploadDataNull" } ], "description": "It represents the unique ID of a file or attachment. This field is specifically used for File Upload and Image Upload fields in a record. Use [GET Records API](record.yaml#$.paths./{module}.get) to retrieve the unique IDs of the files or attachments. " }, "api_name": { "description": "Represents the API name of the fields in the child record that you want to include in the merge. ", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 100, "type": "array" }, "id": { "description": "Specify the unique identifier of the child record to be merged. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 2, "minItems": 1, "type": "array" }, "master_record_fields": { "description": "Specify the fields from the master record whose values should be retained in the merged record. Use this for file upload or image upload fields in the master record. ", "items": { "additionalProperties": false, "description": "Each object specifies the API name of a master record field like file upload or image upload fields, the attachment IDs to retain. ", "properties": { "_data": { "anyOf": [ { "description": "Specify the file or image attachment IDs to retain for this master record field, or set to null to delete all attachments for this field in the merged record. \n\n> Notes\n> - If an image upload or file upload is not specified, all the images/files in the master record will be retained.\n> - If **'_data': null** is provided, all the images/files for that specific field will be deleted.\n> - If a child record has more than **1000 records** in any of its related lists, then the merge action will be **scheduled**. This meas that it performs an asynchronous action, and the response to your request will not be available immediately. Instead, you will receive a unique **job_id** in the response. You can use this job_id to retrieve the status of your merge action. For details, please refer to the [Get Records Merge Status API](find_and_merge.yaml#$.paths./{module}/{masterRecordId}/actions/merge.get).\n> - The **merge** JSON array can only contain one object, while the **data** JSON array can have a maximum of two child records. Exceeding these limits will result in errors.\n> - Each field should only be mentioned once across the **master_record_fields** and **data** arrays.\n> - Only open deals can be merged; closed deals will trigger an error.\n> - The closing date, stage, probability, and expected revenue fields will be automatically populated based on the master record and should not be specified in the request.\n> - Records currently locked or in an approval/review process cannot be merged. \n Specify the file or image attachment IDs to retain for this master record field, or set to null to delete all attachments for this field in the merged record. \n\n > Notes\n > - If an image upload or file upload is not specified, all the images/files in the master record will be retained.\n > - If **'_data': null** is provided, all the images/files for that specific field will be deleted.\n > - If a child record has more than **1000 records** in any of its related lists, then the merge action will be **scheduled**. This meas that it performs an asynchronous action, and the response to your request will not be available immediately. Instead, you will receive a unique **job_id** in the response. You can use this job_id to retrieve the status of your merge action. For details, please refer to the [Get Records Merge Status API](find_and_merge.yaml#$.paths./{module}/{masterRecordId}/actions/merge.get).\n > - The **merge** JSON array can only contain one object, while the **data** JSON array can have a maximum of two child records. Exceeding these limits will result in errors.\n > - Each field should only be mentioned once across the **master_record_fields** and **data** arrays.\n > - Only open deals can be merged; closed deals will trigger an error.\n > - The closing date, stage, probability, and expected revenue fields will be automatically populated based on the master record and should not be specified in the request.\n > - Records currently locked or in an approval/review process cannot be merged. \n", "items": { "additionalProperties": false, "description": "Specify the unique identifier of the file or image attachment to retain in the master record. ", "properties": { "id": { "description": "Specify the unique identifier of the file or image attachment to retain. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 50, "type": "array", "x-zs-$id": "MasterRecordFileUploadDataArray" }, { "description": "Set to null to delete all file or image attachments for this master record field in the merged record. ", "type": "null", "x-zs-$id": "MasterRecordFileUploadDataNull" } ], "description": "Specify the file or image attachment IDs to retain for this master record field, or set to null to delete all attachments for this field in the merged record. \n\n> Notes\n> - If an image upload or file upload is not specified, all the images/files in the master record will be retained.\n> - If **'_data': null** is provided, all the images/files for that specific field will be deleted.\n> - If a child record has more than **1000 records** in any of its related lists, then the merge action will be **scheduled**. This meas that it performs an asynchronous action, and the response to your request will not be available immediately. Instead, you will receive a unique **job_id** in the response. You can use this job_id to retrieve the status of your merge action. For details, please refer to the [Get Records Merge Status API](find_and_merge.yaml#$.paths./{module}/{masterRecordId}/actions/merge.get).\n> - The **merge** JSON array can only contain one object, while the **data** JSON array can have a maximum of two child records. Exceeding these limits will result in errors.\n> - Each field should only be mentioned once across the **master_record_fields** and **data** arrays.\n> - Only open deals can be merged; closed deals will trigger an error.\n> - The closing date, stage, probability, and expected revenue fields will be automatically populated based on the master record and should not be specified in the request.\n> - Records currently locked or in an approval/review process cannot be merged. \n" }, "api_name": { "description": "Specify the API name of the master record field to retain in the merged record. ", "maxLength": 100, "type": "string" } }, "required": [ "api_name" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "data" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "merge" ], "type": "object" }, "x-zs-llm-examples": [ "BasicMerge", "FileDeleteMerge", "FileUploadMerge" ] } }, "description": "The request body contains the data required to perform the operation. ", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "MergeCompleted": { "description": "Shows the response when the merge was completed synchronously, returning a SUCCESS code with the retained master record ID.", "summary": "Example of merge operation completed successfully.", "value": { "merge": [ { "code": "SUCCESS", "details": { "id": "111111000000116112" }, "message": "The records has been merged successfully", "status": "success" } ] } }, "MergeScheduled": { "description": "Shows the response when the merge was scheduled for processing, returning a SCHEDULED code and job_id.", "summary": "Example of merge operation scheduled for processing.", "value": { "merge": [ { "code": "SCHEDULED", "details": { "job_id": "1234567890" }, "message": "The records have been scheduled in a scheduler", "status": "success" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Response when the merge operation is completed or scheduled for processing. ", "properties": { "merge": { "description": "Contains the list of merge operation results indicating whether the merge completed or was scheduled. ", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful merge completion response, returned when the merge was processed synchronously. ", "properties": { "code": { "description": "Represents the success code for a completed merge. \nPossible values: \n**SUCCESS** - The records were merged successfully.\n", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the completed merge, including the ID of the master record retained after the merge. ", "properties": { "id": { "description": "Represents the unique identifier of the master record retained after the merge. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "FindAndMergeId" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the success message for the completed merge operation. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the merge operation. \nPossible values:\n**success** - The merge completed successfully.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FindAndMergeMergeRecordsCompletedResult" }, { "additionalProperties": false, "description": "Scheduled merge operation response, returned when the merge was queued for asynchronous processing. ", "properties": { "code": { "description": "Represents the code indicating that the merge was scheduled for background processing. \nPossible values:\n**SCHEDULED** - The merge operation was queued for asynchronous processing.\n", "enum": [ "SCHEDULED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the scheduled merge, including the job ID for tracking the merge status.", "properties": { "job_id": { "description": "Represents the unique identifier of the scheduled merge job. Use this ID with the [Get Merge Job Status API](find_and_merge.yaml#$.paths./{module}/{masterRecordId}/actions/merge.get) to check the status of the merge. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "job_id" ], "type": "object" }, "message": { "description": "Represents the message about the scheduled merge operation.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the scheduling operation. \nPossible values:\n**success** - The merge was successfully scheduled.\n", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "FindAndMergeMergeRecordsScheduledResult" } ], "description": "Each object represents a merge result item indicating whether the operation completed synchronously or was scheduled for processing. " }, "maxItems": 1, "type": "array" } }, "required": [ "merge" ], "type": "object", "x-zs-$id": "FindAndMergeMergeRecordsCompletedResponse" } ], "description": "Response when the merge operation was initiated - either completed synchronously or scheduled asynchronously. ", "x-zs-$id": "FindAndMergeMergeRecordsResponse" } } }, "description": "Returns the result of a merge operation that was either completed synchronously (with SUCCESS code and merged record ID) or scheduled for asynchronous processing (with SCHEDULED code and job_id). " }, "400": { "content": { "application/json": { "examples": { "ApiNameNotMentioned": { "description": "Shows the error when a field in the _fields array does not include the required api_name property.", "summary": "Example of API name of a field that is not mentioned.", "value": { "merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "API name of the field is not mentioned", "status": "error" } ] } }, "ChildRecordIdMissing": { "description": "Shows the error when the child record ID is missing or empty in the data array.", "summary": "Example of child record ID is empty or not available.", "value": { "merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.merge[0].data[0].id" }, "message": "required id not found", "status": "error" } ] } }, "ClosedDealNotAllowed": { "description": "Shows the error when a closed deal record is included in the merge request, as only open deals can be merged.", "summary": "Example of closed deal is mentioned in the request body to merge.", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "record", "resource_path_index": 1 }, "message": "Only Open Deals can be merged", "status": "error" } }, "ClosingDateNotAllowed": { "description": "Shows the error when the Closing Date field is included in the merge request for the Deals module, as it is automatically populated from the master record.", "summary": "Example of closing date is mentioned for deals module.", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Closing date will be automatically populated based on master record", "status": "error" } ] } }, "CpqAssociationError": { "description": "Shows the error when a child record is associated with CPQ configurations such as product configurators or pricing rules, preventing the merge.", "summary": "Example of records being associated with CPQ rules.", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "data", "data": [ { "_associated_places": [ { "resources": [ { "id": "111111000000071837", "name": "asdfsdf" } ], "type": "product_configurators" }, { "resources": [ { "id": "111111000000072007", "name": "PR -sample" } ], "type": "pricing_rules" } ], "id": "111111000000071814" } ], "json_path": "$.merge[0].data" }, "message": "unable to merge records since there are association in child records", "status": "error" } ] } }, "DataArrayEmpty": { "description": "Shows the error when the data array is missing or empty in the merge request.", "summary": "Example of data array being not mentioned or empty.", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.merge[0].data", "minimum_length": 1 }, "message": " Atleast one child record id is required to be merged.", "status": "error" } ] } }, "DataArraySizeExceeded": { "description": "Shows the error when the data array contains more than two child record objects, exceeding the maximum allowed size.", "summary": "Example of the data size array more than 2.", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "data", "json_path": "$.merge[0].data", "maximum_length": 2 }, "message": " More than 2 child record ids cannot be merged.", "status": "error" } ] } }, "DuplicateFieldMention": { "description": "Shows the error when the same field API name is specified more than once across the data and master_record_fields arrays.", "summary": "Example of one particular field is mentioned more than once.", "value": { "merge": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "When one field is mentioned more than once", "status": "error" } ] } }, "DuplicateRecordIds": { "description": "Shows the error when the master record ID and all child record IDs are identical, as valid distinct record IDs are required.", "summary": "Example of all mentioned record IDs are the same.", "value": { "merge": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "id", "json_path": "$.merge[0].data[0].id" }, "message": "Valid record ids need to be given for merging", "status": "error" } ] } }, "FileSizeLimitExceeded": { "description": "Shows the error when the combined size of files or images across the specified fields exceeds the maximum upload size limit, listing each contributing field.", "summary": "Example of total size of files/images in a field exceeding maximum upload size.", "value": { "merge": [ { "code": "LIMIT_EXCEEDED", "details": { "MAXIMUM_SIZE": "30 MB", "limit_due_to": [ { "api_name": "File_Upload_30MB", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, { "api_name": "File_Upload_30MB", "json_path": "$.merge[0].data[1]._fields[1].api_name" }, { "api_name": "File_Upload_30MB", "json_path": "$.merge[0].master_record_fields[1].api_name" } ] }, "message": "Attachment size limit exceeded", "status": "error" } ] } }, "FileUploadDataMissingChild": { "description": "Shows the error when a file upload or image upload field is specified for a child record in _fields but the _data array is missing.", "summary": "Example of File/Image upload field being mentioned in data array but _data array not given.", "value": { "merge": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "json_path": "$.merge[0].data[0]._fields[0]._data" }, "message": "_data array is not mentioned for the child record", "status": "error" } ] } }, "FileUploadDataMissingMaster": { "description": "Shows the error when a file upload or image upload field is specified in master_record_fields but the _data array is missing.", "summary": "Example of File/Image upload field being mentioned in master record but _data array not given.", "value": { "merge": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "id", "dependee": { "api_name": "api_name", "json_path": "$.merge[0].master_record_fields[0].api_name" }, "json_path": "$.merge[0].master_record_fields[0]._data" }, "message": "_data array is not mentioned for the master record", "status": "error" } ] } }, "InvalidModule": { "description": "Shows the error when the module name in the request URL is not a valid module.", "summary": "Example of invalid module name provided.", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "MasterRecordApiNameMissing": { "description": "Shows the error when an entry in the master_record_fields array does not include the required api_name property.", "summary": "Example of API name being not mentioned in master_record_fields array.", "value": { "merge": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "api_name", "json_path": "$.merge[0].master_record_fields[0].api_name" }, "message": "API name not mentioned for the master record", "status": "error" } ] } }, "MasterRecordNotAvailable": { "description": "Shows the error when the master record ID specified in the URL path does not correspond to an existing record.", "summary": "Example of master record ID is not available.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "Master record id is not available", "status": "error" } }, "MergeArraySizeExceeded": { "description": "Shows the error when the merge array in the request body contains more than one object.", "summary": "Example of merge array size is larger than one.", "value": { "code": "INVALID_DATA", "details": {}, "message": "invalid data", "status": "error" } }, "ProbabilityRevenueNotAllowed": { "description": "Shows the error when the Expected Revenue or Probability field is included in the merge request, as these fields are automatically populated based on the chosen Stage.", "summary": "Example of Expected Revenue and Probability fields are mentioned.", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Probability and Expected Revenue fields will be automatically populated based on chosen Stage", "status": "error" } ] } }, "RecordAlreadyBeingMerged": { "description": "Shows the error when a record in the request is already in the process of being merged and cannot be included in another merge operation.", "summary": "Example of record is already being merged.", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.merge[0].data[0].id" }, "message": "This record id is not allowed to be merged", "status": "error" } ] } }, "ReportingToChildOnly": { "description": "Shows the error when the Reporting To field is specified for only a child record, without specifying the Account field for the same record.", "summary": "Example of providing only Reporting To for child record.", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Reporting to and account should belong to the same record", "status": "error" } ] } }, "ReportingToWithAccountMismatch": { "description": "Shows the error when the Reporting To and Account fields are specified for different records, as both must belong to the same record.", "summary": "Example of configuring Reporting To for child and Account for master (or vice versa).", "value": { "merge": [ { "code": "INVALID_DATA", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Reporting to and account should belong to the same record", "status": "error" } ] } }, "StageFieldNotAllowed": { "description": "Shows the error when the Stage field is included in the merge request for records with different pipelines, as it is automatically populated based on the chosen Pipeline.", "summary": "Example of stage being mentioned when child and master record have different pipelines.", "value": { "merge": [ { "code": "NOT_ALLOWED", "details": { "api_name": "api_name", "json_path": "$.merge[0].data[0]._fields[0].api_name" }, "message": "Stage field will be automatically populated based on chosen Pipeline", "status": "error" } ] } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Standard error response for invalid data or module errors.", "properties": { "code": { "description": "Represents the error code that identifies the type of failure. \nPossible values:\n**INVALID_DATA** - The request contains invalid or malformed data.\n**INVALID_MODULE** - The specified module name is not valid.\n**NOT_ALLOWED** - The requested operation is not permitted.\n", "enum": [ "INVALID_DATA", "INVALID_MODULE", "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains additional context information about the error, such as the field name, JSON path, and constraint limits that caused the validation failure.", "properties": { "api_name": { "description": "Represents the API name of the field or resource that caused the validation error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the validation error.", "maxLength": 200, "type": "string" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that caused the validation error.", "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum required length for the field that caused the validation error.", "format": "int32", "type": "integer" }, "resource_path_index": { "description": "Represents the zero-based index of the path parameter that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message that describes the issue in detail. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the API request. \nPossible values:\n**error** - The request failed due to a validation error or other issue.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "FindAndMergeMergeRecordsStandardErrorResponse" }, { "additionalProperties": false, "description": "Error response with merge array structure, returned when errors are specific to individual merge operations.", "properties": { "merge": { "description": "Contains the list of error details for each merge operation that failed validation. ", "items": { "additionalProperties": false, "description": "Each object represents an individual error that occurred during a merge operation, including the error code, details, and a descriptive message.", "properties": { "code": { "description": "Represents the error code that identifies the type of failure for the merge operation. \nPossible values:\n**MANDATORY_NOT_FOUND** - A required field or property is missing from the request.\n**NOT_ALLOWED** - The operation is not permitted due to a business rule constraint.\n**INVALID_DATA** - The request contains invalid or malformed data.\n**DUPLICATE_DATA** - Duplicate values were detected for a field that must be unique.\n**DEPENDENT_FIELD_MISSING** - A field that depends on another field is missing from the request.\n**LIMIT_EXCEEDED** - A size or count limit has been exceeded.\n", "enum": [ "MANDATORY_NOT_FOUND", "NOT_ALLOWED", "INVALID_DATA", "DUPLICATE_DATA", "DEPENDENT_FIELD_MISSING", "LIMIT_EXCEEDED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains detailed error information for the failed merge operation, including the field name, JSON path, and constraint limits.", "properties": { "MAXIMUM_SIZE": { "description": "Represents the maximum allowed total file size for the file upload or image upload field that caused the limit exceeded error.", "maxLength": 50, "type": "string" }, "api_name": { "description": "Represents the API name of the field that caused the validation error.", "maxLength": 100, "type": "string" }, "data": { "description": "Contains the list of child records that are associated with CPQ rules, preventing the merge operation.", "items": { "additionalProperties": false, "description": "Represents a child record that has CPQ associations blocking the merge operation.", "properties": { "_associated_places": { "description": "Contains the list of CPQ configurations and rules that are associated with the record, preventing the merge.", "items": { "additionalProperties": false, "description": "Each object represents a CPQ association entry, including its type and the specific resources that reference this record.", "properties": { "resources": { "description": "Contains the list of CPQ resources that reference this record, such as product configurators or pricing rules.", "items": { "additionalProperties": false, "description": "Each object represents an individual CPQ resource that references this record, identified by its ID and name.", "properties": { "id": { "description": "Represents the unique identifier of the CPQ resource. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" }, "name": { "description": "Represents the name of the CPQ resource that references this record. ", "maxLength": 200, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "maxItems": 50, "type": "array" }, "type": { "description": "Represents the type of CPQ association, such as the product configurator or pricing rule category. ", "maxLength": 100, "type": "string" } }, "required": [ "type", "resources" ], "type": "object" }, "maxItems": 50, "type": "array" }, "id": { "description": "Represents the unique identifier of the child record that has CPQ associations. ", "maxLength": 50, "pattern": "^[0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 10, "type": "array" }, "dependee": { "additionalProperties": false, "description": "Contains the information about the field that the missing dependent field depends on.", "properties": { "api_name": { "description": "Represents the API name of the field that the missing dependent field depends on. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that the missing dependent field depends on. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "json_path": { "description": "Represents the JSON path to the field in the request that caused the validation error.", "maxLength": 200, "type": "string" }, "limit_due_to": { "description": "Contains the list of fields that contributed to the file size limit being exceeded.", "items": { "additionalProperties": false, "description": "Represents a field that contributed to the file size limit being exceeded, identified by its API name and JSON path.", "properties": { "api_name": { "description": "Represents the API name of the field that contributed to the file size limit being exceeded. ", "maxLength": 100, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field that contributed to the file size limit being exceeded. ", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 20, "type": "array" }, "maximum_length": { "description": "Represents the maximum allowed length for the field that caused the validation error.", "format": "int32", "type": "integer" }, "minimum_length": { "description": "Represents the minimum required length for the field that caused the validation error.", "format": "int32", "type": "integer" }, "resource_path_index": { "description": "Represents the zero-based index of the path parameter that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message for the failed merge operation. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the merge operation. \nPossible values:\n**error** - The operation failed due to a validation error.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 10, "type": "array" } }, "required": [ "merge" ], "type": "object", "x-zs-$id": "FindAndMergeMergeRecordsMergeArrayErrorResponse" } ], "description": "Error response for a merge request that failed due to validation errors, invalid data, or business rule violations.", "x-zs-$id": "FindAndMergeMergeRecordsErrorResponse" } } }, "description": "Shows a bad request due to validation errors, invalid data, or business rule violations. Returns either a standard top-level error object or a merge array with per-operation error details." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.custom.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.leads.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.potentials.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.CREATE" ] } ], "summary": "Merge Records", "tags": [ "find_and_merge" ], "x-zoho-document": "find_and_merge" } }, "/crm/v8/{module}/{recordId}": { "delete": { "description": "To permanently delete a specific record by its unique ID from the specified module in your Zoho CRM organization. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.", "operationId": "deleteRecord", "parameters": [ { "$ref": "#/components/parameters/RecordModule" }, { "$ref": "#/components/parameters/RecordRecord" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDeletion": { "description": "Shows the successful response for the deleteRecord operation, including the record ID and audit metadata.", "summary": "Successfully deleted records", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "5843104000000624046" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteByIdSuccessResponse" } } }, "description": "Returns the deletion status for each record successfully deleted." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows the error response when the user does not have sufficient privileges for this operation.", "summary": "Insufficient privileges for the operation", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to delete records", "status": "error" } }, "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecordId": { "description": "Shows the error response when an invalid record ID is provided in the URL.", "summary": "Invalid record ID in the request URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 0 }, "message": "invalid record id", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows the error response when an unsupported HTTP method is used for this endpoint.", "summary": "Unsupported HTTP method for this endpoint", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MissingParam": { "description": "Shows the error response when a required parameter is missing from the request.", "summary": "Required parameter missing from the request", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "ids" }, "message": "Required parameter is missing", "status": "error" } }, "NotApproved": { "description": "Shows the error response when the record has not been approved and cannot be deleted.", "summary": "Record is not approved and cannot be deleted", "value": { "data": [ { "code": "NOT_APPROVED", "details": { "id": "5040565000001052497" }, "message": "cannot delete record that is not approved yet", "status": "error" } ] } }, "RecordLocked": { "description": "Shows the error response when the target record is locked and cannot be modified.", "summary": "Record is locked and cannot be modified", "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "5040565000001052497" }, "message": "You cannot perform this operation as the record is locked.", "status": "error" } ] } }, "RecordNotDeleted": { "description": "Shows the error response when a record cannot be deleted due to invalid data.", "summary": "Record could not be deleted due to invalid data", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "record not deleted", "status": "error" } }, "UnableToParseDataType": { "description": "Shows the error response when the request body or parameters are in an incorrect format.", "summary": "Request body or parameters in incorrect format", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "either the request body or parameters is in wrong format", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteByIdErrorResponse" } } }, "description": "The request could not be processed because of an invalid module, missing parameters, or invalid record IDs.\n**Resolution:** The request must include valid module API name and record IDs." }, "401": { "content": { "application/json": { "examples": { "ScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteByIdUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to delete", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteByIdNoPermissionResponse" } } }, "description": "Permission denied to delete record in the specified module.\n**Resolution:** The CRM administrator must grant the required deletion permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteByIdInvalidUrlPatternResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern.\n**Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "data": [ { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordDeleteByIdInternalServerErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.DELETE" ] } ], "summary": "Delete a specific record by ID", "tags": [ "record" ], "x-zoho-document": "record" }, "get": { "description": "To retrieve the details of a specific record by its unique ID from the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.", "operationId": "getRecord", "parameters": [ { "$ref": "#/components/parameters/RecordRecord" }, { "$ref": "#/components/parameters/RecordModule" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Leads": { "description": "Shows the successful response for the getRecord operation, including the record ID and audit metadata.", "summary": "Records retrieved from the Leads module", "value": { "data": [ { "Company": "Zylker Corp", "Created_Time": "2023-10-15T10:30:00+00:00", "Email": "john.doe@zylker.com", "First_Name": "John", "Last_Name": "Doe", "Lead_Status": "Not Contacted", "Modified_Time": "2023-10-15T14:20:00+00:00", "Owner": { "email": "patricia.boyle@example.com", "id": "4150868000000225013", "name": "Patricia Boyle" }, "Phone": "+1-555-123-4567", "id": "4150868000000002175" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordIDGETSuccessResponse" } } }, "description": "Returns the details of the requested record from the specified module." }, "204": { "description": "Returns an empty response when the request is successful but no record match the specified criteria." }, "400": { "content": { "application/json": { "examples": { "ExpiredValue": { "description": "Shows the response for the ExpiredValue scenario.", "summary": "ExpiredValue response example", "value": { "code": "EXPIRED_VALUE", "details": { "api_name": "page_token", "json_path": "$.query.page_token" }, "message": "Page token expired", "status": "error" } }, "InvalidData": { "description": "Shows the error response when invalid data is provided in the request.", "summary": "Invalid field value in the request", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "TokenBoundDataMismatch": { "description": "Shows the response for the TokenBoundDataMismatch scenario.", "summary": "TokenBoundDataMismatch response example", "value": { "code": "TOKEN_BOUND_DATA_MISMATCH", "details": { "param_name": "page_token" }, "message": "The page_token given seems to be invalid or input param is added or altered or deleted", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenBoundDataMismatchGETError" }, { "$ref": "#/components/schemas/InvalidModuleGETError" }, { "$ref": "#/components/schemas/ExpiredValueGETError" } ], "description": "Represents the error response returned when one or more record operations fail.", "x-zs-$id": "RecordIDGETErrorResponse" } } }, "description": "The request could not be processed because one or more records contain invalid data or missing required fields.\n**Resolution:** Each error in the data array identifies the specific record and field that caused the failure. The request must be corrected and resubmitted." }, "401": { "content": { "application/json": { "examples": { "ScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to retrieve record in the specified module.\n**Resolution:** The CRM administrator must grant the required retrieval permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern.\n**Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Get a record by ID from a specified module", "tags": [ "record" ], "x-zoho-document": "record" }, "put": { "description": "To update the field values of a specific record in the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and API names.", "operationId": "updateRecord", "parameters": [ { "$ref": "#/components/parameters/RecordModule" }, { "$ref": "#/components/parameters/RecordRecord" } ], "requestBody": { "content": { "application/json": { "examples": { "Leads": { "description": "Shows the request body structure for the updateRecord operation.", "summary": "Records retrieved from the Leads module", "value": { "apply_feature_execution": [ { "name": "layout_rules" } ], "data": [ { "Company": "ABC", "Email": "p.daly@zylker.com", "First_Name": "Paul", "Last_Name": "Daly", "Layout": { "id": "554023000002734009" }, "Lead_Source": "Employee Referral", "State": "Texas", "id": "111112000000142001" } ], "skip_feature_execution": [ { "name": "cadences" } ], "trigger": [ "approval", "workflow", "blueprint", "pathfinder", "orchestration" ] } } }, "schema": { "$ref": "#/components/schemas/RecordsSinglePutInputSchema", "description": "Request body containing the updated resource data to modify the existing record." } } }, "description": "The request body must contain a **data** array with one object. The object must include an **id** field to identify the record to update.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the successful response for the updateRecord operation, including the record ID and audit metadata.", "summary": "Successfully completed operation", "value": { "data": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "5725767000000524157" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordSuccessResponse" } } }, "description": "Returns the details of each successfully updated record, including the record ID and audit metadata." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows the error response when the user does not have sufficient privileges for this operation.", "summary": "Insufficient privileges for the operation", "value": { "data": [ { "code": "AUTHORIZATION_FAILED", "details": { "resource_path_index": 0 }, "message": "User does not have sufficient privilege to perform this action", "status": "error" } ] } }, "DependentFieldMissing": { "description": "Shows the error response when a required dependent field is absent from the request.", "summary": "Required dependent field missing from the request", "value": { "data": [ { "code": "DEPENDENT_FIELD_MISSING", "details": { "api_name": "Product_Subcategory", "dependee": { "api_name": "Product_Category", "json_path": "$.data[0].Product_Category" }, "json_path": "$.data[0].Product_Subcategory" }, "message": "The field 'Product_Subcategory' is required when 'Product_Category' is provided", "status": "error" } ] } }, "DependentMismatch": { "description": "Shows the error response when a dependent field value conflicts with its controlling field.", "summary": "Dependent field value conflicts with controlling field", "value": { "data": [ { "code": "DEPENDENT_MISMATCH", "details": { "api_name": "Unavailable_Till", "dependee": { "api_name": "Status", "json_path": "$.data[0].Status" }, "json_path": "$.data[0].Unavailable_Till" }, "message": "Unavailable Till must be greater than current Time.", "status": "error" } ] } }, "DuplicateDataError": { "description": "Shows the error response when a unique field value already exists in the module.", "summary": "Duplicate unique field value matches an existing record", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Unique_1", "duplicate_record": { "Owner": { "id": "2008662000000454001", "name": "Pranav", "zuid": "75092197" }, "id": "2008662000006256222" }, "id": "2008662000006256222", "json_path": "$.data[0].Unique_1", "more_records": false }, "message": "duplicate data", "status": "error" } ] } }, "InvalidData": { "description": "Shows the error response when invalid data is provided in the request.", "summary": "Invalid field value in the request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Company", "json_path": "$.data[0].Company" }, "message": "The field value given for Company is invalid", "status": "error" } ] } }, "InvalidDataLength": { "description": "Shows the error response when a field value exceeds the maximum allowed length.", "summary": "Field value exceeds the maximum allowed length", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "json_path": "$.data[0].Number_1", "maximum_length": 2 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataType": { "description": "Shows the error response when a field value does not match the expected data type.", "summary": "Field value with an incorrect data type", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "expected_data_type": "integer", "json_path": "$.data[0].Number_1" }, "message": "invalid data", "status": "error" } ] } }, "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request", "value": { "data": [ { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "InvalidRequestMethod": { "description": "Shows the error response when an unsupported HTTP method is used for this endpoint.", "summary": "Unsupported HTTP method for this endpoint", "value": { "data": [ { "code": "INVALID_REQUEST_METHOD", "details": { "resource_path_index": 0 }, "message": "The HTTP request method type is not a valid one.", "status": "error" } ] } }, "InvalidSupportedValue": { "description": "Shows the error response when an unsupported value is provided for a fixed-value field.", "summary": "Unsupported value for a fixed-value field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.apply_feature_execution[0].name", "supported_values": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ] }, "message": "invalid data", "status": "error" } ] } }, "LimitExceededError": { "description": "Shows the error response when the number of records in the request exceeds the allowed limit.", "summary": "Record count exceeds the allowed limit per request", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "data", "maximum_length": 100 }, "message": "count of records in your request exceeds the limit", "status": "error" } ] } }, "MandatoryNotFound": { "description": "Shows the error response when a required field is missing from the request.", "summary": "Required field missing from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.data.service.id" }, "message": "Service Id Not Found", "status": "error" } ] } }, "MandatoryNotFoundLayoutRule": { "description": "Shows the error response when a field made mandatory by a Layout Rule is absent from the update request. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve Layout IDs.", "summary": "Layout rule mandatory field absent from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Phone", "json_path": "$.data[0].Phone", "layout_rule": { "id": "5410702000000761547", "name": "Layout Rule" } }, "message": "required field not found", "status": "error" } ] } }, "MultipleErrors": { "description": "Shows the error response when a single record has multiple validation failures.", "summary": "Multiple validation errors in a single record", "value": { "data": [ { "code": "MULTIPLE_OR_MULTI_ERRORS", "details": { "errors": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Email", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000000428295", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Email", "more_records": true }, "message": "duplicate data", "status": "error" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "Mobile", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000002432007", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Mobile", "more_records": true }, "message": "duplicate data", "status": "error" } ] }, "message": "Multiple errors in the request", "status": "error" } ] } }, "NotApprovedError": { "description": "Shows the error response when the record has not been approved and cannot be modified.", "summary": "Record is not approved and cannot be modified", "value": { "code": "NOT_APPROVED", "details": { "resource_path_index": 1 }, "message": "Cannot update record that is not approved yet", "status": "error" } }, "NotReviewedError": { "description": "Shows the error response when the record is under review and cannot be modified.", "summary": "Record is under review and cannot be modified", "value": { "data": [ { "code": "NOT_REVIEWED", "details": {}, "message": "record in review", "status": "error" } ] } }, "RecordLockedError": { "description": "Shows the error response when the target record is locked and cannot be modified.", "summary": "Record is locked and cannot be modified", "value": { "data": [ { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "api_name": "id", "json_path": "$.data[0].id" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } ] } }, "ResourcePathIndexError": { "description": "Shows the error response when the resource path index indicates an invalid data reference.", "summary": "Invalid resource path index reference", "value": { "data": [ { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "record not deleted", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordsIDPutErrorResponse" } } }, "description": "The request could not be processed because one or more records contain invalid data or missing required fields.\n**Resolution:** Each error in the data array identifies the specific record and field that caused the failure. The request must be corrected and resubmitted." }, "401": { "content": { "application/json": { "examples": { "OauthScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordUnauthorizedResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to update record in the specified module.\n**Resolution:** The CRM administrator must grant the required update permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern.\n**Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "412": { "content": { "application/json": { "examples": { "AlreadyModified": { "description": "Shows the 412 error response when the record has been modified after the If-Unmodified-Since timestamp.", "summary": "Record already modified after the specified timestamp", "value": { "data": [ { "code": "ALREADY_MODIFIED", "details": { "Created_By": { "id": "492070000000209017", "name": "Senthilkumar" }, "Created_Time": "2023-04-17T16:23:25+05:30", "Modified_By": { "id": "492070000000209017", "name": "Senthilkumar" }, "Modified_Time": "2023-06-04T12:00:24+05:30", "id": "492070000199308229" }, "message": "record updated time has already passed if-unmodified-since time", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the record has been modified after the If-Unmodified-Since timestamp.", "properties": { "data": { "description": "Contains the list of per-record results for the operation.", "items": { "additionalProperties": false, "description": "Represents a single record operation result, which is either a success or error item identified by the **status** field.", "properties": { "code": { "description": "Contains the list of per-record results for the operation.", "enum": [ "ALREADY_MODIFIED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "Created_By": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" }, "name": { "description": "Contains the list of per-record results for the operation.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Contains the list of per-record results for the operation.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Contains the list of per-record results for the operation.", "properties": { "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" }, "name": { "description": "Contains the list of per-record results for the operation.", "maxLength": 101, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Contains the list of per-record results for the operation.", "format": "date-time", "type": "string" }, "id": { "description": "Contains the list of per-record results for the operation.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Contains the list of per-record results for the operation.", "maxLength": 255, "type": "string" }, "status": { "description": "Contains the list of per-record results for the operation.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RecordAlreadyModifiedResponse" } } }, "description": "The record has been modified after the timestamp specified in the If-Unmodified-Since header.\n**Resolution:** The latest version of the record must be retrieved and the update must be resubmitted with the current modification timestamp." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Update a specific record by ID", "tags": [ "record" ], "x-zoho-document": "record" } }, "/crm/v8/{module}/{recordId}/Emails/actions/download_attachments": { "get": { "description": "To download the binary content of an attachment that belongs to an email associated with a record in your Zoho CRM organization.", "operationId": "downloadEmailAttachments", "parameters": [ { "$ref": "#/components/parameters/DownloadAttachmentsModule" }, { "$ref": "#/components/parameters/DownloadAttachmentsRecordId" }, { "$ref": "#/components/parameters/DownloadAttachmentsUserId" }, { "$ref": "#/components/parameters/DownloadAttachmentsMessageId" }, { "$ref": "#/components/parameters/DownloadAttachmentsId" }, { "$ref": "#/components/parameters/DownloadAttachmentsName" } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "description": "Represents the binary content of the requested email attachment, returned as an octet stream.", "format": "binary", "type": "string", "x-zs-$id": "AttachmentBinarySchema" } } }, "description": "Returns the binary content of the requested email attachment as an octet stream." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "description": "Shows the response returned when the **record_ID** path parameter does not reference an existing record in the specified module.", "summary": "INVALID_DATA error when the record ID is incorrect. ", "value": { "code": "INVALID_DATA", "message": "Invalid record ID provided.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error returned when the request contains an invalid parameter value.", "properties": { "code": { "description": "Represents the error code that identifies the specific validation failure.", "maxLength": 50, "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional contextual information about the validation failure, such as the parameter or field that triggered the error.", "type": "object" }, "message": { "description": "Represents the message describing the cause of the validation failure. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the outcome of the request. \n**Possible values:**\n**error** - Indicates that the request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "ValidationErrorSchema" }, { "additionalProperties": false, "description": "Represents the error returned when a mandatory parameter is missing from the request.", "properties": { "code": { "const": "MANDATORY_NOT_FOUND", "description": "Represents the error code indicating that a mandatory parameter was not provided in the request. Always returned in the response.\nPossible values:\n**MANDATORY_NOT_FOUND** - Indicates that one or more mandatory parameters are missing from the request.\n", "type": "string" }, "message": { "description": "Represents the message describing which mandatory parameter is missing from the request. ", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the outcome of the request. \nPossible values:\n**error** - Indicates that the request failed.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message" ], "type": "object", "x-zs-$id": "MissingParamSchema" } ], "description": "Represents the error payload returned when the request missed a mandatory parameter or fails validation.", "x-zs-$id": "Error400ResponseSchema" } } }, "description": "The request is missing a mandatory parameter or contains an invalid parameter value.\n**Resolution:** The mandatory query parameters (**user_id**, **message_id**, **id**, and **name**) must be provided with valid values, and the **module** and **record_ID** path parameters must reference an existing record.\n" }, "401": { "content": { "application/json": { "examples": { "AuthFail": { "description": "Shows the 401 response returned when the OAuth access token supplied in the **Authorization** header is invalid.", "summary": "INVALID_TOKEN error for an invalid OAuth access token", "value": { "code": "INVALID_TOKEN", "message": "Invalid token.", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/DownloadAttachmentsErrorResponse" } } }, "description": "The OAuth access token supplied in the request is invalid or has expired.\n**Resolution:** A new access token must be generated with the required scopes for this API.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.emails.READ", "ZohoCRM.modules.leads.READ" ] } ], "summary": "Download an email attachment", "tags": [ "download_attachments" ], "x-zoho-document": "download_attachments" } }, "/crm/v8/{module}/{recordId}/Emails/actions/download_inline_images": { "get": { "description": "To download an inline image embedded in an email associated with a record in your Zoho CRM organization.", "operationId": "getDownloadInlineImages", "parameters": [ { "$ref": "#/components/parameters/DownloadInlineImagesModule" }, { "$ref": "#/components/parameters/DownloadInlineImagesRecordId" }, { "$ref": "#/components/parameters/DownloadInlineImagesUserId" }, { "$ref": "#/components/parameters/DownloadInlineImagesMessageId" }, { "$ref": "#/components/parameters/DownloadInlineImagesId" } ], "responses": { "200": { "content": { "image/png": { "schema": { "description": "Contains the binary data of the inline image file embedded in the email.", "format": "binary", "type": "string", "x-zs-$id": "CrmEmailsInlineImageBinary" } } }, "description": "Returns the binary data of the requested inline image file." }, "400": { "content": { "application/json": { "examples": { "ErrorExample": { "description": "Demonstrates the error response when the record ID in the request URL is invalid. \nThe **resource_path_index** indicates which path segment caused the error.", "summary": "INVALID_DATA error for an invalid record ID.", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "The provided record ID is invalid", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the inline image download request fails due to invalid parameters or missing data.", "properties": { "code": { "description": "Represents the error code identifying the type of issue. \nPossible values:\n**INVALID_URL_PATTERN** - The request URL format is incorrect.\n**INVALID_DATA** - The provided data is invalid.\n**INVALID_REQUEST_METHOD** - The HTTP method is not supported for this endpoint.\n**INVALID_TOKEN** - The access token is invalid or expired.\n**INVALID_MODULE** - The specified module does not exist or is not accessible.\n**REQUIRED_PARAM_MISSING** - A required parameter is missing from the request.\n", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_REQUEST_METHOD", "INVALID_TOKEN", "INVALID_MODULE", "REQUIRED_PARAM_MISSING" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional context about the error, such as the specific field or parameter that caused the issue. ", "properties": { "resource_path_index": { "description": "Represents the zero-based index of the path segment in the request URL that caused the error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue. ", "maxLength": 255, "type": "string" }, "status": { "description": "Indicates the outcome of the API request. \nPossible values:\n**error** - The request failed due to an error condition.\n", "enum": [ "error" ], "type": "string" } }, "required": [ "status", "code", "message", "details" ], "type": "object", "x-zs-$id": "CrmEmailsDownloadError" } } }, "description": "The request contains invalid parameters or references an invalid module.\n**Resolution:** Ensure that you have provided valid values to the parameters and module name.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.emails.READ", "ZohoCRM.modules.leads.all", "ZohoCRM.modules.contacts.all", "ZohoCRM.modules.deals.all" ] } ], "summary": "Download an inline image from an email", "tags": [ "download_inline_images" ], "x-zoho-document": "download_inline_images" } }, "/crm/v8/{module}/{recordId}/__timeline": { "get": { "description": "To retrieve a paginated list of timeline entries for a specific record in your Zoho CRM organization. Each timeline entry captures an audited event such as field changes, ownership transfers, workflow actions, Approval Process progressions, Scoring Rule updates, and signal events from extensions.", "operationId": "getTimelines", "parameters": [ { "$ref": "#/components/parameters/TimelinesModule" }, { "$ref": "#/components/parameters/TimelinesRecordId" }, { "$ref": "#/components/parameters/TimelinesIncludeInnerDetails" }, { "$ref": "#/components/parameters/TimelinesPageToken" }, { "$ref": "#/components/parameters/TimelinesPage" }, { "$ref": "#/components/parameters/TimelinesPerPage" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/TimelinesSortBy" }, { "$ref": "#/components/parameters/TimelinesSortOrder" }, { "$ref": "#/components/parameters/IncludeTimelineType" }, { "$ref": "#/components/parameters/TimelinesInclude" } ], "responses": { "200": { "content": { "application/json": { "examples": { "GetTimelinesResponse": { "description": "Demonstrates a successful response containing paginated timeline entries for a CRM record, including timeline and signal entries with nested automation and field history details.", "summary": "Sample timeline response for a CRM record", "value": { "__timeline": [ { "action": "updated", "audited_time": "2025-11-12T13:13:15+05:30", "automation_details": { "rule": { "id": "1034369000016628528", "name": "PriorityUpdateRule" }, "type": "workflow_rule" }, "done_by": { "id": "104456369000000325980", "name": "NMP" }, "extension": null, "field_history": null, "id": "1034369001121309003", "record": { "id": "1034369000016628523", "module": { "api_name": "Deluge", "id": "null" }, "name": "PriorityUpdateByNava" }, "related_record": { "id": "1034369001121265138", "module": { "api_name": "Bugs", "id": "1034369000000813008" }, "name": "Leads" }, "source": "workflow", "type": "timeline" }, { "action": "updated", "audited_time": "2025-11-12T13:13:15+05:30", "automation_details": { "rule": { "id": "1034369000016628528", "name": "NMP RULE" }, "type": "workflow_rule" }, "done_by": { "id": "104456369000000325980", "name": "NMP" }, "extension": { "id": "1467588000000119001", "namespace": "email", "signal": { "action": "received", "display_label": "zoho.email.incoming", "id": "1467588000000119019", "medium": "Emails" } }, "field_history": null, "id": "1034369001121309003", "record": { "id": "1034369000016628523", "module": { "api_name": "Dhoni", "id": "null" }, "name": "MS Dhoni" }, "related_record": { "id": "1034369001121265138", "module": { "api_name": "NMP_CRICKET", "id": "1034369000000813008" }, "name": "Leads" }, "source": "workflow", "type": "timeline" }, { "action": "added", "audited_time": "2025-11-10T11:22:03+05:30", "automation_details": null, "done_by": null, "extension": { "id": "892620000000119000", "namespace": "emailinsight", "signal": { "action": "bounce", "display_label": "zoho.emailinsight.bounce", "id": "892620000000119000", "medium": "Emails" } }, "field_history": null, "id": "892620000005524002", "record": { "id": null, "module": null, "name": "Blah" }, "related_record": { "id": "892620000005519100", "module": { "api_name": "Leads", "id": "892620000000000125" }, "name": "praveen mail check" }, "source": "crm_api", "type": "signal" } ], "info": { "count": 11, "more_records": false, "next_page_token": null, "page": 1, "per_page": 25, "previous_page_token": null } } } }, "schema": { "additionalProperties": false, "description": "Represents the successful response body for the Get Timelines operation.", "properties": { "__timeline": { "description": "Represents an array of timeline entries for the specified CRM record. Each entry captures an audited event with its timestamp, action type, source, and contextual details.", "items": { "additionalProperties": false, "description": "Represents a single timeline entry recording an audited event on the CRM record.", "properties": { "action": { "description": "Represents the type of action performed on the record. This field is nullable.", "enum": [ "converted", "score_updated", "survey_sent", "email_notification_sent", "consent_mail_sent", "recommendation_feedback", "webhook_invoked", "function_executed", "owner_assigned", "owner_reassigned", "task_assigned", "create_record", "create_connected_record", "transition_executed", "command_center_log", "state_change_on_edit", "process_exit_on_edit", "abrupt_exit", "abrupt_exit_api", "portals_invitation_sent", "portals_invitation_accepted", "portals_invitation_resent", "portals_user_type_activated", "portals_user_type_deactivated", "portal_user_transferred", "portal_user_deleted", "image_removed", "image_uploaded", "find_and_merge_duplicate", "tag_removed", "tag_added", "tags_overwritten", "submitted_for_review", "resubmitted_for_review", "reviewed", "rejected_in_review", "reviewed_during_resubmit", "entered_in_system", "updated", "webinar_invitation_sent", "backstage_invitation_sent", "comment_to_post", "reply_to_message", "reply_to_comment", "like_to_comment", "retweet", "reply_to_tweet", "process_entry", "process_exit", "escalation_mail", "open", "click", "bounce", "received", "missed", "added", "image_approved", "image_approval", "rejection_mail_sent", "final_approval_mail_copy_sent", "automatic_transition", "record_exit_on_edit", "state_executed", "automatic_transition_action", "user_signature", "Message_template_sent", "action_executed", "mass_association", "deleted", "restored", "subform_automation_trigger" ], "type": [ "string", "null" ] }, "audited_time": { "description": "Represents the timestamp at which the action was audited and recorded in the timeline.", "format": "date-time", "type": "string" }, "automation_details": { "additionalProperties": false, "description": "Represents the automation context associated with the timeline entry, including details about triggered workflows, approval processes, scoring rules, ownership changes, and review processes.", "properties": { "approval_process": { "additionalProperties": false, "description": "Represents the Approval Process details associated with the timeline entry.", "properties": { "approver_details": { "additionalProperties": false, "description": "Represents the details of the approver who acted on the Approval Process.", "properties": { "id": { "description": "Represents the unique ID of the approver user.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the approver user.", "maxLength": 255, "type": "string" } }, "type": "object" }, "comments": { "description": "Represents the comments added during the Approval Process action.", "maxLength": 1000, "type": "string" }, "current_stage": { "description": "Represents the current stage number of the Approval Process at the time of the timeline event.", "format": "int32", "type": "integer" }, "delegate_details": { "additionalProperties": false, "description": "Represents the delegation details when the approval task was delegated from one user to another.", "properties": { "from": { "additionalProperties": false, "description": "Represents the user from whom the approval task was delegated.", "properties": { "id": { "description": "Represents the unique ID of the user from whom the approval task was delegated.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user from whom the approval task was delegated.", "maxLength": 255, "type": "string" } }, "type": "object" }, "to": { "additionalProperties": false, "description": "Represents the user to whom the approval task was delegated.", "properties": { "id": { "description": "Represents the unique ID of the user to whom the approval task was delegated.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user to whom the approval task was delegated.", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": "object" }, "next_approver": { "description": "Represents an array of the next approvers in the Approval Process sequence.", "items": { "additionalProperties": false, "description": "Represents a single next approver in the Approval Process.", "properties": { "id": { "description": "Represents the unique ID of the next approver user.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the next approver user.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" }, "rejected_details": { "additionalProperties": false, "description": "Represents the details of the rejection event in the Approval Process.", "properties": { "id": { "description": "Represents the unique ID of the user who rejected the approval request.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who rejected the approval request.", "maxLength": 255, "type": "string" }, "stage": { "additionalProperties": false, "description": "Represents the stage transition details at the time of rejection.", "properties": { "from": { "description": "Represents the approval stage from which the rejection occurred.", "maxLength": 255, "type": "string" }, "to": { "description": "Represents the approval stage to which the process moved after rejection.", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": "object" }, "takeover_reason": { "description": "Represents the reason provided for the approval task takeover.", "maxLength": 255, "type": "string" }, "takeover_stage": { "description": "Represents the approval stage at which the takeover occurred.", "maxLength": 255, "type": "string" } }, "type": "object" }, "assigned_to": { "additionalProperties": false, "description": "Represents the user to whom the record was assigned by an automation action.", "properties": { "id": { "description": "Represents the unique ID of the user assigned to the record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user assigned to the record.", "maxLength": 255, "type": "string" } }, "type": "object" }, "group_id": { "description": "Automation group ID for subform workflow triggers. Only present when action is 'subform_automation_trigger'.", "format": "int64", "maxLength": 255, "type": [ "string", "null" ] }, "module": { "additionalProperties": false, "description": "Module information for subform automation. Only present when action is 'subform_automation_trigger'.", "properties": { "api_name": { "description": "Module API name", "maxLength": 255, "type": "string" }, "id": { "description": "Module ID", "format": "int64", "maxLength": 255, "type": "string" }, "name": { "description": "Module display name", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "owner": { "additionalProperties": false, "description": "Represents the ownership change details recorded in the timeline entry, including previous and new owner information.", "properties": { "id": { "description": "Represents the unique ID of the owner user.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the owner user.", "maxLength": 255, "type": "string" }, "new": { "additionalProperties": false, "description": "Represents the new owner assigned to the record after the ownership change.", "properties": { "id": { "description": "Represents the unique ID of the new owner user.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the new owner user.", "maxLength": 255, "type": "string" } }, "type": "object" }, "old": { "additionalProperties": false, "description": "Represents the previous owner of the record before the ownership change.", "properties": { "id": { "description": "Represents the unique ID of the previous owner user.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the previous owner user.", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": "object" }, "pathfinder": { "additionalProperties": false, "description": "Represents the Blueprint process details associated with the timeline entry, including the triggered state and entry or exit flags.", "properties": { "process_entry": { "description": "Indicates whether the Blueprint process entry action was triggered for this timeline event.", "type": "boolean" }, "process_exit": { "description": "Indicates whether the Blueprint process exit action was triggered for this timeline event.", "type": "boolean" }, "state": { "additionalProperties": false, "description": "Represents the Blueprint state associated with the timeline event.", "properties": { "id": { "description": "Represents the unique ID of the Blueprint state.", "maxLength": 255, "type": "string" }, "is_last_state": { "description": "Indicates whether this Blueprint state is the final state in the process.", "type": "boolean" }, "name": { "description": "Represents the name of the Blueprint state.", "maxLength": 255, "type": "string" }, "trigger_type": { "description": "Represents the trigger type that caused the Blueprint state to activate.", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": "object" }, "review_process": { "additionalProperties": false, "description": "Represents the review process details associated with the timeline entry.", "properties": { "deactivated_process": { "additionalProperties": false, "description": "Represents the process that was deactivated as part of the review process event.", "properties": { "id": { "description": "Represents the unique ID of the deactivated process. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "name": { "description": "Represents the name of the deactivated process.", "maxLength": 255, "type": "string" } }, "type": "object" }, "deluge": { "additionalProperties": false, "description": "Represents the Deluge script associated with the review process event.", "properties": { "id": { "description": "Represents the unique ID of the Deluge script.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the Deluge script.", "maxLength": 255, "type": "string" } }, "type": "object" }, "rejection": { "additionalProperties": false, "description": "Represents the rejection details when the review process was rejected.", "properties": { "comment": { "description": "Represents the comment provided with the rejection.", "maxLength": 255, "type": "string" }, "reason": { "description": "Represents the reason provided for the rejection.", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": "object" }, "rule": { "additionalProperties": false, "description": "Represents the automation rule that triggered the timeline event.", "properties": { "id": { "description": "Represents the unique ID of the automation rule.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the automation rule.", "maxLength": 255, "type": "string" } }, "type": "object" }, "scoring_rule": { "additionalProperties": false, "description": "Represents the Scoring Rule details associated with the timeline entry, including score changes for positive and negative scoring and touchpoint scoring.", "properties": { "negative_score": { "additionalProperties": false, "description": "Represents the negative score change recorded for the record by the Scoring Rule.", "properties": { "new": { "description": "Represents the new negative score value after the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] }, "old": { "description": "Represents the previous negative score value before the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] } }, "type": "object" }, "positive_score": { "additionalProperties": false, "description": "Represents the positive score change recorded for the record by the Scoring Rule.", "properties": { "new": { "description": "Represents the new positive score value after the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] }, "old": { "description": "Represents the previous positive score value before the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] } }, "type": "object" }, "touch_point": { "additionalProperties": false, "description": "Represents the touchpoint score details associated with the Scoring Rule event.", "properties": { "negative_score": { "additionalProperties": false, "description": "Represents the touchpoint negative score change recorded by the Scoring Rule.", "properties": { "new": { "description": "Represents the new touchpoint negative score value after the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] }, "old": { "description": "Represents the previous touchpoint negative score value before the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] } }, "type": "object" }, "positive_score": { "additionalProperties": false, "description": "Represents the touchpoint positive score change recorded by the Scoring Rule.", "properties": { "new": { "description": "Represents the new touchpoint positive score value after the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] }, "old": { "description": "Represents the previous touchpoint positive score value before the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] } }, "type": "object" }, "score": { "additionalProperties": false, "description": "Represents the overall touchpoint score change recorded by the Scoring Rule.", "properties": { "new": { "description": "Represents the new overall touchpoint score value after the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] }, "old": { "description": "Represents the previous overall touchpoint score value before the Scoring Rule was applied. This field is nullable.", "maxLength": 20, "type": [ "string", "null" ] } }, "type": "object" } }, "type": "object" }, "zia_type": { "description": "Indicates whether the Scoring Rule event was triggered by Zia, the AI assistant in Zoho CRM.", "type": "boolean" } }, "type": "object" }, "type": { "description": "Represents the type of automation action that triggered the timeline event, such as a workflow, Approval Process, or Scoring Rule.", "maxLength": 255, "type": "string" }, "workflow": { "additionalProperties": false, "description": "Represents the workflow details associated with the timeline entry.", "properties": { "field_update_action": { "description": "Represents an array of field update actions executed by the workflow.", "items": { "additionalProperties": false, "description": "Represents a single field update action executed by the workflow.", "properties": { "id": { "description": "Represents the unique ID of the workflow field update action.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the workflow field update action.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 50, "type": "array" } }, "type": "object" } }, "type": [ "object", "null" ] }, "converted_record": { "additionalProperties": false, "description": "Represents the details of a converted record associated with the timeline entry.", "properties": { "id": { "description": "Represents the unique ID of the converted record. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "module": { "additionalProperties": false, "description": "Represents the module information for the converted record.", "properties": { "api_name": { "description": "Represents the API name of the module containing the converted record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the module containing the converted record.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "name": { "description": "Represents the name of the converted record. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "done_by": { "additionalProperties": false, "description": "The details of the user who modified the record such as the name, ID, name and ID of that user's profile, and the user type.", "properties": { "id": { "description": "Represents the unique ID of the user who performed the action.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user who performed the action.", "maxLength": 255, "type": "string" }, "profile": { "additionalProperties": false, "description": "Represents the user profile associated with the user who performed the action.", "properties": { "id": { "description": "Represents the unique ID of the user's profile.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the name of the user's profile.", "maxLength": 255, "type": "string" } }, "type": "object" }, "type__s": { "description": "Represents the type of the user who performed the action, such as a standard user, admin, or system user.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "extension": { "additionalProperties": false, "description": "Represents the extension details associated with a signal-type timeline entry, including the extension namespace, ID, and signal information.", "properties": { "id": { "description": "Represents the unique ID of the extension that generated the signal.", "maxLength": 255, "type": "string" }, "namespace": { "description": "Represents the namespace of the extension that generated the signal.", "maxLength": 255, "type": "string" }, "signal": { "additionalProperties": false, "description": "Represents the signal details dispatched by the extension.", "properties": { "action": { "description": "Represents the action performed by the extension signal.", "maxLength": 255, "type": "string" }, "display_label": { "description": "Represents the display label shown for the extension signal in the CRM timeline.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the extension signal.", "maxLength": 255, "type": "string" }, "medium": { "description": "Represents the medium through which the extension signal was generated.", "maxLength": 255, "type": "string" } }, "type": "object" } }, "type": [ "object", "null" ] }, "field_history": { "description": "**Contains the following details:**\n\n* **api_name** - the API name of the field that was modified. This is available by default in the response.\n* **_value** - the old and new values of the field. This is available by default in the response.\n\nThe following values are available when you specify the `include_inner_details` parameter:\n\n* **enable_colour_code** - indicates whether color coding is enabled for the picklist field.\n* **data_type** - the data type of the field that was modified.\n* **pick_list_values** - details of the various values available for the picklist.\n", "items": { "additionalProperties": false, "description": "Represents a single field change recorded in the timeline event.", "properties": { "_value": { "additionalProperties": false, "description": "Represents the old and new values for the changed field.", "properties": { "new": { "description": "Represents the new value of the field after the change. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "old": { "description": "Represents the previous value of the field before the change. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": "object" }, "api_name": { "description": "Represents the API name of the field that changed.", "maxLength": 255, "type": "string" }, "data_type": { "description": "Represents the data type of the field that changed.", "maxLength": 255, "type": "string" }, "enable_colour_code": { "description": "Indicates whether color coding is enabled for the changed field's values.", "type": "boolean" }, "field_label": { "description": "Represents the display label of the field that changed.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the changed field.", "maxLength": 255, "type": "string" }, "pick_list_values": { "description": "Represents an array of picklist options for the changed field, applicable when the field is a picklist type.", "items": { "additionalProperties": false, "description": "Represents a single picklist option for the changed field.", "properties": { "actual_value": { "description": "Represents the actual stored value of the picklist option.", "maxLength": 255, "type": "string" }, "colour_code": { "description": "Represents the color code associated with the picklist option. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "display_value": { "description": "Represents the display text of the picklist option shown in the CRM interface.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the picklist option.", "maxLength": 255, "type": "string" }, "reference_value": { "description": "Represents the reference value of the picklist option, used for lookups and cross-references.", "maxLength": 255, "type": "string" }, "sequence_number": { "description": "Represents the sequence number that determines the display order of the picklist option.", "format": "int32", "type": "integer" }, "type": { "description": "Represents the type of the picklist option.", "maxLength": 255, "type": "string" } }, "type": "object" }, "maxItems": 200, "type": "array" } }, "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "id": { "description": "Represents the unique ID of the timeline entry.", "maxLength": 255, "type": "string" }, "record": { "additionalProperties": false, "description": "Represents the CRM record associated with the timeline entry.", "properties": { "count": { "description": "Represents the count of records associated with this timeline entry. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "id": { "description": "Represents the unique ID of the associated CRM record. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "module": { "additionalProperties": false, "description": "Represents the module information for the associated CRM record.", "properties": { "api_name": { "description": "Represents the API name of the module containing the associated CRM record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the module containing the associated CRM record.", "maxLength": 255, "type": "string" } }, "required": [ "api_name", "id" ], "type": [ "object", "null" ] }, "name": { "description": "Represents the name of the associated CRM record. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "module" ], "type": "object" }, "related_record": { "additionalProperties": false, "description": "The name and ID of the parent record which the task, call, or meeting belongs to.", "properties": { "id": { "description": "Represents the unique ID of the related CRM record. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] }, "module": { "additionalProperties": false, "description": "Represents the module information for the related CRM record.", "properties": { "api_name": { "description": "Represents the API name of the module containing the related CRM record.", "maxLength": 255, "type": "string" }, "id": { "description": "Represents the unique ID of the module containing the related CRM record.", "maxLength": 255, "type": "string" }, "name": { "description": "Represents the display name of the module containing the related CRM record.", "maxLength": 255, "type": "string" } }, "type": [ "object", "null" ] }, "name": { "description": "Represents the name of the related CRM record. This field is nullable.", "maxLength": 255, "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "source": { "description": "Represents the source system or trigger origin of the timeline event.", "enum": [ "unknown", "crm_ui", "crm_api", "webform", "outlook", "crm_mobile", "qb", "social", "workflow", "import", "migration", "convert", "system_generated", "mass_update", "google", "microsoft", "mass_update_via_scheduler", "mass_change_owner_via_scheduler", "mass_delete_via_crm_ui", "mass_delete_via_crm_api", "mass_delete_via_clean_up", "phonebrifge_api", "zoho_docs", "mass_addition_via_ui", "zoho_projects", "sandbox", "approval_manual", "approval_auto", "approval_reject", "approval_reject_action", "mass_update_via_blueprint", "mail_parser", "email_workflow", "bcc_dropbox", "zoho_finance", "zoho_forms", "zoho_desk", "zoho_survey", "google_adwords", "zoho_calendar", "salesiq", "zoho_mail", "custom_function", "zoho_campaign", "zoho_creator", "salesinbox", "mass_email", "zoho_recruit", "sheet_view", "sample_data", "calendar_booking", "zia_voice", "blueprint", "approval_process", "case_escalation", "assignment_rules", "macro", "mass_transfer", "deduplication", "findandmerge", "zohowebinar", "portals", "zohobackstage", "bulkapi", "prediction", "facebook", "twitter", "review_process", "rfm_segmentation", "orchestration", "gmail", "wizard", "scoringrule", "scoringrule_config", "scoringrule_config_downgrade", "bulk_action", "bulk_action_revert", "mass_delete_user_thread", "unsubscribe", "subform", "bigin", "zoho_crm", "automatic_deal_creation", "mailchimp", "business_messages", "pathfinder", "notification", "assignment_restriction", "massconvert", "sandbox_conflict_resolve", "threshold_reallocation", "rollup_summary", "constant_contact", "manual_and_cpq", "cadences", "series_config", "series_config_downgrade", "abm", "prediction_config", "prediction_result", "zia_config", "zia_result", "email-in", "recommendation_feedback", "autolog_mobile", "record_locking_configuration", "canvas_view", "portalform", "record_locking_configuration_bulk", "field_of_lookup", "cscript_sdk", "kiosk", "pf_instant_parent_to_child_sync", "pf_bulk_parent_to_child_sync", "pf_instant_child_to_parent_sync", "pf_bulk_child_to_parent_sync", "zia_did_config_added", "zia_did_config_delete", "zia_did_config_enabled", "zia_did_config_disabled", "zohoone", "change_owner", "data_enrichment", "awaiting_approval", "commandcenter_service", "connected_workflow", "zia_agent" ], "type": "string" }, "type": { "description": "Represents the type of the timeline entry. Possible values: **timeline** (standard CRM activity), **signal** (event from a Zoho extension).", "enum": [ "timeline", "signal" ], "type": "string" } }, "required": [ "audited_time" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents the pagination metadata for the timeline response.", "properties": { "count": { "description": "Represents the number of timeline entries returned in the current page.", "format": "int32", "type": "integer" }, "more_records": { "description": "Indicates whether additional timeline entries are available beyond the current page.", "type": "boolean" }, "next_page_token": { "description": "Represents the token to retrieve the next page of timeline entries. The value is null when no more pages are available.", "maxLength": 255, "type": [ "string", "null" ] }, "page": { "description": "Represents the current page number in the paginated results.", "format": "int32", "type": "integer" }, "per_page": { "description": "The number of records you want to fetch per page. You can use this parameter for the first page only. For the subsequent pages, you must use the \"page_token\" parameter.", "format": "int32", "type": "integer" }, "previous_page_token": { "description": "Represents the token to retrieve the previous page of timeline entries. The value is null on the first page.", "maxLength": 255, "type": [ "string", "null" ] } }, "required": [ "count", "more_records", "page", "per_page", "next_page_token", "previous_page_token" ], "type": "object" } }, "type": "object", "x-zs-$id": "TimelineResponse" } } }, "description": "Returns a paginated list of timeline entries for the specified CRM record." }, "204": { "description": "Returns no content when no timeline entries exist for the specified record." }, "400": { "content": { "application/json": { "examples": { "GetTimelinesBadRequestResponse": { "description": "Demonstrates an error response when the request contains invalid parameters.\n**Resolution:** Correct the parameter values and retry the request.", "summary": "Error response for invalid request parameters", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 1 }, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response returned when the specified module name is invalid.", "properties": { "code": { "description": "Represents the error code **INVALID_MODULE**.", "enum": [ "INVALID_MODULE" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid module error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element that caused the invalid module error.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the invalid module.", "enum": [ "the module name given seems to be invalid" ], "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidModuleErrorResponse" }, { "additionalProperties": false, "description": "Represents an error response returned when the request contains invalid data at a specified resource path.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the invalid data error, including the resource path index.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path element that contains the invalid data.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object" }, "message": { "description": "Represents the error message describing the invalid data in the request.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidDataErrorResponse" }, { "additionalProperties": false, "description": "Represents an error response returned when a query parameter value does not match the expected format or is not supported.", "properties": { "code": { "description": "Represents the error code. Possible values: **NOT_SUPPORTED**, **INVALID_DATA**, **PATTERN_NOT_MATCHED**.", "enum": [ "NOT_SUPPORTED", "INVALID_DATA", "PATTERN_NOT_MATCHED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the parameter validation error, including the parameter name.", "properties": { "param_name": { "description": "Represents the name of the parameter that caused the error.", "maxLength": 255, "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message describing the parameter validation failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "UnsupportedOrPatternMismatchErrorResponse" }, { "additionalProperties": false, "description": "Represents an error response returned when a required query parameter contains invalid data.", "properties": { "code": { "description": "Represents the error code **INVALID_DATA**.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the error details for the required parameter validation error.", "properties": { "param_name": { "description": "Represents the name of the required parameter that is missing or invalid.", "maxLength": 255, "type": "string" } }, "required": [ "param_name" ], "type": "object" }, "message": { "description": "Represents the error message describing the required parameter validation failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. The value is always **error**.", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "InvalidParameterErrorResponse" } ], "description": "Represents an error response returned when the request fails validation.", "x-zs-$id": "TimelineErrorResponse" } } }, "description": "Returns an error response when the request contains invalid parameters or an unrecognized module name.\n**Resolution:** Verify the module API name, record ID, and query parameter values before retrying the request. Specify a valid record ID. Refer to [Get Records API](https://www.zoho.com/crm/developer/docs/api/v8/get-records.html) to get the record ID." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ" ] } ], "summary": "Get Timelines", "tags": [ "timelines" ], "x-zoho-document": "timelines", "x-zs-llm-description": "Retrieves the activity timeline (audit trail) for a specific record in a given module. Returns chronological entries showing actions performed on the record - such as field updates, owner changes, workflow executions, email events, portal activity, blueprint transitions, and more. Requires the module-specific READ scope (e.g., ZohoCRM.modules.Leads.READ). Returns 204 No Content when no timeline entries exist for the record. Supports pagination via page_token or page/per_page (fixed at 3 per page), sorting by audited_time (asc/desc), and filtering by timeline type. The include_inner_details parameter expands nested field-change details within each timeline entry. Only works for standard and custom modules that support timeline tracking." } }, "/crm/v8/{module}/{recordId}/actions/associate_email": { "post": { "description": "Associates an email with a specific record in a module, creating a link between the email and the CRM record.", "operationId": "associateEmail", "parameters": [ { "description": "The API name of the module containing the record. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API names.\n", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, { "description": "The unique ID of the record to associate the email with. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve record IDs.\n", "in": "path", "name": "recordId", "required": true, "schema": { "maxLength": 100, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "Standard": { "value": { "data": [ { "content": "Update content", "date_time": "2025-10-10T14:00:00Z", "from": { "email": "john.doe@example.com", "user_name": "John Doe" }, "original_message_id": "msg_123", "sent": true, "subject": "Project Update", "to": [ { "email": "client@business.com", "user_name": "Client" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/AssociateEmailRequest" } } }, "description": "Payload containing the email details to be associated with the record.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Success": { "value": { "Emails": [ { "code": "SUCCESS", "details": { "message_id": "msg_123" }, "message": "Email associated successfully.", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/ActionResponse", "x-zs-$id": "ActionResponse" } } }, "description": "Email associated successfully with the record." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "value": { "code": "INVALID_DATA", "details": {}, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidValue": { "value": { "code": "INVALID_DATA", "details": { "api_name": "from", "json_path": "$.Emails[0].from" }, "message": "invalid data", "status": "error" } }, "MandatoryNotFound": { "value": { "Emails": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "from", "json_path": "$.Emails[0].from" }, "message": "required field not found", "status": "error" } ] } }, "MaximumLength": { "value": { "code": "INVALID_DATA", "details": { "api_name": "Emails", "json_path": "$.Emails", "maximum_length": 1 }, "message": "invalid data", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/AssociateEmailInvalidModuleError" }, { "$ref": "#/components/schemas/MaximumLengthError" }, { "$ref": "#/components/schemas/AssociateEmailMandatoryNotFoundError" }, { "$ref": "#/components/schemas/AssociateEmailInvalidDataError" }, { "$ref": "#/components/schemas/InvalidValueErrorDetails" } ], "x-zs-$id": "InvalidRequestError" } } }, "description": "Bad Request - The request could not be processed due to invalid input. Review the error details and correct the issues before retrying." }, "404": { "content": { "application/json": { "examples": { "InvalidModule": { "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/AssociateEmailInvalidModuleError", "x-zs-$id": "InvalidModuleError" } } }, "description": "Not Found - The specified module does not exist or is not accessible. Verify the module name and retry." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.emails.CREATE" ] } ], "summary": "Associate Email", "tags": [ "associate_email" ], "x-zoho-document": "associate_email" } }, "/crm/v8/{module}/{recordId}/actions/clone": { "post": { "description": "Clones a record in the specified module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and API names.\nBy default, the field values of the parent record are copied to the cloned record. To modify or add field values, specify the field API names and their corresponding values in the input body. If no field values need to be modified, the input body can be omitted.\nMandatory fields specified in the input must not be null. The Sample Inputs, Sample Responses, and Possible Errors documented for the [Insert Records API](record.yaml#$.paths./module.post) also apply to the [Record Clone API](record.yaml#$.paths./{module}/{recordId}/actions/clone.post).", "operationId": "cloneRecord", "parameters": [ { "$ref": "#/components/parameters/RecordModule" }, { "$ref": "#/components/parameters/RecordRecord" } ], "requestBody": { "content": { "application/json": { "examples": { "Leads": { "description": "Use the \"skip_feature_execution\" array to skip Cadences execution when creating a record through the API. Specify \"cadences\" as the value of the \"name\" key and include this key alongside \"data\" in the request.", "summary": "Records retrieved from the Leads module", "value": { "apply_feature_execution": [ { "name": "layout_rules" } ], "data": [ { "Company": "ABC", "Email": "p.daly@zylker.com", "First_Name": "Paul", "Last_Name": "Daly", "Lead_Source": "Employee Referral", "State": "Texas", "id": "111112000000142001" } ], "skip_feature_execution": [ { "name": "cadences" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordsInputSchema", "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." } } }, "description": "The request body must contain a **data** array with one object containing the field values to override in the cloned record.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Success": { "description": "Shows the successful response for the cloneRecord operation, including the record ID and audit metadata.", "summary": "Successfully completed operation", "value": { "data": [ { "code": "SUCCESS", "details": { "$approval_state": "approved", "Created_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Created_Time": "2023-05-10T01:10:47-07:00", "Modified_By": { "id": "5725767000000411001", "name": "Patricia Boyle" }, "Modified_Time": "2023-05-10T01:10:47-07:00", "id": "5725767000000524157" }, "message": "record added", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/RecordSuccessResponse" } } }, "description": "Returns the details of each successfully cloned record, including the record ID and audit metadata." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows the error response when the user does not have sufficient privileges for this operation.", "summary": "Insufficient privileges for the operation", "value": { "data": [ { "code": "AUTHORIZATION_FAILED", "details": { "resource_path_index": 0 }, "message": "User does not have sufficient privilege to perform this action", "status": "error" } ] } }, "DependentServiceError": { "description": "Shows the error response when a dependent external service fails during the operation.", "summary": "Dependent external service error during processing", "value": { "data": [ { "code": "DEPENDENT_SERVICE_ERROR", "details": { "dependency_error": "NO_PERMISSION" }, "message": "The dependent service does not have permission to complete the operation", "status": "error" } ] } }, "DuplicateDataError": { "description": "Shows the error response when a unique field value already exists in the module.", "summary": "Duplicate unique field value matches an existing record", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Unique_1", "duplicate_record": { "Owner": { "id": "2008662000000454001", "name": "Pranav", "zuid": "75092197" }, "id": "2008662000006256222" }, "id": "2008662000006256222", "json_path": "$.data[0].Unique_1", "more_records": false }, "message": "duplicate data", "status": "error" } ] } }, "InvalidData": { "description": "Shows the error response when invalid data is provided in the request.", "summary": "Invalid field value in the request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Company", "json_path": "$.data[0].Company" }, "message": "The field value given for Company is invalid", "status": "error" } ] } }, "InvalidDataLength": { "description": "Shows the error response when a field value exceeds the maximum allowed length.", "summary": "Field value exceeds the maximum allowed length", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "json_path": "$.data[0].Number_1", "maximum_length": 2 }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataType": { "description": "Shows the error response when a field value does not match the expected data type.", "summary": "Field value with an incorrect data type", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "Number_1", "expected_data_type": "integer", "json_path": "$.data[0].Number_1" }, "message": "invalid data", "status": "error" } ] } }, "InvalidModule": { "description": "Shows the error response when an invalid module name is provided in the request URL.", "summary": "Invalid module API name in the request", "value": { "data": [ { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } ] } }, "InvalidRequestMethod": { "description": "Shows the error response when an unsupported HTTP method is used for this endpoint.", "summary": "Unsupported HTTP method for this endpoint", "value": { "data": [ { "code": "INVALID_REQUEST_METHOD", "details": { "resource_path_index": 0 }, "message": "The HTTP request method type is not a valid one.", "status": "error" } ] } }, "InvalidSupportedValue": { "description": "Shows the error response when an unsupported value is provided for a fixed-value field.", "summary": "Unsupported value for a fixed-value field", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "name", "json_path": "$.apply_feature_execution[0].name", "supported_values": [ "layout_rules", "range_validation", "assignment_rules", "function_validation_rule", "criteria_validation_rule", "global_map_dependency", "territory_subordinates" ] }, "message": "invalid data", "status": "error" } ] } }, "MandatoryNotFound": { "description": "Shows the error response when a required field is missing from the request.", "summary": "Required field missing from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.data.service.id" }, "message": "Service Id Not Found", "status": "error" } ] } }, "MandatoryNotFoundLayoutRule": { "description": "Shows the error response when a field made mandatory by a Layout Rule is absent from the clone request. Use the [Get Layouts Metadata API](layouts.yaml#$.paths./settings/layouts.get) to retrieve Layout IDs.", "summary": "Layout rule mandatory field absent from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "Phone", "json_path": "$.data[0].Phone", "layout_rule": { "id": "5410702000000761547", "name": "Layout Rule" } }, "message": "required field not found", "status": "error" } ] } }, "MultipleErrors": { "description": "Shows the error response when a single record has multiple validation failures.", "summary": "Multiple validation errors in a single record", "value": { "data": [ { "code": "MULTIPLE_OR_MULTI_ERRORS", "details": { "errors": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "Email", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000000428295", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Email", "more_records": true }, "message": "duplicate data", "status": "error" }, { "code": "DUPLICATE_DATA", "details": { "api_name": "Mobile", "duplicate_record": { "Owner": { "id": "4881139000000307001", "name": "Prajesh Kumar S", "zuid": "736078909" }, "id": "4881139000002432007", "module": { "api_name": "Leads", "id": "4881139000000002175" } }, "json_path": "$.data[0].Mobile", "more_records": true }, "message": "duplicate data", "status": "error" } ] }, "message": "Multiple errors in the request", "status": "error" } ] } }, "ResourcePathIndexError": { "description": "Shows the error response when the resource path index indicates an invalid data reference.", "summary": "Invalid resource path index reference", "value": { "data": [ { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "record not deleted", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordDependentFieldMissingError" }, { "$ref": "#/components/schemas/RecordDeleteByIdInvalidDataError" }, { "$ref": "#/components/schemas/RecordsIdPostErrorResponse" }, { "$ref": "#/components/schemas/InvalidModuleGETError" } ], "x-zs-$id": "RecordCloneErrorResponse" } } }, "description": "The request could not be processed because one or more records contain invalid data or missing required fields.\n**Resolution:** Each error in the data array identifies the specific record and field that caused the failure. The request must be corrected and resubmitted." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "description": "Shows the 401 error response when the authentication token is missing or invalid.", "summary": "Authentication token missing or invalid", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "OauthScopeMismatch": { "description": "Shows the 401 error response when the OAuth access token does not include the required scope for this operation.", "summary": "OAuth access token missing the required scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "Unauthorized", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordUnauthorizedResponse" }, { "$ref": "#/components/schemas/RecordAuthenticationFailureResponse" } ], "description": "Represents the response schema for the cloneRecord operation.", "x-zs-$id": "RecordUnauthorizedOrAuthenticationFailureResponse" } } }, "description": "Authentication failed because the OAuth token is missing, expired, or does not include the required scope.\n**Resolution:** A new access token must be generated with the required scope for this operation." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows the 403 error response when the user profile lacks the required module permission.", "summary": "User profile lacks the required module permission", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordPermissionResponse" } } }, "description": "Permission denied to clone record in the specified module.\n**Resolution:** The CRM administrator must grant the required clone permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows the 404 error response when the API endpoint URL does not match any recognized pattern.", "summary": "Invalid or unrecognized API endpoint URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInvalidURLResponse" } } }, "description": "The request URL does not match any valid API endpoint pattern.\n**Resolution:** The API endpoint URL must be verified for correct format and path parameters." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows the 500 error response when an unexpected server error occurs.", "summary": "Unexpected internal server error during processing", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Internal Server Error", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RecordInternalErrorResponse" } } }, "description": "An unexpected server error occurred while processing the request.\n**Resolution:** The request can be retried after some time. If the error persists, Zoho CRM support must be contacted." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CREATE" ] } ], "summary": "Record Clone", "tags": [ "record" ], "x-zoho-document": "record" } }, "/crm/v8/{module}/{recordId}/actions/portal_invite": { "post": { "description": "To send a portal invitation to a single CRM record in your Zoho CRM organization, inviting or re-inviting the record as a portal user for the specified user type.", "operationId": "singleInviteUser", "parameters": [ { "$ref": "#/components/parameters/PortalUsersModule" }, { "$ref": "#/components/parameters/PortalUsersRecordId" }, { "description": "Preferred language for the invitation", "in": "query", "name": "language", "required": false, "schema": { "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" ], "type": "string" } }, { "description": "The ID of the user type you want to assign this user with. Use the [Get User Types API](https://www.zoho.com/crm/developer/docs/api/v8/get-user-types.html) for this ID.", "in": "query", "name": "user_type_id", "required": true, "schema": { "maxLength": 255, "type": "string" } }, { "description": "Represents whether the user is invited the first time or is re-invited. The possible values are invite and reinvite.", "in": "query", "name": "type", "required": true, "schema": { "enum": [ "reinvite", "invite" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "description": "Shows a successful response when a single CRM record is invited to the portal, including the record ID in the details.", "summary": "Successful single portal user invitation", "value": { "portal_invite": [ { "code": "SUCCESS", "details": { "record_id": "5020928000002338037" }, "message": "An Invite has been sent to the personality.", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response for portal user invitation requests", "properties": { "portal_invite": { "description": "Represents the list of portal invitation response objects. Contains one object per invitation batch.", "items": { "additionalProperties": false, "description": "Represents the invitation result for a single portal invitation batch.", "properties": { "code": { "description": "Represents the error code. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the operation result.", "properties": { "record_id": { "description": "Represents the unique identifier of the CRM record associated with this invitation.", "maxLength": 255, "type": "string" } }, "required": [ "record_id" ], "type": "object" }, "message": { "description": "Represents the success or informational message for this operation result.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success**.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "SingleInviteUserResponse" } } }, "description": "Returns the result of the single portal user invitation." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupported": { "description": "Shows the API_NOT_SUPPORTED error returned when the single invite operation is attempted in a sandbox environment.", "summary": "Error when the API runs in a sandbox environment", "value": { "code": "API_NOT_SUPPORTED", "details": { "unsupported_environment": "sandbox" }, "message": "api not supported in sandbox", "status": "error" } }, "CannotProcess": { "description": "Shows the CANNOT_PROCESS error returned when the invitation type provided is not valid for the specified record.", "summary": "Error when the invitation type is invalid", "value": { "code": "CANNOT_PROCESS", "details": {}, "message": "Invalid type for the portal invite", "status": "error" } }, "DuplicateData": { "description": "Shows the DUPLICATE_DATA error returned when a portal user with the same email address already exists in the portal.", "summary": "Error when a portal user with the same email already exists", "value": { "code": "DUPLICATE_DATA", "details": { "record_id": "67890" }, "message": "Invitation sent has failed as a portal user exists with same email id", "status": "error" } }, "InvalidData": { "description": "Shows the INVALID_DATA error returned when the CRM record does not have an email address required for portal invitation.", "summary": "Error when the record does not have an email address", "value": { "code": "INVALID_DATA", "details": {}, "message": "Invitation sent has failed as provided personality record does not have email id.", "status": "error" } }, "NotApproved": { "description": "Shows the NOT_APPROVED error returned when the record has not yet been approved for portal invitation.", "summary": "Error when the record has not been approved", "value": { "code": "NOT_APPROVED", "details": { "record_id": "67890" }, "message": "Entity has not approved to invite yet.", "status": "error" } }, "NotReviewed": { "description": "Shows the NOT_REVIEWED error returned when the record cannot be invited because it is awaiting approval in a review process.", "summary": "Error when the record is pending review approval", "value": { "code": "NOT_REVIEWED", "details": { "record_id": "67890" }, "message": "You cannot sent portal invitation since the record is waiting for approval under review process.", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response containing a list of portal invitation errors, one per failed invitation.", "properties": { "code": { "description": "Represents the error code. Possible values: **CANNOT_PROCESS**, **INVALID_DATA**, **REQUIRED_PARAM_MISSING**, **LICENSE_LIMIT_EXCEEDED**, **NOT_REVIEWED**, **NOT_APPROVED**, **DUPLICATE_DATA**. ", "enum": [ "CANNOT_PROCESS", "INVALID_DATA", "REQUIRED_PARAM_MISSING", "LICENSE_LIMIT_EXCEEDED", "NOT_REVIEWED", "NOT_APPROVED", "DUPLICATE_DATA" ], "maxLength": 255, "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response.", "maxLength": 255, "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "SingleInviteUserErrorResponse" }, { "additionalProperties": false, "description": "Error response returned when the API is invoked in an unsupported environment, such as a sandbox.", "properties": { "code": { "description": "Represents the error code. Possible values: **API_NOT_SUPPORTED**. ", "enum": [ "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the error.", "properties": { "unsupported_environment": { "description": "Represents the name of the environment where this API is not supported.", "maxLength": 255, "type": "string" } }, "required": [ "unsupported_environment" ], "type": "object" }, "message": { "description": "Represents the error message. Possible values: **api not supported in sandbox**. ", "enum": [ "api not supported in sandbox" ], "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "SingleInviteUserApiNotSupportedResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "SingleInviteUserBadRequestResponse" } } }, "description": "Invalid request - the portal invitation failed due to a validation error. Resolution: Check the error code for the specific failure reason and correct the request." }, "403": { "content": { "application/json": { "examples": { "NoPermissions": { "description": "Shows the NO_PERMISSION error returned when the authenticated user does not have the required permission to invite portal users.", "summary": "Error when the user lacks required permissions", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Manage_ClientPortal_Users" ] }, "message": "NO_PERMISSION", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Error response returned when the module specified in the request path is invalid or not accessible.", "properties": { "code": { "description": "Represents the error code. Possible values: **NO_PERMISSION**. ", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional details about the error.", "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "details", "status" ], "type": "object", "x-zs-$id": "SingleInviteNoPermissionErrorResponse" }, { "additionalProperties": false, "description": "Error response containing a list of portal invitation errors, one per failed invitation.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": false, "description": "Represents the permission error for a single portal invitation.", "properties": { "code": { "description": "Represents the status code of the operation.", "maxLength": 255, "type": "string" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 1000, "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "SingleInvitePortalInviteErrorResponse" }, { "additionalProperties": false, "description": "Alternative error response format for portal invitation failures.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": true, "description": "Represents the permission error for a single portal invitation.", "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "portal_invite" ], "type": "object", "x-zs-$id": "SingleInviteAlternativePortalInviteErrorResponse" }, { "additionalProperties": false, "description": "Error response containing an array of portal invitation error objects.", "properties": { "portal_invite": { "description": "Represents the list of portal invitation permission error objects.", "items": { "additionalProperties": true, "description": "Represents the permission error for a single portal invitation.", "type": "object" }, "maxItems": 100, "type": "array" } }, "type": "object", "x-zs-$id": "SingleInviteAdditionalPortalInviteErrorResponse" } ], "description": "Response schema for this operation.", "x-zs-$id": "SingleInviteUserForbiddenResponse" } } }, "description": "Permission denied. Resolution: The CRM administrator must grant the **ZohoCRM.settings.clientportal** scope permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.settings.clientportal.CREATE" ] } ], "summary": "Invite portal users", "tags": [ "portal_users" ], "x-zoho-document": "portal_users", "x-zs-llm-description": "Invitation will be sent to the record which is specified in url path." } }, "/crm/v8/{module}/{record}/__email_drafts": { "get": { "description": "Retrieves the list of email drafts associated with the specified record in the given module.", "operationId": "getEmailDrafts", "parameters": [ { "description": "Specifies the module of the record. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the API names of modules.\n", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, { "$ref": "#/components/parameters/EmailDraftsRecord" }, { "$ref": "#/components/parameters/EmailDraftsPage" }, { "$ref": "#/components/parameters/EmailDraftsPerPage" }, { "description": "Field to sort the email drafts by. Default:created_time.", "in": "query", "name": "sort_by", "required": false, "schema": { "default": "created_time", "enum": [ "created_time", "modified_time" ], "type": "string" } }, { "description": "Sort direction. Default:asc.", "in": "query", "name": "sort_order", "required": false, "schema": { "default": "asc", "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "summary": "Example response with one draft", "value": { "__email_drafts": [ { "$sharing_permission": "full_access", "attachments": [ { "file_name": "attachment.txt", "file_size": "8990", "id": "0b9e5596cdd8cafe6a5c09f78f095bd6434c863110a6d1e094285c6ebf9dd0d5", "service_name": "ZFSAttached" } ], "bcc": [ { "email": "user3@zylker.com", "user_name": "user3" } ], "cc": [ { "email": "user2@zylker.com", "user_name": "user2" } ], "content": "This is the email content.", "created_time": "2023-11-09T12:30:00+05:30", "from": "patricia.boyle@zylker.com", "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330", "inventory_details": null, "linked_record": null, "modified_time": "2023-11-09T14:45:25+05:30", "owner": { "id": "2309216000000012345", "name": "Patricia Boyle" }, "reply_to": "pat.boyle@zylker.com", "rich_text": true, "schedule_details": { "source": "upTime", "time": "2023-11-30T18:40:00+05:30", "timezone": "Asia/Calcutta" }, "source": "", "subject": "Test Draft Subject", "summary": "This is the email content.", "to": [ { "email": "user1@zylker.com", "user_name": "user1" } ] } ], "info": { "count": 1, "more_records": false, "page": 1, "per_page": 10 } } } }, "schema": { "additionalProperties": false, "description": "Response containing the list of email drafts and pagination info.", "properties": { "__email_drafts": { "description": "List of email draft objects.", "items": { "additionalProperties": false, "description": "Email draft object with metadata, recipients, and attachments.", "properties": { "$sharing_permission": { "description": "Sharing permission level for the requesting user.", "maxLength": 64, "type": "string" }, "attachments": { "description": "Attachments included with the draft; null if none.", "items": { "additionalProperties": false, "description": "Attachment metadata.", "properties": { "file_name": { "description": "Original file name.", "maxLength": 512, "type": "string" }, "file_size": { "description": "File size in bytes as a numeric string.", "maxLength": 20, "type": "string" }, "id": { "description": "Encrypted attachment/file identifier.", "maxLength": 256, "type": "string" }, "service_name": { "description": "Storage service name.", "maxLength": 100, "type": "string" } }, "required": [ "id", "file_name", "file_size", "service_name" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "bcc": { "description": "BCC recipients for the draft; null if none.", "items": { "additionalProperties": false, "description": "BCC recipient object.", "properties": { "email": { "description": "BCC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "BCC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "user_name", "email" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "cc": { "description": "CC recipients for the draft; null if none.", "items": { "additionalProperties": false, "description": "CC recipient object.", "properties": { "email": { "description": "CC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "CC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "user_name", "email" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "content": { "description": "Email HTML body content; null if not set.", "maxLength": 200000, "type": [ "string", "null" ] }, "created_time": { "description": "Timestamp when the draft was created (ISO 8601 format).", "format": "date-time", "type": "string" }, "from": { "description": "Sender email address.", "maxLength": 256, "type": "string" }, "id": { "description": "Represents the unique encrypted draft identifier. Use this ID to update or delete the draft.\n", "maxLength": 256, "type": "string", "x-zs-$id": "EmailDraftId" }, "inventory_details": { "additionalProperties": false, "description": "Inventory email details; null if not an inventory draft.", "properties": { "inventory_template": { "additionalProperties": false, "description": "Inventory template details.", "properties": { "id": { "description": "Inventory template identifier.", "maxLength": 64, "type": "string" }, "name": { "description": "Inventory template name.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "paper_type": { "description": "Paper type for rendered inventory.", "enum": [ "A4", "USLetter" ], "type": "string" }, "record": { "additionalProperties": false, "description": "CRM record associated with this inventory draft.", "properties": { "id": { "description": "CRM record identifier.", "maxLength": 64, "type": "string" }, "name": { "description": "CRM record display name.", "maxLength": 256, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "view_type": { "description": "Layout/view type for the inventory.", "enum": [ "portrait", "landscape" ], "type": "string" } }, "required": [ "inventory_template", "paper_type", "view_type" ], "type": [ "object", "null" ] }, "linked_record": { "additionalProperties": false, "description": "CRM record linked to this draft; null if not linked.", "properties": { "id": { "description": "Linked CRM record identifier.", "maxLength": 64, "type": "string" }, "module": { "additionalProperties": false, "description": "Module of the linked record.", "properties": { "api_name": { "description": "Module API name.", "maxLength": 100, "type": "string" }, "id": { "description": "Module tab identifier.", "maxLength": 64, "type": "string" } }, "required": [ "api_name" ], "type": "object" } }, "required": [ "id", "module" ], "type": [ "object", "null" ] }, "modified_time": { "description": "Timestamp when the draft was last modified (ISO 8601 format).", "format": "date-time", "type": "string" }, "owner": { "additionalProperties": false, "description": "Owner who created the draft.", "properties": { "id": { "description": "Owner user identifier. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs.\n", "maxLength": 64, "type": "string" }, "name": { "description": "Owner display name.", "maxLength": 256, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "reply_to": { "description": "Reply-to email address; null if not set.", "maxLength": 256, "type": [ "string", "null" ] }, "rich_text": { "description": "true when HTML editor was used; false for plain text.", "type": "boolean" }, "schedule_details": { "additionalProperties": false, "description": "Scheduling information; null if not scheduled.", "properties": { "source": { "description": "Source of the schedule decision.", "enum": [ "ecOneHourAhead", "upTime", "ecSchduleBestTime", "ecUpComing", "ecSchduleTime" ], "type": "string" }, "time": { "description": "Scheduled send time in the requesting user's timezone (ISO 8601 format).", "format": "date-time", "type": "string" }, "timezone": { "description": "Timezone identifier (Java TimeZone ID) or null.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "time" ], "type": [ "object", "null" ] }, "source": { "description": "Source identifier string stored at draft creation time.", "maxLength": 256, "type": "string" }, "subject": { "description": "Email subject; null if not set.", "maxLength": 512, "type": [ "string", "null" ] }, "summary": { "description": "Plain text preview of the draft body (up to 250 characters); null if empty.", "maxLength": 500, "type": [ "string", "null" ] }, "to": { "description": "Primary recipients for the draft; null if none.", "items": { "additionalProperties": false, "description": "Recipient object.", "properties": { "email": { "description": "Recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "Recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "user_name", "email" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] } }, "required": [ "id", "modified_time", "created_time", "from", "to", "reply_to", "cc", "bcc", "subject", "summary", "owner" ], "type": "object" }, "maxItems": 100, "type": "array" }, "info": { "additionalProperties": false, "description": "Pagination info for the list response.", "properties": { "count": { "description": "Number of records returned in this page.", "format": "int32", "type": "integer" }, "more_records": { "description": "true if additional pages exist.", "type": "boolean" }, "page": { "description": "Current page number.", "format": "int32", "type": "integer" }, "per_page": { "description": "Number of records per page.", "format": "int32", "type": "integer" } }, "required": [ "page", "per_page", "count", "more_records" ], "type": "object" } }, "required": [ "__email_drafts", "info" ], "type": "object", "x-zs-$id": "EmailDraftsResponse" } } }, "description": "Returns the list of email drafts associated with the specified record." }, "204": { "description": "Indicates that no email drafts exist for the specified record." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "summary": "Invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecord": { "summary": "Invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidSortBy": { "summary": "sort_by value does not match the allowed pattern", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "sort_by" }, "message": "Please check whether the input values are correct", "status": "error" } }, "InvalidSortOrder": { "summary": "sort_order value does not match the allowed pattern", "value": { "code": "PATTERN_NOT_MATCHED", "details": { "param_name": "sort_order" }, "message": "Please check whether the input values are correct", "status": "error" } } }, "schema": { "additionalProperties": true, "description": "Error response for invalid module or record path parameters.", "properties": { "code": { "description": "Machine-readable error code.\n\n**Possible values:**\n- **INVALID_MODULE** - The specified module is invalid.\n- **INVALID_DATA** - The specified record ID is invalid.\n- **PATTERN_NOT_MATCHED** - A query parameter's value does not match its required pattern (e.g. `sort_by`, `sort_order`).\n", "enum": [ "INVALID_MODULE", "INVALID_DATA", "PATTERN_NOT_MATCHED" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context about the error.", "properties": { "param_name": { "description": "Name of the query parameter whose value failed pattern validation.", "maxLength": 255, "type": "string" }, "resource_path_index": { "description": "Index of the invalid path parameter.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "GetEmailDraftsErrorResponses" } } }, "description": "Bad Request - The request could not be processed due to invalid input.\n\n**Resolution:** Verify that the module name is valid and the record ID exists in the CRM organization.\n" }, "403": { "$ref": "#/components/responses/NoPermissionForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.invoices.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.READ" ] } ], "summary": "List Email Drafts for a Record", "tags": [ "email_drafts" ], "x-zoho-document": "email_drafts", "x-zs-llm-description": "Use this API to list all saved email drafts for a specific CRM record (e.g., a Lead or Contact). The draft `id` values returned in the response can be used as input to the update or delete draft APIs. Supports pagination via `page` and `per_page` query parameters." }, "post": { "description": "Creates one or more email drafts associated with the specified record in the given module.", "operationId": "createEmailDrafts", "parameters": [ { "description": "Specifies the module of the record. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the API names of modules.\n", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, { "$ref": "#/components/parameters/EmailDraftsRecord" } ], "requestBody": { "content": { "application/json": { "examples": { "CreateDraft": { "summary": "Example request to create email drafts", "value": { "__email_drafts": [ { "bcc": [], "cc": [], "content": "

Hello!

", "from": "john@example.com", "inventory_details": null, "reply_to": null, "rich_text": true, "schedule_details": null, "subject": "Test Subject", "to": [ { "email": "john.doe@example.com", "user_name": "John Doe" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for creating email drafts.", "properties": { "__email_drafts": { "description": "List of email drafts to create.", "items": { "additionalProperties": false, "description": "Email draft object.", "properties": { "attachments": { "description": "Attachments to add to the draft.", "items": { "additionalProperties": false, "description": "Attachment reference.", "properties": { "file_name": { "description": "File name.", "maxLength": 512, "type": "string" }, "file_size": { "description": "File size in bytes as a numeric string.", "maxLength": 20, "type": "string" }, "id": { "description": "Attachment/file identifier. Use the [Files API](files.yaml#$.paths./files.get) to retrieve file IDs.\n", "maxLength": 256, "type": "string" }, "service_name": { "description": "Storage service name (e.g., Desktop, ZFSAttached).", "maxLength": 100, "type": "string" } }, "required": [ "id", "service_name" ], "type": "object" }, "maxItems": 50, "type": "array" }, "bcc": { "description": "List of BCC recipients.", "items": { "additionalProperties": false, "description": "BCC recipient object.", "properties": { "email": { "description": "BCC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "BCC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" }, "cc": { "description": "List of CC recipients.", "items": { "additionalProperties": false, "description": "CC recipient object.", "properties": { "email": { "description": "CC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "CC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" }, "content": { "description": "HTML body when rich_text is true; null to clear.", "maxLength": 200000, "type": [ "string", "null" ] }, "from": { "description": "Specifies the sender email address. Must be a configured outgoing address for the user. Use the [From Addresses API](from_addresses.yaml#$.paths./settings/emails/actions/from_addresses.get) to retrieve valid from addresses.\n", "maxLength": 254, "pattern": "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFromAddresses", "propertyId": "FromAddressEmail" } ], "resource": "from_addresses" } }, "inventory_details": { "additionalProperties": false, "description": "Inventory email details; null if not an inventory draft.", "properties": { "inventory_template": { "additionalProperties": false, "description": "Inventory template to use.", "properties": { "id": { "description": "Inventory template identifier.", "maxLength": 64, "type": "string" } }, "required": [ "id" ], "type": "object" }, "paper_type": { "description": "Paper type.", "enum": [ "A4", "USLetter" ], "type": "string" }, "view_type": { "description": "View type.", "enum": [ "portrait", "landscape" ], "type": "string" } }, "required": [ "inventory_template", "paper_type", "view_type" ], "type": [ "object", "null" ] }, "linked_record": { "additionalProperties": false, "description": "CRM record to link this draft to (Contacts module only); null to clear.", "properties": { "id": { "description": "CRM record identifier to link.", "maxLength": 64, "type": "string" }, "module": { "additionalProperties": false, "description": "Module to which the record belongs. Specify at least one of api_name\" or \"id\". If both are specified, they must refer to the same module.", "minProperties": 1, "properties": { "api_name": { "description": "API name of the module.", "maxLength": 100, "type": "string" }, "id": { "description": "Tab identifier of the module.", "maxLength": 20, "type": "string" } }, "type": "object" } }, "required": [ "id", "module" ], "type": [ "object", "null" ] }, "plainTextContent": { "description": "Plain text body when rich_text is false; null to clear.", "maxLength": 200000, "type": [ "string", "null" ] }, "reply_to": { "description": "Reply-to email address; null to clear.", "maxLength": 256, "type": [ "string", "null" ] }, "rich_text": { "description": "true for HTML editor mode; false for plain text mode.", "type": "boolean" }, "schedule_details": { "additionalProperties": false, "description": "Scheduling details; null to remove schedule.", "properties": { "source": { "description": "Source of the schedule decision.", "enum": [ "ecOneHourAhead", "upTime", "ecSchduleBestTime", "ecUpComing", "ecSchduleTime" ], "type": "string" }, "time": { "description": "Scheduled send time (ISO 8601 format).", "format": "date-time", "type": "string" }, "timezone": { "description": "Java TimeZone ID string; null uses organization default.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "time" ], "type": [ "object", "null" ] }, "source": { "description": "Source identifier string stored at draft creation time (e.g., campaign name or integration identifier).", "maxLength": 256, "type": "string" }, "subject": { "description": "Email subject; null to clear.", "maxLength": 512, "type": [ "string", "null" ] }, "to": { "description": "List of primary recipients.", "items": { "additionalProperties": false, "description": "Recipient object.", "properties": { "email": { "description": "Recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "Recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "from", "rich_text" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object" }, "x-zs-llm-examples": [ "CreateDraft" ] } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "Success": { "summary": "Successful Creation", "value": { "__email_drafts": [ { "code": "SUCCESS", "details": { "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330" }, "message": "Draft created Successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the result of created email drafts.", "properties": { "__email_drafts": { "description": "List of created email draft results.", "items": { "additionalProperties": false, "description": "Result of a single created email draft.", "properties": { "code": { "description": "Status code for the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the created draft.", "properties": { "id": { "description": "Encrypted identifier of the created draft. Use this ID to update or delete the draft.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Operation message.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object", "x-zs-$id": "PostEmailDraftsResponse" } } }, "description": "Returns the creation results when all email drafts in the request are created successfully." }, "207": { "$ref": "#/components/responses/EmailDraftsMultiStatus" }, "400": { "content": { "application/json": { "examples": { "InvalidDataFromEmail": { "summary": "Batch - from is not a valid email", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "from", "json_path": "$.__email_drafts[0].from" }, "message": "invalid email", "status": "error" } ] } }, "InvalidDataPaperType": { "summary": "Batch - inventory_details.paper_type value is invalid", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "paper_type", "json_path": "$.__email_drafts[0].inventory_details.paper_type" }, "message": "invalid data", "status": "error" } ] } }, "InvalidDataReplyToEmail": { "summary": "Batch - reply_to is not a valid email", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "reply_to", "json_path": "$.__email_drafts[0].reply_to" }, "message": "invalid email", "status": "error" } ] } }, "InvalidDataToEmail": { "summary": "Batch - to[].email is not a valid email", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "email", "json_path": "$.__email_drafts[0].to[0].email" }, "message": "invalid email", "status": "error" } ] } }, "InvalidFrom": { "summary": "Batch - from not in allowed address list (API layer)", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "from" }, "message": "Email can't be saved as draft using this from address.Kindly check the allowed from address list", "status": "error" } ] } }, "InvalidModule": { "summary": "Generic - invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRecord": { "summary": "Generic - invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "MandatoryNotFoundAttachmentFileName": { "summary": "Batch - attachments[].file_name is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "file_name", "json_path": "$.__email_drafts[0].attachments[0].file_name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundAttachmentId": { "summary": "Batch - attachments[].id is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.__email_drafts[0].attachments[0].id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundBccEmail": { "summary": "Batch - bcc[].email is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "email", "json_path": "$.__email_drafts[0].bcc[0].email" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundCcEmail": { "summary": "Batch - cc[].email is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "email", "json_path": "$.__email_drafts[0].cc[0].email" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundFrom": { "summary": "Batch - from is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "from", "json_path": "$.__email_drafts[0].from" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundInventoryTemplate": { "summary": "Batch - inventory_details.inventory_template is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "inventory_template", "json_path": "$.__email_drafts[0].inventory_details.inventory_template" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundRichText": { "summary": "Batch - rich_text is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "rich_text", "json_path": "$.__email_drafts[0].rich_text" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundScheduleTime": { "summary": "Batch - schedule_details.time is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "time", "json_path": "$.__email_drafts[0].schedule_details.time" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundToEmail": { "summary": "Batch - to[].email is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "email", "json_path": "$.__email_drafts[0].to[0].email" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "additionalProperties": true, "description": "Error response - either a generic request-level error (has top-level code/message/status/details) or a batch validation error (has __email_drafts array with per-draft errors).", "properties": { "__email_drafts": { "description": "Per-draft validation error array (present for batch validation errors).", "items": { "additionalProperties": true, "description": "Per-draft error detail.", "properties": { "code": { "description": "Error code.\n\n**Possible values:**\n- **MANDATORY_NOT_FOUND** - A required field is missing.\n- **INVALID_DATA** - The field contains invalid data.\n- **NOT_ALLOWED** - The field is not allowed in this operation.\n- **DUPLICATE_DATA** - A duplicate value was found (e.g. a duplicate attachment).\n- **EXPECTED_FIELD_MISSING** - At least one of a set of expected fields must be specified.\n- **AMBIGUITY_DURING_PROCESSING** - The given field values are ambiguous or conflicting.\n- **NOT_SUPPORTED** - The given field or value is not supported for this module.\n- **DEPENDENT_MISMATCH** - A field value does not match its dependent field.\n", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "NOT_ALLOWED", "DUPLICATE_DATA", "EXPECTED_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING", "NOT_SUPPORTED", "DEPENDENT_MISMATCH" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context for this draft's error.", "properties": { "api_name": { "description": "API field name that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the offending field.", "maxLength": 256, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message for this draft.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object" }, "maxItems": 100, "type": "array" }, "code": { "description": "Machine-readable error code for generic errors.\n\n**Possible values:**\n- **INVALID_MODULE** - The specified module is invalid.\n- **INVALID_DATA** - The specified record ID is invalid.\n", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context for generic errors.", "properties": { "resource_path_index": { "description": "Index of the invalid path parameter.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message for generic errors.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "PostEmailDraftsErrorResponses" } } }, "description": "Bad Request - The request could not be processed due to invalid input.\n\n**Resolution:** Review the error details, correct any invalid fields, and retry the request.\n" }, "403": { "$ref": "#/components/responses/NoPermissionForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.invoices.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.CREATE" ] } ], "summary": "Create Email Drafts for a Record", "tags": [ "email_drafts" ], "x-zoho-document": "email_drafts", "x-zs-llm-description": "Use this API to create one or more email drafts for a CRM record. The `from` address must be a configured outgoing email address for the user. Set `rich_text: true` for HTML body (`content`) or `rich_text: false` for plain text body (`plainTextContent`). The `id` returned in the response `details` can be used to update or delete the draft later." }, "put": { "description": "Updates one or more email drafts associated with the specified record in the given module.", "operationId": "updateEmailDraftsForRecord", "parameters": [ { "description": "Specifies the module of the record. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the API names of modules.\n", "in": "path", "name": "module", "required": true, "schema": { "maxLength": 100, "type": "string" } }, { "$ref": "#/components/parameters/EmailDraftsRecord" } ], "requestBody": { "content": { "application/json": { "examples": { "LeadsUpdateDraft": { "summary": "Example request to update a Leads email draft", "value": { "__email_drafts": [ { "bcc": [ { "email": "user3@example.com", "user_name": "user3" } ], "cc": [ { "email": "user2@example.com", "user_name": "user2" } ], "content": "this is the updated content", "from": "user1@example.com", "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330", "reply_to": "reply@example.com", "rich_text": true, "schedule_details": { "source": "upTime", "time": "2023-03-25T14:00:54+05:30", "timezone": null }, "subject": "Test Draft update", "to": [ { "email": "user1@example.com", "user_name": "user1" } ] } ] } }, "LeadsUpdateDraftWithId": { "summary": "Sample request body for updating a Leads email draft", "value": { "__email_drafts": [ { "bcc": [ { "email": "user3@zylker.com", "user_name": "user3" } ], "cc": [ { "email": "user2@zylker.com", "user_name": "user2" } ], "content": "this is the updated content", "from": "patricia.boyle@zylker.com", "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330", "reply_to": "pat.boyle@zylker.com", "rich_text": true, "schedule_details": { "time": "2023-03-25T14:00:54+05:30", "timezone": null }, "subject": "Test Draft update", "to": [ { "email": "user1@zylker.com", "user_name": "user1" } ] } ] } }, "UpdateDraft": { "summary": "Example request to update email drafts", "value": { "__email_drafts": [ { "bcc": [], "cc": [], "content": "

Hello!

", "from": "john@example.com", "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330", "inventory_details": null, "reply_to": null, "rich_text": true, "schedule_details": null, "subject": "Test Subject", "to": [ { "email": "john.doe@example.com", "user_name": "John Doe" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for updating email drafts.", "properties": { "__email_drafts": { "description": "List of email drafts to update.", "items": { "additionalProperties": false, "description": "Email draft object for update.", "properties": { "attachments": { "description": "Attachments list; replaces existing.", "items": { "additionalProperties": false, "description": "Attachment reference.", "properties": { "_delete": { "description": "true to remove this attachment.", "type": "boolean" }, "file_name": { "description": "File name.", "maxLength": 512, "type": "string" }, "file_size": { "description": "File size in bytes as a numeric string.", "maxLength": 20, "type": "string" }, "id": { "description": "Attachment/file identifier. Use the [Files API](files.yaml#$.paths./files.get) to retrieve file IDs.\n", "maxLength": 256, "type": "string" }, "service_name": { "description": "Storage service name.", "maxLength": 100, "type": "string" } }, "required": [ "id", "service_name" ], "type": "object" }, "maxItems": 50, "type": "array" }, "bcc": { "description": "BCC recipients. Replaces the existing list.", "items": { "additionalProperties": false, "description": "BCC recipient object.", "properties": { "email": { "description": "BCC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "BCC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" }, "cc": { "description": "CC recipients. Replaces the existing list.", "items": { "additionalProperties": false, "description": "CC recipient object.", "properties": { "email": { "description": "CC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "CC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" }, "content": { "description": "HTML body when rich_text is true; null to clear.", "maxLength": 200000, "type": [ "string", "null" ] }, "from": { "description": "Specifies the sender email address. Must be a configured outgoing address for the user. Use the [From Addresses API](from_addresses.yaml#$.paths./settings/emails/actions/from_addresses.get) to retrieve valid from addresses.\n", "maxLength": 254, "pattern": "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFromAddresses", "propertyId": "FromAddressEmail" } ], "resource": "from_addresses" } }, "id": { "description": "Encrypted draft identifier. Required to identify which draft to update. Use the [Get Email Drafts](email_drafts.yaml#$.paths./{module}/{record}/__email_drafts.get) resource to retrieve draft IDs.\n", "maxLength": 256, "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getEmailDrafts", "propertyId": "EmailDraftId" } ], "resource": "email_drafts" } }, "inventory_details": { "additionalProperties": false, "description": "Inventory email details; null to remove.", "properties": { "inventory_template": { "additionalProperties": false, "description": "Inventory template to use.", "properties": { "id": { "description": "Inventory template identifier.", "maxLength": 64, "type": "string" } }, "required": [ "id" ], "type": "object" }, "paper_type": { "description": "Paper type.", "enum": [ "A4", "USLetter" ], "type": "string" }, "view_type": { "description": "View type.", "enum": [ "portrait", "landscape" ], "type": "string" } }, "required": [ "inventory_template", "paper_type", "view_type" ], "type": [ "object", "null" ] }, "linked_record": { "additionalProperties": false, "description": "CRM record to link this draft to; null to clear.", "properties": { "id": { "description": "CRM record identifier to link.", "maxLength": 64, "type": "string" }, "module": { "additionalProperties": false, "description": "Module to which the record belongs. Specify at least one of \"api_name\" or \"id\". If both are specified, they must refer to the same module.", "minProperties": 1, "properties": { "api_name": { "description": "API name of the module.", "maxLength": 100, "type": "string" }, "id": { "description": "Tab identifier of the module.", "maxLength": 20, "type": "string" } }, "type": "object" } }, "required": [ "id", "module" ], "type": [ "object", "null" ] }, "plainTextContent": { "description": "Plain text body when rich_text is false; null to clear.", "maxLength": 200000, "type": [ "string", "null" ] }, "reply_to": { "description": "Reply-to email address; null to clear.", "maxLength": 256, "type": [ "string", "null" ] }, "rich_text": { "description": "true for HTML editor; false for plain text.", "type": "boolean" }, "schedule_details": { "additionalProperties": false, "description": "Scheduling details; null to remove schedule.", "properties": { "source": { "description": "Source of the schedule decision.", "enum": [ "ecOneHourAhead", "upTime", "ecSchduleBestTime", "ecUpComing", "ecSchduleTime" ], "type": "string" }, "time": { "description": "Scheduled send time (ISO 8601 format).", "format": "date-time", "type": "string" }, "timezone": { "description": "Java TimeZone ID string; null uses organization default.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "time" ], "type": [ "object", "null" ] }, "source": { "description": "Source identifier string stored at draft creation time (e.g., campaign name or integration identifier).", "maxLength": 256, "type": "string" }, "subject": { "description": "Email subject; null to clear.", "maxLength": 512, "type": [ "string", "null" ] }, "to": { "description": "Primary recipients. Replaces the existing list.", "items": { "additionalProperties": false, "description": "Recipient object.", "properties": { "email": { "description": "Recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "Recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "id", "from", "rich_text" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateDraft" ] } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "summary": "Successful update", "value": { "__email_drafts": [ { "code": "SUCCESS", "details": { "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330" }, "message": "Draft updated Successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the result of updating email drafts.", "properties": { "__email_drafts": { "description": "List of updated email draft results.", "items": { "additionalProperties": false, "description": "Result of a single updated email draft.", "properties": { "code": { "description": "Status code for the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the updated draft.", "properties": { "id": { "description": "Encrypted identifier of the updated draft.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Operation message.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object", "x-zs-$id": "PutEmailDraftsResponse" } } }, "description": "Returns the update results when all email drafts in the request are updated successfully." }, "207": { "$ref": "#/components/responses/EmailDraftsMultiStatus" }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "summary": "Generic - invalid path parameter", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidDataFromEmail": { "summary": "Batch - from is not a valid email", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "from", "json_path": "$.__email_drafts[0].from" }, "message": "invalid email", "status": "error" } ] } }, "InvalidDataReplyToEmail": { "summary": "Batch - reply_to is not a valid email", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "reply_to", "json_path": "$.__email_drafts[0].reply_to" }, "message": "invalid email", "status": "error" } ] } }, "InvalidFrom": { "summary": "Batch - from not in allowed address list (API layer)", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "from" }, "message": "Email can't be saved as draft using this from address.Kindly check the allowed from address list", "status": "error" } ] } }, "InvalidModule": { "summary": "Generic - invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InventoryNotAllowed": { "summary": "Batch - inventory_details not allowed in update (API layer)", "value": { "__email_drafts": [ { "code": "NOT_ALLOWED", "details": { "api_name": "inventory_details", "json_path": "$.__email_drafts[0].inventory_details" }, "message": "The inventory_details field is not allowed in update draft request.", "status": "error" } ] } }, "MandatoryNotFoundAttachmentFileName": { "summary": "Batch - attachments[].file_name is required on edit", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "file_name", "json_path": "$.__email_drafts[0].attachments[0].file_name" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundAttachmentId": { "summary": "Batch - attachments[].id is required on edit", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.__email_drafts[0].attachments[0].id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundBccEmail": { "summary": "Batch - bcc[].email is required on edit", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "email", "json_path": "$.__email_drafts[0].bcc[0].email" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundCcEmail": { "summary": "Batch - cc[].email is required on edit", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "email", "json_path": "$.__email_drafts[0].cc[0].email" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundFrom": { "summary": "Batch - from is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "from", "json_path": "$.__email_drafts[0].from" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundId": { "summary": "Batch - id is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": "$.__email_drafts[0].id" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundRichText": { "summary": "Batch - rich_text is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "rich_text", "json_path": "$.__email_drafts[0].rich_text" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundScheduleTime": { "summary": "Batch - schedule_details.time is required", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "time", "json_path": "$.__email_drafts[0].schedule_details.time" }, "message": "required field not found", "status": "error" } ] } }, "MandatoryNotFoundToEmail": { "summary": "Batch - to[].email is required on edit", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "email", "json_path": "$.__email_drafts[0].to[0].email" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "additionalProperties": true, "description": "Error response - either a generic request-level error or a batch validation error with per-draft details.", "properties": { "__email_drafts": { "description": "Per-draft validation error array (present for batch validation errors).", "items": { "additionalProperties": true, "description": "Per-draft error detail.", "properties": { "code": { "description": "Error code.\n\n**Possible values:**\n- **MANDATORY_NOT_FOUND** - A required field is missing.\n- **INVALID_DATA** - The field contains invalid data.\n- **NOT_ALLOWED** - The field is not allowed in this operation.\n- **DUPLICATE_DATA** - A duplicate value was found (e.g. a duplicate attachment).\n- **EXPECTED_FIELD_MISSING** - At least one of a set of expected fields must be specified.\n- **AMBIGUITY_DURING_PROCESSING** - The given field values are ambiguous or conflicting.\n- **NOT_SUPPORTED** - The given field or value is not supported for this module.\n- **DEPENDENT_MISMATCH** - A field value does not match its dependent field.\n", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "NOT_ALLOWED", "DUPLICATE_DATA", "EXPECTED_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING", "NOT_SUPPORTED", "DEPENDENT_MISMATCH" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context for this draft's error.", "properties": { "api_name": { "description": "API field name that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the offending field.", "maxLength": 256, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message for this draft.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object" }, "maxItems": 100, "type": "array" }, "code": { "description": "Machine-readable error code for generic errors.\n\n**Possible values:**\n- **INVALID_MODULE** - The specified module is invalid.\n- **INVALID_DATA** - The specified record ID or draft ID is invalid.\n", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context for generic errors.", "properties": { "resource_path_index": { "description": "Index of the invalid path parameter.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message for generic errors.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "PutEmailDraftsErrorResponses" } } }, "description": "Bad Request - The request could not be processed due to invalid input.\n\n**Resolution:** Review the error details, correct any invalid fields, and retry the request.\n" }, "403": { "$ref": "#/components/responses/NoPermissionForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.invoices.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.UPDATE" ] } ], "summary": "Update Email Drafts for a Record", "tags": [ "email_drafts" ], "x-zoho-document": "email_drafts", "x-zs-llm-description": "Use this API to update multiple email drafts in a single batch request for a CRM record. Each draft entry in the request must include the `id` of the draft to update (obtained from getEmailDrafts or createEmailDrafts response), along with the `from` address and `rich_text` flag. Fields not provided in the request will be cleared or reset." } }, "/crm/v8/{module}/{record}/__email_drafts/{draft}": { "delete": { "description": "Deletes the specified email draft for the given record.", "operationId": "deleteEmailDrafts", "parameters": [ { "$ref": "#/components/parameters/EmailDraftsModule" }, { "$ref": "#/components/parameters/EmailDraftsRecord" }, { "$ref": "#/components/parameters/Draft" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "summary": "Successful deletion", "value": { "__email_drafts": [ { "code": "SUCCESS", "details": { "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330" }, "message": "Draft deleted Successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the result of deleting email drafts.", "properties": { "__email_drafts": { "description": "List of deleted email draft results.", "items": { "additionalProperties": false, "description": "Result of a single deleted email draft.", "properties": { "code": { "description": "Status code for the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the deleted draft.", "properties": { "id": { "description": "Encrypted identifier of the deleted draft.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Operation message.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object", "x-zs-$id": "DeleteDetailEmailDraftsErrorResponses" } } }, "description": "Returns the deletion result when the email draft is deleted successfully." }, "400": { "content": { "application/json": { "examples": { "DraftNotDeleted": { "summary": "Draft could not be deleted", "value": { "code": "INVALID_DATA", "details": { "id": "473895000000583029" }, "message": "draft not deleted", "status": "error" } }, "InvalidDraftId": { "summary": "Invalid draft ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "Invalid draft Id", "status": "error" } }, "InvalidModule": { "summary": "Invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRelatedID": { "summary": "Invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": true, "description": "Generic error response for an invalid DELETE request.", "properties": { "code": { "description": "Machine-readable error code.\n\n**Possible values:**\n- **INVALID_MODULE** - The specified module is invalid.\n- **INVALID_DATA** - The specified record ID or draft ID is invalid.\n", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context (varies by code).", "properties": { "id": { "description": "Encrypted identifier of the draft that could not be deleted.", "maxLength": 256, "type": "string" }, "resource_path_index": { "description": "Index of the invalid path parameter.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "DeleteDetailEmailDraftsErrorResponse" } } }, "description": "Bad Request - The request could not be processed due to invalid input.\n\n**Resolution:** Verify that the module name is valid, the record ID exists, and the draft ID is correct.\n" }, "403": { "$ref": "#/components/responses/NoPermissionForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.invoices.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.DELETE" ] } ], "summary": "Delete an Email Draft", "tags": [ "email_drafts" ], "x-zoho-document": "email_drafts", "x-zs-llm-description": "Use this API to permanently delete a specific email draft identified by the `draft` path parameter. The draft `id` is passed in the URL. Call getEmailDrafts or getEmailDraft first to get the `id` of the draft to delete." }, "get": { "description": "Retrieves the specified email draft for the given record in the module.", "operationId": "getEmailDraft", "parameters": [ { "$ref": "#/components/parameters/EmailDraftsModule" }, { "$ref": "#/components/parameters/EmailDraftsRecord" }, { "$ref": "#/components/parameters/Draft" } ], "responses": { "200": { "content": { "application/json": { "examples": { "Default": { "summary": "Example response for a single email draft", "value": { "__email_drafts": [ { "$sharing_permission": "full_access", "attachments": [ { "file_name": "attachment.txt", "file_size": "8990", "id": "0b9e5596cdd8cafe6a5c09f78f095bd6434c863110a6d1e094285c6ebf9dd0d5", "service_name": "ZFSAttached" } ], "bcc": [ { "email": "user4email@zoho.com", "user_name": "user4" } ], "cc": [ { "email": "user2@zylker.com", "user_name": "user2" } ], "content": "This is the email content.", "created_time": "2023-11-09T14:45:25+05:30", "from": "patricia.boyle@zylker.com", "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330", "inventory_details": null, "linked_record": null, "modified_time": "2023-11-09T14:45:25+05:30", "owner": { "id": "4567890123", "name": "Owner Name" }, "reply_to": "pat.boyle@zylker.com", "rich_text": true, "schedule_details": { "time": "2023-11-30T18:40:00+05:30" }, "source": "", "subject": "Test Draft", "summary": "This is the email content.", "to": [ { "email": "user1@zylker.com", "user_name": "user1" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Response containing a single email draft.", "properties": { "__email_drafts": { "description": "Array containing exactly one email draft object.", "items": { "additionalProperties": false, "description": "Email draft object with metadata, recipients, and attachments.", "properties": { "$sharing_permission": { "description": "Sharing permission level for the requesting user.", "maxLength": 64, "type": "string" }, "attachments": { "description": "Attachments included with the draft; null if none.", "items": { "additionalProperties": false, "description": "Attachment metadata.", "properties": { "file_name": { "description": "Original file name.", "maxLength": 512, "type": "string" }, "file_size": { "description": "File size in bytes as a numeric string.", "maxLength": 20, "type": "string" }, "id": { "description": "Encrypted attachment/file identifier.", "maxLength": 256, "type": "string" }, "service_name": { "description": "Storage service name.", "maxLength": 100, "type": "string" } }, "required": [ "id", "file_name", "file_size", "service_name" ], "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "bcc": { "description": "BCC recipients; null if none.", "items": { "additionalProperties": false, "description": "BCC recipient object.", "properties": { "email": { "description": "BCC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "BCC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "user_name", "email" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "cc": { "description": "CC recipients; null if none.", "items": { "additionalProperties": false, "description": "CC recipient object.", "properties": { "email": { "description": "CC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "CC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "user_name", "email" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "content": { "description": "Email HTML body content; null if not set.", "maxLength": 200000, "type": [ "string", "null" ] }, "created_time": { "description": "Timestamp when the draft was created (ISO 8601 format).", "format": "date-time", "type": "string" }, "from": { "description": "Sender email address.", "maxLength": 256, "type": "string" }, "id": { "description": "Unique encrypted draft identifier.", "maxLength": 256, "type": "string" }, "inventory_details": { "additionalProperties": false, "description": "Inventory email details; null if not an inventory draft.", "properties": { "inventory_template": { "additionalProperties": false, "description": "Inventory template details.", "properties": { "id": { "description": "Inventory template identifier.", "maxLength": 64, "type": "string" }, "name": { "description": "Inventory template name.", "maxLength": 256, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "paper_type": { "description": "Paper type for rendered inventory.", "enum": [ "A4", "USLetter" ], "type": "string" }, "record": { "additionalProperties": false, "description": "CRM record associated with this inventory draft.", "properties": { "id": { "description": "CRM record identifier.", "maxLength": 64, "type": "string" }, "name": { "description": "CRM record display name.", "maxLength": 256, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "view_type": { "description": "Layout/view type for the inventory.", "enum": [ "portrait", "landscape" ], "type": "string" } }, "required": [ "inventory_template", "paper_type", "view_type" ], "type": [ "object", "null" ] }, "linked_record": { "additionalProperties": false, "description": "CRM record linked to this draft; null if not linked.", "properties": { "id": { "description": "Linked CRM record identifier.", "maxLength": 64, "type": "string" }, "module": { "additionalProperties": false, "description": "Module of the linked record.", "properties": { "api_name": { "description": "Module API name.", "maxLength": 100, "type": "string" }, "id": { "description": "Module tab identifier.", "maxLength": 64, "type": "string" } }, "required": [ "api_name" ], "type": "object" } }, "required": [ "id", "module" ], "type": [ "object", "null" ] }, "modified_time": { "description": "Timestamp when the draft was last modified (ISO 8601 format).", "format": "date-time", "type": "string" }, "owner": { "additionalProperties": false, "description": "Owner who created the draft.", "properties": { "id": { "description": "Owner user identifier. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve user IDs.\n", "maxLength": 64, "type": "string" }, "name": { "description": "Owner display name.", "maxLength": 256, "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "reply_to": { "description": "Reply-to email address; null if not set.", "maxLength": 256, "type": [ "string", "null" ] }, "rich_text": { "description": "true when HTML editor was used; false for plain text.", "type": "boolean" }, "schedule_details": { "additionalProperties": false, "description": "Scheduling information; null if not scheduled.", "properties": { "source": { "description": "Source of the schedule decision.", "enum": [ "ecOneHourAhead", "upTime", "ecSchduleBestTime", "ecUpComing", "ecSchduleTime" ], "type": "string" }, "time": { "description": "Scheduled send time (ISO 8601 format).", "format": "date-time", "type": "string" }, "timezone": { "description": "Timezone identifier or null.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "time" ], "type": [ "object", "null" ] }, "source": { "description": "Source identifier string stored at draft creation time.", "maxLength": 256, "type": "string" }, "subject": { "description": "Email subject; null if not set.", "maxLength": 512, "type": [ "string", "null" ] }, "summary": { "description": "Plain text preview of the draft body; null if empty.", "maxLength": 500, "type": [ "string", "null" ] }, "to": { "description": "Primary recipients; null if none.", "items": { "additionalProperties": false, "description": "Recipient object.", "properties": { "email": { "description": "Recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "Recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "user_name", "email" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] } }, "required": [ "id", "modified_time", "created_time", "from", "to", "reply_to", "cc", "bcc", "rich_text", "subject", "content", "summary", "owner" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object", "x-zs-$id": "GetDetailEmailDraftsResponse" } } }, "description": "Returns the details of the specified email draft." }, "204": { "description": "Indicates that the specified email draft does not exist, or that the draft ID could not be resolved (e.g. malformed or undecryptable)." }, "400": { "content": { "application/json": { "examples": { "InvalidModule": { "summary": "Invalid module name", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "the module name given seems to be invalid", "status": "error" } }, "InvalidRelatedID": { "summary": "Invalid record ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } } }, "schema": { "additionalProperties": true, "description": "Generic error response for an invalid GET single-draft request.", "properties": { "code": { "description": "Machine-readable error code.\n\n**Possible values:**\n- **INVALID_MODULE** - The specified module is invalid.\n- **INVALID_DATA** - The specified record ID is invalid.\n", "enum": [ "INVALID_MODULE", "INVALID_DATA" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context (varies by code).", "properties": { "resource_path_index": { "description": "Index of the invalid path parameter.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "GetDetailEmailDraftsErrorResponses" } } }, "description": "Bad Request - The request could not be processed due to invalid input.\n\n**Resolution:** Verify that the module name is valid and the record ID exists. A malformed or non-existent draft ID does not return this error — see the `204` response instead.\n" }, "403": { "$ref": "#/components/responses/NoPermissionForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.invoices.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.READ" ] } ], "summary": "Get an Email Draft", "tags": [ "email_drafts" ], "x-zoho-document": "email_drafts", "x-zs-llm-description": "Use this API to retrieve a single email draft by its `id` (the `draft` path parameter). The `id` can be obtained from the getEmailDrafts (list) response. Returns the full draft detail including recipients, content, attachments, schedule details, and owner." }, "put": { "description": "Updates the specified email draft for the given record in the module.", "operationId": "updateEmailDrafts", "parameters": [ { "$ref": "#/components/parameters/EmailDraftsModule" }, { "$ref": "#/components/parameters/EmailDraftsRecord" }, { "$ref": "#/components/parameters/Draft" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateDraft": { "summary": "Example request to update a single email draft", "value": { "__email_drafts": [ { "bcc": [], "cc": [], "content": "

Hello!

", "from": "john@example.com", "inventory_details": null, "reply_to": null, "rich_text": true, "schedule_details": null, "subject": "Test Subject", "to": [ { "email": "john.doe@example.com", "user_name": "John Doe" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Request body for updating a single email draft.", "properties": { "__email_drafts": { "description": "List containing the single draft to update.", "items": { "additionalProperties": false, "description": "Email draft object for update.", "properties": { "attachments": { "description": "Attachments list; replaces existing.", "items": { "additionalProperties": false, "description": "Attachment reference.", "properties": { "_delete": { "description": "true to remove this attachment.", "type": "boolean" }, "file_name": { "description": "File name.", "maxLength": 512, "type": "string" }, "file_size": { "description": "File size in bytes as a numeric string.", "maxLength": 20, "type": "string" }, "id": { "description": "Attachment/file identifier. Use the [Files API](files.yaml#$.paths./files.get) to retrieve file IDs.\n", "maxLength": 256, "type": "string" }, "service_name": { "description": "Storage service name.", "maxLength": 100, "type": "string" } }, "required": [ "id", "service_name" ], "type": "object" }, "maxItems": 50, "type": "array" }, "bcc": { "description": "BCC recipients. Replaces the existing list.", "items": { "additionalProperties": false, "description": "BCC recipient object.", "properties": { "email": { "description": "BCC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "BCC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" }, "cc": { "description": "CC recipients. Replaces the existing list.", "items": { "additionalProperties": false, "description": "CC recipient object.", "properties": { "email": { "description": "CC recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "CC recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" }, "content": { "description": "HTML body when rich_text is true; null to clear.", "maxLength": 200000, "type": [ "string", "null" ] }, "from": { "description": "Specifies the sender email address. Must be a configured outgoing address for the user. Use the [From Addresses API](from_addresses.yaml#$.paths./settings/emails/actions/from_addresses.get) to retrieve valid from addresses.\n", "maxLength": 254, "pattern": "[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getFromAddresses", "propertyId": "FromAddressEmail" } ], "resource": "from_addresses" } }, "inventory_details": { "additionalProperties": false, "description": "Inventory email details; null to remove.", "properties": { "inventory_template": { "additionalProperties": false, "description": "Inventory template to use.", "properties": { "id": { "description": "Inventory template identifier.", "maxLength": 64, "type": "string" } }, "required": [ "id" ], "type": "object" }, "paper_type": { "description": "Paper type.", "enum": [ "A4", "USLetter" ], "type": "string" }, "view_type": { "description": "View type.", "enum": [ "portrait", "landscape" ], "type": "string" } }, "required": [ "inventory_template", "paper_type", "view_type" ], "type": [ "object", "null" ] }, "linked_record": { "additionalProperties": false, "description": "CRM record to link this draft to; null to clear.", "properties": { "id": { "description": "CRM record identifier to link.", "maxLength": 64, "type": "string" }, "module": { "additionalProperties": false, "description": "Module to which the record belongs. Specify at least one of \"api_name\" or \"id\". If both are specified, they must refer to the same module.", "minProperties": 1, "properties": { "api_name": { "description": "API name of the module.", "maxLength": 100, "type": "string" }, "id": { "description": "Tab identifier of the module.", "maxLength": 20, "type": "string" } }, "type": "object" } }, "required": [ "id", "module" ], "type": [ "object", "null" ] }, "plainTextContent": { "description": "Plain text body when rich_text is false; null to clear.", "maxLength": 200000, "type": [ "string", "null" ] }, "reply_to": { "description": "Reply-to email address; null to clear.", "maxLength": 256, "type": [ "string", "null" ] }, "rich_text": { "description": "true for HTML editor; false for plain text.", "type": "boolean" }, "schedule_details": { "additionalProperties": false, "description": "Scheduling details; null to remove schedule.", "properties": { "source": { "description": "Source of the schedule decision.", "enum": [ "ecOneHourAhead", "upTime", "ecSchduleBestTime", "ecUpComing", "ecSchduleTime" ], "type": "string" }, "time": { "description": "Scheduled send time (ISO 8601 format).", "format": "date-time", "type": "string" }, "timezone": { "description": "Java TimeZone ID string; null uses organization default.", "maxLength": 100, "type": [ "string", "null" ] } }, "required": [ "time" ], "type": [ "object", "null" ] }, "source": { "description": "Source identifier string stored at draft creation time (e.g., campaign name or integration identifier).", "maxLength": 256, "type": "string" }, "subject": { "description": "Email subject; null to clear.", "maxLength": 512, "type": [ "string", "null" ] }, "to": { "description": "Primary recipients. Replaces the existing list.", "items": { "additionalProperties": false, "description": "Recipient object.", "properties": { "email": { "description": "Recipient email address.", "maxLength": 256, "type": "string" }, "user_name": { "description": "Recipient display name; null if not available.", "maxLength": 256, "type": [ "string", "null" ] } }, "required": [ "email" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "from", "rich_text" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "Success": { "summary": "Successful update", "value": { "__email_drafts": [ { "code": "SUCCESS", "details": { "id": "4f8efdcbaf23fd33c939217d4e14222d6d1cb21e4a45914fb9ba0c31c3c47330" }, "message": "Draft updated Successfully", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Response object containing the result of updating email drafts.", "properties": { "__email_drafts": { "description": "List of updated email draft results.", "items": { "additionalProperties": false, "description": "Result of a single updated email draft.", "properties": { "code": { "description": "Status code for the operation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Details of the updated draft.", "properties": { "id": { "description": "Encrypted identifier of the updated draft.", "maxLength": 256, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Operation message.", "maxLength": 512, "type": "string" }, "status": { "description": "Status of the operation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "__email_drafts" ], "type": "object", "x-zs-$id": "GetDetailEmailDraftsForbiddenResponse" } } }, "description": "Returns the update result when the email draft is updated successfully." }, "400": { "content": { "application/json": { "examples": { "InvalidData": { "summary": "Generic error - invalid path parameter", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "the related id given seems to be invalid", "status": "error" } }, "InvalidDraftId": { "summary": "Generic error - invalid draft ID in URL", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 3 }, "message": "invalid draft id in the url", "status": "error" } }, "InvalidFrom": { "summary": "Batch error - invalid from address", "value": { "__email_drafts": [ { "code": "INVALID_DATA", "details": { "api_name": "from" }, "message": "Email can't be saved as draft using this from address.Kindly check the allowed from address list", "status": "error" } ] } }, "InventoryNotAllowed": { "summary": "Batch error - inventory_details not allowed in update (API layer)", "value": { "__email_drafts": [ { "code": "NOT_ALLOWED", "details": { "api_name": "inventory_details", "json_path": "$.__email_drafts[0].inventory_details" }, "message": "The inventory_details field is not allowed in update draft request.", "status": "error" } ] } }, "MandatoryNotFound": { "summary": "Batch error - required field missing", "value": { "__email_drafts": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "from", "json_path": "$.__email_drafts[0].from" }, "message": "required field not found", "status": "error" } ] } } }, "schema": { "additionalProperties": true, "description": "Error response - either a generic request-level error or a batch validation error with per-draft details.", "properties": { "__email_drafts": { "description": "Per-draft validation error array (present for batch validation errors).", "items": { "additionalProperties": true, "description": "Per-draft error detail.", "properties": { "code": { "description": "Error code.\n\n**Possible values:**\n- **MANDATORY_NOT_FOUND** - A required field is missing.\n- **INVALID_DATA** - The field contains invalid data.\n- **NOT_ALLOWED** - The field is not allowed in this operation.\n- **DUPLICATE_DATA** - A duplicate value was found (e.g. a duplicate attachment).\n- **EXPECTED_FIELD_MISSING** - At least one of a set of expected fields must be specified.\n- **AMBIGUITY_DURING_PROCESSING** - The given field values are ambiguous or conflicting.\n- **NOT_SUPPORTED** - The given field or value is not supported for this module.\n- **DEPENDENT_MISMATCH** - A field value does not match its dependent field.\n", "enum": [ "MANDATORY_NOT_FOUND", "INVALID_DATA", "NOT_ALLOWED", "DUPLICATE_DATA", "EXPECTED_FIELD_MISSING", "AMBIGUITY_DURING_PROCESSING", "NOT_SUPPORTED", "DEPENDENT_MISMATCH" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context for this draft's error.", "properties": { "api_name": { "description": "API field name that caused the error.", "maxLength": 100, "type": "string" }, "json_path": { "description": "JSON path to the offending field.", "maxLength": 256, "type": "string" } }, "type": "object" }, "message": { "description": "Human-readable error message for this draft.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" }, "code": { "description": "Machine-readable error code for generic errors.\n\n**Possible values:**\n- **INVALID_DATA** - The specified record ID or draft ID is invalid.\n- **INVALID_MODULE** - The specified module is invalid.\n", "enum": [ "INVALID_DATA", "INVALID_MODULE" ], "maxLength": 100, "type": "string" }, "details": { "additionalProperties": true, "description": "Additional context for generic errors.", "properties": { "resource_path_index": { "description": "Index of the invalid path parameter.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Human-readable error message for generic errors.", "maxLength": 512, "type": "string" }, "status": { "description": "Always \"error\".", "enum": [ "error" ], "type": "string" } }, "type": "object", "x-zs-$id": "UpdateDetailEmailDraftsErrorResponses" } } }, "description": "Bad Request - The request could not be processed due to invalid input.\n\n**Resolution:** Review the error details, correct any invalid fields, and retry the request.\n" }, "403": { "$ref": "#/components/responses/NoPermissionForbidden" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.leads.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.accounts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.contacts.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.deals.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.quotes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.salesorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.purchaseorders.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.invoices.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.vendors.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.custom.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.cases.UPDATE" ] } ], "summary": "Update an Email Draft", "tags": [ "email_drafts" ], "x-zoho-document": "email_drafts", "x-zs-llm-description": "Use this API to update a single specific email draft identified by the `draft` path parameter. The draft `id` is passed in the URL (not in the request body). The request body must contain `from` and `rich_text`. Pass `content` for HTML drafts (`rich_text: true`) or `plainTextContent` for plain-text drafts (`rich_text: false`)." } }, "/crm/v8/{module}/{record}/actions/assign_territories": { "post": { "description": "To assign one or more territories to a single record in your Zoho CRM organization.", "operationId": "assignTerritoriesToRecord", "parameters": [ { "$ref": "#/components/parameters/TerritoriesRecord", "description": "The unique ID of the record to assign territories to." }, { "$ref": "#/components/parameters/TerritoriesModule", "description": "The API name of the module that contains the record." } ], "requestBody": { "content": { "application/json": { "examples": { "AssignTerritoryByRecordId": { "summary": "Territory assignment request for a single record", "value": { "data": [ { "Territories": [ { "id": "123456712345623456" }, { "id": "123456712345623467" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the records and territories to assign in this request.", "properties": { "data": { "description": "Specify the list of records and their associated territories to assign. Each object must include a record ID and a **Territories** array.", "items": { "additionalProperties": false, "description": "Specify the record ID and the list of territories to assign to that record.", "properties": { "Territories": { "description": "Specify the list of territories to assign to the record. Use the Get Territories API to retrieve the available territory IDs.", "items": { "additionalProperties": false, "description": "Specify a territory to assign to the record by providing its unique ID.", "properties": { "id": { "description": "Specify the unique ID of the territory to assign to the record.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "id": { "description": "Specify the unique ID of the record for which to assign the territories. This field is optional when the record ID is specified in the request URL.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecord", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "Territories" ], "type": "object", "x-zs-$id": "AssignTerritoriesToRecordRequestDataItem" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "AssignTerritoriesToRecordRequestBody" }, "x-zs-llm-examples": [ "AssignTerritoryByRecordId" ] } }, "description": "The request body must contain a **data** array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "AssignTerritoriesSuccess": { "summary": "Successful immediate territory assignment response", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "5319055000000749946" }, "message": "the territories data updated successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryAssignRecordSuccessResponse" } } }, "description": "Returns the details of the territory assignment operation when territories are assigned immediately to the record." }, "202": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Scheduled territory assignment response", "value": { "data": [ { "code": "SCHEDULED", "details": { "id": "2345678234534545", "job_id": "482367546723546372" }, "message": "Territory assignment process scheduled successfully", "status": "success" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignRecordScheduledResponse" }, { "$ref": "#/components/schemas/TerritoryAssignRecordSuccessResponse" } ], "description": "Contains the scheduled or immediate success response for a territory assignment to a single record.", "x-zs-$id": "TerritoryAssignRecordResponse" } } }, "description": "Returns a scheduled response indicating that the territory assignment job was queued successfully. The **code** field is set to **SCHEDULED**, and the **details** object contains the record ID and the job ID." }, "400": { "content": { "application/json": { "examples": { "DuplicateTerritoryError": { "summary": "Duplicate territory error for a single-record assignment", "value": { "data": [ { "code": "DUPLICATE_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Territories[1].id" }, "message": "Given Territory already exists for that record", "status": "error" } ] } }, "InvalidModuleError": { "summary": "Invalid module name error for a territory assignment", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "the api is not supported for this module", "status": "error" } }, "InvalidTerritoryIdError": { "summary": "Invalid territory ID error for a single-record assignment", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": " $.data[0].Territories[1].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "LimitExceededOnAssign": { "summary": "Territory limit exceeded error on single-record assignment", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Territories", "json_path": "$.data[0].Territories", "limit": 10 }, "message": "Maximum limit of territories for that record exceeds", "status": "error" } ] } }, "MandatoryNotFoundError": { "summary": "Mandatory parameter missing error for a territory assignment", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": " $.data[0].Territories[1].id" }, "message": "required field not found", "status": "error" } ] } }, "TerritoryNotYetEnabled": { "summary": "Territory feature not enabled error for the specified module", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignInvalidDataTerritoryId" }, { "$ref": "#/components/schemas/TerritoryAssignInvalidDataOnURL" }, { "$ref": "#/components/schemas/TerritoryAssignMandatoryNotFound" }, { "$ref": "#/components/schemas/TerritoryAssignDuplicateData" }, { "$ref": "#/components/schemas/TerritoryAssignNotSupported" }, { "$ref": "#/components/schemas/TerritoryAssignAlreadyUsed" }, { "$ref": "#/components/schemas/TerritoryAssignRecordLockedInURL" }, { "$ref": "#/components/schemas/TerritoryAssignInvalidDataMaxLen" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/AssignTerritoryAssignErrorDataObject" }, { "$ref": "#/components/schemas/InvalidModule" }, { "$ref": "#/components/schemas/TerritoryInvalidUrlPathErrorSchema" } ], "description": "Represents the error response for an invalid or failed territory assignment request.", "x-zs-$id": "TerritoryAssignErrorResponse" } } }, "description": "The territory assignment request contains invalid or missing data.\n**Resolution:** Verify that all required fields are present, the record and territory IDs are valid, and the assignment does not exceed the configured limits.\n" }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure due to invalid OAuth token", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "NoPermissionForTerritoryId": { "summary": "No permission to assign the specified territory to the record", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "api_name": "id", "json_path": "$.data[0].Territories" }, "message": "User has no permission to add / remove the Territories", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignNoPermission" }, { "$ref": "#/components/schemas/UnauthorizedError" } ], "x-zs-$id": "TerritoryAssignUnauthorizedErrorResponse" } } }, "description": "The access token does not include the required scope for this operation.\n**Resolution:** A new access token must be generated with the required ZohoCRM.modules scope for this API.\n" }, "403": { "content": { "application/json": { "examples": { "NOPermissionForRecord": { "summary": "No permission to update the record for territory assignment", "value": { "code": "NO_PERMISSION", "details": { "resource_path_index": 1 }, "message": "User has no permission to update the record", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryRecordNoPermission" } ], "x-zs-$id": "TerritoryAssignPermissionDeniedErrorResponse" } } }, "description": "Territory management is not enabled or the user lacks permission to update the record.\n**Resolution:** The CRM administrator must enable the territory feature in the organization settings and grant the required profile permissions.\n" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Assign territories to a record", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Assigns one or more territories to a single record in the specified module. The module and record id are passed as URL path parameters. Returns 202 - the assignment is processed asynchronously. To track the asynchronous job status on a record, use getFeatureSpecificInfo (feature_specific_info.json) with features=territory_scheduled_jobs along with the module and record id. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/{module}/{record}/actions/change_owner": { "post": { "description": "To change the owner of a specific record in the specified CRM module in your Zoho CRM organization. Note: The module name `Deals` is accepted and internally resolved to `Potentials`. `Meetings` is internally resolved to `Events`.", "operationId": "changeSingleRecordOwner", "parameters": [ { "$ref": "#/components/parameters/ChangeOwnerModule" }, { "$ref": "#/components/parameters/ChangeOwnerRecord" }, { "deprecated": true, "description": "Deprecated — use the `notify` field in the request body instead.", "in": "query", "name": "notify", "required": false, "schema": { "type": "boolean" } }, { "deprecated": true, "description": "Deprecated — use the `owner.id` field in the request body instead.", "in": "query", "name": "owner_id", "required": false, "schema": { "maxLength": 19, "type": "string" } }, { "deprecated": true, "description": "Deprecated — use the `related_modules` array in the request body instead.", "in": "query", "name": "related_modules", "required": false, "schema": { "maxLength": 2000, "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "ChangeOwnerExample": { "value": { "notify": true, "owner": { "id": "5725767000000291001" }, "related_modules": [ { "api_name": "Tasks", "id": "5725767000000293001" }, { "api_name": "Events", "id": "5725767000000293005" } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the owner details for the single record owner change request.", "properties": { "notify": { "description": "Specify whether to notify the new owner via email when the record is assigned.\\nPossible values:\\n**true** - The new owner is notified via email.\\n**false** - The new owner is not notified via email.", "type": [ "boolean", "null" ] }, "owner": { "additionalProperties": false, "description": "Specify the details of the new owner for the record.", "properties": { "id": { "description": "Specify the user ID of the new owner.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "related_modules": { "description": "Specify the related modules for which you want to transfer record ownership along with the main record.", "items": { "additionalProperties": false, "description": "Specify the API name and record ID of a related module record to transfer to the new owner.", "properties": { "api_name": { "description": "Specify the API name of the related module for which the records are transferred.\\nPossible values:\\n**Tasks**\\n**Events**\\n**Calls**\\n**Contacts**\\n**Deals**", "enum": [ "Tasks", "Events", "Calls", "Contacts", "Deals" ], "type": "string" }, "id": { "description": "Specify the record ID of the related module record to transfer to the new owner.", "maxLength": 19, "type": "string" } }, "type": "object" }, "maxItems": 5, "type": "array" } }, "required": [ "owner" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "value": { "data": [ { "code": "SUCCESS", "details": { "id": "475418000007459055" }, "message": "owner is successfully updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Successful owner change response", "properties": { "data": { "description": "Data containing the result of the owner change operation", "items": { "additionalProperties": false, "description": "Represents a successful owner change response.", "properties": { "code": { "description": "Represents the response code indicating the outcome of the request. Possible values: **SUCCESS** - The owner change operation completed successfully.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details of the record for which the owner change was applied.", "properties": { "id": { "description": "Represents the unique identifier of the record for which the owner change was applied.", "maxLength": 19, "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents a brief message confirming the outcome of the owner change operation.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the operation. Possible values: **success** - The owner change operation completed without errors.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "x-zs-$id": "SuccessResponse" } } }, "description": "Returns the result of the owner change operation for the specified record." }, "400": { "content": { "application/json": { "examples": { "ApiNotSupportedError": { "value": { "code": "API_NOT_SUPPORTED", "details": { "supported_version": 3 }, "message": "Change Owner is not supported in this API version", "status": "error" } }, "InactiveOwnerError": { "summary": "New owner's user account is not active", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id", "owner_status": "inactive" }, "message": "The user to whom you are trying to transfer the records is not active.", "status": "error" } }, "InvalidDataError": { "value": { "code": "INVALID_DATA", "details": { "api_name": "owner", "json_path": "$.owner.id" }, "message": "Invalid data provided", "status": "error" } }, "LiteUserOwnerError": { "summary": "New owner is a Lite user", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id" }, "message": "The user to whom you are trying to transfer the records is a Lite User.", "status": "error" } }, "NonSubordinateUser": { "description": "Returned when owner-restriction settings prevent assigning to a non-subordinate user (role hierarchy or territory hierarchy restriction).", "summary": "Owner is not a subordinate of the current user", "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id", "owner_status": "include_subordinate_owners" }, "message": "The user to whom you are trying to transfer the records is not a subordinate.", "status": "error" } }, "NotSupportedError": { "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "The requested operation is not supported", "status": "error" } }, "RecordLockedError": { "description": "Returned when the record is locked, for example by an active Find & Merge operation or a record-locking preference.", "summary": "The record is locked", "value": { "code": "RECORD_LOCKED", "details": { "action": "record_locking", "id": "4987786000003224629" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } }, "ServiceProviderOwnerError": { "summary": "New owner is a Service Provider user not allowed for this module", "value": { "code": "NOT_ALLOWED", "details": { "api_name": "id", "json_path": "$.owner.id" }, "message": "Service Provider User can only be assigned to tasks, meetings, calls, and appointments", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response for unsupported operations or an invalid module.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**NOT_SUPPORTED** - The specified module or operation is not supported.\\n**INVALID_DATA** - The input data is invalid.\\n**INVALID_MODULE** - The module API name in the request URL is invalid.\\n**API_NOT_SUPPORTED** - The Change Owner API is not supported in the requested API version (minimum version 3 required for customer calls).", "enum": [ "NOT_SUPPORTED", "INVALID_DATA", "INVALID_MODULE", "API_NOT_SUPPORTED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the error.", "properties": { "resource_path_index": { "description": "Represents the index of the resource path in the request that caused the error.", "format": "int32", "type": "integer" }, "supported_version": { "description": "Represents the minimum supported API version. Returned with the API_NOT_SUPPORTED error code.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseForUnsupportedOperationsOrInvalidModule" }, { "additionalProperties": false, "description": "Represents an error response for invalid data or a mandatory field that was not found.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**INVALID_DATA** - The input data provided is invalid.\\n**NOT_SUPPORTED** - The specified module or operation is not supported.\\n**MANDATORY_NOT_FOUND** - A required field is missing from the request.", "enum": [ "INVALID_DATA", "NOT_SUPPORTED", "MANDATORY_NOT_FOUND" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional context about the invalid or missing field.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the error.", "maxLength": 500, "type": "string" }, "owner_status": { "description": "Represents the owner-restriction context that triggered the owner validation error. Possible values: **include_subordinate_owners** - Indicates that ownership can be assigned only to users who are subordinates of the current user based on the role or territory hierarchy. **inactive** - Indicates that the new owner's user account is not active. Returned only when the error is caused by a subordinate-owner or inactive-owner permission check.", "maxLength": 200, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "Errorresponseforinvaliddataormandatoryfieldnotfound" }, { "additionalProperties": false, "description": "Represents an error response when a required field in the request is missing.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**EXPECTED_FIELD_MISSING** - A required field in the related modules object is missing from the request.", "enum": [ "EXPECTED_FIELD_MISSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the missing expected fields.", "properties": { "expected_fields": { "description": "Represents the list of expected fields that are missing from the request.", "items": { "additionalProperties": false, "description": "Represents an expected field that is missing from the request.", "properties": { "api_name": { "description": "Represents the API name of the missing expected field.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the missing expected field in the request body.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_fields" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponseformissingexpectedfields" }, { "additionalProperties": false, "description": "Represents an error response when the request contains ambiguous data that cannot be processed.", "properties": { "code": { "description": "Represents the error code indicating the cause of the failure. \\nPossible values:\\n**AMBIGUITY_DURING_PROCESSING** - The request contains ambiguous data that cannot be resolved.", "enum": [ "AMBIGUITY_DURING_PROCESSING" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the details about the ambiguous data in the request.", "properties": { "ambiguity_due_to": { "description": "Represents the list of fields that contain ambiguous values in the request.", "items": { "additionalProperties": false, "description": "Represents a field that contains ambiguous data in the request.", "properties": { "api_name": { "description": "Represents the API name of the field containing ambiguous data.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field containing ambiguous data in the request body.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "ambiguity_due_to" ], "type": "object" }, "message": { "description": "Represents the error message describing the issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponseforambiguousdataduringprocessing" }, { "additionalProperties": false, "description": "Returned when the record is in a stop-processing state and the Change Owner action is blocked.", "properties": { "code": { "description": "Error code indicating the record is in a stop-processing state. Possible values: **CANNOT_PROCESS** - The record's privacy settings block the Change Owner action.", "enum": [ "CANNOT_PROCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the affected record.", "properties": { "id": { "description": "The ID of the record that is in stop-processing state.", "maxLength": 19, "type": "string" }, "index": { "description": "The zero-based index of the record in the request.", "format": "int32", "type": "integer" } }, "type": "object" }, "message": { "description": "Error message describing why the Change Owner action was blocked.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseForRecordInStopProcessingState" }, { "additionalProperties": false, "description": "Returned when the record is locked (for example, by an active Find & Merge operation or a record-locking preference) and the Change Owner action is blocked.", "properties": { "code": { "description": "Error code indicating the record is locked. Possible values: **RECORD_LOCKED** - The record is locked and cannot be reassigned.", "enum": [ "RECORD_LOCKED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the locked record.", "properties": { "action": { "description": "The action that caused the locking conflict, for example **merge** or **record_locking**.", "maxLength": 100, "type": "string" }, "id": { "description": "The ID of the locked record.", "maxLength": 19, "type": "string" } }, "required": [ "id", "action" ], "type": "object" }, "message": { "description": "Error message describing why the Change Owner action was blocked.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseForRecordLockedSingle" }, { "additionalProperties": false, "description": "Returned when the new owner is a Service Provider user and the target module does not allow Service Provider ownership.", "properties": { "code": { "description": "Error code indicating the ownership restriction. Possible values: **NOT_ALLOWED** - Service Provider users can only be assigned as owner of Tasks, Events, Calls, and Appointments.", "enum": [ "NOT_ALLOWED" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the owner field that caused the error.", "properties": { "api_name": { "description": "Represents the API name of the field that caused the error.", "maxLength": 200, "type": "string" }, "json_path": { "description": "Represents the JSON path to the field in the request body that caused the error.", "maxLength": 500, "type": "string" } }, "required": [ "api_name", "json_path" ], "type": "object" }, "message": { "description": "Error message describing the ownership restriction.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseForServiceProviderOwnerRestriction" } ], "x-zs-$id": "MutipleErrorResponses" } } }, "description": "Invalid request. The module is unsupported, the data is invalid, or a required field is missing.\\n**Resolution:** The module API name in the request URL must be valid and the owner ID must be specified correctly." }, "403": { "content": { "application/json": { "examples": { "ClosedOrDeletedUserError": { "value": { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.owner.id", "owner_status": "deleted" }, "message": "The user to whom you are trying to transfer the records has closed their account.", "status": "error" } }, "NoPermissionError": { "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_Change_Owner_Leads" ] }, "message": "You do not have permission to perform this operation", "status": "error" } } }, "schema": { "anyOf": [ { "additionalProperties": false, "description": "Represents an error response when the user lacks the required permission to change record ownership.", "properties": { "code": { "description": "Represents the error code indicating the cause of the permission failure. \\nPossible values:\\n**NO_PERMISSION** - The user's CRM profile lacks the required permission to change record ownership.", "enum": [ "NO_PERMISSION" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents the additional details about the missing permissions.", "properties": { "permissions": { "description": "Represents the list of required permissions that the user's profile is missing.", "items": { "description": "Represents the name of a required permission that is missing from the user's profile.", "maxLength": 200, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Represents the error message describing the permission issue.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. \\nPossible values:\\n**error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "Errorresponsewhenuserlacksrequiredpermissions" }, { "additionalProperties": false, "description": "Represents the error response returned when the Change Owner operation is not allowed for the specified module even though the user has the required permission.", "properties": { "code": { "description": "Represents the error code indicating that the Change Owner operation cannot be performed on the module. Possible values: **CANNOT_PERFORM_ACTION** - The specified module does not permit the Change Owner action.", "enum": [ "CANNOT_PERFORM_ACTION" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Represents additional context about the operation that is not allowed on the module.", "type": "object" }, "message": { "description": "Represents the error message describing why the Change Owner operation cannot be performed on the specified module.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **error** - The request encountered an error and did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseWhenOperationNotAllowedForModuleCannotPerformAction" }, { "additionalProperties": false, "description": "Error response for transferee with no module permission", "properties": { "code": { "description": "Error code indicating the type of error", "enum": [ "CANNOT_ASSIGN" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional details about the error", "properties": { "permissions": { "description": "List of permissions that the transferee lacks for the module, causing the error", "items": { "description": "Permission name that the transferee lacks for the module", "maxLength": 250, "type": "string" }, "maxItems": 1, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "message": { "description": "Error message describing the issue", "maxLength": 500, "type": "string" }, "status": { "description": "Status of the response", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseForTransfereeNoModulePermission" }, { "additionalProperties": false, "description": "Returned when the target user account is closed or deleted.", "properties": { "code": { "description": "Error code indicating the target user is closed or deleted. Possible values: **INVALID_DATA** - The supplied owner ID refers to a closed or deleted user.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Additional context identifying the invalid owner field.", "properties": { "api_name": { "description": "The API name of the field that contains the invalid owner reference.", "maxLength": 200, "type": "string" }, "json_path": { "description": "The JSON path to the field that contains the invalid owner reference.", "maxLength": 500, "type": "string" }, "owner_status": { "description": "Indicates the state of the target user. Possible values: **deleted** - The user account is closed or deleted.", "enum": [ "deleted" ], "type": "string" } }, "required": [ "api_name", "json_path", "owner_status" ], "type": "object" }, "message": { "description": "Error message describing why the owner assignment was rejected.", "maxLength": 500, "type": "string" }, "status": { "description": "Response status. Possible values: **error** - The operation did not complete.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "ErrorResponseForClosedOrDeletedTargetUser" } ], "x-zs-$id": "ErrorResponse403" } } }, "description": "Permission denied to change record ownership in this module.\\n**Resolution:** The CRM administrator must grant the required permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.change_owner.CREATE" ] } ], "summary": "Change Owner", "tags": [ "change_owner" ], "x-zoho-document": "change_owner" } }, "/crm/v8/{module}/{record}/actions/remove_territories": { "post": { "description": "To remove one or more territories from a single record in your Zoho CRM organization. This operation is supported for records in the Leads, Accounts, Contacts, and Deals modules.", "operationId": "removeTerritoriesFromRecord", "parameters": [ { "$ref": "#/components/parameters/TerritoriesRecord", "description": "The unique ID of the record from which to remove territories." }, { "$ref": "#/components/parameters/TerritoriesModule", "description": "The API name of the module that contains the record." } ], "requestBody": { "content": { "application/json": { "examples": { "RemoveTerritoriesSuccess": { "summary": "Remove territories from a single record", "value": { "data": [ { "Territories": [ { "id": "123456712345623456" }, { "id": "123456712345623467" } ] } ] } } }, "schema": { "additionalProperties": false, "description": "Specify the territories and the record from which they are to be removed.", "properties": { "data": { "description": "Specify the list of records and their associated territories to remove from the record.", "items": { "additionalProperties": false, "description": "Specify the record and its associated territories to remove.", "properties": { "Territories": { "description": "Specify the list of territories to remove from the record.", "items": { "additionalProperties": false, "description": "Specify a territory object containing the unique territory ID to remove from the record.", "properties": { "id": { "description": "Specify the unique ID of the territory to remove from the record.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getTerritories", "propertyId": "TerritoriesId" } ], "resource": "territories" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" }, "id": { "description": "Specify the unique ID of the record from which to remove territories.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecord", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "Territories" ], "type": "object", "x-zs-$id": "RemoveTerritoriesFromRecordRequestDataItem" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "RemoveTerritoriesFromRecordRequestBody" }, "x-zs-llm-examples": [ "RemoveTerritoriesSuccess" ] } }, "description": "The request body must contain a **data** array with one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "RemoveTerritoriesSuccess": { "summary": "Successful territory removal from a record", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "5319055000000750908" }, "message": "the territories data removed successfully", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/TerritoryRemoveRecordSuccessResponse" } } }, "description": "Returns the result of the territory removal when the operation completes synchronously." }, "202": { "content": { "application/json": { "examples": { "AutoGeneratedExample": { "summary": "Scheduled territory removal from a record", "value": { "data": [ { "code": "SCHEDULED", "details": { "id": "2345678234534545", "job_id": "482367546723546372" }, "message": "Territory removal process scheduled successfully", "status": "success" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryRemoveRecordScheduledResponse" }, { "$ref": "#/components/schemas/TerritoryRemoveRecordSuccessResponse" } ], "description": "Returns a scheduled or synchronous response when territories are removed from a record.", "x-zs-$id": "TerritoryRemoveRecordResponse" } } }, "description": "Returns a scheduled response indicating that the territory removal job was queued successfully. The **code** field is set to **SCHEDULED**, and the **details** object contains the record ID and the job ID." }, "400": { "content": { "application/json": { "examples": { "InvalidDataErrorOnDelete": { "summary": "Removing a territory not assigned to the record", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].Territories[1].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "InvalidTerritoryIdError": { "summary": "Invalid territory ID in the removal request", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": " $.data[0].Territories[1].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } }, "LimitExceededOnAssign": { "summary": "Territory limit exceeded for the record", "value": { "data": [ { "code": "LIMIT_EXCEEDED", "details": { "api_name": "Territories", "json_path": "$.data[0].Territories", "limit": 10 }, "message": "Maximum limit of territories for that record exceeds", "status": "error" } ] } }, "MandatoryNotFoundError": { "summary": "Mandatory parameter missing from the request", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "id", "json_path": " $.data[0].Territories[1].id" }, "message": "required field not found", "status": "error" } ] } }, "NotSupportedError": { "summary": "Territory removal not supported for the specified module", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "the api is not supported for this module", "status": "error" } }, "TerritoryNotEnabled": { "summary": "Territory management not enabled for the organization", "value": { "code": "FEATURE_NOT_ENABLED", "details": {}, "message": "Territory Management is not enabled", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignInvalidDataTerritoryId" }, { "$ref": "#/components/schemas/TerritoryAssignInvalidDataOnURL" }, { "$ref": "#/components/schemas/TerritoryAssignMandatoryNotFound" }, { "$ref": "#/components/schemas/TerritoryFeatureNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryAssignNotSupported" }, { "$ref": "#/components/schemas/TerritoryRemoveSystemAssignedNotAllowed" }, { "$ref": "#/components/schemas/TerritoryAssignAlreadyUsed" }, { "$ref": "#/components/schemas/TerritoryAssignRecordLockedInURL" }, { "$ref": "#/components/schemas/TerritoryAssignInvalidDataMaxLen" }, { "$ref": "#/components/schemas/InvalidModule" }, { "$ref": "#/components/schemas/TerritoryInvalidUrlPathErrorSchema" }, { "$ref": "#/components/schemas/AssignTerritoryAssignErrorDataObject" } ], "description": "Represents the error response for an invalid or failed territory removal request.", "x-zs-$id": "RemoveTerritoryAssignErrorResponse" } } }, "description": "The territory removal request contains invalid or missing data.\\n**Resolution:** Verify that all required fields are present, the record and territory IDs are valid, the territory is currently assigned to the record, and the record is not locked." }, "401": { "content": { "application/json": { "examples": { "AuthenticationFailure": { "summary": "Authentication failure due to invalid or missing token", "value": { "code": "AUTHENTICATION_FAILURE", "details": {}, "message": "Authentication failed", "status": "error" } }, "NoPermissionForTerritoryId": { "summary": "No permission to add or remove territories for the record", "value": { "data": [ { "code": "NO_PERMISSION", "details": { "api_name": "id", "json_path": "$.data[0].Territories" }, "message": "User has no permission to add / remove the Territories", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryAssignNoPermission" }, { "$ref": "#/components/schemas/UnauthorizedError" } ], "x-zs-$id": "TerritoryRemoveUnauthorizedErrorResponse" } } }, "description": "The access token does not include the required scope or the user does not have permission to remove territories.\\n**Resolution:** A new access token must be generated with the required scope for this API, or the CRM administrator must grant the required permission to the user's profile." }, "403": { "content": { "application/json": { "examples": { "NoPermissionForRecord": { "summary": "No permission to update the record", "value": { "code": "NO_PERMISSION", "details": { "resource_path_index": 1 }, "message": "User has no permission to update the record", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TerritoryNotEnabledError" }, { "$ref": "#/components/schemas/TerritoryRecordNoPermission" } ], "x-zs-$id": "TerritoryRemoveForbiddenErrorResponse" } } }, "description": "Territory management is not enabled for the organization, or the user does not have permission to update the record.\\n**Resolution:** The CRM administrator must enable territory management in the organization settings and grant the required record update permission to the user's profile." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Remove territories from a record", "tags": [ "territories" ], "x-zoho-document": "territories", "x-zs-llm-description": "Available only in Enterprise and above editions. Removes one or more territory associations from a single record in the specified module. The module and record id are passed as URL path parameters. Returns 202 - removals are processed asynchronously. To track the asynchronous job status on a record, use getFeatureSpecificInfo (feature_specific_info.json) with features=territory_scheduled_jobs along with the module and record id. Before triggering Territory CRUD and other territory assignment and user association operations, ensure Territory Management is enabled. Refer to territory_configuration.json (getTerritoryConfiguration, updateTerritoryConfiguration)." } }, "/crm/v8/{module}/{record}/photo": { "delete": { "description": "To delete the photo associated with a specific record in your Zoho CRM organization.", "operationId": "deleteRecordPhoto", "parameters": [ { "$ref": "#/components/parameters/RecordPhotoModule" }, { "$ref": "#/components/parameters/RecordPhotoRecord" }, { "$ref": "#/components/parameters/RestrictTriggers" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful photo delete response with the SUCCESS code and a confirmation message.", "summary": "Delete record photo success", "value": { "code": "SUCCESS", "details": {}, "message": "Photo deleted successfully", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned after a successful photo delete operation.", "properties": { "code": { "description": "Represents the success code for the photo delete operation. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the delete operation.", "type": "object" }, "message": { "description": "Represents the success message describing the result of the delete operation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **success**. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordPhotoDeleteSuccessResponse" } } }, "description": "Returns a success response confirming the record photo delete operation completed." }, "400": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows a 400 error response when the request URL does not match the expected pattern for the photo DELETE endpoint.", "summary": "Delete record photo with invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the photo DELETE request fails due to an invalid URL pattern, data, or module.", "properties": { "code": { "description": "Represents the error code indicating the type of request error. Possible values: **INVALID_URL_PATTERN**, **INVALID_DATA**, **INVALID_MODULE**. ", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_MODULE" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents an empty details object returned when no additional error context is available.", "type": "object", "x-zs-$id": "RecordPhotoDeleteErrorDetailsEmpty" }, { "additionalProperties": false, "description": "Represents the error details containing the invalid identifier that caused the request to fail.", "properties": { "id": { "description": "Represents the invalid identifier that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "RecordPhotoDeleteErrorDetailsInvalidID" }, { "additionalProperties": false, "description": "Represents the error details containing the index of the invalid resource path in the request URL.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource path in the request URL.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "RecordPhotoDeleteErrorDetailsResourcePathIndex" } ], "description": "Represents additional details about the error. Contains the invalid identifier or resource path index when applicable." }, "message": { "description": "Represents the error message describing the request failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordPhotoDeleteErrorResponse" } } }, "description": "The request is invalid due to an incorrect URL pattern, data, or module name.\n**Resolution:** The module API name and record ID in the request URL must be valid." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.DELETE" ] } ], "summary": "Delete a record photo", "tags": [ "record_photo" ], "x-zoho-document": "record_photo", "x-zs-llm-description": "Use this operation to permanently remove the profile photo of a single CRM record in a given module. Before calling this, the LLM agent must first resolve the target module's api_name using the Modules API (getModules) and the target record's id using the Records API (getRecord/getRecords); never guess these values." }, "get": { "description": "To retrieve the photo associated with a specific record in your Zoho CRM organization.", "operationId": "getRecordPhoto", "parameters": [ { "$ref": "#/components/parameters/RecordPhotoModule" }, { "$ref": "#/components/parameters/RecordPhotoRecord" } ], "responses": { "200": { "content": { "image/png": { "schema": { "description": "Represents the binary image data of the record photo.", "format": "binary", "type": "string", "x-zs-$id": "RecordPhotoGetSuccessResponse" } } }, "description": "Returns the binary image data of the record photo as a PNG file." }, "204": { "description": "Indicates that no photo is associated with the specified record." }, "400": { "content": { "application/json": { "examples": { "InvalidUrlPattern": { "description": "Shows a 400 error response when the request URL does not match the expected pattern for the photo retrieval endpoint.", "summary": "Get record photo with invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the photo retrieval request fails due to an invalid URL pattern, data, or module.", "properties": { "code": { "description": "Represents the error code indicating the type of request error. Possible values: **INVALID_URL_PATTERN**, **INVALID_DATA**, **INVALID_MODULE**.", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_MODULE" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents an empty details object returned when no additional error context is available.", "type": "object", "x-zs-$id": "RecordPhotoGetErrorDetailsEmpty" }, { "additionalProperties": false, "description": "Represents the error details containing the invalid identifier that caused the request to fail.", "properties": { "id": { "description": "Represents the invalid identifier that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "RecordPhotoGetErrorDetailsInvalidID" }, { "additionalProperties": false, "description": "Represents the error details containing the index of the invalid resource path in the request URL.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource path in the request URL.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "RecordPhotoGetErrorDetailsResourcePathIndex" } ], "description": "Represents additional details about the error. Contains the invalid identifier or resource path index when applicable." }, "message": { "description": "Represents the error message describing the request failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordPhotoGetErrorResponse" } } }, "description": "The request is invalid due to an incorrect URL pattern, data, or module name.\n**Resolution:** The module API name and record ID in the request URL must be valid." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Get a record photo", "tags": [ "record_photo" ], "x-zoho-document": "record_photo", "x-zs-llm-description": "Use this operation to fetch the profile photo binary of a single CRM record in a given module. Before calling this, the LLM agent must first resolve the target module's api_name using the Modules API (getModules) and the target record's id using the Records API (getRecord/getRecords); never guess these values." }, "post": { "description": "To upload a photo for a specific record in your Zoho CRM organization.", "operationId": "uploadRecordPhoto", "parameters": [ { "$ref": "#/components/parameters/RecordPhotoModule" }, { "$ref": "#/components/parameters/RecordPhotoRecord" }, { "$ref": "#/components/parameters/RestrictTriggers" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "description": "Represents the schema for the photo upload request, containing the photo file in multipart/form-data format.", "properties": { "file": { "description": "Specify the photo file to upload for the record.", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "description": "The request body must be a multipart/form-data payload containing the **file** field with the binary photo data to upload for the record.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful photo upload response with the SUCCESS code and a confirmation message.", "summary": "Upload record photo success", "value": { "code": "SUCCESS", "details": {}, "message": "Photo uploaded successfully", "status": "success" } } }, "schema": { "additionalProperties": false, "description": "Represents the success response returned when the record photo is uploaded successfully.", "properties": { "code": { "description": "Represents the success code for the photo upload operation. Possible values: **SUCCESS**. ", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the upload operation.", "type": "object" }, "message": { "description": "Represents the success message describing the result of the upload operation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the response. Possible values: **success**. ", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordPhotoUploadSuccessResponse" } } }, "description": "Returns a success response confirming that the record photo was uploaded." }, "400": { "content": { "application/json": { "examples": { "CannotPerformAction": { "description": "Shows a 400 error response when the requesting user does not have permission to upload a photo for the specified record.", "summary": "Upload record photo with no permission", "value": { "code": "CANNOT_PERFORM_ACTION", "details": {}, "message": "no permission to perform an action on this record", "status": "error" } }, "InvalidUrlPattern": { "description": "Shows a 400 error response when the request URL does not match the expected pattern for the photo upload endpoint.", "summary": "Upload record photo with invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "UnderApprovalProcess": { "description": "Shows a 400 error response when the record is pending approval and the photo cannot be uploaded until the approval is complete.", "summary": "Upload record photo for record under Approval Process", "value": { "code": "NOT_APPROVED", "details": { "id": "111111000000091057" }, "message": "cannot upload the record image that is not approved yet", "status": "error" } }, "UnderRecordLockingFeature": { "description": "Shows a 400 error response when the record is locked and cannot be modified.", "summary": "Upload record photo for locked record", "value": { "code": "RECORD_LOCKED", "details": { "id": "111111000000091019" }, "message": "Sorry, you cannot perform this operation as the record is locked.", "status": "error" } }, "UnderReviewProcess": { "description": "Shows a 400 error response when the record is under review and the photo cannot be uploaded until the review is complete.", "summary": "Upload record photo for record under review process", "value": { "code": "NOT_REVIEWED", "details": { "id": "111111000000091108" }, "message": "cannot upload the record image that is not reviewed yet", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the photo upload request fails due to an invalid request or a business rule violation.", "properties": { "code": { "description": "Represents the error code indicating the type of request error. Possible values: **INVALID_URL_PATTERN**, **INVALID_DATA**, **INVALID_MODULE**, **CANNOT_PERFORM_ACTION**, **NOT_REVIEWED**, **NOT_APPROVED**, **RECORD_LOCKED**. ", "enum": [ "INVALID_URL_PATTERN", "INVALID_DATA", "INVALID_MODULE", "CANNOT_PERFORM_ACTION", "NOT_REVIEWED", "NOT_APPROVED", "RECORD_LOCKED" ], "type": "string" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/RecordPhotoErrorDetailsEmpty" }, { "additionalProperties": false, "description": "Represents the error details containing the invalid identifier that caused the upload request to fail.", "properties": { "id": { "description": "Represents the invalid identifier that caused the error.", "maxLength": 100, "type": "string" } }, "required": [ "id" ], "type": "object", "x-zs-$id": "RecordPhotoUploadErrorDetailsInvalidID" }, { "additionalProperties": false, "description": "Represents the error details containing the index of the invalid resource path in the request URL.", "properties": { "resource_path_index": { "description": "Represents the index of the invalid resource path in the request URL.", "format": "int32", "type": "integer" } }, "required": [ "resource_path_index" ], "type": "object", "x-zs-$id": "RecordPhotoUploadErrorDetailsResourcePathIndex" } ], "description": "Represents additional details about the error. Contains the invalid identifier or resource path index when applicable." }, "message": { "description": "Represents the error message describing the request failure.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "RecordPhotoUploadErrorResponse" } } }, "description": "The request is invalid due to an incorrect URL pattern, data, module name, or insufficient permissions.\n**Resolution:** The module API name and record ID in the request URL must be valid. The requesting user must have the required permission, and the record must not be locked, under review, or pending approval." }, "413": { "content": { "application/json": { "examples": { "FileSizeExceeds": { "description": "Shows a 413 error response when the uploaded photo file exceeds the maximum allowed size.", "summary": "Upload record photo with file size exceeded", "value": { "code": "FILE_SIZE_EXCEEDS", "details": { "size": 10485760 }, "message": "File exceeded its maximum limit", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the uploaded photo file exceeds the maximum allowed size.", "properties": { "code": { "description": "Represents the error code indicating that the uploaded file exceeds the maximum allowed size. Possible values: **FILE_SIZE_EXCEEDS**. ", "enum": [ "FILE_SIZE_EXCEEDS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Represents additional details about the file size error, including the size of the file that exceeded the limit.", "properties": { "size": { "description": "Represents the size of the uploaded file that exceeded the maximum allowed limit.", "format": "int32", "type": "integer" } }, "required": [ "size" ], "type": "object" }, "message": { "description": "Represents the error message describing the file size violation.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RecordPhotoUploadPayloadTooLargeResponse" } } }, "description": "The uploaded file exceeds the maximum allowed size.\n**Resolution:** The photo file size must be within the maximum allowed limit before uploading." }, "415": { "content": { "application/json": { "examples": { "FileResolutionExceeds": { "description": "Shows a 415 error response when the uploaded photo file resolution exceeds the maximum allowed limit.", "summary": "Upload record photo with file resolution exceeded", "value": { "code": "FILE_RESOLUTION_EXCEEDS", "details": { "resolution": 16062248 }, "message": "File exceeded its maximum limit", "status": "error" } }, "InvalidFileType": { "description": "Shows a 415 error response when the uploaded photo file is not a supported image format.", "summary": "Upload record photo with invalid file type", "value": { "code": "INVALID_DATA", "details": {}, "message": "invalid file type", "status": "error" } } }, "schema": { "additionalProperties": false, "description": "Represents the error response returned when the uploaded photo file has an unsupported format or its resolution exceeds the allowed limit.", "properties": { "code": { "description": "Represents the error code indicating an unsupported media type or invalid file format. Possible values: **FILE_RESOLUTION_EXCEEDS**, **INVALID_DATA**. ", "enum": [ "FILE_RESOLUTION_EXCEEDS", "INVALID_DATA" ], "type": "string" }, "details": { "anyOf": [ { "additionalProperties": false, "description": "Represents the error details containing the file resolution that exceeded the maximum allowed limit.", "properties": { "resolution": { "description": "Represents the resolution of the uploaded file that exceeded the maximum allowed limit.", "format": "int32", "type": "integer" } }, "required": [ "resolution" ], "type": "object", "x-zs-$id": "RecordPhotoUploadFileResolutionExceedsDetails" }, { "$ref": "#/components/schemas/RecordPhotoErrorDetailsEmpty" } ], "description": "Represents additional details about the media type error. Contains the file resolution that exceeded the limit when applicable." }, "message": { "description": "Represents the error message describing the media type or file format issue.", "maxLength": 1000, "type": "string" }, "status": { "description": "Represents the status of the error response. Possible values: **error**. ", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "details", "message", "status" ], "type": "object", "x-zs-$id": "RecordPhotoUploadUnsupportedMediaTypeResponse" } } }, "description": "The uploaded file has an unsupported format or its resolution exceeds the maximum allowed limit.\n**Resolution:** The photo file must be a supported image type and within the maximum allowed resolution." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.CREATE" ] } ], "summary": "Upload a record photo", "tags": [ "record_photo" ], "x-zoho-document": "record_photo", "x-zs-llm-description": "Use this operation to upload or replace the profile photo of a single CRM record in a given module by sending the image file as multipart/form-data. Before calling this, the LLM agent must first resolve the target module's api_name using the Modules API (getModules) and the target record's id using the Records API (getRecord/getRecords); never guess these values." } }, "/crm/v8/{parentRecordModule}/deleted/{parentRecord}/{relatedList}": { "get": { "description": "To retrieve the list of records that were previously associated with a parent record but have since been deleted from the related list in your Zoho CRM organization.", "operationId": "getDeletedRelatedRecord", "parameters": [ { "$ref": "#/components/parameters/RelatedRecordsParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecord" }, { "$ref": "#/components/parameters/RelatedList" }, { "$ref": "#/components/parameters/RelatedRecordsFields" }, { "$ref": "#/components/parameters/RelatedRecordsPage" }, { "$ref": "#/components/parameters/RelatedRecordsPerPage" } ], "responses": { "200": { "content": { "application/json": { "examples": { "DeletedProducts": { "description": "Shows list of deleted product records.", "summary": "List of deleted product records", "value": { "data": [ { "$member_info": { "Created_Time": "2023-10-31T18:10:23+05:30", "Modified_Time": "2023-10-31T18:10:23+05:30", "id": "2423488000000558116" }, "Owner": { "email": "patricia@zoho.com", "id": "2423488000000483001", "name": "Patricia" }, "id": "2423488000000552158" } ], "info": { "count": 1, "more_records": false, "next_page_token": null, "page": 1, "page_token_expiry": null, "per_page": 200, "previous_page_token": null } } } }, "schema": { "additionalProperties": false, "description": "Represents the response for deleted related records, including the record references and pagination metadata.", "properties": { "data": { "description": "Array of deleted related record references.", "items": { "additionalProperties": true, "description": "Represents a deleted related record reference, including its identifier and associated metadata.", "properties": { "$member_info": { "additionalProperties": false, "description": "Metadata about the related record.", "properties": { "Created_Time": { "description": "Represents the creation date and time of the record.", "format": "date-time", "type": "string" }, "Modified_Time": { "description": "Timestamp when the record was last modified.", "format": "date-time", "type": "string" }, "id": { "description": "ID of the member info.", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string" } }, "type": "object" }, "Moved_To__s": { "description": "Stage value to which the record was moved (stage history / picklist movement).", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the deleted record.", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "RelatedRecordsId" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Pagination metadata for deleted records.", "properties": { "count": { "description": "Number of records in current response.", "format": "int32", "minimum": 0, "type": "integer" }, "more_records": { "description": "Indicates if more pages are available.", "type": "boolean" }, "next_page_token": { "description": "Token to retrieve the next page of results.", "maxLength": 500, "type": [ "string", "null" ] }, "page": { "description": "Current page number.", "format": "int32", "minimum": 1, "type": "integer" }, "page_token_expiry": { "description": "Expiration timestamp for the page token.", "format": "date-time", "type": [ "string", "null" ] }, "per_page": { "description": "Number of records per page.", "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" }, "previous_page_token": { "description": "Token to retrieve the previous page of results.", "maxLength": 500, "type": [ "string", "null" ] } }, "required": [ "page", "per_page", "count", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "SuccessResponseForDeletedRelatedRecords" } } }, "description": "Returns the list of deleted related records for the specified parent record, along with pagination metadata." }, "204": { "description": "No deleted related records were found for the specified parent record." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows an authorization failure response when the access token lacks the required read privilege.", "summary": "Insufficient privilege to read related records data", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to read related records data", "status": "error" } }, "InvalidDataError": { "description": "Shows an invalid data error response when a related record ID in the request is invalid.", "summary": "Invalid data or related ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNameError": { "description": "Shows an invalid data error response when the related list name in the request is invalid.", "summary": "Invalid data or related name", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related name given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows an error response when the module name in the request URL is not a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The given module is not supported", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an error response when the HTTP method used does not match the supported method for this endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "NotSupported": { "description": "Shows module not supported in API.", "summary": "Module not supported in API", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "The given module is not supported in API", "status": "error" } }, "RequiredParamMissing": { "description": "Shows a required parameter is missing.", "summary": "A required parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidModuleError" }, { "$ref": "#/components/schemas/RelatedRecordsNotSupportedError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RelatedRecordsAuthorizationFailedError" }, { "$ref": "#/components/schemas/RelatedRecordsRequiredParamMissingError" } ], "description": "Contains one of the possible client error responses for invalid module name, unsupported module, invalid data, invalid request method, or authorization failure. May also indicate a missing required parameter.", "x-zs-$id": "GetDeletedRelatedRecord400ErrorResponse" } } }, "description": "The request contains invalid input, an unsupported module, or an invalid request method.\n**Resolution:** Review the error code and message in the response to identify the specific issue." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows invalid authentication token.", "summary": "Invalid authentication token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid OAuth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows missing DELETE scope.", "summary": "Missing DELETE scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token you have used to make this API call does not have the required scope.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidTokenError" }, { "$ref": "#/components/schemas/RelatedRecordsOAuthScopeMismatchError" } ], "description": "Contains one of the possible unauthorized access error responses for invalid token or OAuth scope mismatch.", "x-zs-$id": "GetDeletedRelatedRecords401ErrorResponse" } } }, "description": "Authentication failed due to an invalid or expired token.\n**Resolution:** A valid access token must be provided in the Authorization header." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows no permission to read related records.", "summary": "No permission to read related records", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to read related records", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsNoPermissionError", "x-zs-$id": "NoPermissionError" } } }, "description": "The access token does not have permission to read related records in this module.\n**Resolution:** The CRM administrator must grant the required read permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "description": "Shows invalid URL pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "RecordNotFound": { "description": "Shows a not-found error response when the specified parent record does not exist.", "summary": "Parent record not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "The record does not exist", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidUrlPatternError" } ], "description": "Contains one of the possible not-found error responses for record not found or invalid URL pattern.", "x-zs-$id": "RecordNotFoundErrorForDeletedRecords" } } }, "description": "The specified parent record does not exist.\n**Resolution:** The **parentRecord** path parameter value must refer to an existing record." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows unexpected server error.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Unexpected and unhandled exception in Server", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsInternalError", "x-zs-$id": "InternalError" } } }, "description": "An internal server error occurred.\n**Resolution:** Retry the request after a brief delay. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "List deleted related records", "tags": [ "related_records" ], "x-zoho-document": "related_records" } }, "/crm/v8/{parentRecordModule}/{parentRecordId}/Notes": { "delete": { "description": "Deletes one or more notes associated with a specific parent record using comma-separated note IDs in the query parameter.", "operationId": "deleteBulkNotes", "parameters": [ { "$ref": "#/components/parameters/RelatedNotesParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecordId" }, { "$ref": "#/components/parameters/RelatedNotesIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "BulkDeletion": { "description": "Shows a successful bulk deletion response with action status for each note deleted in the request.", "summary": "Multiple notes successfully deleted", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4876876000006021002" }, "message": "record deleted", "status": "success" }, { "code": "SUCCESS", "details": { "id": "4876876000006021003" }, "message": "record deleted", "status": "success" } ] } }, "SuccessfulDeletion": { "description": "Shows a successful deletion response with action status for a single deleted note.", "summary": "Single note successfully deleted", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4876876000006021002" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for bulk note deletion, containing the action status for each deleted note.", "properties": { "data": { "description": "JSON array representing the list of action status objects for each note deleted in this request.", "items": { "additionalProperties": false, "description": "Represents the action status for an individual note deletion.", "properties": { "code": { "description": "The result code indicating the outcome of the requested note deletion.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the deleted note record.", "properties": { "id": { "description": "Represents the unique identifier of the deleted note.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for this requested note deletion", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this requested note deletion.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteNotesResponse" } } }, "description": "Returns the action status for each deleted note." }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "description": "Shows a 207 mixed-status response where some notes were deleted successfully and others failed.", "summary": "Partial success - some notes deleted, some failed", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "111111000000116001" }, "message": "record deleted", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "111111000000116002" }, "message": "record not deleted", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Mixed-status response for bulk note deletion where some notes were deleted successfully and others failed.", "properties": { "data": { "description": "Represents the list of mixed action status objects for each note in this request.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful note deletion result with action status and note identifier.", "properties": { "code": { "description": "The result code indicating the outcome of deleting the requested note.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the deleted note record.", "properties": { "id": { "description": "Represents the unique identifier of the deleted note.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for deleting the requested note.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of deleting the note.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "DeleteNoteSuccessResult" }, { "additionalProperties": false, "description": "Failed note deletion result with error code and details.", "properties": { "code": { "description": "Represents the error code for this note deletion failure.", "enum": [ "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the note deletion error.", "properties": { "id": { "description": "Represents the identifier of the note that failed to delete.", "format": "int64", "type": "string" } }, "type": "object" }, "message": { "description": "Represents the error message for failure of the requested note deletion.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of failure of note deletion.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "DeleteNoteErrorResult" } ], "description": "Represents an individual note deletion result, which may be a success or an error." }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteNotesMultiStatusResponse207" } } }, "description": "Returns mixed results where some notes were deleted successfully and others failed." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/RelatedNotesRequiredParamMissingError" }, { "$ref": "#/components/schemas/RelatedNotesInvalidDataError" } ], "description": "Validation error response for the DELETE bulk notes request.", "x-zs-$id": "DeleteNotesBadRequestError" } } }, "description": "The request parameters are invalid. **Resolution:** Ensure the ids parameter contains valid note IDs that belong to the specified parent record." }, "401": { "$ref": "#/components/responses/RelatedNotesUnauthorized" }, "404": { "$ref": "#/components/responses/RelatedNotesNotFound" }, "500": { "$ref": "#/components/responses/RelatedNotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.modules.notes.DELETE" ] } ], "summary": "Related Notes", "tags": [ "related_notes" ], "x-zoho-document": "related_notes", "x-zs-llm-description": "Deletes multiple related notes using ids query parameter under a parent-scoped path. Prefer this when removing several notes at once; inspect 207 responses for per-id success or failure." }, "get": { "description": "Retrieves a paginated list of notes associated with a specific parent record in a CRM module.", "operationId": "getNotes", "parameters": [ { "$ref": "#/components/parameters/RelatedNotesParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecordId" }, { "$ref": "#/components/parameters/RelatedNotesFields" }, { "$ref": "#/components/parameters/RelatedNotesPage" }, { "$ref": "#/components/parameters/RelatedNotesPerPage" }, { "$ref": "#/components/parameters/RelatedNotesSortBy" }, { "$ref": "#/components/parameters/RelatedNotesSortOrder" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful response listing notes associated with the specified parent record, including attachment and pagination details.", "summary": "Success response for status 200", "value": { "data": [ { "$attachments": [ { "$file_id": "2rsp48b6960fb9f4d444dada8740791775f35", "File_Name": "20251117_194524.jpg", "Size": "1623514", "id": "1043386000020248003" } ], "Created_Time": "2025-11-14T11:54:12+05:30", "Modified_Time": "2025-11-19T19:27:53+05:30", "Note_Content": "sdf", "Note_Title": null, "Owner": { "email": "prasanna.saravanan@zohocorp.com", "id": "1043386000000322001", "name": "Prasanna" }, "Parent_Id": { "id": "1043386000019763257", "module": { "api_name": "Leads", "id": "1043386000000002175" }, "name": "a" }, "id": "1043386000020244003" } ], "info": { "count": 1, "more_records": false, "next_page_token": null, "page": 1, "page_token_expiry": null, "per_page": 200, "previous_page_token": null } } } }, "schema": { "additionalProperties": false, "description": "Response payload containing the list of note records and pagination metadata for the specified parent record.", "properties": { "data": { "description": "Represents the list of note records returned for the specified parent record.", "items": { "additionalProperties": true, "description": "Represents an individual note record associated with the parent record.", "properties": { "$attachments": { "description": "Represents the list of file attachments associated with the note.", "items": { "additionalProperties": true, "description": "Specifies an individual file attachment associated with the note.", "properties": { "$file_id": { "description": "Specifies the unique file identifier of the attachment.", "maxLength": 255, "type": "string" }, "File_Name": { "description": "Specifies the name of the attached file.", "maxLength": 255, "type": "string" }, "Size": { "description": "Represents the size of the attached file in bytes.", "format": "int64", "type": "string" }, "id": { "description": "Indicates the unique identifier of the attachment record.", "format": "int64", "type": "string" } }, "type": "object" }, "maxItems": 5, "type": [ "array", "null" ] }, "Note_Content": { "description": "The content of the note.", "maxLength": 65535, "type": [ "string", "null" ] }, "Note_Title": { "description": "Represents the title of the note.", "maxLength": 255, "type": [ "string", "null" ] }, "Parent_Id": { "additionalProperties": false, "description": "Represents the parent record associated with the note.", "properties": { "id": { "description": "Specify the unique ID of the parent record. Refer to Refer the [GET Records API](record.yaml#.$path./{module}.get) to get valid record IDs.", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the module of the parent record.", "properties": { "api_name": { "description": "Represents the API name of the parent record module. Refer to [Get Modules](modules.yaml#$.paths./settings/modules.get) for the list of supported modules.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the parent record module.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Represents the name of the parent record.", "maxLength": 255, "type": "string" } }, "required": [ "module", "id", "name" ], "type": "object" }, "id": { "description": "Represents the unique identifier of the note.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Represents the pagination metadata for this response.", "properties": { "count": { "description": "The number of note records returned in the current page.", "format": "int32", "type": "integer" }, "more_records": { "description": "Represents whether more note records are available beyond the current page.", "type": "boolean" }, "next_page_token": { "description": "Indicates the token used to retrieve the next page of results.", "maxLength": 1024, "type": [ "string", "null" ] }, "page": { "description": "Specifies the current page number.", "format": "int32", "type": "integer" }, "page_token_expiry": { "description": "Represents the expiry date and time of the page tokens.", "format": "date-time", "type": [ "string", "null" ] }, "per_page": { "description": "Represents the number of records returned per page.", "format": "int32", "type": "integer" }, "previous_page_token": { "description": "Represents the token used to retrieve the previous page of results.", "maxLength": 500, "type": [ "string", "null" ] } }, "required": [ "page", "per_page", "count", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "GetNotesResponse" } } }, "description": "Returns the list of notes associated with the specified parent record." }, "204": { "$ref": "#/components/responses/RelatedNotesNoContent" }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/RelatedNotesRequiredParamMissingError" }, { "$ref": "#/components/schemas/RelatedNotesDiscretePaginationLimitExceededError" } ], "description": "Validation error response for the GET notes request.", "x-zs-$id": "GetNotesBadRequestError" } } }, "description": "The request parameters are invalid. Resolution: Ensure the module name, parent record ID, and query parameters are valid." }, "401": { "$ref": "#/components/responses/RelatedNotesUnauthorized" }, "404": { "$ref": "#/components/responses/RelatedNotesNotFound" }, "500": { "$ref": "#/components/responses/RelatedNotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.modules.notes.READ" ] } ], "summary": "Related Notes", "tags": [ "related_notes" ], "x-zoho-document": "related_notes", "x-zs-llm-description": "Use this endpoint when notes are scoped to a known parent record. Always pass parentRecordModule and parentRecordId from the same record context, and use fields to limit payload size when only specific note fields are needed." }, "post": { "description": "Creates one or more notes associated with a specific parent record. Either note content or note title must be provided (at least one is mandatory).", "operationId": "createNotes", "parameters": [ { "$ref": "#/components/parameters/RelatedNotesParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "CreateNote": { "description": "Shows a sample POST request body for creating a note with a title, content, and parent record reference.", "summary": "Sample request body for creating a note for a lead", "value": { "data": [ { "Note_Content": "Need to do further tracking", "Note_Title": "Contacted", "Parent_Id": { "id": "4876876000005996165", "module": { "api_name": "Leads", "id": "4876876000000002175" } } } ] } } }, "schema": { "additionalProperties": false, "description": "Request payload for creating one or more notes.", "properties": { "data": { "description": "A JSON array containing the notes to create.", "items": { "additionalProperties": true, "description": "A note object containing the title, content, and parent record information.", "properties": { "Note_Content": { "description": "Specify the content of the note.", "maxLength": 65535, "type": "string" }, "Note_Title": { "description": "Provide the title of the note.", "maxLength": 120, "type": "string" }, "Parent_Id": { "additionalProperties": false, "description": "Specify the parent record for this note.", "properties": { "id": { "description": "Specify the unique ID of the parent record. Refer to Refer the [GET Records API](record.yaml#.$path./{module}.get) to get valid record IDs.", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the details of the requested module. It is mandatory to specify either the API name or the unique ID of the requested module. Refer to [GET Modules API](modules.yaml#$.paths./settings/modules.get) to get the details.", "properties": { "api_name": { "description": "Specify the API name of the parent record module. Refer to [Get Modules](modules.yaml#$.paths./settings/modules.get) for the list of supported modules.", "maxLength": 50, "type": "string" }, "id": { "description": "Specify the unique identifier of the parent record module.", "format": "int64", "type": "string" } }, "type": "object" } }, "required": [ "module", "id" ], "type": "object" } }, "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object" }, "x-zs-llm-examples": [ "CreateNote" ] } }, "description": "The request body must contain a data array with one or more note objects.", "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "SuccessfulCreation": { "description": "Shows a successful 201 response with the action status for each newly created note.", "summary": "Success response for status 201", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:07+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T16:45:07+05:30", "id": "4876876000006021002" }, "message": "record added", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for note creation, containing the action status for each created note.", "properties": { "data": { "description": "JSON array representing the list of action status objects for each note created in this request.", "items": { "additionalProperties": false, "description": "Represents the action status for an individual note creation.", "properties": { "code": { "description": "Represents the result code for this note creation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the created note record.", "properties": { "Created_By": { "additionalProperties": false, "description": "Specifies the user who created the note.", "properties": { "id": { "description": "Indicaates the ID of the user who created the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who created the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the creation date and time of the note.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified the note.", "properties": { "id": { "description": "Represents the ID of the user who last modified the note.", "format": "int64", "type": "string" }, "name": { "description": "Specifies the name of the user who last modified the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Specifies the date and time when the note was last modified.", "format": "date-time", "type": "string" }, "id": { "description": "The unique identifier of the created note.", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Represents the result message for this note creation.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this note creation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CreateNotesResponse" } } }, "description": "Returns the action status for each newly created note." }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "description": "Shows a 207 mixed-status response where some notes were created successfully and others failed validation.", "summary": "Partial success - some notes created, some failed", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Created_Time": "2026-01-05T14:27:48+05:30", "Modified_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Modified_Time": "2026-01-05T14:27:48+05:30", "id": "111111000000116018" }, "message": "record added", "status": "success" }, { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "Note_Content", "json_path": "$.data[1].Note_Content" }, { "api_name": "Note_Title", "json_path": "$.data[1].Note_Title" } ] }, "message": "should contain either content or title", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Mixed-status response for note creation where some notes were created successfully and others failed.", "properties": { "data": { "description": "JSON array representing the list of mixed action status objects for each note in this request.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful note creation result with action status and note details.", "properties": { "code": { "description": "Represents the result code for this note creation.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the created note record.", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the user who created the note.", "properties": { "id": { "description": "Represents the ID of the user who created the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who created the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the creation date and time of the note.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified the note.", "properties": { "id": { "description": "Represents the ID of the user who last modified the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who last modified the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Represents the date and time when the note was last modified.", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique identifier of the created note.", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Represents the result message for this note creation.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this note creation.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateNoteSuccessResult" }, { "additionalProperties": false, "description": "Failed note creation result with error code and details.", "properties": { "code": { "description": "Represents the error code for this note creation failure.", "enum": [ "EXPECTED_FIELD_MISSING", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the note creation error.", "type": "object" }, "message": { "description": "Represents the error message for this note creation failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this note creation failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "CreateNoteErrorResult" } ], "description": "Represents an individual note creation result, which may be a success or an error." }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "CreateNotesMultiStatusResponse207" } } }, "description": "Returns mixed results where some notes were created successfully and others failed validation." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/RelatedNotesExpectedFieldMissingError" }, { "$ref": "#/components/schemas/RelatedNotesInvalidDataError" }, { "$ref": "#/components/schemas/RelatedNotesNotAllowedError" }, { "$ref": "#/components/schemas/RelatedNotesFileSizeExceedsError" } ], "description": "Validation error response for the POST create notes request.", "x-zs-$id": "CreateNotesBadRequestError" } } }, "description": "The request data is invalid. Resolution: Ensure the request body contains valid field values, and that at least one of Note_Title or Note_Content is provided." }, "401": { "$ref": "#/components/responses/RelatedNotesUnauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedNotesNoPermissionError" } } }, "description": "Permission denied to create notes. Resolution: Verify that the OAuth token includes the ZohoCRM.modules.notes.CREATE scope." }, "404": { "$ref": "#/components/responses/RelatedNotesNotFound" }, "500": { "$ref": "#/components/responses/RelatedNotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.modules.notes.CREATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.modules.notes.CREATE" ] } ], "summary": "Related Notes", "tags": [ "related_notes" ], "x-zoho-document": "related_notes", "x-zs-llm-description": "Creates related notes under a specific parent record path. For each item, include at least one of Note_Content or Note_Title. Use this when creating notes in parent-context flows instead of the module-level notes endpoint." }, "put": { "description": "Updates one or more notes associated with a specific CRM record in your Zoho CRM organization. Either note content or note title must be provided (at least one is mandatory) for each note.", "operationId": "updateBulkNotes", "parameters": [ { "$ref": "#/components/parameters/RelatedNotesParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecordId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateMultipleNotes": { "description": "Shows a sample PUT request body for updating multiple notes with their IDs, titles, and content.", "summary": "Sample request body for bulk-updating notes", "value": { "data": [ { "Note_Content": "Customer requested additional information", "Note_Title": "Follow-up Completed", "id": "4876876000006021002" }, { "Note_Content": "Discussed project requirements", "Note_Title": "Meeting Notes", "id": "4876876000006021003" } ] } } }, "schema": { "additionalProperties": false, "description": "Request payload for updating one or more notes.", "properties": { "data": { "description": "Specify the notes to update.", "items": { "additionalProperties": true, "description": "A note object containing the ID and the fields to update.", "properties": { "Note_Content": { "description": "Specify the updated content of the note.", "maxLength": 65535, "type": "string" }, "Note_Title": { "description": "Specify the updated title of the note.", "maxLength": 120, "type": "string" }, "id": { "description": "Specify the unique identifier of the note to update.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateMultipleNotes" ] } }, "description": "The request body must contain a data array with one or more note objects, each including a valid note ID.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpdate": { "description": "Shows a successful bulk note update response with the action status for each updated note.", "summary": "Success response for status 200", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:07+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T17:30:15+05:30", "id": "4876876000006021002" }, "message": "record updated", "status": "success" }, { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:08+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T17:30:16+05:30", "id": "4876876000006021003" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for bulk note update, containing the action status for each updated note.", "properties": { "data": { "description": "Represents the list of action status objects for each note updated in this request.", "items": { "additionalProperties": false, "description": "Represents the action status for an individual note update.", "properties": { "code": { "description": "Represents the result code for this note update.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the updated note record.", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the user who created the note.", "properties": { "id": { "description": "Represents the ID of the user who created the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who created the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the creation date and time of the note.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified the note.", "properties": { "id": { "description": "Represents the ID of the user who last modified the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who last modified the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Represents the date and time when the note was last modified.", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique identifier of the updated note.", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Indicates the result message for this note update.", "maxLength": 500, "type": "string" }, "status": { "description": "Specifies the status of this note update.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UpdateNotesResponse" } } }, "description": "Returns the action status for each updated note." }, "207": { "content": { "application/json": { "examples": { "PartialSuccess": { "description": "Shows a 207 mixed-status response where some notes were updated successfully and others failed validation.", "summary": "Partial success - some notes updated, some failed", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Created_Time": "2026-01-05T14:27:48+05:30", "Modified_By": { "id": "111111000000059489", "name": "Prasanna CEO" }, "Modified_Time": "2026-01-05T14:27:48+05:30", "id": "111111000000116018" }, "message": "record updated", "status": "success" }, { "code": "EXPECTED_FIELD_MISSING", "details": { "expected_fields": [ { "api_name": "Note_Content", "json_path": "$.data[1].Note_Content" }, { "api_name": "Note_Title", "json_path": "$.data[1].Note_Title" } ] }, "message": "should contain either content or title", "status": "error" } ] } } }, "schema": { "additionalProperties": false, "description": "Mixed-status response for bulk note update where some notes were updated successfully and others failed.", "properties": { "data": { "description": "Represents the list of mixed action status objects for each note in this request.", "items": { "anyOf": [ { "additionalProperties": false, "description": "Successful note update result with action status and note details.", "properties": { "code": { "description": "Represents the result code for this note update.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the updated note record.", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the user who created the note.", "properties": { "id": { "description": "Represents the ID of the user who created the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who created the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the creation date and time of the note.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified the note.", "properties": { "id": { "description": "Represents the ID of the user who last modified the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who last modified the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Represents the date and time when the note was last modified.", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique identifier of the updated note.", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Represents the result message for this note update.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this note update.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateNoteSuccessResult" }, { "additionalProperties": false, "description": "Failed note update result with error code and details.", "properties": { "code": { "description": "Represents the error code for this note update failure.", "enum": [ "EXPECTED_FIELD_MISSING", "MANDATORY_NOT_FOUND", "INVALID_DATA" ], "type": "string" }, "details": { "additionalProperties": true, "description": "Contains additional details about the note update error.", "type": "object" }, "message": { "description": "Represents the error message for this note update failure.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this note update failure.", "enum": [ "error" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object", "x-zs-$id": "UpdateNoteErrorResult" } ], "description": "Represents an individual note update result, which may be a success or an error." }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UpdateNotesMultiStatusResponse207" } } }, "description": "Returns mixed results where some notes were updated successfully and others failed." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/RelatedNotesExpectedFieldMissingError" }, { "$ref": "#/components/schemas/RelatedNotesMandatoryNotFoundError" }, { "$ref": "#/components/schemas/RelatedNotesInvalidDataError" }, { "$ref": "#/components/schemas/RelatedNotesNotAllowedError" }, { "$ref": "#/components/schemas/RelatedNotesCannotPerformActionError" } ], "description": "Validation error response for the PUT bulk update notes request.", "x-zs-$id": "UpdateNotesBadRequestError" } } }, "description": "The request data is invalid. Resolution: Ensure each note object includes a valid ID and at least one of Note_Title or Note_Content." }, "401": { "$ref": "#/components/responses/RelatedNotesUnauthorized" }, "404": { "$ref": "#/components/responses/RelatedNotesNotFound" }, "500": { "$ref": "#/components/responses/RelatedNotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.modules.notes.UPDATE" ] } ], "summary": "Related Notes", "tags": [ "related_notes" ], "x-zoho-document": "related_notes", "x-zs-llm-description": "Bulk-updates notes for a specific parent record. Each item must include note id and at least one of Note_Content or Note_Title. Use this for batch edits when multiple related notes need updates in one call." } }, "/crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}": { "delete": { "description": "Deletes a specific note record associated with a parent record using the note ID in the path.", "operationId": "deleteRelatedNoteById", "parameters": [ { "$ref": "#/components/parameters/RelatedNotesParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecordId" }, { "$ref": "#/components/parameters/NoteId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDeletion": { "description": "Shows a successful deletion response with the action status for the deleted note.", "summary": "Success response for status 200", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4876876000006021002" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for single note deletion, containing the action status and identifier of the deleted note.", "properties": { "data": { "description": "A JSON array representing the list of action status objects for the deleted note.", "items": { "additionalProperties": false, "description": "Represents the action status for the note deletion.", "properties": { "code": { "description": "The result code indicating the outcome of the requested note deletion.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the deleted note record.", "properties": { "id": { "description": "Represents the unique identifier of the deleted note.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "message": { "description": "Represents the result message for deleting the requested note.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this note deletion.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "DeleteNotesResponse200" } } }, "description": "Returns the action status for the deleted note." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError", "description": "Error response for single note deletion failures" } } }, "description": "The request parameters are invalid. Resolution: Ensure the module name, parent record ID, and note ID in the path are valid." }, "401": { "$ref": "#/components/responses/RelatedNotesUnauthorized" }, "404": { "$ref": "#/components/responses/RelatedNotesNotFound" }, "500": { "$ref": "#/components/responses/RelatedNotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.modules.notes.DELETE" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.modules.notes.DELETE" ] } ], "summary": "Related Note", "tags": [ "related_notes" ], "x-zoho-document": "related_notes", "x-zs-llm-description": "Deletes a single related note by noteId within a parent-scoped path. Use this when removing one known note; for multiple note deletions use the bulk delete variant with ids query parameter." }, "get": { "description": "Retrieves details of a specific note record associated with a CRM record in your Zoho CRM organization.", "operationId": "getNotesById", "parameters": [ { "$ref": "#/components/parameters/RelatedNotesParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecordId" }, { "$ref": "#/components/parameters/NoteId" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessResponse": { "description": "Shows a successful response with the complete details of the specified note, including attachments.", "summary": "Success response for status 200", "value": { "data": [ { "$attachments": [ { "$file_id": "2rsp48b6960fb9f4d444dada8740791775f35", "File_Name": "20251117_194524.jpg", "Size": "1623514", "id": "1043386000020248003" } ], "Created_Time": "2025-11-14T11:54:12+05:30", "Modified_Time": "2025-11-19T19:27:53+05:30", "Note_Content": "sdf", "Note_Title": null, "Owner": { "email": "prasanna.saravanan@zohocorp.com", "id": "1043386000000322001", "name": "Prasanna" }, "Parent_Id": { "id": "1043386000019763257", "module": { "api_name": "Leads", "id": "1043386000000002175" }, "name": "a" }, "id": "1043386000020244003" } ] } } }, "schema": { "additionalProperties": false, "description": "Response payload containing the details of the requested note record.", "properties": { "data": { "description": "JSON array representing the list containing the requested note record.", "items": { "additionalProperties": true, "description": "Represents the note record matching the specified note ID.", "properties": { "$attachments": { "description": "Represents the list of file attachments associated with the note.", "items": { "additionalProperties": true, "description": "Represents an individual file attachment associated with the note.", "properties": { "$file_id": { "description": "Represents the unique file identifier of the attachment.", "maxLength": 255, "type": "string" }, "File_Name": { "description": "Represents the name of the attached file.", "maxLength": 255, "type": "string" }, "Size": { "description": "Represents the size of the attached file in bytes.", "format": "int64", "type": "string" }, "id": { "description": "Represents the unique identifier of the attachment record.", "format": "int64", "type": "string" } }, "type": "object" }, "maxItems": 50, "type": [ "array", "null" ] }, "Note_Content": { "description": "Represents the content of the note.", "maxLength": 65535, "type": [ "string", "null" ] }, "Note_Title": { "description": "Represents the title of the note.", "maxLength": 120, "type": [ "string", "null" ] }, "Parent_Id": { "additionalProperties": false, "description": "Represents the parent record associated with the note.", "properties": { "id": { "description": "Specify the unique ID of the parent record. Refer to Refer the [GET Records API](record.yaml#.$path./{module}.get) to get valid record IDs.", "format": "int64", "type": "string" }, "module": { "additionalProperties": false, "description": "Represents the module of the parent record.", "properties": { "api_name": { "description": "Represents the API name of the parent record module. Refer to [Get Modules](modules.yaml#$.paths./settings/modules.get) for the list of supported modules.", "maxLength": 50, "type": "string" }, "id": { "description": "Represents the unique identifier of the parent record module.", "format": "int64", "type": "string" } }, "required": [ "api_name", "id" ], "type": "object" }, "name": { "description": "Represents the name of the parent record.", "maxLength": 255, "type": "string" } }, "required": [ "module", "id" ], "type": "object" }, "id": { "description": "Represents the unique identifier of the note.", "format": "int64", "type": "string" } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "GetNotesByIdResponse200" } } }, "description": "Returns the details of the specified note." }, "204": { "$ref": "#/components/responses/RelatedNotesNoContent" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestError", "description": "Error response for single note retrieval failures" } } }, "description": "The request parameters are invalid. Resolution: Ensure the module name, parent record ID, and note ID in the path are valid." }, "401": { "$ref": "#/components/responses/RelatedNotesUnauthorized" }, "404": { "$ref": "#/components/responses/RelatedNotesNotFound" }, "500": { "$ref": "#/components/responses/RelatedNotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.modules.notes.READ" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.modules.notes.READ" ] } ], "summary": "Specific Related Note", "tags": [ "related_notes" ], "x-zoho-document": "related_notes", "x-zs-llm-description": "Fetches one related note by noteId in the context of its parent module and parent record. Use this before update or delete to confirm the target note and parent association." }, "put": { "description": "Updates an existing note associated with a specific parent record. Either note content or note title must be provided (at least one is mandatory).", "operationId": "updateRelatedNoteById", "parameters": [ { "$ref": "#/components/parameters/RelatedNotesParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecordId" }, { "$ref": "#/components/parameters/NoteId" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateNote": { "description": "Shows a sample PUT request body for updating a note's content and title.", "summary": "Sample request body for updating a note", "value": { "data": [ { "Note_Content": "Customer requested additional information", "Note_Title": "Follow-up Completed" } ] } } }, "schema": { "additionalProperties": false, "description": "Request payload for updating the title and content of a specific note.", "properties": { "data": { "description": "Specify the note fields to update.", "items": { "additionalProperties": true, "description": "A note object containing the fields to update.", "properties": { "Note_Content": { "description": "Specify the updated content of the note.", "maxLength": 65535, "type": "string" }, "Note_Title": { "description": "Specify the updated title of the note.", "maxLength": 120, "type": "string" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" }, "x-zs-llm-examples": [ "UpdateNote" ] } }, "description": "The request body must contain a data array with one note object including at least one of Note_Title or Note_Content.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpdate": { "description": "Shows a successful note update response with the action status and details of the updated note.", "summary": "Success response for status 200", "value": { "data": [ { "code": "SUCCESS", "details": { "Created_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Created_Time": "2023-12-19T16:45:07+05:30", "Modified_By": { "id": "4876876000000327001", "name": "Patricia Boyle" }, "Modified_Time": "2023-12-19T17:30:15+05:30", "id": "4876876000006021002" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "additionalProperties": false, "description": "Success response for single note update, containing the action status and details of the updated note.", "properties": { "data": { "description": "Represents the list of action status objects for the updated note.", "items": { "additionalProperties": false, "description": "Represents the action status for the note update.", "properties": { "code": { "description": "Represents the result code for this note update.", "enum": [ "SUCCESS" ], "type": "string" }, "details": { "additionalProperties": false, "description": "Contains the details of the updated note record.", "properties": { "Created_By": { "additionalProperties": false, "description": "Represents the user who created the note.", "properties": { "id": { "description": "Represents the ID of the user who created the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who created the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Created_Time": { "description": "Represents the creation date and time of the note.", "format": "date-time", "type": "string" }, "Modified_By": { "additionalProperties": false, "description": "Represents the user who last modified the note.", "properties": { "id": { "description": "Represents the ID of the user who last modified the note.", "format": "int64", "type": "string" }, "name": { "description": "Represents the name of the user who last modified the note.", "maxLength": 255, "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "Modified_Time": { "description": "Represents the date and time when the note was last modified.", "format": "date-time", "type": "string" }, "id": { "description": "Represents the unique identifier of the updated note.", "format": "int64", "type": "string" } }, "required": [ "id", "Modified_Time", "Created_Time", "Created_By", "Modified_By" ], "type": "object" }, "message": { "description": "Represents the result message for this note update.", "maxLength": 500, "type": "string" }, "status": { "description": "Represents the status of this note update.", "enum": [ "success" ], "type": "string" } }, "required": [ "code", "message", "status", "details" ], "type": "object" }, "maxItems": 200, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "UpdateNoteResponse200" } } }, "description": "Returns the action status and details of the updated note." }, "400": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/RelatedNotesExpectedFieldMissingError" }, { "$ref": "#/components/schemas/RelatedNotesNotAllowedErrorSingle" }, { "$ref": "#/components/schemas/RelatedNotesCannotPerformActionErrorSingle" } ], "description": "Validation error response for the PUT single note update request.", "x-zs-$id": "UpdateNotesBadRequestError400" } } }, "description": "The request data is invalid. Resolution: Ensure the request body includes valid values and that at least one of Note_Title or Note_Content is provided." }, "401": { "$ref": "#/components/responses/RelatedNotesUnauthorized" }, "404": { "$ref": "#/components/responses/RelatedNotesNotFound" }, "500": { "$ref": "#/components/responses/RelatedNotesInternalServerError" } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.Leads.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Contacts.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Accounts.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Deals.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Tasks.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Events.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Calls.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Products.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Vendors.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Campaigns.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Cases.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Solutions.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Pricebooks.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Quotes.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Salesorders.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Purchaseorders.READ", "ZohoCRM.modules.notes.UPDATE" ] }, { "OAuth2": [ "ZohoCRM.modules.Custom.READ", "ZohoCRM.modules.notes.UPDATE" ] } ], "summary": "Related Note", "tags": [ "related_notes" ], "x-zoho-document": "related_notes", "x-zs-llm-description": "Updates one related note identified by noteId under the specified parent record. Provide at least one of Note_Content or Note_Title. Use this for single-record edits where bulk update is not required." } }, "/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}": { "delete": { "description": "To delink multiple records from a parent record's related list in your Zoho CRM organization. This operation removes only the relationship links - the related records themselves remain intact in their respective modules.", "operationId": "delinkRelatedRecords", "parameters": [ { "$ref": "#/components/parameters/RelatedRecordsParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecord" }, { "$ref": "#/components/parameters/RelatedList" }, { "$ref": "#/components/parameters/RelatedRecordsIds" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDelink": { "description": "Shows a successful response when all specified record IDs are delinked from the parent record.", "summary": "Records delinked successfully", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "3652397000001234001" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } }, "description": "Returns the bulk operation response indicating the status of each delink request." }, "207": { "content": { "application/json": { "examples": { "PartialSuccessDelink": { "description": "Shows a mixed-status response when some record IDs are delinked and others are invalid or not found.", "summary": "Some relations removed, some relation IDs invalid/not found", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4732219000018885044" }, "message": "relation removed", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "99999999" }, "message": "relation not found", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } }, "description": "Returns a bulk operation response when some records are delinked and others fail. Each item in the **data** array indicates whether the delink succeeded or the reason for failure." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows an authorization failure response when the access token lacks the required delete privilege.", "summary": "Insufficient privilege to delete related records data", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to delete related records data", "status": "error" } }, "InvalidDataError": { "description": "Shows an invalid data error response when a related record ID in the request is invalid.", "summary": "Invalid data or related ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "The related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNameError": { "description": "Shows an invalid data error response when the related list name in the request is invalid.", "summary": "Invalid data or related name", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related name given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows an error response when the module name in the request URL is not a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an error response when the HTTP method used does not match the supported method for this endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "LimitExceeded": { "description": "Shows an error response when the number of record IDs in the request exceeds the allowed limit.", "summary": "Too many record IDs provided", "value": { "code": "LIMIT_EXCEEDED", "details": { "limit": "100", "param_name": "ids" }, "message": "Limit Exceeded, You cannot give more than 100 record ids", "status": "error" } }, "MandatoryNotFound": { "description": "Shows a required parameter is missing.", "summary": "A required parameter is missing", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "param_name": "ids" }, "message": "One of the expected parameter is missing", "status": "error" } }, "NotSupported": { "description": "Shows module not supported in API.", "summary": "Module not supported in API", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "The given module is not supported in API", "status": "error" } }, "RelationNotFound": { "description": "Shows relation not found for the given record.", "summary": "Relation not found for the given record", "value": { "data": [ { "code": "INVALID_DATA", "details": { "id": "36547" }, "message": "relation not found", "status": "error" } ] } }, "UnableToParseDataType": { "description": "Shows request body or parameters in wrong format.", "summary": "Request body or parameters in wrong format", "value": { "code": "UNABLE_TO_PARSE_DATA_TYPE", "details": {}, "message": "Either the request body or parameters is in wrong format", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidModuleError" }, { "$ref": "#/components/schemas/RelatedRecordsNotSupportedError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RelatedRecordsAuthorizationFailedError" }, { "$ref": "#/components/schemas/RelatedRecordsMandatoryNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsUnableToParseDataTypeError" }, { "$ref": "#/components/schemas/RelationNotFoundBulkError" }, { "$ref": "#/components/schemas/RelatedRecordsLimitExceededError" } ], "description": "Contains one of the possible client error responses for invalid module name, unsupported module, invalid data, invalid request method, authorization failure, mandatory field not found, unable to parse data type, relation not found, or record limit exceeded.", "x-zs-$id": "DelinkRelatedRecords400ErrorResponse" } } }, "description": "The request contains invalid input, an unsupported module, an invalid request method, or exceeds the record limit.\n**Resolution:** Review the error code and message in the response to identify the specific issue." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows invalid authentication token.", "summary": "Invalid authentication token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid OAuth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows missing DELETE scope.", "summary": "Missing DELETE scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token you have used to make this API call does not have the required scope.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidTokenError" }, { "$ref": "#/components/schemas/RelatedRecordsOAuthScopeMismatchError" } ], "description": "Contains one of the possible unauthorized access error responses for invalid token or OAuth scope mismatch.", "x-zs-$id": "DeleteRelatedRecords401ErrorResponse" } } }, "description": "Authentication failed due to an invalid or expired token.\n**Resolution:** A valid access token must be provided in the Authorization header." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows no permission to delete related records.", "summary": "No permission to delete related records", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to delete records", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsNoPermissionError", "x-zs-$id": "NoPermissionError" } } }, "description": "The access token does not have permission to delete related records in this module.\n**Resolution:** The CRM administrator must grant the required delete permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "description": "Shows invalid URL pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "RecordNotFound": { "description": "Shows parent or related record not found.", "summary": "Parent or related record not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "The record does not exist", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidUrlPatternError" } ], "description": "Contains one of the possible not-found error responses for record not found or invalid URL pattern.", "x-zs-$id": "RecordNotFoundAndInvalidUrlPatternErrorForDeleteRecordByIds" } } }, "description": "The specified parent record or related list does not exist.\n**Resolution:** The **parentRecord** and **relatedList** path parameter values must refer to existing resources." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows unexpected server error.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Unexpected and unhandled exception in Server", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsInternalError", "x-zs-$id": "InternalError" } } }, "description": "An internal server error occurred.\n**Resolution:** Retry the request after a brief delay. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.DELETE" ] } ], "summary": "Delink related records", "tags": [ "related_records" ], "x-zoho-document": "related_records" }, "get": { "description": "To retrieve the list of records associated with a parent record from a specified related list in your Zoho CRM organization.", "operationId": "getRelatedRecords", "parameters": [ { "$ref": "#/components/parameters/RelatedRecordsParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecord" }, { "$ref": "#/components/parameters/RelatedList" }, { "$ref": "#/components/parameters/RelatedRecordsFields" }, { "$ref": "#/components/parameters/RelatedRecordsPage" }, { "$ref": "#/components/parameters/RelatedRecordsPerPage" }, { "$ref": "#/components/parameters/RelatedRecordsIfModifiedSince" }, { "$ref": "#/components/parameters/RelatedRecordsPageToken" }, { "$ref": "#/components/parameters/IdsOptional" }, { "$ref": "#/components/parameters/RelatedRecordsSortOrder" }, { "$ref": "#/components/parameters/RelatedRecordsSortBy" }, { "$ref": "#/components/parameters/RelatedRecordsConverted" }, { "$ref": "#/components/parameters/RelatedRecordsApproved" }, { "$ref": "#/components/parameters/RelatedRecordsApprovalState" }, { "$ref": "#/components/parameters/RelatedRecordsFilters" } ], "responses": { "200": { "content": { "application/json": { "examples": { "ContactProductsSuccess": { "description": "Shows contact with related Products.", "summary": "Contact with related Products", "value": { "data": [ { "Created_Time": "2024-01-15T10:30:00Z", "Modified_Time": "2024-01-20T14:45:00Z", "Product_Name": "Premium Widget", "Unit_Price": 99.99, "id": "3652397000001234001" } ], "info": { "count": 1, "more_records": false, "next_page_token": null, "page": 1, "page_token_expiry": null, "per_page": 200, "previous_page_token": null } } }, "DealContactsPaginated": { "description": "Shows deal with multiple related Contacts (paginated).", "summary": "Deal with multiple related Contacts (paginated)", "value": { "data": [ { "Created_Time": "2024-01-10T09:00:00Z", "Email": "john.doe@example.com", "First_Name": "John", "Last_Name": "Doe", "Modified_Time": "2024-01-15T11:20:00Z", "id": "3652397000000624001" } ], "info": { "count": 1, "more_records": true, "next_page_token": "abc123", "page": 1, "page_token_expiry": "2024-01-25T10:00:00Z", "per_page": 200, "previous_page_token": null } } } }, "schema": { "additionalProperties": false, "description": "Represents the response for a list of related records, including the record fields and pagination metadata.", "properties": { "data": { "description": "Array of related record objects with requested fields.", "items": { "additionalProperties": true, "description": "Individual related record with dynamic CRM fields.", "properties": { "Created_Time": { "description": "Represents the creation date and time of the related record.", "format": "date-time", "type": "string" }, "Modified_Time": { "description": "Timestamp when the record was last modified.", "format": "date-time", "type": "string" }, "Moved_To__s": { "description": "Stage value to which the record was moved (stage history / picklist movement).", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the related record.", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "RelatedRecordsId2" } }, "type": "object" }, "maxItems": 200, "type": "array" }, "info": { "additionalProperties": false, "description": "Pagination and response metadata.", "properties": { "count": { "description": "Number of records in current response.", "format": "int32", "minimum": 0, "type": "integer" }, "more_records": { "description": "Indicates if more pages are available.", "type": "boolean" }, "next_page_token": { "description": "Token to retrieve the next page of results.", "maxLength": 500, "type": [ "string", "null" ] }, "page": { "description": "Current page number.", "format": "int32", "minimum": 1, "type": "integer" }, "page_token_expiry": { "description": "Expiration timestamp for the page token.", "format": "date-time", "type": [ "string", "null" ] }, "per_page": { "description": "Number of records per page.", "format": "int32", "maximum": 200, "minimum": 1, "type": "integer" }, "previous_page_token": { "description": "Token to retrieve the previous page of results.", "maxLength": 500, "type": [ "string", "null" ] } }, "required": [ "page", "per_page", "count", "more_records" ], "type": "object" } }, "required": [ "data", "info" ], "type": "object", "x-zs-$id": "SuccessResponse" } } }, "description": "Returns the list of related records for the specified parent record, along with pagination metadata." }, "204": { "description": "No related records were found for the specified parent record in the given related list." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows an authorization failure response when the access token lacks the required read privilege.", "summary": "Insufficient privilege to read related records data", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to read related records data", "status": "error" } }, "InvalidDataError": { "description": "Shows an invalid data error response when a related record ID in the request is invalid.", "summary": "Invalid data or related ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "The related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNameError": { "description": "Shows an invalid data error response when the related list name in the request is invalid.", "summary": "Invalid data or related name", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related name given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows an error response when the module name in the request URL is not a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The given module is not supported", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an error response when the HTTP method used does not match the supported method for this endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "NotSupported": { "description": "Shows module not supported in API.", "summary": "Module not supported in API", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "The given module is not supported in API", "status": "error" } }, "RequiredParamMissing": { "description": "Shows a required parameter is missing.", "summary": "A required parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidModuleError" }, { "$ref": "#/components/schemas/RelatedRecordsNotSupportedError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RelatedRecordsAuthorizationFailedError" }, { "$ref": "#/components/schemas/RelatedRecordsRequiredParamMissingError" } ], "description": "Contains one of the possible client error responses for invalid module name, unsupported module, invalid data, invalid request method, or authorization failure. May also indicate a missing required parameter.", "x-zs-$id": "GetRelatedRecords400ErrorResponse" } } }, "description": "The request contains invalid input, an unsupported module, or an invalid request method.\n**Resolution:** Review the error code and message in the response to identify the specific issue." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows invalid authentication token.", "summary": "Invalid authentication token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid OAuth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows missing READ scope.", "summary": "Missing READ scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token you have used to make this API call does not have the required scope.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidTokenError" }, { "$ref": "#/components/schemas/RelatedRecordsOAuthScopeMismatchError" } ], "description": "Contains one of the possible unauthorized access error responses for invalid token or OAuth scope mismatch.", "x-zs-$id": "GetRelatedRecords401ErrorResponse" } } }, "description": "Authentication failed due to an invalid or expired token.\n**Resolution:** A valid access token must be provided in the Authorization header." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows no permission to read related records.", "summary": "No permission to read related records", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to read related records", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsNoPermissionError", "x-zs-$id": "NoPermissionError" } } }, "description": "The access token does not have permission to read related records in this module.\n**Resolution:** The CRM administrator must grant the required read permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "description": "Shows invalid URL pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "RecordNotFound": { "description": "Shows a not-found error response when the specified parent record does not exist.", "summary": "Parent record not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "The record does not exist", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidUrlPatternError" } ], "description": "Contains one of the possible not-found error responses for record not found or invalid URL pattern.", "x-zs-$id": "RecordNotFoundAndInvalidUrlPatternErrorForGetRelatedRecords" } } }, "description": "The specified parent record or related list does not exist.\n**Resolution:** The **parentRecord** and **relatedList** path parameter values must refer to existing resources." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows unexpected server error.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Unexpected and unhandled exception in Server", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsInternalError", "x-zs-$id": "InternalError" } } }, "description": "An internal server error occurred.\n**Resolution:** Retry the request after a brief delay. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Related Records", "tags": [ "related_records" ], "x-zoho-document": "related_records" }, "put": { "description": "To update multiple records associated with a parent record in a specified related list in your Zoho CRM organization.", "operationId": "updateRelatedRecords", "parameters": [ { "$ref": "#/components/parameters/RelatedRecordsParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecord" }, { "$ref": "#/components/parameters/RelatedList" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateMultipleProducts": { "description": "Shows update prices for multiple products.", "summary": "Update prices for multiple products", "value": { "data": [ { "Discount": 10, "Unit_Price": 109.99, "id": "3652397000001234001" }, { "Discount": 5, "Unit_Price": 79.99, "id": "3652397000001234002" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload for updating multiple related records in a related list.", "properties": { "data": { "description": "Array of records to update with their IDs and field values.", "items": { "additionalProperties": true, "description": "Individual record update with ID and fields to modify.", "properties": { "id": { "description": "Unique identifier of the record to update.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "description": "The request body must contain a **data** array with one or more objects. You can include a maximum of 100 objects per request.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpdate": { "description": "Shows all records updated successfully.", "summary": "All records updated successfully", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "3652397000001234001" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } }, "description": "Returns the bulk operation response indicating the status of each update request." }, "207": { "content": { "application/json": { "examples": { "PartialSuccessUpdate": { "description": "Shows some records updated, some records failed.", "summary": "Some records updated, some records failed", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "4732219000018885044" }, "message": "record updated", "status": "success" }, { "code": "INVALID_DATA", "details": { "id": "99999999" }, "message": "invalid data", "status": "error" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } }, "description": "Returns a mixed-status bulk operation response when some records update successfully and others fail. Each item in the **data** array indicates whether the record update succeeded or provides the reason for failure." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows an authorization failure response when the access token lacks the required update privilege.", "summary": "Insufficient privilege to update related records data", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to update related records data", "status": "error" } }, "InvalidDataError": { "description": "Shows an invalid data error response when a related record ID in the request is invalid.", "summary": "Invalid data or related ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "The related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNameError": { "description": "Shows an invalid data error response when the related list name in the request is invalid.", "summary": "Invalid data or related name", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related name given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows an error response when the module name in the request URL is not a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The given module is not supported", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an error response when the HTTP method used does not match the supported method for this endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFound": { "description": "Shows required field not found.", "summary": "Required field not found", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "list_price", "json_path": "$.data[0].list_price" }, "message": "Required field not found", "status": "error" } }, "MandatoryNotFoundBulk": { "description": "Shows required field not found in bulk operation.", "summary": "Required field not found in bulk operation", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "list_price", "json_path": "$.data[0].list_price" }, "message": "required field not found", "status": "error" } ] } }, "NotSupported": { "description": "Shows module not supported in API.", "summary": "Module not supported in API", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The given module is not supported in API", "status": "error" } }, "RelationNotFoundBulk": { "description": "Shows relation not found error.", "summary": "Relation not found error", "value": { "data": [ { "code": "INVALID_DATA", "details": { "api_name": "id", "json_path": "$.data[0].id" }, "message": "the id given seems to be invalid", "status": "error" } ] } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidModuleError" }, { "$ref": "#/components/schemas/RelatedRecordsNotSupportedError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RelatedRecordsAuthorizationFailedError" }, { "$ref": "#/components/schemas/RelatedRecordsMandatoryNotFoundError" }, { "$ref": "#/components/schemas/RelationNotFoundBulkError" }, { "$ref": "#/components/schemas/MandatoryNotFoundBulkError" } ], "description": "Contains one of the possible client error responses for invalid module name, unsupported module, invalid data, invalid request method, authorization failure, mandatory field not found, relation not found, or mandatory field missing in bulk data.", "x-zs-$id": "UpdateSpecificRelatedRecord400ErrorResponse" } } }, "description": "The request contains invalid input, an unsupported module, mandatory field missing, or an invalid request method.\n**Resolution:** Review the error code and message in the response to identify the specific issue." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows invalid authentication token.", "summary": "Invalid authentication token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid OAuth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows missing READ scope.", "summary": "Missing READ scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token you have used to make this API call does not have the required scope.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidTokenError" }, { "$ref": "#/components/schemas/RelatedRecordsOAuthScopeMismatchError" } ], "description": "Contains one of the possible unauthorized access error responses for invalid token or OAuth scope mismatch.", "x-zs-$id": "UpdateRelatedRecords401ErrorResponse" } } }, "description": "Authentication failed due to an invalid or expired token.\n**Resolution:** A valid access token must be provided in the Authorization header." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows no permission to read related records.", "summary": "No permission to read related records", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to read related records", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsNoPermissionError", "x-zs-$id": "NoPermissionError" } } }, "description": "The access token does not have permission to update related records in this module.\n**Resolution:** The CRM administrator must grant the required update permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "description": "Shows invalid URL pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "RecordNotFound": { "description": "Shows a not-found error response when the specified related record does not exist.", "summary": "Related record not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "The record does not exist", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidUrlPatternError" } ], "description": "Contains one of the possible not-found error responses for record not found or invalid URL pattern.", "x-zs-$id": "RecordNotFoundAndInvalidUrlPatternErrorForUpdateRelatedRecords" } } }, "description": "The request URL does not match a valid API endpoint pattern.\n**Resolution:** The URL must follow the pattern `{api-domain}/crm/{version}/{parentRecordModule}/{parentRecord}/{relatedList}`." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows unexpected server error.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Unexpected and unhandled exception in Server", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsInternalError", "x-zs-$id": "InternalError" } } }, "description": "An internal server error occurred.\n**Resolution:** Retry the request after a brief delay. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Update related records", "tags": [ "related_records" ], "x-zoho-document": "related_records" } }, "/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}": { "delete": { "description": "To delink a specific related record from a parent record in your Zoho CRM organization. This operation removes only the relationship link - the related record itself remains intact in its module.", "operationId": "delinkSpecificRelatedRecord", "parameters": [ { "$ref": "#/components/parameters/RelatedRecordsParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecord" }, { "$ref": "#/components/parameters/RelatedList" }, { "$ref": "#/components/parameters/RelatedRecordsRecord" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulDelink": { "description": "Shows record delinked successfully.", "summary": "Record delinked successfully", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "3652397000001234001" }, "message": "record deleted", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } }, "description": "Returns the bulk operation response indicating the status of the delink request." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows an authorization failure response when the access token lacks the required delete privilege.", "summary": "Insufficient privilege to delete related records data", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to delete related records data", "status": "error" } }, "InvalidDataError": { "description": "Shows an invalid data error response when a related record ID in the request is invalid.", "summary": "Invalid data or related ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "The related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNameError": { "description": "Shows an invalid data error response when the related list name in the request is invalid.", "summary": "Invalid data or related name", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related name given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows an error response when the module name in the request URL is not a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The module name given seems to be invalid", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an error response when the HTTP method used does not match the supported method for this endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFound": { "description": "Shows a required parameter is missing.", "summary": "A required parameter is missing", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "list_price", "json_path": "$.data[0].list_price" }, "message": "One of the expected parameter is missing", "status": "error" } }, "NotSupported": { "description": "Shows module not supported in API.", "summary": "Module not supported in API", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "The given module is not supported in API", "status": "error" } }, "UnableToParseDataType": { "description": "Shows request body or parameters in wrong format.", "summary": "Request body or parameters in wrong format", "value": { "code": "UNABLE_TO_PARSE_DATA_TYPE", "details": {}, "message": "Either the request body or parameters is in wrong format", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidModuleError" }, { "$ref": "#/components/schemas/RelatedRecordsNotSupportedError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RelatedRecordsAuthorizationFailedError" }, { "$ref": "#/components/schemas/RelatedRecordsMandatoryNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsUnableToParseDataTypeError" } ], "description": "Contains one of the possible client error responses for invalid module name, unsupported module, invalid data, invalid request method, authorization failure, mandatory field not found, or unable to parse data type.", "x-zs-$id": "DelinkSpecificRelatedRecord400ErrorResponse" } } }, "description": "The request contains invalid input, an unsupported module, or an invalid request method.\n**Resolution:** Review the error code and message in the response to identify the specific issue." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows invalid authentication token.", "summary": "Invalid authentication token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid OAuth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows missing DELETE scope.", "summary": "Missing DELETE scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token you have used to make this API call does not have the required scope.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidTokenError" }, { "$ref": "#/components/schemas/RelatedRecordsOAuthScopeMismatchError" } ], "description": "Contains one of the possible unauthorized access error responses for invalid token or OAuth scope mismatch.", "x-zs-$id": "DeleteRelatedRecord401ErrorResponse" } } }, "description": "Authentication failed due to an invalid or expired token.\n**Resolution:** A valid access token must be provided in the Authorization header." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows no permission to delete related records.", "summary": "No permission to delete related records", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to delete records", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsNoPermissionError", "x-zs-$id": "NoPermissionError" } } }, "description": "The access token does not have permission to delete related records in this module.\n**Resolution:** The CRM administrator must grant the required delete permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "description": "Shows invalid URL pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "RecordNotFound": { "description": "Shows a not-found error response when the specified related record does not exist.", "summary": "Related record not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "The record does not exist", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidUrlPatternError" } ], "description": "Contains one of the possible not-found error responses for record not found or invalid URL pattern.", "x-zs-$id": "RecordNotFoundAndInvalidUrlPatternErrorForDeleteRecordById" } } }, "description": "The specified parent record, related record, or relationship does not exist.\n**Resolution:** The **parentRecord**, **relatedList**, and **record** path parameter values must refer to existing resources." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows unexpected server error.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Unexpected and unhandled exception in Server", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsInternalError", "x-zs-$id": "InternalError" } } }, "description": "An internal server error occurred.\n**Resolution:** Retry the request after a brief delay. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.DELETE" ] } ], "summary": "Delink a related record", "tags": [ "related_records" ], "x-zoho-document": "related_records" }, "get": { "description": "To retrieve the details of a specific related record from a specified related list of a parent record in your Zoho CRM organization.", "operationId": "getRelatedRecord", "parameters": [ { "$ref": "#/components/parameters/RelatedRecordsParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecord" }, { "$ref": "#/components/parameters/RelatedList" }, { "$ref": "#/components/parameters/RelatedRecordsRecord" }, { "$ref": "#/components/parameters/RelatedRecordsFields" } ], "responses": { "200": { "content": { "application/json": { "examples": { "SingleProductRecord": { "description": "Shows single product related to a contact.", "summary": "Single product related to a contact", "value": { "data": [ { "Created_Time": "2024-01-15T10:30:00Z", "Modified_Time": "2024-01-20T14:45:00Z", "Product_Name": "Premium Widget", "Unit_Price": 99.99, "id": "3652397000001234001" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the response for a single related record, including the record fields and metadata.", "properties": { "data": { "description": "Array containing the single related record.", "items": { "additionalProperties": true, "description": "Related record object with requested fields.", "properties": { "Created_Time": { "description": "Represents the creation date and time of the related record.", "format": "date-time", "type": "string" }, "Modified_Time": { "description": "Timestamp when the record was last modified.", "format": "date-time", "type": "string" }, "Moved_To__s": { "description": "Stage value to which the record was moved (stage history / picklist movement).", "maxLength": 255, "type": "string" }, "id": { "description": "Unique identifier of the related record.", "maxLength": 20, "pattern": "^[0-9]+$", "type": "string", "x-zs-$id": "RelatedRecordId" } }, "type": "object" }, "maxItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object", "x-zs-$id": "SuccessResponseContainingSingleRelatedRecordWithMetadata" } } }, "description": "Returns the details of the specified related record." }, "204": { "description": "The specified related record was not found for the given parent record." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows an authorization failure response when the access token lacks the required read privilege.", "summary": "Insufficient privilege to read related records data", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to read related records data", "status": "error" } }, "InvalidDataError": { "description": "Shows an invalid data error response when a related record ID in the request is invalid.", "summary": "Invalid data or related ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "The related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNameError": { "description": "Shows an invalid data error response when the related list name in the request is invalid.", "summary": "Invalid data or related name", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related name given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows an error response when the module name in the request URL is not a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The given module is not supported", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an error response when the HTTP method used does not match the supported method for this endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "NotSupported": { "description": "Shows module not supported in API.", "summary": "Module not supported in API", "value": { "code": "NOT_SUPPORTED", "details": { "resource_path_index": 0 }, "message": "The given module is not supported in API", "status": "error" } }, "RequiredParamMissing": { "description": "Shows a required parameter is missing.", "summary": "A required parameter is missing", "value": { "code": "REQUIRED_PARAM_MISSING", "details": { "param_name": "fields" }, "message": "One of the expected parameter is missing", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidModuleError" }, { "$ref": "#/components/schemas/RelatedRecordsNotSupportedError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RelatedRecordsAuthorizationFailedError" }, { "$ref": "#/components/schemas/RelatedRecordsRequiredParamMissingError" } ], "description": "Contains one of the possible client error responses for invalid module name, unsupported module, invalid data, invalid request method, or authorization failure. May also indicate a missing required parameter.", "x-zs-$id": "GetRelatedRecord400ErrorResponse" } } }, "description": "The request contains invalid input, an unsupported module, or an invalid request method.\n**Resolution:** Review the error code and message in the response to identify the specific issue." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows invalid authentication token.", "summary": "Invalid authentication token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid OAuth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows missing READ scope.", "summary": "Missing READ scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token you have used to make this API call does not have the required scope.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidTokenError" }, { "$ref": "#/components/schemas/RelatedRecordsOAuthScopeMismatchError" } ], "description": "Contains one of the possible unauthorized access error responses for invalid token or OAuth scope mismatch.", "x-zs-$id": "GetSpecificRelatedRecords401ErrorResponse" } } }, "description": "Authentication failed due to an invalid or expired token.\n**Resolution:** A valid access token must be provided in the Authorization header." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows no permission to read related records.", "summary": "No permission to read related records", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to read related records", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsNoPermissionError", "x-zs-$id": "NoPermissionError" } } }, "description": "The access token does not have permission to read related records in this module.\n**Resolution:** The CRM administrator must grant the required read permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "description": "Shows invalid URL pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "RecordNotFound": { "description": "Shows a not-found error response when the specified related record does not exist.", "summary": "Related record not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "The record does not exist", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidUrlPatternError" } ], "description": "Contains one of the possible not-found error responses for record not found or invalid URL pattern.", "x-zs-$id": "RecordNotFoundAndInvalidUrlPatternErrorForGetRelatedRecord" } } }, "description": "The specified related record does not exist.\n**Resolution:** The **parentRecord**, **relatedList**, and **record** path parameter values must refer to existing resources." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows unexpected server error.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Unexpected and unhandled exception in Server", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsInternalError", "x-zs-$id": "InternalError" } } }, "description": "An internal server error occurred.\n**Resolution:** Retry the request after a brief delay. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.READ" ] } ], "summary": "Get a related record", "tags": [ "related_records" ], "x-zoho-document": "related_records" }, "put": { "description": "To update the properties of a specific record associated with a parent record in your Zoho CRM organization.", "operationId": "updateSpecificRelatedRecord", "parameters": [ { "$ref": "#/components/parameters/RelatedRecordsParentRecordModule" }, { "$ref": "#/components/parameters/ParentRecord" }, { "$ref": "#/components/parameters/RelatedList" }, { "$ref": "#/components/parameters/RelatedRecordsRecord" } ], "requestBody": { "content": { "application/json": { "examples": { "UpdateSingleProduct": { "description": "Shows update price for a single product.", "summary": "Update price for a single product", "value": { "data": [ { "Discount": 10, "Unit_Price": 109.99, "id": "3652397000001234001" } ] } } }, "schema": { "additionalProperties": false, "description": "Represents the request payload for updating a specific related record.", "properties": { "data": { "description": "Array containing the record to update.", "items": { "additionalProperties": true, "description": "Record update with ID and fields to modify.", "properties": { "id": { "description": "Unique identifier of the record to update.", "format": "int64", "type": "string", "x-zs-$ref": { "origins": [ { "operationId": "getRecords", "propertyId": "RecordsId" } ], "resource": "record" } } }, "required": [ "id" ], "type": "object" }, "maxItems": 1, "minItems": 1, "type": "array" } }, "required": [ "data" ], "type": "object" } } }, "description": "The request body must contain a **data** array with exactly one object.", "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "SuccessfulUpdate": { "description": "Shows record updated successfully.", "summary": "Record updated successfully", "value": { "data": [ { "code": "SUCCESS", "details": { "id": "3652397000001234001" }, "message": "record updated", "status": "success" } ] } } }, "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } }, "description": "Returns the bulk operation response indicating the status of the update request." }, "400": { "content": { "application/json": { "examples": { "AuthorizationFailed": { "description": "Shows an authorization failure response when the access token lacks the required update privilege.", "summary": "Insufficient privilege to update related records data", "value": { "code": "AUTHORIZATION_FAILED", "details": {}, "message": "User does not have sufficient privilege to update related records data", "status": "error" } }, "InvalidDataError": { "description": "Shows an invalid data error response when a related record ID in the request is invalid.", "summary": "Invalid data or related ID", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 1 }, "message": "The related id given seems to be invalid", "status": "error" } }, "InvalidDataRelationNameError": { "description": "Shows an invalid data error response when the related list name in the request is invalid.", "summary": "Invalid data or related name", "value": { "code": "INVALID_DATA", "details": { "resource_path_index": 2 }, "message": "The related name given seems to be invalid", "status": "error" } }, "InvalidModule": { "description": "Shows an error response when the module name in the request URL is not a valid Zoho CRM module.", "summary": "Invalid module name provided", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The given module is not supported", "status": "error" } }, "InvalidRequestMethod": { "description": "Shows an error response when the HTTP method used does not match the supported method for this endpoint.", "summary": "Invalid HTTP request method", "value": { "code": "INVALID_REQUEST_METHOD", "details": {}, "message": "The http request method type is not a valid one", "status": "error" } }, "MandatoryNotFound": { "description": "Shows required field not found.", "summary": "Required field not found", "value": { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "list_price", "json_path": "$.data[0].list_price" }, "message": "Required field not found", "status": "error" } }, "MandatoryNotFoundBulk": { "description": "Shows required field not found in bulk operation.", "summary": "Required field not found in bulk operation", "value": { "data": [ { "code": "MANDATORY_NOT_FOUND", "details": { "api_name": "list_price", "json_path": "$.data[0].list_price" }, "message": "required field not found", "status": "error" } ] } }, "NotSupported": { "description": "Shows module not supported in API.", "summary": "Module not supported in API", "value": { "code": "INVALID_MODULE", "details": { "resource_path_index": 0 }, "message": "The given module is not supported in API", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidModuleError" }, { "$ref": "#/components/schemas/RelatedRecordsNotSupportedError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidDataError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidRequestMethodError" }, { "$ref": "#/components/schemas/RelatedRecordsAuthorizationFailedError" }, { "$ref": "#/components/schemas/RelatedRecordsMandatoryNotFoundError" }, { "$ref": "#/components/schemas/MandatoryNotFoundBulkError" } ], "description": "Contains one of the possible client error responses for invalid module name, unsupported module, invalid data, invalid request method, authorization failure, or mandatory field not found.", "x-zs-$id": "UpdateRelatedRecords400ErrorResponse" } } }, "description": "The request contains invalid input, an unsupported module, mandatory field missing, or an invalid request method.\n**Resolution:** Review the error code and message in the response to identify the specific issue." }, "401": { "content": { "application/json": { "examples": { "InvalidToken": { "description": "Shows invalid authentication token.", "summary": "Invalid authentication token", "value": { "code": "INVALID_TOKEN", "details": {}, "message": "Invalid OAuth token", "status": "error" } }, "OAuthScopeMismatch": { "description": "Shows missing READ scope.", "summary": "Missing READ scope", "value": { "code": "OAUTH_SCOPE_MISMATCH", "details": {}, "message": "The access token you have used to make this API call does not have the required scope.", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RelatedRecordsInvalidTokenError" }, { "$ref": "#/components/schemas/RelatedRecordsOAuthScopeMismatchError" } ], "description": "Contains one of the possible unauthorized access error responses for invalid token or OAuth scope mismatch.", "x-zs-$id": "UpdateRelatedRecord401ErrorResponse" } } }, "description": "Authentication failed due to an invalid or expired token.\n**Resolution:** A valid access token must be provided in the Authorization header." }, "403": { "content": { "application/json": { "examples": { "NoPermission": { "description": "Shows no permission to read related records.", "summary": "No permission to read related records", "value": { "code": "NO_PERMISSION", "details": { "permissions": [ "Crm_Implied_View_Leads" ] }, "message": "Permission denied to read related records", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsNoPermissionError", "x-zs-$id": "NoPermissionError" } } }, "description": "The access token does not have permission to update related records in this module.\n**Resolution:** The CRM administrator must grant the required update permission to the user's profile." }, "404": { "content": { "application/json": { "examples": { "InvalidURLPattern": { "description": "Shows invalid URL pattern.", "summary": "Invalid URL pattern", "value": { "code": "INVALID_URL_PATTERN", "details": {}, "message": "Please check if the URL trying to access is a correct one", "status": "error" } }, "RecordNotFound": { "description": "Shows a not-found error response when the specified related record does not exist.", "summary": "Related record not found", "value": { "code": "INVALID_DATA", "details": {}, "message": "The record does not exist", "status": "error" } } }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RecordNotFoundError" }, { "$ref": "#/components/schemas/RelatedRecordsInvalidUrlPatternError" } ], "description": "Contains one of the possible not-found error responses for record not found or invalid URL pattern.", "x-zs-$id": "RecordNotFoundAndInvalidUrlPatternErrorForUpdateRelatedRecord" } } }, "description": "The specified related record does not exist.\n**Resolution:** The **parentRecord**, **relatedList**, and **record** path parameter values must refer to existing resources." }, "500": { "content": { "application/json": { "examples": { "InternalError": { "description": "Shows unexpected server error.", "summary": "Unexpected server error", "value": { "code": "INTERNAL_ERROR", "details": {}, "message": "Unexpected and unhandled exception in Server", "status": "error" } } }, "schema": { "$ref": "#/components/schemas/RelatedRecordsInternalError", "x-zs-$id": "InternalError" } } }, "description": "An internal server error occurred.\n**Resolution:** Retry the request after a brief delay. If the issue persists, contact Zoho CRM support." } }, "security": [ { "OAuth2": [ "ZohoCRM.modules.UPDATE" ] } ], "summary": "Update a related record", "tags": [ "related_records" ], "x-zoho-document": "related_records" } } } }